Class: Google::Cloud::RecaptchaEnterprise::V1beta1::Assessment

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

Overview

A reCAPTCHA Enterprise assessment resource.

Defined Under Namespace

Modules: ClassificationReason

Instance Attribute Summary collapse

Instance Attribute Details

#account_defender_assessment ⇒ ::Google::Cloud::RecaptchaEnterprise::V1beta1::AccountDefenderAssessment

Returns Assessment returned by account defender when a hashed_account_id is provided.

Returns:



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.rb', line 331

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

  # Reasons contributing to the risk analysis verdict.
  module ClassificationReason
    # Default unspecified type.
    CLASSIFICATION_REASON_UNSPECIFIED = 0

    # Interactions matched the behavior of an automated agent.
    AUTOMATION = 1

    # The event originated from an illegitimate environment.
    UNEXPECTED_ENVIRONMENT = 2

    # Traffic volume from the event source is higher than normal.
    TOO_MUCH_TRAFFIC = 3

    # Interactions with the site were significantly different than expected
    # patterns.
    UNEXPECTED_USAGE_PATTERNS = 4

    # Too little traffic has been received from this site thus far to generate
    # quality risk analysis.
    LOW_CONFIDENCE_SCORE = 5

    # The request matches behavioral characteristics of a carding attack.
    SUSPECTED_CARDING = 6

    # The request matches behavioral characteristics of chargebacks for fraud.
    SUSPECTED_CHARGEBACK = 7
  end
end

#event ⇒ ::Google::Cloud::RecaptchaEnterprise::V1beta1::Event

Returns The event being assessed.

Returns:



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.rb', line 331

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

  # Reasons contributing to the risk analysis verdict.
  module ClassificationReason
    # Default unspecified type.
    CLASSIFICATION_REASON_UNSPECIFIED = 0

    # Interactions matched the behavior of an automated agent.
    AUTOMATION = 1

    # The event originated from an illegitimate environment.
    UNEXPECTED_ENVIRONMENT = 2

    # Traffic volume from the event source is higher than normal.
    TOO_MUCH_TRAFFIC = 3

    # Interactions with the site were significantly different than expected
    # patterns.
    UNEXPECTED_USAGE_PATTERNS = 4

    # Too little traffic has been received from this site thus far to generate
    # quality risk analysis.
    LOW_CONFIDENCE_SCORE = 5

    # The request matches behavioral characteristics of a carding attack.
    SUSPECTED_CARDING = 6

    # The request matches behavioral characteristics of chargebacks for fraud.
    SUSPECTED_CHARGEBACK = 7
  end
end

#fraud_prevention_assessment ⇒ ::Google::Cloud::RecaptchaEnterprise::V1beta1::FraudPreventionAssessment

Returns Assessment returned by Fraud Prevention when TransactionData is provided.

Returns:



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.rb', line 331

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

  # Reasons contributing to the risk analysis verdict.
  module ClassificationReason
    # Default unspecified type.
    CLASSIFICATION_REASON_UNSPECIFIED = 0

    # Interactions matched the behavior of an automated agent.
    AUTOMATION = 1

    # The event originated from an illegitimate environment.
    UNEXPECTED_ENVIRONMENT = 2

    # Traffic volume from the event source is higher than normal.
    TOO_MUCH_TRAFFIC = 3

    # Interactions with the site were significantly different than expected
    # patterns.
    UNEXPECTED_USAGE_PATTERNS = 4

    # Too little traffic has been received from this site thus far to generate
    # quality risk analysis.
    LOW_CONFIDENCE_SCORE = 5

    # The request matches behavioral characteristics of a carding attack.
    SUSPECTED_CARDING = 6

    # The request matches behavioral characteristics of chargebacks for fraud.
    SUSPECTED_CHARGEBACK = 7
  end
end

#name ⇒ ::String (readonly)

Returns Output only. The resource name for the Assessment in the format projects/{project_number}/assessments/{assessment_id}.

Returns:

  • (::String) —

    Output only. The resource name for the Assessment in the format projects/{project_number}/assessments/{assessment_id}.



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.rb', line 331

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

  # Reasons contributing to the risk analysis verdict.
  module ClassificationReason
    # Default unspecified type.
    CLASSIFICATION_REASON_UNSPECIFIED = 0

    # Interactions matched the behavior of an automated agent.
    AUTOMATION = 1

    # The event originated from an illegitimate environment.
    UNEXPECTED_ENVIRONMENT = 2

    # Traffic volume from the event source is higher than normal.
    TOO_MUCH_TRAFFIC = 3

    # Interactions with the site were significantly different than expected
    # patterns.
    UNEXPECTED_USAGE_PATTERNS = 4

    # Too little traffic has been received from this site thus far to generate
    # quality risk analysis.
    LOW_CONFIDENCE_SCORE = 5

    # The request matches behavioral characteristics of a carding attack.
    SUSPECTED_CARDING = 6

    # The request matches behavioral characteristics of chargebacks for fraud.
    SUSPECTED_CHARGEBACK = 7
  end
