v1beta1

google.cloud.recaptchaenterprise. v1beta1

Source:

Members

(static) Annotation :number

Enum that reprensents the types of annotations.

Properties:
Name Type Description
ANNOTATION_UNSPECIFIED number

Default unspecified type.
LEGITIMATE number

Provides information that the event turned out to be legitimate.
FRAUDULENT number

Provides information that the event turned out to be fraudulent.
Source:

(static) ClassificationReason :number

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

Properties:
Name Type Description
CLASSIFICATION_REASON_UNSPECIFIED number

Default unspecified type.
AUTOMATION number

The event appeared to be automated.
UNEXPECTED_ENVIRONMENT number

The event was not made from the proper context on the real site.
UNEXPECTED_USAGE_PATTERNS number

Browsing behavior leading up to the event was generated was out of the ordinary.
PROVISIONAL_RISK_ANALYSIS number

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

(static) InvalidReason :number

Enum that represents the types of invalid token reasons.

Properties:
Name Type Description
INVALID_REASON_UNSPECIFIED number

Default unspecified type.
UNKNOWN_INVALID_REASON number

If the failure reason was not accounted for.
MALFORMED number

The provided user verification token was malformed.
EXPIRED number

The user verification token had expired.
DUPE number

The user verification had already been seen.
SITE_MISMATCH number

The user verification token did not match the provided site secret. 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 number

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

Type Definitions

AnnotateAssessmentRequest

The request message to annotate an Assessment.

Properties:
Name Type Description
name string

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

The annotation that will be assigned to the Event.

The number should be among the values of Annotation
Source:
See:

AnnotateAssessmentResponse

Empty response for AnnotateAssessment.

Source:
See:

Assessment

A recaptcha assessment resource.

Properties:
Name Type Description
name string

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

The event being assessed.

This object should have the same structure as Event
score number

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

Output only. Properties of the provided event token.

This object should have the same structure as TokenProperties
reasons Array.<number>

Output only. Reasons contributing to the risk analysis verdict.

The number should be among the values of ClassificationReason
Source:
See:

CreateAssessmentRequest

The create assessment request message.

Properties:
Name Type Description
parent string

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

The asessment details.

This object should have the same structure as Assessment
Source:
See:

Event

Properties:
Name Type Description
token string

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

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

TokenProperties

Properties:
Name Type Description
valid boolean

Output only. Whether the provided user response token is valid.
invalidReason number

Output only. Reason associated with the response when valid = false.

The number should be among the values of InvalidReason
createTime Object

Output only. The timestamp corresponding to the generation of the token.

This object should have the same structure as Timestamp
hostname string

Output only. The hostname of the page on which the token was generated.
action string

Output only. Action name provided at token generation.
Source:
See: