package google.cloud.recaptchaenterprise.v1beta1

Get desktop application:
View/edit binary Protocol Buffers messages

Service to determine the likelihood an event is legitimate.

• rpc CreateAssessment (CreateAssessmentRequest, Assessment)

  recaptchaenterprise.proto:40

  Creates an Assessment of the likelihood an event is legitimate.

  message CreateAssessmentRequest

  recaptchaenterprise.proto:60

  The create assessment request message.

  • string parent = 1

    Required. The name of the project in which the assessment will be created, in the format "projects/{project_number}".

  • optional Assessment assessment = 2

    Required. The assessment details.

• rpc AnnotateAssessment (AnnotateAssessmentRequest, AnnotateAssessmentResponse)

  recaptchaenterprise.proto:50

  Annotates a previously created Assessment to provide additional information on whether the event turned out to be authentic or fradulent.

  message AnnotateAssessmentRequest

  recaptchaenterprise.proto:75

  The request message to annotate an Assessment.

  • string name = 1

    Required. The resource name of the Assessment, in the format "projects/{project_number}/assessments/{assessment_id}".

  • AnnotateAssessmentRequest.Annotation annotation = 2

    Required. The annotation that will be assigned to the Event.

  message AnnotateAssessmentResponse

  recaptchaenterprise.proto:102

  Empty response for AnnotateAssessment.

  (message has no fields)

Enum that reprensents the types of annotations.

Used in: AnnotateAssessmentRequest

• ANNOTATION_UNSPECIFIED = 0

  Default unspecified type.

• LEGITIMATE = 1

  Provides information that the event turned out to be legitimate.

• FRAUDULENT = 2

  Provides information that the event turned out to be fraudulent.

A recaptcha assessment resource.

Used as response type in: RecaptchaEnterpriseServiceV1Beta1.CreateAssessment

Used as field type in: CreateAssessmentRequest

• string name = 1

  Output only. The resource name for the Assessment in the format "projects/{project_number}/assessments/{assessment_id}".

• optional Event event = 2

  The event being assessed.

• float score = 3

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

• optional TokenProperties token_properties = 4

  Output only. Properties of the provided event token.

• repeated Assessment.ClassificationReason reasons = 5

  Output only. Reasons contributing to the risk analysis verdict.

LINT.IfChange(classification_reason) Reasons contributing to the risk analysis verdict.

Used in: Assessment

• CLASSIFICATION_REASON_UNSPECIFIED = 0

  Default unspecified type.

• AUTOMATION = 1

  Interactions matched the behavior of an automated agent.

• UNEXPECTED_ENVIRONMENT = 2

  The event originated from an illegitimate environment.

• TOO_MUCH_TRAFFIC = 3

  Traffic volume from the event source is higher than normal.

• UNEXPECTED_USAGE_PATTERNS = 4

  Interactions with the site were significantly different than expected patterns.

• LOW_CONFIDENCE_SCORE = 5

  Too little traffic has been received from this site thus far to generate quality risk analysis.

Used in: Assessment

• string token = 1

  Required. The user response token provided by the reCAPTCHA client-side integration on your site.

• string site_key = 2

  Required. The site key that was used to invoke reCAPTCHA on your site and generate the token.

Used in: Assessment

• bool valid = 1

  Whether the provided user response token is valid.

• TokenProperties.InvalidReason invalid_reason = 2

  Reason associated with the response when valid = false.

• optional protobuf.Timestamp create_time = 3

  The timestamp corresponding to the generation of the token.

• string hostname = 4

  The hostname of the page on which the token was generated.

• string action = 5

  Action name provided at token generation.

LINT.IfChange Enum that represents the types of invalid token reasons.

Used in: TokenProperties

• INVALID_REASON_UNSPECIFIED = 0

  Default unspecified type.

• UNKNOWN_INVALID_REASON = 1

  If the failure reason was not accounted for.

• MALFORMED = 2

  The provided user verification token was malformed.

• EXPIRED = 3

  The user verification token had expired.

• DUPE = 4

  The user verification had already been seen.

• SITE_MISMATCH = 5

  The user verification token did not match the provided site key. This may be a configuration error (e.g. development keys used in production) or end users trying to use verification tokens from other sites.

• MISSING = 6

  The user verification token was not present. It is a required input.