end

#password_leak_verification ⇒ ::Google::Cloud::RecaptchaEnterprise::V1beta1::PasswordLeakVerification

Returns Information about the user's credentials used to check for leaks. This feature is part of the Early Access Program (EAP). Exercise caution, and do not deploy integrations based on this feature in a production environment.

Returns:



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.rb', line 331

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

  # Reasons contributing to the risk analysis verdict.
  module ClassificationReason
    # Default unspecified type.
    CLASSIFICATION_REASON_UNSPECIFIED = 0

    # Interactions matched the behavior of an automated agent.
    AUTOMATION = 1

    # The event originated from an illegitimate environment.
    UNEXPECTED_ENVIRONMENT = 2

    # Traffic volume from the event source is higher than normal.
    TOO_MUCH_TRAFFIC = 3

    # Interactions with the site were significantly different than expected
    # patterns.
    UNEXPECTED_USAGE_PATTERNS = 4

    # Too little traffic has been received from this site thus far to generate
    # quality risk analysis.
    LOW_CONFIDENCE_SCORE = 5

    # The request matches behavioral characteristics of a carding attack.
    SUSPECTED_CARDING = 6

    # The request matches behavioral characteristics of chargebacks for fraud.
    SUSPECTED_CHARGEBACK = 7
  end
end

#reasons ⇒ ::Array<::Google::Cloud::RecaptchaEnterprise::V1beta1::Assessment::ClassificationReason> (readonly)

Returns Output only. Reasons contributing to the risk analysis verdict.

Returns:



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.rb', line 331

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

  # Reasons contributing to the risk analysis verdict.
  module ClassificationReason
    # Default unspecified type.
    CLASSIFICATION_REASON_UNSPECIFIED = 0

    # Interactions matched the behavior of an automated agent.
    AUTOMATION = 1

    # The event originated from an illegitimate environment.
    UNEXPECTED_ENVIRONMENT = 2

    # Traffic volume from the event source is higher than normal.
    TOO_MUCH_TRAFFIC = 3

    # Interactions with the site were significantly different than expected
    # patterns.
    UNEXPECTED_USAGE_PATTERNS = 4

    # Too little traffic has been received from this site thus far to generate
    # quality risk analysis.
    LOW_CONFIDENCE_SCORE = 5

    # The request matches behavioral characteristics of a carding attack.
    SUSPECTED_CARDING = 6

    # The request matches behavioral characteristics of chargebacks for fraud.
    SUSPECTED_CHARGEBACK = 7
  end
end

#score ⇒ ::Float (readonly)

Returns Output only. Legitimate event score from 0.0 to 1.0. (1.0 means very likely legitimate traffic while 0.0 means very likely non-legitimate traffic).

Returns:

  • (::Float) —

    Output only. Legitimate event score from 0.0 to 1.0. (1.0 means very likely legitimate traffic while 0.0 means very likely non-legitimate traffic).



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.rb', line 331

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

  # Reasons contributing to the risk analysis verdict.
  module ClassificationReason
    # Default unspecified type.
    CLASSIFICATION_REASON_UNSPECIFIED = 0

    # Interactions matched the behavior of an automated agent.
    AUTOMATION = 1

    # The event originated from an illegitimate environment.
    UNEXPECTED_ENVIRONMENT = 2

    # Traffic volume from the event source is higher than normal.
    TOO_MUCH_TRAFFIC = 3

    # Interactions with the site were significantly different than expected
    # patterns.
    UNEXPECTED_USAGE_PATTERNS = 4

    # Too little traffic has been received from this site thus far to generate
    # quality risk analysis.
    LOW_CONFIDENCE_SCORE = 5

    # The request matches behavioral characteristics of a carding attack.
    SUSPECTED_CARDING = 6

    # The request matches behavioral characteristics of chargebacks for fraud.
    SUSPECTED_CHARGEBACK = 7
  end
end

#token_properties ⇒ ::Google::Cloud::RecaptchaEnterprise::V1beta1::TokenProperties (readonly)

Returns Output only. Properties of the provided event token.

Returns:



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.rb', line 331

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

  # Reasons contributing to the risk analysis verdict.
  module ClassificationReason
    # Default unspecified type.
    CLASSIFICATION_REASON_UNSPECIFIED = 0

    # Interactions matched the behavior of an automated agent.
    AUTOMATION = 1

    # The event originated from an illegitimate environment.
    UNEXPECTED_ENVIRONMENT = 2

    # Traffic volume from the event source is higher than normal.
    TOO_MUCH_TRAFFIC = 3

    # Interactions with the site were significantly different than expected
    # patterns.
    UNEXPECTED_USAGE_PATTERNS = 4

    # Too little traffic has been received from this site thus far to generate
    # quality risk analysis.
    LOW_CONFIDENCE_SCORE = 5

    # The request matches behavioral characteristics of a carding attack.
    SUSPECTED_CARDING = 6

    # The request matches behavioral characteristics of chargebacks for fraud.
    SUSPECTED_CHARGEBACK = 7
  end
end