recaptchaenterprisepb

package
v2.24.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 13, 2026 License: Apache-2.0 Imports: 11 Imported by: 1

Documentation

Index

Constants

View Source
const (
	RecaptchaEnterpriseServiceV1Beta1_CreateAssessment_FullMethodName   = "/google.cloud.recaptchaenterprise.v1beta1.RecaptchaEnterpriseServiceV1Beta1/CreateAssessment"
	RecaptchaEnterpriseServiceV1Beta1_AnnotateAssessment_FullMethodName = "/google.cloud.recaptchaenterprise.v1beta1.RecaptchaEnterpriseServiceV1Beta1/AnnotateAssessment"
)

Variables

View Source
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.

View Source
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.

View Source
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.

View Source
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.

View Source
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.

View Source
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.

View Source
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.

View Source
var File_google_cloud_recaptchaenterprise_v1beta1_recaptchaenterprise_proto protoreflect.FileDescriptor
View Source
var RecaptchaEnterpriseServiceV1Beta1_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.cloud.recaptchaenterprise.v1beta1.RecaptchaEnterpriseServiceV1Beta1",
	HandlerType: (*RecaptchaEnterpriseServiceV1Beta1Server)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "CreateAssessment",
			Handler:    _RecaptchaEnterpriseServiceV1Beta1_CreateAssessment_Handler,
		},
		{
			MethodName: "AnnotateAssessment",
			Handler:    _RecaptchaEnterpriseServiceV1Beta1_AnnotateAssessment_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.proto",
}

RecaptchaEnterpriseServiceV1Beta1_ServiceDesc is the grpc.ServiceDesc for RecaptchaEnterpriseServiceV1Beta1 service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterRecaptchaEnterpriseServiceV1Beta1Server

func RegisterRecaptchaEnterpriseServiceV1Beta1Server(s grpc.ServiceRegistrar, srv RecaptchaEnterpriseServiceV1Beta1Server)

Types

type AccountDefenderAssessment

type AccountDefenderAssessment struct {

	// Labels for this request.
	Labels []AccountDefenderAssessment_AccountDefenderLabel `` /* 166-byte string literal not displayed */
	// contains filtered or unexported fields
}

Account defender risk assessment.

func (*AccountDefenderAssessment) Descriptor deprecated

func (*AccountDefenderAssessment) Descriptor() ([]byte, []int)

Deprecated: Use AccountDefenderAssessment.ProtoReflect.Descriptor instead.

func (*AccountDefenderAssessment) GetLabels

func (*AccountDefenderAssessment) ProtoMessage

func (*AccountDefenderAssessment) ProtoMessage()

func (*AccountDefenderAssessment) ProtoReflect

func (*AccountDefenderAssessment) Reset

func (x *AccountDefenderAssessment) Reset()

func (*AccountDefenderAssessment) String

func (x *AccountDefenderAssessment) String() string

type AccountDefenderAssessment_AccountDefenderLabel

type AccountDefenderAssessment_AccountDefenderLabel int32

Labels returned by account defender for this request.

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) Enum

func (AccountDefenderAssessment_AccountDefenderLabel) EnumDescriptor deprecated

Deprecated: Use AccountDefenderAssessment_AccountDefenderLabel.Descriptor instead.

func (AccountDefenderAssessment_AccountDefenderLabel) Number

func (AccountDefenderAssessment_AccountDefenderLabel) String

func (AccountDefenderAssessment_AccountDefenderLabel) Type

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 `` /* 157-byte string literal not displayed */
	// Optional. Reasons for the annotation that are assigned to the event.
	Reasons []AnnotateAssessmentRequest_Reason `` /* 154-byte string literal not displayed */
	// 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 deprecated

func (*AnnotateAssessmentRequest) Descriptor() ([]byte, []int)

Deprecated: Use AnnotateAssessmentRequest.ProtoReflect.Descriptor instead.

func (*AnnotateAssessmentRequest) GetAnnotation

func (*AnnotateAssessmentRequest) GetHashedAccountId

func (x *AnnotateAssessmentRequest) GetHashedAccountId() []byte

func (*AnnotateAssessmentRequest) GetName

func (x *AnnotateAssessmentRequest) GetName() string

func (*AnnotateAssessmentRequest) GetReasons

func (*AnnotateAssessmentRequest) GetTransactionEvent added in v2.7.1

func (x *AnnotateAssessmentRequest) GetTransactionEvent() *TransactionEvent

func (*AnnotateAssessmentRequest) ProtoMessage

func (*AnnotateAssessmentRequest) ProtoMessage()

func (*AnnotateAssessmentRequest) ProtoReflect

func (*AnnotateAssessmentRequest) Reset

func (x *AnnotateAssessmentRequest) Reset()

func (*AnnotateAssessmentRequest) String

func (x *AnnotateAssessmentRequest) String() string

type AnnotateAssessmentRequest_Annotation

type AnnotateAssessmentRequest_Annotation int32

Enum that represents the types of annotations.

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) Enum

func (AnnotateAssessmentRequest_Annotation) EnumDescriptor deprecated

func (AnnotateAssessmentRequest_Annotation) EnumDescriptor() ([]byte, []int)

Deprecated: Use AnnotateAssessmentRequest_Annotation.Descriptor instead.

func (AnnotateAssessmentRequest_Annotation) Number

func (AnnotateAssessmentRequest_Annotation) String

func (AnnotateAssessmentRequest_Annotation) Type

type AnnotateAssessmentRequest_Reason

type AnnotateAssessmentRequest_Reason int32

Enum that represents potential reasons for annotating an assessment.

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) Enum

func (AnnotateAssessmentRequest_Reason) EnumDescriptor deprecated

func (AnnotateAssessmentRequest_Reason) EnumDescriptor() ([]byte, []int)

Deprecated: Use AnnotateAssessmentRequest_Reason.Descriptor instead.

func (AnnotateAssessmentRequest_Reason) Number

func (AnnotateAssessmentRequest_Reason) String

func (AnnotateAssessmentRequest_Reason) Type

type AnnotateAssessmentResponse

type AnnotateAssessmentResponse struct {
	// contains filtered or unexported fields
}

Empty response for AnnotateAssessment.

func (*AnnotateAssessmentResponse) Descriptor deprecated

func (*AnnotateAssessmentResponse) Descriptor() ([]byte, []int)

Deprecated: Use AnnotateAssessmentResponse.ProtoReflect.Descriptor instead.

func (*AnnotateAssessmentResponse) ProtoMessage

func (*AnnotateAssessmentResponse) ProtoMessage()

func (*AnnotateAssessmentResponse) ProtoReflect

func (*AnnotateAssessmentResponse) Reset

func (x *AnnotateAssessmentResponse) Reset()

func (*AnnotateAssessmentResponse) String

func (x *AnnotateAssessmentResponse) String() string

type 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 `` /* 153-byte string literal not displayed */
	// 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 `` /* 135-byte string literal not displayed */
	// Assessment returned by account defender when a hashed_account_id is
	// provided.
	AccountDefenderAssessment *AccountDefenderAssessment `` /* 138-byte string literal not displayed */
	// Assessment returned by Fraud Prevention when TransactionData is provided.
	FraudPreventionAssessment *FraudPreventionAssessment `` /* 139-byte string literal not displayed */
	// contains filtered or unexported fields
}

A reCAPTCHA Enterprise assessment resource.

func (*Assessment) Descriptor deprecated

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 added in v2.7.1

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

type Assessment_ClassificationReason

type Assessment_ClassificationReason int32

Reasons contributing to the risk analysis verdict.

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) Enum

func (Assessment_ClassificationReason) EnumDescriptor deprecated

func (Assessment_ClassificationReason) EnumDescriptor() ([]byte, []int)

Deprecated: Use Assessment_ClassificationReason.Descriptor instead.

func (Assessment_ClassificationReason) Number

func (Assessment_ClassificationReason) String

func (Assessment_ClassificationReason) Type

type 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 deprecated

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

type 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 `` /* 176-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*Event) Descriptor deprecated

func (*Event) Descriptor() ([]byte, []int)

Deprecated: Use Event.ProtoReflect.Descriptor instead.

func (*Event) GetExpectedAction

func (x *Event) GetExpectedAction() string

func (*Event) GetFraudPrevention added in v2.13.0

func (x *Event) GetFraudPrevention() Event_FraudPrevention

func (*Event) GetHashedAccountId

func (x *Event) GetHashedAccountId() []byte

func (*Event) GetSiteKey

func (x *Event) GetSiteKey() string

func (*Event) GetToken

func (x *Event) GetToken() string

func (*Event) GetTransactionData added in v2.7.1

func (x *Event) GetTransactionData() *TransactionData

func (*Event) GetUserAgent

func (x *Event) GetUserAgent() string

func (*Event) GetUserIpAddress

func (x *Event) GetUserIpAddress() string

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

func (x *Event) String() string

type Event_FraudPrevention added in v2.13.0

type Event_FraudPrevention int32

Setting that controls Fraud Prevention assessments.

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 Event_FraudPrevention = 1
	// Disable Fraud Prevention for this assessment, regardless of the Google
	// Cloud console settings.
	Event_DISABLED Event_FraudPrevention = 2
)

func (Event_FraudPrevention) Descriptor added in v2.13.0

func (Event_FraudPrevention) Enum added in v2.13.0

func (Event_FraudPrevention) EnumDescriptor deprecated added in v2.13.0

func (Event_FraudPrevention) EnumDescriptor() ([]byte, []int)

Deprecated: Use Event_FraudPrevention.Descriptor instead.

func (Event_FraudPrevention) Number added in v2.13.0

func (Event_FraudPrevention) String added in v2.13.0

func (x Event_FraudPrevention) String() string

func (Event_FraudPrevention) Type added in v2.13.0

type FraudPreventionAssessment added in v2.7.1

type FraudPreventionAssessment struct {

	// Output only. Probability (0-1) of this transaction being fraudulent.
	// Summarizes the combined risk of attack vectors below.
	TransactionRisk float32 `protobuf:"fixed32,1,opt,name=transaction_risk,json=transactionRisk,proto3" json:"transaction_risk,omitempty"`
	// Output only. Assessment of this transaction for risk of a stolen
	// instrument.
	StolenInstrumentVerdict *FraudPreventionAssessment_StolenInstrumentVerdict `` /* 132-byte string literal not displayed */
	// Output only. Assessment of this transaction for risk of being part of a
	// card testing attack.
	CardTestingVerdict *FraudPreventionAssessment_CardTestingVerdict `protobuf:"bytes,3,opt,name=card_testing_verdict,json=cardTestingVerdict,proto3" json:"card_testing_verdict,omitempty"`
	// Output only. Assessment of this transaction for behavioral trust.
	BehavioralTrustVerdict *FraudPreventionAssessment_BehavioralTrustVerdict `` /* 129-byte string literal not displayed */
	// contains filtered or unexported fields
}

Assessment for Fraud Prevention.

func (*FraudPreventionAssessment) Descriptor deprecated added in v2.7.1

func (*FraudPreventionAssessment) Descriptor() ([]byte, []int)

Deprecated: Use FraudPreventionAssessment.ProtoReflect.Descriptor instead.

func (*FraudPreventionAssessment) GetBehavioralTrustVerdict added in v2.8.0

func (*FraudPreventionAssessment) GetCardTestingVerdict added in v2.7.1

func (*FraudPreventionAssessment) GetStolenInstrumentVerdict added in v2.7.1

func (*FraudPreventionAssessment) GetTransactionRisk added in v2.7.1

func (x *FraudPreventionAssessment) GetTransactionRisk() float32

func (*FraudPreventionAssessment) ProtoMessage added in v2.7.1

