Reference documentation and code samples for the Google Cloud Recaptcha Enterprise V1 Client class Event.
The event being assessed.
Generated from protobuf message google.cloud.recaptchaenterprise.v1.Event
Namespace
Google \ Cloud \ RecaptchaEnterprise \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ token
string
Optional. The user response token provided by the reCAPTCHA Enterprise client-side integration on your site.
↳ site_key
string
Optional. The site key that was used to invoke reCAPTCHA Enterprise on your site and generate the token.
↳ user_agent
string
Optional. The user agent present in the request from the user's device related to this event.
↳ user_ip_address
string
Optional. The IP address in the request from the user's device related to this event.
↳ expected_action
string
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
string
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 an Express site key.
↳ requested_uri
string
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
string
Optional. JA3 fingerprint for SSL clients. To learn how to compute this fingerprint, please refer to https://github.com/salesforce/ja3 .
↳ ja4
string
Optional. JA4 fingerprint for SSL clients. To learn how to compute this fingerprint, please refer to https://github.com/FoxIO-LLC/ja4 .
↳ headers
array
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 is evaluated and a suggested firewall action is returned in the response.
↳ transaction_data
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
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
int
Optional. The Fraud Prevention setting for this assessment.
getToken
Optional. The user response token provided by the reCAPTCHA Enterprise client-side integration on your site.
string
setToken
Optional. The user response token provided by the reCAPTCHA Enterprise client-side integration on your site.
var
string
$this
getSiteKey
Optional. The site key that was used to invoke reCAPTCHA Enterprise on your site and generate the token.
string
setSiteKey
Optional. The site key that was used to invoke reCAPTCHA Enterprise on your site and generate the token.
var
string
$this
getUserAgent
Optional. The user agent present in the request from the user's device related to this event.
string
setUserAgent
Optional. The user agent present in the request from the user's device related to this event.
var
string
$this
getUserIpAddress
Optional. The IP address in the request from the user's device related to this event.
string
setUserIpAddress
Optional. The IP address in the request from the user's device related to this event.
var
string
$this
getExpectedAction
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.
string
setExpectedAction
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.
var
string
$this
getHashedAccountId
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.
string
setHashedAccountId
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.
var
string
$this
getExpress
Optional. Flag for a reCAPTCHA express request for an assessment without a
token. If enabled, site_key
must reference an Express site key.
bool
setExpress
Optional. Flag for a reCAPTCHA express request for an assessment without a
token. If enabled, site_key
must reference an Express site key.
var
bool
$this
getRequestedUri
Optional. The URI resource the user requested that triggered an assessment.
string
setRequestedUri
Optional. The URI resource the user requested that triggered an assessment.
var
string
$this
getWafTokenAssessment
Optional. Flag for running WAF token assessment.
If enabled, the token must be specified, and have been created by a WAF-enabled key.
bool
setWafTokenAssessment
Optional. Flag for running WAF token assessment.
If enabled, the token must be specified, and have been created by a WAF-enabled key.
var
bool
$this
getJa3
Optional. JA3 fingerprint for SSL clients. To learn how to compute this fingerprint, please refer to https://github.com/salesforce/ja3 .
string
setJa3
Optional. JA3 fingerprint for SSL clients. To learn how to compute this fingerprint, please refer to https://github.com/salesforce/ja3 .
var
string
$this
getJa4
Optional. JA4 fingerprint for SSL clients. To learn how to compute this fingerprint, please refer to https://github.com/FoxIO-LLC/ja4 .
string
setJa4
Optional. JA4 fingerprint for SSL clients. To learn how to compute this fingerprint, please refer to https://github.com/FoxIO-LLC/ja4 .
var
string
$this
getHeaders
Optional. HTTP header information about the request.
setHeaders
Optional. HTTP header information about the request.
var
string[]
$this
getFirewallPolicyEvaluation
Optional. Flag for enabling firewall policy config assessment.
If this flag is enabled, the firewall policy is evaluated and a suggested firewall action is returned in the response.
bool
setFirewallPolicyEvaluation
Optional. Flag for enabling firewall policy config assessment.
If this flag is enabled, the firewall policy is evaluated and a suggested firewall action is returned in the response.
var
bool
$this
getTransactionData
Optional. Data describing a payment transaction to be assessed. Sending this data enables reCAPTCHA Enterprise Fraud Prevention and the FraudPreventionAssessment component in the response.
hasTransactionData
clearTransactionData
setTransactionData
Optional. Data describing a payment transaction to be assessed. Sending this data enables reCAPTCHA Enterprise Fraud Prevention and the FraudPreventionAssessment component in the response.
$this
getUserInfo
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.
hasUserInfo
clearUserInfo
setUserInfo
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.
$this
getFraudPrevention
Optional. The Fraud Prevention setting for this assessment.
int
setFraudPrevention
Optional. The Fraud Prevention setting for this assessment.
var
int
$this
