Class: Google::Cloud::RecaptchaEnterprise::V1beta1::Event

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.rb

Defined Under Namespace

Modules: FraudPrevention

Instance Attribute Summary collapse

Instance Attribute Details

#expected_action ⇒ ::String

Returns 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.

Returns:

  • (::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.



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.rb', line 398

class Event
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Setting that controls Fraud Prevention assessments.
  module FraudPrevention
    # 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.
    FRAUD_PREVENTION_UNSPECIFIED = 0

    # Enable Fraud Prevention for this assessment, if Fraud Prevention is
    # enabled in the Google Cloud console.
    ENABLED = 1

    # Disable Fraud Prevention for this assessment, regardless of opt-in
    # status or the Google Cloud console settings.
    DISABLED = 2
  end
end

#fraud_prevention ⇒ ::Google::Cloud::RecaptchaEnterprise::V1beta1::Event::FraudPrevention

Returns Optional. The Fraud Prevention setting for this Assessment.

Returns:



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.rb', line 398

class Event
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Setting that controls Fraud Prevention assessments.
  module FraudPrevention
    # 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.
    FRAUD_PREVENTION_UNSPECIFIED = 0

    # Enable Fraud Prevention for this assessment, if Fraud Prevention is
    # enabled in the Google Cloud console.
    ENABLED = 1

    # Disable Fraud Prevention for this assessment, regardless of opt-in
    # status or the Google Cloud console settings.
    DISABLED = 2
  end
end

#hashed_account_id ⇒ ::String

Returns Optional. Unique stable hashed user identifier for the request. The identifier must be hashed using hmac-sha256 with stable secret.

Returns:

  • (::String) —

    Optional. Unique stable hashed user identifier for the request. The identifier must be hashed using hmac-sha256 with stable secret.



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.rb', line 398

class Event
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Setting that controls Fraud Prevention assessments.
  module FraudPrevention
    # 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.
    FRAUD_PREVENTION_UNSPECIFIED = 0

    # Enable Fraud Prevention for this assessment, if Fraud Prevention is
    # enabled in the Google Cloud console.
    ENABLED = 1

    # Disable Fraud Prevention for this assessment, regardless of opt-in
    # status or the Google Cloud console settings.
    DISABLED = 2
  end
end

#site_key ⇒ ::String

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

Returns:

  • (::String) —

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



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.rb', line 398

class Event
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Setting that controls Fraud Prevention assessments.
  module FraudPrevention
    # 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.
    FRAUD_PREVENTION_UNSPECIFIED = 0

    # Enable Fraud Prevention for this assessment, if Fraud Prevention is
    # enabled in the Google Cloud console.
    ENABLED = 1

    # Disable Fraud Prevention for this assessment, regardless of opt-in
    # status or the Google Cloud console settings.
    DISABLED = 2
  end
end

#token ⇒ ::String

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

Returns:

  • (::String) —

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



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.rb', line 398

class Event
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Setting that controls Fraud Prevention assessments.
  module FraudPrevention
    # 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.
    FRAUD_PREVENTION_UNSPECIFIED = 0

    # Enable Fraud Prevention for this assessment, if Fraud Prevention is
    # enabled in the Google Cloud console.
    ENABLED = 1

    # Disable Fraud Prevention for this assessment, regardless of opt-in
    # status or the Google Cloud console settings.
    DISABLED = 2
  end
end

#transaction_data ⇒ ::Google::Cloud::RecaptchaEnterprise::V1beta1::TransactionData

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

Returns:



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.rb', line 398

class Event
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Setting that controls Fraud Prevention assessments.
  module FraudPrevention
    # 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.
    FRAUD_PREVENTION_UNSPECIFIED = 0

    # Enable Fraud Prevention for this assessment, if Fraud Prevention is
    # enabled in the Google Cloud console.
    ENABLED = 1

    # Disable Fraud Prevention for this assessment, regardless of opt-in
    # status or the Google Cloud console settings.
    DISABLED = 2
  end
end

#user_agent ⇒ ::String

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

Returns:

  • (::String) —

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



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.rb', line 398

class Event
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Setting that controls Fraud Prevention assessments.
  module FraudPrevention
    # 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.
    FRAUD_PREVENTION_UNSPECIFIED = 0

    # Enable Fraud Prevention for this assessment, if Fraud Prevention is
    # enabled in the Google Cloud console.
    ENABLED = 1

    # Disable Fraud Prevention for this assessment, regardless of opt-in
    # status or the Google Cloud console settings.
    DISABLED = 2
  end
end

#user_ip_address ⇒ ::String

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

Returns:

  • (::String) —

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



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.rb', line 398

class Event
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Setting that controls Fraud Prevention assessments.
  module FraudPrevention
    # 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.
    FRAUD_PREVENTION_UNSPECIFIED = 0

    # Enable Fraud Prevention for this assessment, if Fraud Prevention is
    # enabled in the Google Cloud console.
    ENABLED = 1

    # Disable Fraud Prevention for this assessment, regardless of opt-in
    # status or the Google Cloud console settings.
    DISABLED = 2
  end
end