func (*FraudPreventionAssessment) ProtoMessage()

func (*FraudPreventionAssessment) ProtoReflect added in v2.7.1

func (*FraudPreventionAssessment) Reset added in v2.7.1

func (x *FraudPreventionAssessment) Reset()

func (*FraudPreventionAssessment) String added in v2.7.1

func (x *FraudPreventionAssessment) String() string

type FraudPreventionAssessment_BehavioralTrustVerdict added in v2.8.0

type FraudPreventionAssessment_BehavioralTrustVerdict struct {

	// Output only. Probability (0-1) of this transaction attempt being executed
	// in a behaviorally trustworthy way.
	Trust float32 `protobuf:"fixed32,1,opt,name=trust,proto3" json:"trust,omitempty"`
	// contains filtered or unexported fields
}

Information about behavioral trust of the transaction.

func (*FraudPreventionAssessment_BehavioralTrustVerdict) Descriptor deprecated added in v2.8.0

Deprecated: Use FraudPreventionAssessment_BehavioralTrustVerdict.ProtoReflect.Descriptor instead.

func (*FraudPreventionAssessment_BehavioralTrustVerdict) GetTrust added in v2.8.0

func (*FraudPreventionAssessment_BehavioralTrustVerdict) ProtoMessage added in v2.8.0

func (*FraudPreventionAssessment_BehavioralTrustVerdict) ProtoReflect added in v2.8.0

func (*FraudPreventionAssessment_BehavioralTrustVerdict) Reset added in v2.8.0

func (*FraudPreventionAssessment_BehavioralTrustVerdict) String added in v2.8.0

type FraudPreventionAssessment_CardTestingVerdict added in v2.7.1

type FraudPreventionAssessment_CardTestingVerdict struct {

	// Output only. Probability (0-1) of this transaction attempt being part of
	// a card testing attack.
	Risk float32 `protobuf:"fixed32,1,opt,name=risk,proto3" json:"risk,omitempty"`
	// contains filtered or unexported fields
}

Information about card testing fraud, where an adversary is testing fraudulently obtained cards or brute forcing their details.

func (*FraudPreventionAssessment_CardTestingVerdict) Descriptor deprecated added in v2.7.1

Deprecated: Use FraudPreventionAssessment_CardTestingVerdict.ProtoReflect.Descriptor instead.

func (*FraudPreventionAssessment_CardTestingVerdict) GetRisk added in v2.7.1

func (*FraudPreventionAssessment_CardTestingVerdict) ProtoMessage added in v2.7.1

func (*FraudPreventionAssessment_CardTestingVerdict) ProtoReflect added in v2.7.1

func (*FraudPreventionAssessment_CardTestingVerdict) Reset added in v2.7.1

func (*FraudPreventionAssessment_CardTestingVerdict) String added in v2.7.1

type FraudPreventionAssessment_StolenInstrumentVerdict added in v2.7.1

type FraudPreventionAssessment_StolenInstrumentVerdict struct {

	// Output only. Probability (0-1) of this transaction being executed with a
	// stolen instrument.
	Risk float32 `protobuf:"fixed32,1,opt,name=risk,proto3" json:"risk,omitempty"`
	// contains filtered or unexported fields
}

Information about stolen instrument fraud, where the user is not the legitimate owner of the instrument being used for the purchase.

func (*FraudPreventionAssessment_StolenInstrumentVerdict) Descriptor deprecated added in v2.7.1

Deprecated: Use FraudPreventionAssessment_StolenInstrumentVerdict.ProtoReflect.Descriptor instead.

func (*FraudPreventionAssessment_StolenInstrumentVerdict) GetRisk added in v2.7.1

func (*FraudPreventionAssessment_StolenInstrumentVerdict) ProtoMessage added in v2.7.1

func (*FraudPreventionAssessment_StolenInstrumentVerdict) ProtoReflect added in v2.7.1

func (*FraudPreventionAssessment_StolenInstrumentVerdict) Reset added in v2.7.1

func (*FraudPreventionAssessment_StolenInstrumentVerdict) String added in v2.7.1

type PasswordLeakVerification

type PasswordLeakVerification struct {

	// Optional. Scrypt hash of the username+password that the customer wants to
	// verify against a known password leak.
	HashedUserCredentials []byte `` /* 126-byte string literal not displayed */
	// Output only. Whether or not the user's credentials are present in a known
	// leak.
	CredentialsLeaked bool `protobuf:"varint,2,opt,name=credentials_leaked,json=credentialsLeaked,proto3" json:"credentials_leaked,omitempty"`
	// Optional. The username part of the user credentials for which we want to
	// trigger a leak check in canonicalized form. This is the same data used to
	// create the hashed_user_credentials on the customer side.
	CanonicalizedUsername string `protobuf:"bytes,3,opt,name=canonicalized_username,json=canonicalizedUsername,proto3" json:"canonicalized_username,omitempty"`
	// contains filtered or unexported fields
}

Password leak verification info.

func (*PasswordLeakVerification) Descriptor deprecated

func (*PasswordLeakVerification) Descriptor() ([]byte, []int)

Deprecated: Use PasswordLeakVerification.ProtoReflect.Descriptor instead.

func (*PasswordLeakVerification) GetCanonicalizedUsername

func (x *PasswordLeakVerification) GetCanonicalizedUsername() string

func (*PasswordLeakVerification) GetCredentialsLeaked

func (x *PasswordLeakVerification) GetCredentialsLeaked() bool

func (*PasswordLeakVerification) GetHashedUserCredentials

func (x *PasswordLeakVerification) GetHashedUserCredentials() []byte

func (*PasswordLeakVerification) ProtoMessage

func (*PasswordLeakVerification) ProtoMessage()

func (*PasswordLeakVerification) ProtoReflect

func (x *PasswordLeakVerification) ProtoReflect() protoreflect.Message

func (*PasswordLeakVerification) Reset

func (x *PasswordLeakVerification) Reset()

