Class Event (1.20.0)

Event(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The event being assessed.

Attributes

Name Description
token str
Optional. The user response token provided by the reCAPTCHA Enterprise client-side integration on your site.
site_key str
Optional. The site key that was used to invoke reCAPTCHA Enterprise on your site and generate the token.
user_agent str
Optional. The user agent present in the request from the user's device related to this event.
user_ip_address str
Optional. The IP address in the request from the user's device related to this event.
expected_action str
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 enterprise.
hashed_account_id bytes
Optional. Deprecated: use user_info.account_id instead. Unique stable hashed user identifier for the request. The identifier must be hashed using hmac-sha256 with stable secret.
express bool
Optional. Flag for a reCAPTCHA express request for an assessment without a token. If enabled, site_key must reference a SCORE key with WAF feature set to EXPRESS.
requested_uri str
Optional. The URI resource the user requested that triggered an assessment.
waf_token_assessment bool
Optional. Flag for running WAF token assessment. If enabled, the token must be specified, and have been created by a WAF-enabled key.
ja3 str
Optional. JA3 fingerprint for SSL clients.
headers MutableSequence[str]
Optional. HTTP header information about the request.
firewall_policy_evaluation bool
Optional. Flag for enabling firewall policy config assessment. If this flag is enabled, the firewall policy will be evaluated and a suggested firewall action will be returned in the response.
transaction_data google.cloud.recaptchaenterprise_v1.types.TransactionData
Optional. Data describing a payment transaction to be assessed. Sending this data enables reCAPTCHA Enterprise Fraud Prevention and the FraudPreventionAssessment component in the response.
user_info google.cloud.recaptchaenterprise_v1.types.UserInfo
Optional. Information about the user that generates this event, when they can be identified. They are often identified through the use of an account for logged-in requests or login/registration requests, or by providing user identifiers for guest actions like checkout.
fraud_prevention google.cloud.recaptchaenterprise_v1.types.Event.FraudPrevention
Optional. The Fraud Prevention setting for this assessment.

Classes

FraudPrevention

FraudPrevention(value)

Setting that controls Fraud Prevention assessments.

Values: FRAUD_PREVENTION_UNSPECIFIED (0): Default, unspecified setting. If opted in for automatic detection, fraud_prevention_assessment is returned based on the request. Otherwise, fraud_prevention_assessment is returned if transaction_data is present in the Event and Fraud Prevention is enabled in the Google Cloud console. ENABLED (1): Enable Fraud Prevention for this assessment, if Fraud Prevention is enabled in the Google Cloud console. DISABLED (2): Disable Fraud Prevention for this assessment, regardless of opt-in status or Google Cloud console settings.