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. Unique stable hashed user identifier for the request. The identifier must be hashed using hmac-sha256 with stable secret.
↳ transaction_data
Google\Cloud\RecaptchaEnterprise\V1\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.
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. Unique stable hashed user identifier for the request. The identifier must be hashed using hmac-sha256 with stable secret.
string
setHashedAccountId
Optional. Unique stable hashed user identifier for the request. The identifier must be hashed using hmac-sha256 with stable secret.
var
string
$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