func (*PasswordLeakVerification) String

func (x *PasswordLeakVerification) String() string

type RecaptchaEnterpriseServiceV1Beta1Client

type RecaptchaEnterpriseServiceV1Beta1Client interface {
	// Creates an Assessment of the likelihood an event is legitimate.
	CreateAssessment(ctx context.Context, in *CreateAssessmentRequest, opts ...grpc.CallOption) (*Assessment, error)
	// Annotates a previously created Assessment to provide additional information
	// on whether the event turned out to be authentic or fradulent.
	AnnotateAssessment(ctx context.Context, in *AnnotateAssessmentRequest, opts ...grpc.CallOption) (*AnnotateAssessmentResponse, error)
}

RecaptchaEnterpriseServiceV1Beta1Client is the client API for RecaptchaEnterpriseServiceV1Beta1 service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

type RecaptchaEnterpriseServiceV1Beta1Server

type RecaptchaEnterpriseServiceV1Beta1Server interface {
	// Creates an Assessment of the likelihood an event is legitimate.
	CreateAssessment(context.Context, *CreateAssessmentRequest) (*Assessment, error)
	// Annotates a previously created Assessment to provide additional information
	// on whether the event turned out to be authentic or fradulent.
	AnnotateAssessment(context.Context, *AnnotateAssessmentRequest) (*AnnotateAssessmentResponse, error)
}

RecaptchaEnterpriseServiceV1Beta1Server is the server API for RecaptchaEnterpriseServiceV1Beta1 service. All implementations should embed UnimplementedRecaptchaEnterpriseServiceV1Beta1Server for forward compatibility

type TokenProperties

type TokenProperties struct {

	// Whether the provided user response token is valid. When valid = false, the
	// reason could be specified in invalid_reason or it could also be due to
	// a user failing to solve a challenge or a sitekey mismatch (i.e the sitekey
	// used to generate the token was different than the one specified in the
	// assessment).
	Valid bool `protobuf:"varint,1,opt,name=valid,proto3" json:"valid,omitempty"`
	// Reason associated with the response when valid = false.
	InvalidReason TokenProperties_InvalidReason `` /* 177-byte string literal not displayed */
	// The timestamp corresponding to the generation of the token.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// The hostname of the page on which the token was generated.
	Hostname string `protobuf:"bytes,4,opt,name=hostname,proto3" json:"hostname,omitempty"`
	// Action name provided at token generation.
	Action string `protobuf:"bytes,5,opt,name=action,proto3" json:"action,omitempty"`
	// contains filtered or unexported fields
}

func (*TokenProperties) Descriptor deprecated

func (*TokenProperties) Descriptor() ([]byte, []int)

Deprecated: Use TokenProperties.ProtoReflect.Descriptor instead.

func (*TokenProperties) GetAction

func (x *TokenProperties) GetAction() string

func (*TokenProperties) GetCreateTime

func (x *TokenProperties) GetCreateTime() *timestamppb.Timestamp

func (*TokenProperties) GetHostname

func (x *TokenProperties) GetHostname() string

func (*TokenProperties) GetInvalidReason

func (x *TokenProperties) GetInvalidReason() TokenProperties_InvalidReason

func (*TokenProperties) GetValid

func (x *TokenProperties) GetValid() bool

func (*TokenProperties) ProtoMessage

func (*TokenProperties) ProtoMessage()

func (*TokenProperties) ProtoReflect

func (x *TokenProperties) ProtoReflect() protoreflect.Message

func (*TokenProperties) Reset

func (x *TokenProperties) Reset()

func (*TokenProperties) String

func (x *TokenProperties) String() string

type TokenProperties_InvalidReason

type TokenProperties_InvalidReason int32

Enum that represents the types of invalid token reasons.

const (
	// Default unspecified type.
	TokenProperties_INVALID_REASON_UNSPECIFIED TokenProperties_InvalidReason = 0
	// If the failure reason was not accounted for.
	TokenProperties_UNKNOWN_INVALID_REASON TokenProperties_InvalidReason = 1
	// The provided user verification token was malformed.
	TokenProperties_MALFORMED TokenProperties_InvalidReason = 2
	// The user verification token had expired.
	TokenProperties_EXPIRED TokenProperties_InvalidReason = 3
	// The user verification had already been seen.
	TokenProperties_DUPE TokenProperties_InvalidReason = 4
	// The user verification token did not match the provided site key.
	// This may be a configuration error (for example, development keys used in
	// production) or end users trying to use verification tokens from other
	// sites.
	//
	// Deprecated: Marked as deprecated in google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.proto.
	TokenProperties_SITE_MISMATCH TokenProperties_InvalidReason = 5
	// The user verification token was not present.  It is a required input.
	TokenProperties_MISSING TokenProperties_InvalidReason = 6
	// A retriable error (such as network failure) occurred on the browser.
	// Could easily be simulated by an attacker.
	TokenProperties_BROWSER_ERROR TokenProperties_InvalidReason = 7
)

func (TokenProperties_InvalidReason) Descriptor

func (TokenProperties_InvalidReason) Enum

func (TokenProperties_InvalidReason) EnumDescriptor deprecated

func (TokenProperties_InvalidReason) EnumDescriptor() ([]byte, []int)

Deprecated: Use TokenProperties_InvalidReason.Descriptor instead.

func (TokenProperties_InvalidReason) Number

func (TokenProperties_InvalidReason) String

func (TokenProperties_InvalidReason) Type

type TransactionData added in v2.7.1

