Google Cloud reCAPTCHA Enterprise v1 API - Class Event (2.9.0)

public sealed class Event : IMessage<Event>, IEquatable<Event>, IDeepCloneable<Event>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud reCAPTCHA Enterprise v1 API class Event.

The event being assessed.

Inheritance

object > Event

Namespace

Google.Cloud.RecaptchaEnterprise.V1

Assembly

Google.Cloud.RecaptchaEnterprise.V1.dll

Constructors

Event()

public Event()

Event(Event)

public Event(Event other)
Parameter
NameDescription
otherEvent

Properties

ExpectedAction

public string ExpectedAction { get; set; }

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.

Property Value
TypeDescription
string

Express

public bool Express { get; set; }

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.

Property Value
TypeDescription
bool

FirewallPolicyEvaluation

public bool FirewallPolicyEvaluation { get; set; }

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.

Property Value
TypeDescription
bool

HashedAccountId

[Obsolete]
public ByteString HashedAccountId { get; set; }

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.

Property Value
TypeDescription
ByteString

Headers

public RepeatedField<string> Headers { get; }

Optional. HTTP header information about the request.

Property Value
TypeDescription
RepeatedFieldstring

Ja3

public string Ja3 { get; set; }

Optional. JA3 fingerprint for SSL clients.

Property Value
TypeDescription
string

RequestedUri

public string RequestedUri { get; set; }

Optional. The URI resource the user requested that triggered an assessment.

Property Value
TypeDescription
string

SiteKey

public string SiteKey { get; set; }

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

Property Value
TypeDescription
string

Token

public string Token { get; set; }

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

Property Value
TypeDescription
string

TransactionData

public TransactionData TransactionData { get; set; }

Optional. Data describing a payment transaction to be assessed. Sending this data enables reCAPTCHA Enterprise Fraud Prevention and the FraudPreventionAssessment component in the response.

Property Value
TypeDescription
TransactionData

UserAgent

public string UserAgent { get; set; }

Optional. The user agent present in the request from the user's device related to this event.

Property Value
TypeDescription
string

UserInfo

public UserInfo UserInfo { get; set; }

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.

Property Value
TypeDescription
UserInfo

UserIpAddress

public string UserIpAddress { get; set; }

Optional. The IP address in the request from the user's device related to this event.

Property Value
TypeDescription
string

WafTokenAssessment

public bool WafTokenAssessment { get; set; }

Optional. Flag for running WAF token assessment. If enabled, the token must be specified, and have been created by a WAF-enabled key.

Property Value
TypeDescription
bool