Variables
TransactionEvent_TransactionEventType_name, TransactionEvent_TransactionEventType_value
var (
TransactionEvent_TransactionEventType_name = map[int32]string{
0: "TRANSACTION_EVENT_TYPE_UNSPECIFIED",
1: "MERCHANT_APPROVE",
2: "MERCHANT_DENY",
3: "MANUAL_REVIEW",
4: "AUTHORIZATION",
5: "AUTHORIZATION_DECLINE",
6: "PAYMENT_CAPTURE",
7: "PAYMENT_CAPTURE_DECLINE",
8: "CANCEL",
9: "CHARGEBACK_INQUIRY",
10: "CHARGEBACK_ALERT",
11: "FRAUD_NOTIFICATION",
12: "CHARGEBACK",
13: "CHARGEBACK_REPRESENTMENT",
14: "CHARGEBACK_REVERSE",
15: "REFUND_REQUEST",
16: "REFUND_DECLINE",
17: "REFUND",
18: "REFUND_REVERSE",
}
TransactionEvent_TransactionEventType_value = map[string]int32{
"TRANSACTION_EVENT_TYPE_UNSPECIFIED": 0,
"MERCHANT_APPROVE": 1,
"MERCHANT_DENY": 2,
"MANUAL_REVIEW": 3,
"AUTHORIZATION": 4,
"AUTHORIZATION_DECLINE": 5,
"PAYMENT_CAPTURE": 6,
"PAYMENT_CAPTURE_DECLINE": 7,
"CANCEL": 8,
"CHARGEBACK_INQUIRY": 9,
"CHARGEBACK_ALERT": 10,
"FRAUD_NOTIFICATION": 11,
"CHARGEBACK": 12,
"CHARGEBACK_REPRESENTMENT": 13,
"CHARGEBACK_REVERSE": 14,
"REFUND_REQUEST": 15,
"REFUND_DECLINE": 16,
"REFUND": 17,
"REFUND_REVERSE": 18,
}
)
Enum value maps for TransactionEvent_TransactionEventType.
AnnotateAssessmentRequest_Annotation_name, AnnotateAssessmentRequest_Annotation_value
var (
AnnotateAssessmentRequest_Annotation_name = map[int32]string{
0: "ANNOTATION_UNSPECIFIED",
1: "LEGITIMATE",
2: "FRAUDULENT",
3: "PASSWORD_CORRECT",
4: "PASSWORD_INCORRECT",
}
AnnotateAssessmentRequest_Annotation_value = map[string]int32{
"ANNOTATION_UNSPECIFIED": 0,
"LEGITIMATE": 1,
"FRAUDULENT": 2,
"PASSWORD_CORRECT": 3,
"PASSWORD_INCORRECT": 4,
}
)
Enum value maps for AnnotateAssessmentRequest_Annotation.
AnnotateAssessmentRequest_Reason_name, AnnotateAssessmentRequest_Reason_value
var (
AnnotateAssessmentRequest_Reason_name = map[int32]string{
0: "REASON_UNSPECIFIED",
1: "CHARGEBACK",
8: "CHARGEBACK_FRAUD",
9: "CHARGEBACK_DISPUTE",
10: "REFUND",
11: "REFUND_FRAUD",
12: "TRANSACTION_ACCEPTED",
13: "TRANSACTION_DECLINED",
2: "PAYMENT_HEURISTICS",
7: "INITIATED_TWO_FACTOR",
3: "PASSED_TWO_FACTOR",
4: "FAILED_TWO_FACTOR",
5: "CORRECT_PASSWORD",
6: "INCORRECT_PASSWORD",
14: "SOCIAL_SPAM",
}
AnnotateAssessmentRequest_Reason_value = map[string]int32{
"REASON_UNSPECIFIED": 0,
"CHARGEBACK": 1,
"CHARGEBACK_FRAUD": 8,
"CHARGEBACK_DISPUTE": 9,
"REFUND": 10,
"REFUND_FRAUD": 11,
"TRANSACTION_ACCEPTED": 12,
"TRANSACTION_DECLINED": 13,
"PAYMENT_HEURISTICS": 2,
"INITIATED_TWO_FACTOR": 7,
"PASSED_TWO_FACTOR": 3,
"FAILED_TWO_FACTOR": 4,
"CORRECT_PASSWORD": 5,
"INCORRECT_PASSWORD": 6,
"SOCIAL_SPAM": 14,
}
)
Enum value maps for AnnotateAssessmentRequest_Reason.
Assessment_ClassificationReason_name, Assessment_ClassificationReason_value
var (
Assessment_ClassificationReason_name = map[int32]string{
0: "CLASSIFICATION_REASON_UNSPECIFIED",
1: "AUTOMATION",
2: "UNEXPECTED_ENVIRONMENT",
3: "TOO_MUCH_TRAFFIC",
4: "UNEXPECTED_USAGE_PATTERNS",
5: "LOW_CONFIDENCE_SCORE",
6: "SUSPECTED_CARDING",
7: "SUSPECTED_CHARGEBACK",
}
Assessment_ClassificationReason_value = map[string]int32{
"CLASSIFICATION_REASON_UNSPECIFIED": 0,
"AUTOMATION": 1,
"UNEXPECTED_ENVIRONMENT": 2,
"TOO_MUCH_TRAFFIC": 3,
"UNEXPECTED_USAGE_PATTERNS": 4,
"LOW_CONFIDENCE_SCORE": 5,
"SUSPECTED_CARDING": 6,
"SUSPECTED_CHARGEBACK": 7,
}
)
Enum value maps for Assessment_ClassificationReason.
Event_FraudPrevention_name, Event_FraudPrevention_value
var (
Event_FraudPrevention_name = map[int32]string{
0: "FRAUD_PREVENTION_UNSPECIFIED",
1: "ENABLED",
2: "DISABLED",
}
Event_FraudPrevention_value = map[string]int32{
"FRAUD_PREVENTION_UNSPECIFIED": 0,
"ENABLED": 1,
"DISABLED": 2,
}
)
Enum value maps for Event_FraudPrevention.
TokenProperties_InvalidReason_name, TokenProperties_InvalidReason_value
var (
TokenProperties_InvalidReason_name = map[int32]string{
0: "INVALID_REASON_UNSPECIFIED",
1: "UNKNOWN_INVALID_REASON",
2: "MALFORMED",
3: "EXPIRED",
4: "DUPE",
5: "SITE_MISMATCH",
6: "MISSING",
7: "BROWSER_ERROR",
}
TokenProperties_InvalidReason_value = map[string]int32{
"INVALID_REASON_UNSPECIFIED": 0,
"UNKNOWN_INVALID_REASON": 1,
"MALFORMED": 2,
"EXPIRED": 3,
"DUPE": 4,
"SITE_MISMATCH": 5,
"MISSING": 6,
"BROWSER_ERROR": 7,
}
)
Enum value maps for TokenProperties_InvalidReason.
AccountDefenderAssessment_AccountDefenderLabel_name, AccountDefenderAssessment_AccountDefenderLabel_value
var (
AccountDefenderAssessment_AccountDefenderLabel_name = map[int32]string{
0: "ACCOUNT_DEFENDER_LABEL_UNSPECIFIED",
1: "PROFILE_MATCH",
2: "SUSPICIOUS_LOGIN_ACTIVITY",
3: "SUSPICIOUS_ACCOUNT_CREATION",
4: "RELATED_ACCOUNTS_NUMBER_HIGH",
}
AccountDefenderAssessment_AccountDefenderLabel_value = map[string]int32{
"ACCOUNT_DEFENDER_LABEL_UNSPECIFIED": 0,
"PROFILE_MATCH": 1,
"SUSPICIOUS_LOGIN_ACTIVITY": 2,
"SUSPICIOUS_ACCOUNT_CREATION": 3,
"RELATED_ACCOUNTS_NUMBER_HIGH": 4,
}
)
Enum value maps for AccountDefenderAssessment_AccountDefenderLabel.
File_google_cloud_recaptchaenterprise_v1beta1_recaptchaenterprise_proto
var File_google_cloud_recaptchaenterprise_v1beta1_recaptchaenterprise_proto protoreflect.FileDescriptor
Functions
func RegisterRecaptchaEnterpriseServiceV1Beta1Server
func RegisterRecaptchaEnterpriseServiceV1Beta1Server(s *grpc.Server, srv RecaptchaEnterpriseServiceV1Beta1Server)
AccountDefenderAssessment
type AccountDefenderAssessment struct {
// Labels for this request.
Labels []AccountDefenderAssessment_AccountDefenderLabel `protobuf:"varint,1,rep,packed,name=labels,proto3,enum=google.cloud.recaptchaenterprise.v1beta1.AccountDefenderAssessment_AccountDefenderLabel" json:"labels,omitempty"`
// contains filtered or unexported fields
}
Account defender risk assessment.
func (*AccountDefenderAssessment) Descriptor
func (*AccountDefenderAssessment) Descriptor() ([]byte, []int)
Deprecated: Use AccountDefenderAssessment.ProtoReflect.Descriptor instead.
func (*AccountDefenderAssessment) GetLabels
func (x *AccountDefenderAssessment) GetLabels() []AccountDefenderAssessment_AccountDefenderLabel
func (*AccountDefenderAssessment) ProtoMessage
func (*AccountDefenderAssessment) ProtoMessage()
func (*AccountDefenderAssessment) ProtoReflect
func (x *AccountDefenderAssessment) ProtoReflect() protoreflect.Message
func (*AccountDefenderAssessment) Reset
func (x *AccountDefenderAssessment) Reset()
func (*AccountDefenderAssessment) String
func (x *AccountDefenderAssessment) String() string
AccountDefenderAssessment_AccountDefenderLabel
type AccountDefenderAssessment_AccountDefenderLabel int32
Labels returned by account defender for this request.
AccountDefenderAssessment_ACCOUNT_DEFENDER_LABEL_UNSPECIFIED, AccountDefenderAssessment_PROFILE_MATCH, AccountDefenderAssessment_SUSPICIOUS_LOGIN_ACTIVITY, AccountDefenderAssessment_SUSPICIOUS_ACCOUNT_CREATION, AccountDefenderAssessment_RELATED_ACCOUNTS_NUMBER_HIGH
const (
// Default unspecified type.
AccountDefenderAssessment_ACCOUNT_DEFENDER_LABEL_UNSPECIFIED AccountDefenderAssessment_AccountDefenderLabel = 0
// The request matches a known good profile for the user.
AccountDefenderAssessment_PROFILE_MATCH AccountDefenderAssessment_AccountDefenderLabel = 1
// The request is potentially a suspicious login event and should be further
// verified either via multi-factor authentication or another system.
AccountDefenderAssessment_SUSPICIOUS_LOGIN_ACTIVITY AccountDefenderAssessment_AccountDefenderLabel = 2
// The request matched a profile that previously had suspicious account
// creation behavior. This could mean this is a fake account.
AccountDefenderAssessment_SUSPICIOUS_ACCOUNT_CREATION AccountDefenderAssessment_AccountDefenderLabel = 3
// The account in the request has a high number of related accounts. It does
// not necessarily imply that the account is bad but could require
// investigating.
AccountDefenderAssessment_RELATED_ACCOUNTS_NUMBER_HIGH AccountDefenderAssessment_AccountDefenderLabel = 4
)
func (AccountDefenderAssessment_AccountDefenderLabel) Descriptor
func (AccountDefenderAssessment_AccountDefenderLabel) Descriptor() protoreflect.EnumDescriptor
func (AccountDefenderAssessment_AccountDefenderLabel) Enum
func (x AccountDefenderAssessment_AccountDefenderLabel) Enum() *AccountDefenderAssessment_AccountDefenderLabel
func (AccountDefenderAssessment_AccountDefenderLabel) EnumDescriptor
func (AccountDefenderAssessment_AccountDefenderLabel) EnumDescriptor() ([]byte, []int)
Deprecated: Use AccountDefenderAssessment_AccountDefenderLabel.Descriptor instead.
func (AccountDefenderAssessment_AccountDefenderLabel) Number
func (x AccountDefenderAssessment_AccountDefenderLabel) Number() protoreflect.EnumNumber
func (AccountDefenderAssessment_AccountDefenderLabel) String
func (x AccountDefenderAssessment_AccountDefenderLabel) String() string
func (AccountDefenderAssessment_AccountDefenderLabel) Type
AnnotateAssessmentRequest
type AnnotateAssessmentRequest struct {
// Required. The resource name of the Assessment, in the format
// `projects/{project_number}/assessments/{assessment_id}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. The annotation that is assigned to the Event. This field can be
// left empty to provide reasons that apply to an event without concluding
// whether the event is legitimate or fraudulent.
Annotation AnnotateAssessmentRequest_Annotation `protobuf:"varint,2,opt,name=annotation,proto3,enum=google.cloud.recaptchaenterprise.v1beta1.AnnotateAssessmentRequest_Annotation" json:"annotation,omitempty"`
// Optional. Reasons for the annotation that are assigned to the event.
Reasons []AnnotateAssessmentRequest_Reason `protobuf:"varint,3,rep,packed,name=reasons,proto3,enum=google.cloud.recaptchaenterprise.v1beta1.AnnotateAssessmentRequest_Reason" json:"reasons,omitempty"`
// Optional. Unique stable hashed user identifier to apply to the assessment.
// This is an alternative to setting the `hashed_account_id` in
// `CreateAssessment`, for example, when the account identifier is not yet
// known in the initial request. It is recommended that the identifier is
// hashed using hmac-sha256 with stable secret.
HashedAccountId []byte `protobuf:"bytes,4,opt,name=hashed_account_id,json=hashedAccountId,proto3" json:"hashed_account_id,omitempty"`
// Optional. If the assessment is part of a payment transaction, provide
// details on payment lifecycle events that occur in the transaction.
TransactionEvent *TransactionEvent `protobuf:"bytes,5,opt,name=transaction_event,json=transactionEvent,proto3" json:"transaction_event,omitempty"`
// contains filtered or unexported fields
}
The request message to annotate an Assessment.
func (*AnnotateAssessmentRequest) Descriptor
func (*AnnotateAssessmentRequest) Descriptor() ([]byte, []int)
Deprecated: Use AnnotateAssessmentRequest.ProtoReflect.Descriptor instead.
func (*AnnotateAssessmentRequest) GetAnnotation
func (x *AnnotateAssessmentRequest) GetAnnotation() AnnotateAssessmentRequest_Annotation
func (*AnnotateAssessmentRequest) GetHashedAccountId
func (x *AnnotateAssessmentRequest) GetHashedAccountId() []byte
func (*AnnotateAssessmentRequest) GetName
func (x *AnnotateAssessmentRequest) GetName() string
func (*AnnotateAssessmentRequest) GetReasons
func (x *AnnotateAssessmentRequest) GetReasons() []AnnotateAssessmentRequest_Reason
func (*AnnotateAssessmentRequest) GetTransactionEvent
func (x *AnnotateAssessmentRequest) GetTransactionEvent() *TransactionEvent
func (*AnnotateAssessmentRequest) ProtoMessage
func (*AnnotateAssessmentRequest) ProtoMessage()
func (*AnnotateAssessmentRequest) ProtoReflect
func (x *AnnotateAssessmentRequest) ProtoReflect() protoreflect.Message
func (*AnnotateAssessmentRequest) Reset
func (x *AnnotateAssessmentRequest) Reset()
func (*AnnotateAssessmentRequest) String
func (x *AnnotateAssessmentRequest) String() string
AnnotateAssessmentRequest_Annotation
type AnnotateAssessmentRequest_Annotation int32
Enum that represents the types of annotations.
AnnotateAssessmentRequest_ANNOTATION_UNSPECIFIED, AnnotateAssessmentRequest_LEGITIMATE, AnnotateAssessmentRequest_FRAUDULENT, AnnotateAssessmentRequest_PASSWORD_CORRECT, AnnotateAssessmentRequest_PASSWORD_INCORRECT
const (
// Default unspecified type.
AnnotateAssessmentRequest_ANNOTATION_UNSPECIFIED AnnotateAssessmentRequest_Annotation = 0
// Provides information that the event turned out to be legitimate.
AnnotateAssessmentRequest_LEGITIMATE AnnotateAssessmentRequest_Annotation = 1
// Provides information that the event turned out to be fraudulent.
AnnotateAssessmentRequest_FRAUDULENT AnnotateAssessmentRequest_Annotation = 2
// Provides information that the event was related to a login event in which
// the user typed the correct password. Deprecated, prefer indicating
// CORRECT_PASSWORD through the reasons field instead.
//
// Deprecated: Marked as deprecated in google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.proto.
AnnotateAssessmentRequest_PASSWORD_CORRECT AnnotateAssessmentRequest_Annotation = 3
// Provides information that the event was related to a login event in which
// the user typed the incorrect password. Deprecated, prefer indicating
// INCORRECT_PASSWORD through the reasons field instead.
//
// Deprecated: Marked as deprecated in google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.proto.
AnnotateAssessmentRequest_PASSWORD_INCORRECT AnnotateAssessmentRequest_Annotation = 4
)
func (AnnotateAssessmentRequest_Annotation) Descriptor
func (AnnotateAssessmentRequest_Annotation) Descriptor() protoreflect.EnumDescriptor
func (AnnotateAssessmentRequest_Annotation) Enum
func (x AnnotateAssessmentRequest_Annotation) Enum() *AnnotateAssessmentRequest_Annotation
func (AnnotateAssessmentRequest_Annotation) EnumDescriptor
func (AnnotateAssessmentRequest_Annotation) EnumDescriptor() ([]byte, []int)
Deprecated: Use AnnotateAssessmentRequest_Annotation.Descriptor instead.
func (AnnotateAssessmentRequest_Annotation) Number
func (x AnnotateAssessmentRequest_Annotation) Number() protoreflect.EnumNumber
func (AnnotateAssessmentRequest_Annotation) String
func (x AnnotateAssessmentRequest_Annotation) String() string
func (AnnotateAssessmentRequest_Annotation) Type
func (AnnotateAssessmentRequest_Annotation) Type() protoreflect.EnumType
AnnotateAssessmentRequest_Reason
type AnnotateAssessmentRequest_Reason int32
Enum that represents potential reasons for annotating an assessment.
AnnotateAssessmentRequest_REASON_UNSPECIFIED, AnnotateAssessmentRequest_CHARGEBACK, AnnotateAssessmentRequest_CHARGEBACK_FRAUD, AnnotateAssessmentRequest_CHARGEBACK_DISPUTE, AnnotateAssessmentRequest_REFUND, AnnotateAssessmentRequest_REFUND_FRAUD, AnnotateAssessmentRequest_TRANSACTION_ACCEPTED, AnnotateAssessmentRequest_TRANSACTION_DECLINED, AnnotateAssessmentRequest_PAYMENT_HEURISTICS, AnnotateAssessmentRequest_INITIATED_TWO_FACTOR, AnnotateAssessmentRequest_PASSED_TWO_FACTOR, AnnotateAssessmentRequest_FAILED_TWO_FACTOR, AnnotateAssessmentRequest_CORRECT_PASSWORD, AnnotateAssessmentRequest_INCORRECT_PASSWORD, AnnotateAssessmentRequest_SOCIAL_SPAM
const (
// Default unspecified reason.
AnnotateAssessmentRequest_REASON_UNSPECIFIED AnnotateAssessmentRequest_Reason = 0
// Indicates that the transaction had a chargeback issued with no other
// details. When possible, specify the type by using CHARGEBACK_FRAUD or
// CHARGEBACK_DISPUTE instead.
AnnotateAssessmentRequest_CHARGEBACK AnnotateAssessmentRequest_Reason = 1
// Indicates that the transaction had a chargeback issued related to an
// alleged unauthorized transaction from the cardholder's perspective (for
// example, the card number was stolen).
AnnotateAssessmentRequest_CHARGEBACK_FRAUD AnnotateAssessmentRequest_Reason = 8
// Indicates that the transaction had a chargeback issued related to the
// cardholder having provided their card details but allegedly not being
// satisfied with the purchase (for example, misrepresentation, attempted
// cancellation).
AnnotateAssessmentRequest_CHARGEBACK_DISPUTE AnnotateAssessmentRequest_Reason = 9
// Indicates that the completed payment transaction was refunded by the
// seller.
AnnotateAssessmentRequest_REFUND AnnotateAssessmentRequest_Reason = 10
// Indicates that the completed payment transaction was determined to be
// fraudulent by the seller, and was cancelled and refunded as a result.
AnnotateAssessmentRequest_REFUND_FRAUD AnnotateAssessmentRequest_Reason = 11
// Indicates that the payment transaction was accepted, and the user was
// charged.
AnnotateAssessmentRequest_TRANSACTION_ACCEPTED AnnotateAssessmentRequest_Reason = 12
// Indicates that the payment transaction was declined, for example due to
// invalid card details.
AnnotateAssessmentRequest_TRANSACTION_DECLINED AnnotateAssessmentRequest_Reason = 13
// Indicates the transaction associated with the assessment is suspected of
// being fraudulent based on the payment method, billing details, shipping
// address or other transaction information.
AnnotateAssessmentRequest_PAYMENT_HEURISTICS AnnotateAssessmentRequest_Reason = 2
// Indicates that the user was served a 2FA challenge. An old assessment
// with `ENUM_VALUES.INITIATED_TWO_FACTOR` reason that has not been
// overwritten with `PASSED_TWO_FACTOR` is treated as an abandoned 2FA flow.
// This is equivalent to `FAILED_TWO_FACTOR`.
AnnotateAssessmentRequest_INITIATED_TWO_FACTOR AnnotateAssessmentRequest_Reason = 7
// Indicates that the user passed a 2FA challenge.
AnnotateAssessmentRequest_PASSED_TWO_FACTOR AnnotateAssessmentRequest_Reason = 3
// Indicates that the user failed a 2FA challenge.
AnnotateAssessmentRequest_FAILED_TWO_FACTOR AnnotateAssessmentRequest_Reason = 4
// Indicates the user provided the correct password.
AnnotateAssessmentRequest_CORRECT_PASSWORD AnnotateAssessmentRequest_Reason = 5
// Indicates the user provided an incorrect password.
AnnotateAssessmentRequest_INCORRECT_PASSWORD AnnotateAssessmentRequest_Reason = 6
// Indicates that the user sent unwanted and abusive messages to other users
// of the platform, such as spam, scams, phishing, or social engineering.
AnnotateAssessmentRequest_SOCIAL_SPAM AnnotateAssessmentRequest_Reason = 14
)
func (AnnotateAssessmentRequest_Reason) Descriptor
func (AnnotateAssessmentRequest_Reason) Descriptor() protoreflect.EnumDescriptor
func (AnnotateAssessmentRequest_Reason) Enum
func (x AnnotateAssessmentRequest_Reason) Enum() *AnnotateAssessmentRequest_Reason
func (AnnotateAssessmentRequest_Reason) EnumDescriptor
func (AnnotateAssessmentRequest_Reason) EnumDescriptor() ([]byte, []int)
Deprecated: Use AnnotateAssessmentRequest_Reason.Descriptor instead.
func (AnnotateAssessmentRequest_Reason) Number
func (x AnnotateAssessmentRequest_Reason) Number() protoreflect.EnumNumber
func (AnnotateAssessmentRequest_Reason) String
func (x AnnotateAssessmentRequest_Reason) String() string
func (AnnotateAssessmentRequest_Reason) Type
func (AnnotateAssessmentRequest_Reason) Type() protoreflect.EnumType
AnnotateAssessmentResponse
type AnnotateAssessmentResponse struct {
// contains filtered or unexported fields
}
Empty response for AnnotateAssessment.
func (*AnnotateAssessmentResponse) Descriptor
func (*AnnotateAssessmentResponse) Descriptor() ([]byte, []int)
Deprecated: Use AnnotateAssessmentResponse.ProtoReflect.Descriptor instead.
func (*AnnotateAssessmentResponse) ProtoMessage
func (*AnnotateAssessmentResponse) ProtoMessage()
func (*AnnotateAssessmentResponse) ProtoReflect
func (x *AnnotateAssessmentResponse) ProtoReflect() protoreflect.Message
func (*AnnotateAssessmentResponse) Reset
func (x *AnnotateAssessmentResponse) Reset()
func (*AnnotateAssessmentResponse) String
func (x *AnnotateAssessmentResponse) String() string
Assessment
type Assessment struct {
// Output only. The resource name for the Assessment in the format
// `projects/{project_number}/assessments/{assessment_id}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The event being assessed.
Event *Event `protobuf:"bytes,2,opt,name=event,proto3" json:"event,omitempty"`
// Output only. Legitimate event score from 0.0 to 1.0.
// (1.0 means very likely legitimate traffic while 0.0 means very likely
// non-legitimate traffic).
Score float32 `protobuf:"fixed32,3,opt,name=score,proto3" json:"score,omitempty"`
// Output only. Properties of the provided event token.
TokenProperties *TokenProperties `protobuf:"bytes,4,opt,name=token_properties,json=tokenProperties,proto3" json:"token_properties,omitempty"`
// Output only. Reasons contributing to the risk analysis verdict.
Reasons []Assessment_ClassificationReason `protobuf:"varint,5,rep,packed,name=reasons,proto3,enum=google.cloud.recaptchaenterprise.v1beta1.Assessment_ClassificationReason" json:"reasons,omitempty"`
// Information about the user's credentials used to check for leaks.
// This feature is part of the Early Access Program (EAP). Exercise caution,
// and do not deploy integrations based on this feature in a production
// environment.
PasswordLeakVerification *PasswordLeakVerification `protobuf:"bytes,7,opt,name=password_leak_verification,json=passwordLeakVerification,proto3" json:"password_leak_verification,omitempty"`
// Assessment returned by account defender when a hashed_account_id is
// provided.
AccountDefenderAssessment *AccountDefenderAssessment `protobuf:"bytes,8,opt,name=account_defender_assessment,json=accountDefenderAssessment,proto3" json:"account_defender_assessment,omitempty"`
// Assessment returned by Fraud Prevention when TransactionData is provided.
FraudPreventionAssessment *FraudPreventionAssessment `protobuf:"bytes,11,opt,name=fraud_prevention_assessment,json=fraudPreventionAssessment,proto3" json:"fraud_prevention_assessment,omitempty"`
// contains filtered or unexported fields
}
A reCAPTCHA Enterprise assessment resource.
func (*Assessment) Descriptor
func (*Assessment) Descriptor() ([]byte, []int)
Deprecated: Use Assessment.ProtoReflect.Descriptor instead.
func (*Assessment) GetAccountDefenderAssessment
func (x *Assessment) GetAccountDefenderAssessment() *AccountDefenderAssessment
func (*Assessment) GetEvent
func (x *Assessment) GetEvent() *Event
func (*Assessment) GetFraudPreventionAssessment
func (x *Assessment) GetFraudPreventionAssessment() *FraudPreventionAssessment
func (*Assessment) GetName
func (x *Assessment) GetName() string
func (*Assessment) GetPasswordLeakVerification
func (x *Assessment) GetPasswordLeakVerification() *PasswordLeakVerification
func (*Assessment) GetReasons
func (x *Assessment) GetReasons() []Assessment_ClassificationReason
func (*Assessment) GetScore
func (x *Assessment) GetScore() float32
func (*Assessment) GetTokenProperties
func (x *Assessment) GetTokenProperties() *TokenProperties
func (*Assessment) ProtoMessage
func (*Assessment) ProtoMessage()
func (*Assessment) ProtoReflect
func (x *Assessment) ProtoReflect() protoreflect.Message
func (*Assessment) Reset
func (x *Assessment) Reset()
func (*Assessment) String
func (x *Assessment) String() string
Assessment_ClassificationReason
type Assessment_ClassificationReason int32
Reasons contributing to the risk analysis verdict.
Assessment_CLASSIFICATION_REASON_UNSPECIFIED, Assessment_AUTOMATION, Assessment_UNEXPECTED_ENVIRONMENT, Assessment_TOO_MUCH_TRAFFIC, Assessment_UNEXPECTED_USAGE_PATTERNS, Assessment_LOW_CONFIDENCE_SCORE, Assessment_SUSPECTED_CARDING, Assessment_SUSPECTED_CHARGEBACK
const (
// Default unspecified type.
Assessment_CLASSIFICATION_REASON_UNSPECIFIED Assessment_ClassificationReason = 0
// Interactions matched the behavior of an automated agent.
Assessment_AUTOMATION Assessment_ClassificationReason = 1
// The event originated from an illegitimate environment.
Assessment_UNEXPECTED_ENVIRONMENT Assessment_ClassificationReason = 2
// Traffic volume from the event source is higher than normal.
Assessment_TOO_MUCH_TRAFFIC Assessment_ClassificationReason = 3
// Interactions with the site were significantly different than expected
// patterns.
Assessment_UNEXPECTED_USAGE_PATTERNS Assessment_ClassificationReason = 4
// Too little traffic has been received from this site thus far to generate
// quality risk analysis.
Assessment_LOW_CONFIDENCE_SCORE Assessment_ClassificationReason = 5
// The request matches behavioral characteristics of a carding attack.
Assessment_SUSPECTED_CARDING Assessment_ClassificationReason = 6
// The request matches behavioral characteristics of chargebacks for fraud.
Assessment_SUSPECTED_CHARGEBACK Assessment_ClassificationReason = 7
)
func (Assessment_ClassificationReason) Descriptor
func (Assessment_ClassificationReason) Descriptor() protoreflect.EnumDescriptor
func (Assessment_ClassificationReason) Enum
func (x Assessment_ClassificationReason) Enum() *Assessment_ClassificationReason
func (Assessment_ClassificationReason) EnumDescriptor
func (Assessment_ClassificationReason) EnumDescriptor() ([]byte, []int)
Deprecated: Use Assessment_ClassificationReason.Descriptor instead.
func (Assessment_ClassificationReason) Number
func (x Assessment_ClassificationReason) Number() protoreflect.EnumNumber
func (Assessment_ClassificationReason) String
func (x Assessment_ClassificationReason) String() string
func (Assessment_ClassificationReason) Type
func (Assessment_ClassificationReason) Type() protoreflect.EnumType
CreateAssessmentRequest
type CreateAssessmentRequest struct {
// Required. The name of the project in which the assessment is created,
// in the format `projects/{project_number}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The assessment details.
Assessment *Assessment `protobuf:"bytes,2,opt,name=assessment,proto3" json:"assessment,omitempty"`
// contains filtered or unexported fields
}
The create assessment request message.
func (*CreateAssessmentRequest) Descriptor
func (*CreateAssessmentRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateAssessmentRequest.ProtoReflect.Descriptor instead.
func (*CreateAssessmentRequest) GetAssessment
func (x *CreateAssessmentRequest) GetAssessment() *Assessment
func (*CreateAssessmentRequest) GetParent
func (x *CreateAssessmentRequest) GetParent() string
func (*CreateAssessmentRequest) ProtoMessage
func (*CreateAssessmentRequest) ProtoMessage()
func (*CreateAssessmentRequest) ProtoReflect
func (x *CreateAssessmentRequest) ProtoReflect() protoreflect.Message
func (*CreateAssessmentRequest) Reset
func (x *CreateAssessmentRequest) Reset()
func (*CreateAssessmentRequest) String
func (x *CreateAssessmentRequest) String() string
Event
type Event struct {
// Optional. The user response token provided by the reCAPTCHA client-side
// integration on your site.
Token string `protobuf:"bytes,1,opt,name=token,proto3" json:"token,omitempty"`
// Optional. The site key that was used to invoke reCAPTCHA on your site and
// generate the token.
SiteKey string `protobuf:"bytes,2,opt,name=site_key,json=siteKey,proto3" json:"site_key,omitempty"`
// Optional. The user agent present in the request from the user's device
// related to this event.
UserAgent string `protobuf:"bytes,3,opt,name=user_agent,json=userAgent,proto3" json:"user_agent,omitempty"`
// Optional. The IP address in the request from the user's device related to
// this event.
UserIpAddress string `protobuf:"bytes,4,opt,name=user_ip_address,json=userIpAddress,proto3" json:"user_ip_address,omitempty"`
// Optional. The expected action for this type of event. This should be the
// same action provided at token generation time on client-side platforms
// already integrated with reCAPTCHA.
ExpectedAction string `protobuf:"bytes,5,opt,name=expected_action,json=expectedAction,proto3" json:"expected_action,omitempty"`
// Optional. Unique stable hashed user identifier for the request. The
// identifier must be hashed using hmac-sha256 with stable secret.
HashedAccountId []byte `protobuf:"bytes,6,opt,name=hashed_account_id,json=hashedAccountId,proto3" json:"hashed_account_id,omitempty"`
// Optional. Data describing a payment transaction to be assessed. Sending
// this data enables reCAPTCHA Fraud Prevention and the
// FraudPreventionAssessment component in the response.
TransactionData *TransactionData `protobuf:"bytes,13,opt,name=transaction_data,json=transactionData,proto3" json:"transaction_data,omitempty"`
// Optional. The Fraud Prevention setting for this Assessment.
FraudPrevention Event_FraudPrevention `protobuf:"varint,17,opt,name=fraud_prevention,json=fraudPrevention,proto3,enum=google.cloud.recaptchaenterprise.v1beta1.Event_FraudPrevention" json:"fraud_prevention,omitempty"`
// contains filtered or unexported fields
}
func (*Event) Descriptor
Deprecated: Use Event.ProtoReflect.Descriptor instead.
func (*Event) GetExpectedAction
func (*Event) GetFraudPrevention
func (x *Event) GetFraudPrevention() Event_FraudPrevention
func (*Event) GetHashedAccountId
func (*Event) GetSiteKey
func (*Event) GetToken
func (*Event) GetTransactionData
func (x *Event) GetTransactionData() *TransactionData
func (*Event) GetUserAgent
func (*Event) GetUserIpAddress
func (*Event) ProtoMessage
func (*Event) ProtoMessage()
func (*Event) ProtoReflect
func (x *Event) ProtoReflect() protoreflect.Message
func (*Event) Reset
func (x *Event) Reset()
func (*Event) String
Event_FraudPrevention
type Event_FraudPrevention int32
Setting that controls Fraud Prevention assessments.
Event_FRAUD_PREVENTION_UNSPECIFIED, Event_ENABLED, Event_DISABLED
const (
// Default, unspecified setting. `fraud_prevention_assessment` is returned
// if `transaction_data` is present in `Event` and Fraud Prevention is
// enabled in the Google Cloud console.
Event_FRAUD_PREVENTION_UNSPECIFIED Event_FraudPrevention = 0
// Enable Fraud Prevention for this assessment, if Fraud Prevention is
// enabled in the Google Cloud console.
Event_ENABLED