type TransactionData struct {

	// Unique identifier for the transaction. This custom identifier can be used
	// to reference this transaction in the future, for example, labeling a refund
	// or chargeback event. Two attempts at the same transaction should use the
	// same transaction id.
	TransactionId *string `protobuf:"bytes,11,opt,name=transaction_id,json=transactionId,proto3,oneof" json:"transaction_id,omitempty"`
	// The payment method for the transaction. The allowed values are:
	//
	// * credit-card
	// * debit-card
	// * gift-card
	// * processor-{name} (If a third-party is used, for example,
	// processor-paypal)
	// * custom-{name} (If an alternative method is used, for example,
	// custom-crypto)
	PaymentMethod string `protobuf:"bytes,1,opt,name=payment_method,json=paymentMethod,proto3" json:"payment_method,omitempty"`
	// The Bank Identification Number - generally the first 6 or 8 digits of the
	// card.
	CardBin string `protobuf:"bytes,2,opt,name=card_bin,json=cardBin,proto3" json:"card_bin,omitempty"`
	// The last four digits of the card.
	CardLastFour string `protobuf:"bytes,3,opt,name=card_last_four,json=cardLastFour,proto3" json:"card_last_four,omitempty"`
	// The currency code in ISO-4217 format.
	CurrencyCode string `protobuf:"bytes,4,opt,name=currency_code,json=currencyCode,proto3" json:"currency_code,omitempty"`
	// The decimal value of the transaction in the specified currency.
	Value float64 `protobuf:"fixed64,5,opt,name=value,proto3" json:"value,omitempty"`
	// The value of shipping in the specified currency. 0 for free or no shipping.
	ShippingValue float64 `protobuf:"fixed64,12,opt,name=shipping_value,json=shippingValue,proto3" json:"shipping_value,omitempty"`
	// Destination address if this transaction involves shipping a physical item.
	ShippingAddress *TransactionData_Address `protobuf:"bytes,6,opt,name=shipping_address,json=shippingAddress,proto3" json:"shipping_address,omitempty"`
	// Address associated with the payment method when applicable.
	BillingAddress *TransactionData_Address `protobuf:"bytes,7,opt,name=billing_address,json=billingAddress,proto3" json:"billing_address,omitempty"`
	// Information about the user paying/initiating the transaction.
	User *TransactionData_User `protobuf:"bytes,8,opt,name=user,proto3" json:"user,omitempty"`
	// Information about the user or users fulfilling the transaction.
	Merchants []*TransactionData_User `protobuf:"bytes,13,rep,name=merchants,proto3" json:"merchants,omitempty"`
	// Items purchased in this transaction.
	Items []*TransactionData_Item `protobuf:"bytes,14,rep,name=items,proto3" json:"items,omitempty"`
	// Information about the payment gateway's response to the transaction.
	GatewayInfo *TransactionData_GatewayInfo `protobuf:"bytes,10,opt,name=gateway_info,json=gatewayInfo,proto3" json:"gateway_info,omitempty"`
	// contains filtered or unexported fields
}

Transaction data associated with a payment protected by reCAPTCHA.

func (*TransactionData) Descriptor deprecated added in v2.7.1

func (*TransactionData) Descriptor() ([]byte, []int)

Deprecated: Use TransactionData.ProtoReflect.Descriptor instead.

func (*TransactionData) GetBillingAddress added in v2.7.1

func (x *TransactionData) GetBillingAddress() *TransactionData_Address

func (*TransactionData) GetCardBin added in v2.7.1

func (x *TransactionData) GetCardBin() string

func (*TransactionData) GetCardLastFour added in v2.7.1

func (x *TransactionData) GetCardLastFour() string

func (*TransactionData) GetCurrencyCode added in v2.7.1

func (x *TransactionData) GetCurrencyCode() string

func (*TransactionData) GetGatewayInfo added in v2.7.1

func (x *TransactionData) GetGatewayInfo() *TransactionData_GatewayInfo

func (*TransactionData) GetItems added in v2.7.1

func (x *TransactionData) GetItems() []*TransactionData_Item

func (*TransactionData) GetMerchants added in v2.7.1

func (x *TransactionData) GetMerchants() []*TransactionData_User

func (*TransactionData) GetPaymentMethod added in v2.7.1

func (x *TransactionData) GetPaymentMethod() string

func (*TransactionData) GetShippingAddress added in v2.7.1

func (x *TransactionData) GetShippingAddress() *TransactionData_Address

func (*TransactionData) GetShippingValue added in v2.7.1

func (x *TransactionData) GetShippingValue() float64

func (*TransactionData) GetTransactionId added in v2.7.1

func (x *TransactionData) GetTransactionId() string

func (*TransactionData) GetUser added in v2.7.1

func (x *TransactionData) GetUser() *TransactionData_User

func (*TransactionData) GetValue added in v2.7.1

func (x *TransactionData) GetValue() float64

func (*TransactionData) ProtoMessage added in v2.7.1

func (*TransactionData) ProtoMessage()

func (*TransactionData) ProtoReflect added in v2.7.1

func (x *TransactionData) ProtoReflect() protoreflect.Message

func (*TransactionData) Reset added in v2.7.1

func (x *TransactionData) Reset()

func (*TransactionData) String added in v2.7.1

func (x *TransactionData) String() string

type TransactionData_Address added in v2.7.1

type TransactionData_Address struct {

	// The recipient name, potentially including information such as "care of".
	Recipient string `protobuf:"bytes,1,opt,name=recipient,proto3" json:"recipient,omitempty"`
	// The first lines of the address. The first line generally contains the
	// street name and number, and further lines may include information such as
	// an apartment number.
	Address []string `protobuf:"bytes,2,rep,name=address,proto3" json:"address,omitempty"`
	// The town/city of the address.
	Locality string `protobuf:"bytes,3,opt,name=locality,proto3" json:"locality,omitempty"`
	// The state, province, or otherwise administrative area of the address.
	AdministrativeArea string `protobuf:"bytes,4,opt,name=administrative_area,json=administrativeArea,proto3" json:"administrative_area,omitempty"`
	// The CLDR country/region of the address.
	RegionCode string `protobuf:"bytes,5,opt,name=region_code,json=regionCode,proto3" json:"region_code,omitempty"`
	// The postal or ZIP code of the address.
	PostalCode string `protobuf:"bytes,6,opt,name=postal_code,json=postalCode,proto3" json:"postal_code,omitempty"`
	// contains filtered or unexported fields
}

Structured address format for billing and shipping addresses.

func (*TransactionData_Address) Descriptor deprecated added in v2.7.1

func (*TransactionData_Address) Descriptor() ([]byte, []int)

Deprecated: Use TransactionData_Address.ProtoReflect.Descriptor instead.

func (*TransactionData_Address) GetAddress added in v2.7.1

func (x *TransactionData_Address) GetAddress() []string

func (*TransactionData_Address) GetAdministrativeArea added in v2.7.1

func (x *TransactionData_Address) GetAdministrativeArea() string

func (*TransactionData_Address) GetLocality added in v2.7.1

func (x *TransactionData_Address) GetLocality() string

func (*TransactionData_Address) GetPostalCode added in v2.7.1

func (x *TransactionData_Address) GetPostalCode() string

func (*TransactionData_Address) GetRecipient added in v2.7.1

func (x *TransactionData_Address) GetRecipient() string

func (*TransactionData_Address) GetRegionCode added in v2.7.1

func (x *TransactionData_Address) GetRegionCode() string

func (*TransactionData_Address) ProtoMessage added in v2.7.1

func (*TransactionData_Address) ProtoMessage()

func (*TransactionData_Address) ProtoReflect added in v2.7.1

func (x *TransactionData_Address) ProtoReflect() protoreflect.Message

func (*TransactionData_Address) Reset added in v2.7.1

func (x *TransactionData_Address) Reset()

func (*TransactionData_Address) String added in v2.7.1

func (x *TransactionData_Address) String() string

type TransactionData_GatewayInfo added in v2.7.1

type TransactionData_GatewayInfo struct {

	// Name of the gateway service (for example, stripe, square, paypal).
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Gateway response code describing the state of the transaction.
	GatewayResponseCode string `protobuf:"bytes,2,opt,name=gateway_response_code,json=gatewayResponseCode,proto3" json:"gateway_response_code,omitempty"`
	// AVS response code from the gateway
	// (available only when reCAPTCHA is called after authorization).
	AvsResponseCode string `protobuf:"bytes,3,opt,name=avs_response_code,json=avsResponseCode,proto3" json:"avs_response_code,omitempty"`
	// CVV response code from the gateway
	// (available only when reCAPTCHA is called after authorization).
	CvvResponseCode string `protobuf:"bytes,4,opt,name=cvv_response_code,json=cvvResponseCode,proto3" json:"cvv_response_code,omitempty"`
	// contains filtered or unexported fields
}

Details about the transaction from the gateway.

func (*TransactionData_GatewayInfo) Descriptor deprecated added in v2.7.1

func (*TransactionData_GatewayInfo) Descriptor() ([]byte, []int)

Deprecated: Use TransactionData_GatewayInfo.ProtoReflect.Descriptor instead.

func (*TransactionData_GatewayInfo) GetAvsResponseCode added in v2.7.1

func (x *TransactionData_GatewayInfo) GetAvsResponseCode() string

func (*TransactionData_GatewayInfo) GetCvvResponseCode added in v2.7.1

func (x *TransactionData_GatewayInfo) GetCvvResponseCode() string

func (*TransactionData_GatewayInfo) GetGatewayResponseCode added in v2.7.1

func (x *TransactionData_GatewayInfo) GetGatewayResponseCode() string

func (*TransactionData_GatewayInfo) GetName added in v2.7.1

func (x *TransactionData_GatewayInfo) GetName() string

func (*TransactionData_GatewayInfo) ProtoMessage added in v2.7.1

func (*TransactionData_GatewayInfo) ProtoMessage()

func (*TransactionData_GatewayInfo) ProtoReflect added in v2.7.1

func (*TransactionData_GatewayInfo) Reset added in v2.7.1

func (x *TransactionData_GatewayInfo) Reset()

func (*TransactionData_GatewayInfo) String added in v2.7.1

func (x *TransactionData_GatewayInfo) String() string

type TransactionData_Item added in v2.7.1

type TransactionData_Item struct {

	// The full name of the item.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The value per item that the user is paying, in the transaction currency,
	// after discounts.
	Value float64 `protobuf:"fixed64,2,opt,name=value,proto3" json:"value,omitempty"`
	// The quantity of this item that is being purchased.
	Quantity int64 `protobuf:"varint,3,opt,name=quantity,proto3" json:"quantity,omitempty"`
	// When a merchant is specified, its corresponding account_id. Necessary to
	// populate marketplace-style transactions.
	MerchantAccountId string `protobuf:"bytes,4,opt,name=merchant_account_id,json=merchantAccountId,proto3" json:"merchant_account_id,omitempty"`
	// contains filtered or unexported fields
}

Line items being purchased in this transaction.

func (*TransactionData_Item) Descriptor deprecated added in v2.7.1

func (*TransactionData_Item) Descriptor() ([]byte, []int)

Deprecated: Use TransactionData_Item.ProtoReflect.Descriptor instead.

func (*TransactionData_Item) GetMerchantAccountId added in v2.7.1

func (x *TransactionData_Item) GetMerchantAccountId() string

func (*TransactionData_Item) GetName added in v2.7.1

func (x *TransactionData_Item) GetName() string

func (*TransactionData_Item) GetQuantity added in v2.7.1

func (x *TransactionData_Item) GetQuantity() int64

func (*TransactionData_Item) GetValue added in v2.7.1

func (x *TransactionData_Item) GetValue() float64

func (*TransactionData_Item) ProtoMessage added in v2.7.1

func (*TransactionData_Item) ProtoMessage()

func (*TransactionData_Item) ProtoReflect added in v2.7.1

func (x *TransactionData_Item) ProtoReflect() protoreflect.Message

func (*TransactionData_Item) Reset added in v2.7.1

func (x *TransactionData_Item) Reset()

func (*TransactionData_Item) String added in v2.7.1

func (x *TransactionData_Item) String() string

type TransactionData_User added in v2.7.1

type TransactionData_User struct {

	// Unique account identifier for this user. If using account defender,
	// this should match the hashed_account_id field. Otherwise, a unique and
	// persistent identifier for this account.
	AccountId string `protobuf:"bytes,6,opt,name=account_id,json=accountId,proto3" json:"account_id,omitempty"`
	// The epoch milliseconds of the user's account creation.
	CreationMs int64 `protobuf:"varint,1,opt,name=creation_ms,json=creationMs,proto3" json:"creation_ms,omitempty"`
	// The email address of the user.
	Email string `protobuf:"bytes,2,opt,name=email,proto3" json:"email,omitempty"`
	// Whether the email has been verified to be accessible by the user (OTP or
	// similar).
	EmailVerified bool `protobuf:"varint,3,opt,name=email_verified,json=emailVerified,proto3" json:"email_verified,omitempty"`
	// The phone number of the user, with country code.
	PhoneNumber string `protobuf:"bytes,4,opt,name=phone_number,json=phoneNumber,proto3" json:"phone_number,omitempty"`
	// Whether the phone number has been verified to be accessible by the user
	// (OTP or similar).
	PhoneVerified bool `protobuf:"varint,5,opt,name=phone_verified,json=phoneVerified,proto3" json:"phone_verified,omitempty"`
	// contains filtered or unexported fields
}

Details about a user's account involved in the transaction.

func (*TransactionData_User) Descriptor deprecated added in v2.7.1

func (*TransactionData_User) Descriptor() ([]byte, []int)

Deprecated: Use TransactionData_User.ProtoReflect.Descriptor instead.

func (*TransactionData_User) GetAccountId added in v2.7.1

func (x *TransactionData_User) GetAccountId() string

func (*TransactionData_User) GetCreationMs added in v2.7.1

func (x *TransactionData_User) GetCreationMs() int64

func (*TransactionData_User) GetEmail added in v2.7.1

func (x *TransactionData_User) GetEmail() string

func (*TransactionData_User) GetEmailVerified added in v2.7.1

func (x *TransactionData_User) GetEmailVerified() bool

func (*TransactionData_User) GetPhoneNumber added in v2.7.1

func (x *TransactionData_User) GetPhoneNumber() string

func (*TransactionData_User) GetPhoneVerified added in v2.7.1

func (x *TransactionData_User) GetPhoneVerified() bool

func (*TransactionData_User) ProtoMessage added in v2.7.1

func (*TransactionData_User) ProtoMessage()

func (*TransactionData_User) ProtoReflect added in v2.7.1

func (x *TransactionData_User) ProtoReflect() protoreflect.Message

func (*TransactionData_User) Reset added in v2.7.1

func (x *TransactionData_User) Reset()

func (*TransactionData_User) String added in v2.7.1

func (x *TransactionData_User) String() string

type TransactionEvent added in v2.7.1

type TransactionEvent struct {

	// Optional. The type of this transaction event.
	EventType TransactionEvent_TransactionEventType `` /* 173-byte string literal not displayed */
	// Optional. The reason or standardized code that corresponds with this
	// transaction event, if one exists. For example, a CHARGEBACK event with code
	// 6005.
	Reason string `protobuf:"bytes,2,opt,name=reason,proto3" json:"reason,omitempty"`
	// Optional. The value that corresponds with this transaction event, if one
	// exists. For example, a refund event where $5.00 was refunded. Currency is
	// obtained from the original transaction data.
	Value float64 `protobuf:"fixed64,3,opt,name=value,proto3" json:"value,omitempty"`
	// Optional. Timestamp when this transaction event occurred; otherwise assumed
	// to be the time of the API call.
	EventTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=event_time,json=eventTime,proto3" json:"event_time,omitempty"`
	// contains filtered or unexported fields
}

Describes an event in the lifecycle of a payment transaction.

func (*TransactionEvent) Descriptor deprecated added in v2.7.1

func (*TransactionEvent) Descriptor() ([]byte, []int)

Deprecated: Use TransactionEvent.ProtoReflect.Descriptor instead.

func (*TransactionEvent) GetEventTime added in v2.7.1

func (x *TransactionEvent) GetEventTime() *timestamppb.Timestamp

func (*TransactionEvent) GetEventType added in v2.7.1

func (*TransactionEvent) GetReason added in v2.7.1

func (x *TransactionEvent) GetReason() string

func (*TransactionEvent) GetValue added in v2.7.1

func (x *TransactionEvent) GetValue() float64

func (*TransactionEvent) ProtoMessage added in v2.7.1

func (*TransactionEvent) ProtoMessage()

func (*TransactionEvent) ProtoReflect added in v2.7.1

func (x *TransactionEvent) ProtoReflect() protoreflect.Message

func (*TransactionEvent) Reset added in v2.7.1

func (x *TransactionEvent) Reset()

func (*TransactionEvent) String added in v2.7.1

func (x *TransactionEvent) String() string

type TransactionEvent_TransactionEventType added in v2.7.1

type TransactionEvent_TransactionEventType int32

Enum that represents an event in the payment transaction lifecycle.

const (
	// Default, unspecified event type.
	TransactionEvent_TRANSACTION_EVENT_TYPE_UNSPECIFIED TransactionEvent_TransactionEventType = 0
	// Indicates that the transaction is approved by the merchant. The
	// accompanying reasons can include terms such as 'INHOUSE', 'ACCERTIFY',
	// 'CYBERSOURCE', or 'MANUAL_REVIEW'.
	TransactionEvent_MERCHANT_APPROVE TransactionEvent_TransactionEventType = 1
	// Indicates that the transaction is denied and concluded due to risks
	// detected by the merchant. The accompanying reasons can include terms such
	// as 'INHOUSE',  'ACCERTIFY',  'CYBERSOURCE', or 'MANUAL_REVIEW'.
	TransactionEvent_MERCHANT_DENY TransactionEvent_TransactionEventType = 2
	// Indicates that the transaction is being evaluated by a human, due to
	// suspicion or risk.
	TransactionEvent_MANUAL_REVIEW TransactionEvent_TransactionEventType = 3
	// Indicates that the authorization attempt with the card issuer succeeded.
	TransactionEvent_AUTHORIZATION TransactionEvent_TransactionEventType = 4
	// Indicates that the authorization attempt with the card issuer failed.
	// The accompanying reasons can include Visa's '54' indicating that the card
	// is expired, or '82' indicating that the CVV is incorrect.
	TransactionEvent_AUTHORIZATION_DECLINE TransactionEvent_TransactionEventType = 5
	// Indicates that the transaction is completed because the funds were
	// settled.
	TransactionEvent_PAYMENT_CAPTURE TransactionEvent_TransactionEventType = 6
	// Indicates that the transaction could not be completed because the funds
	// were not settled.
	TransactionEvent_PAYMENT_CAPTURE_DECLINE TransactionEvent_TransactionEventType = 7
	// Indicates that the transaction has been canceled. Specify the reason
	// for the cancellation. For example, 'INSUFFICIENT_INVENTORY'.
	TransactionEvent_CANCEL TransactionEvent_TransactionEventType = 8
	// Indicates that the merchant has received a chargeback inquiry due to
	// fraud for the transaction, requesting additional information before a
	// fraud chargeback is officially issued and a formal chargeback
	// notification is sent.
	TransactionEvent_CHARGEBACK_INQUIRY TransactionEvent_TransactionEventType = 9
	// Indicates that the merchant has received a chargeback alert due to fraud
	// for the transaction. The process of resolving the dispute without
	// involving the payment network is started.
	TransactionEvent_CHARGEBACK_ALERT TransactionEvent_TransactionEventType = 10
	// Indicates that a fraud notification is issued for the transaction, sent
	// by the payment instrument's issuing bank because the transaction appears
	// to be fraudulent. We recommend including TC40 or SAFE data in the
	// `reason` field for this event type. For partial chargebacks, we recommend
	// that you include an amount in the `value` field.
	TransactionEvent_FRAUD_NOTIFICATION TransactionEvent_TransactionEventType = 11
	// Indicates that the merchant is informed by the payment network that the
	// transaction has entered the chargeback process due to fraud. Reason code
	// examples include Discover's '6005' and '6041'. For partial chargebacks,
	// we recommend that you include an amount in the `value` field.
	TransactionEvent_CHARGEBACK TransactionEvent_TransactionEventType = 12
	// Indicates that the transaction has entered the chargeback process due to
	// fraud, and that the merchant has chosen to enter representment. Reason
	// examples include Discover's '6005' and '6041'. For partial chargebacks,
	// we recommend that you include an amount in the `value` field.
	TransactionEvent_CHARGEBACK_REPRESENTMENT TransactionEvent_TransactionEventType = 13
	// Indicates that the transaction has had a fraud chargeback which was
	// illegitimate and was reversed as a result. For partial chargebacks, we
	// recommend that you include an amount in the `value` field.
	TransactionEvent_CHARGEBACK_REVERSE TransactionEvent_TransactionEventType = 14
	// Indicates that the merchant has received a refund for a completed
	// transaction. For partial refunds, we recommend that you include an amount
	// in the `value` field. Reason example: 'TAX_EXEMPT' (partial refund of
	// exempt tax)
	TransactionEvent_REFUND_REQUEST TransactionEvent_TransactionEventType = 15
	// Indicates that the merchant has received a refund request for this
	// transaction, but that they have declined it. For partial refunds, we
	// recommend that you include an amount in the `value` field. Reason
	// example: 'TAX_EXEMPT' (partial refund of exempt tax)
	TransactionEvent_REFUND_DECLINE TransactionEvent_TransactionEventType = 16
	// Indicates that the completed transaction was refunded by the merchant.
	// For partial refunds, we recommend that you include an amount in the
	// `value` field. Reason example: 'TAX_EXEMPT' (partial refund of exempt
	// tax)
	TransactionEvent_REFUND TransactionEvent_TransactionEventType = 17
	// Indicates that the completed transaction was refunded by the merchant,
	// and that this refund was reversed. For partial refunds, we recommend that
	// you include an amount in the `value` field.
	TransactionEvent_REFUND_REVERSE TransactionEvent_TransactionEventType = 18
)

func (TransactionEvent_TransactionEventType) Descriptor added in v2.7.1

func (TransactionEvent_TransactionEventType) Enum added in v2.7.1

func (TransactionEvent_TransactionEventType) EnumDescriptor deprecated added in v2.7.1

func (TransactionEvent_TransactionEventType) EnumDescriptor() ([]byte, []int)

Deprecated: Use TransactionEvent_TransactionEventType.Descriptor instead.

func (TransactionEvent_TransactionEventType) Number added in v2.7.1

func (TransactionEvent_TransactionEventType) String added in v2.7.1

func (TransactionEvent_TransactionEventType) Type added in v2.7.1

type UnimplementedRecaptchaEnterpriseServiceV1Beta1Server

type UnimplementedRecaptchaEnterpriseServiceV1Beta1Server struct {
}

UnimplementedRecaptchaEnterpriseServiceV1Beta1Server should be embedded to have forward compatible implementations.

func (UnimplementedRecaptchaEnterpriseServiceV1Beta1Server) AnnotateAssessment

func (UnimplementedRecaptchaEnterpriseServiceV1Beta1Server) CreateAssessment

type UnsafeRecaptchaEnterpriseServiceV1Beta1Server added in v2.20.5

type UnsafeRecaptchaEnterpriseServiceV1Beta1Server interface {
	// contains filtered or unexported methods
}

UnsafeRecaptchaEnterpriseServiceV1Beta1Server may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to RecaptchaEnterpriseServiceV1Beta1Server will result in compilation errors.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL