Class: Google::Cloud::RecaptchaEnterprise::V1::WebKeySettings

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

Overview

Settings specific to keys that can be used by websites.

Defined Under Namespace

Modules: ChallengeSecurityPreference, IntegrationType

Instance Attribute Summary collapse

Instance Attribute Details

#allow_all_domains ⇒ ::Boolean

Returns Optional. If set to true, it means allowed_domains are not enforced.

Returns:

  • (::Boolean) —

    Optional. If set to true, it means allowed_domains are not enforced.



1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 1379

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

  # Enum that represents the integration types for web keys.
  module IntegrationType
    # Default type that indicates this enum hasn't been specified. This is not
    # a valid IntegrationType, one of the other types must be specified
    # instead.
    INTEGRATION_TYPE_UNSPECIFIED = 0

    # Only used to produce scores. It doesn't display the "I'm not a robot"
    # checkbox and never shows captcha challenges.
    SCORE = 1

    # Displays the "I'm not a robot" checkbox and may show captcha challenges
    # after it is checked.
    CHECKBOX = 2

    # Doesn't display the "I'm not a robot" checkbox, but may show captcha
    # challenges after risk analysis.
    INVISIBLE = 3
  end

  # Enum that represents the possible challenge frequency and difficulty
  # configurations for a web key.
  module ChallengeSecurityPreference
    # Default type that indicates this enum hasn't been specified.
    CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED = 0

    # Key tends to show fewer and easier challenges.
    USABILITY = 1

    # Key tends to show balanced (in amount and difficulty) challenges.
    BALANCE = 2

    # Key tends to show more and harder challenges.
    SECURITY = 3
  end
end

#allow_amp_traffic ⇒ ::Boolean

Returns Optional. If set to true, the key can be used on AMP (Accelerated Mobile Pages) websites. This is supported only for the SCORE integration type.

Returns:

  • (::Boolean) —

    Optional. If set to true, the key can be used on AMP (Accelerated Mobile Pages) websites. This is supported only for the SCORE integration type.



1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 1379

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

  # Enum that represents the integration types for web keys.
  module IntegrationType
    # Default type that indicates this enum hasn't been specified. This is not
    # a valid IntegrationType, one of the other types must be specified
    # instead.
    INTEGRATION_TYPE_UNSPECIFIED = 0

    # Only used to produce scores. It doesn't display the "I'm not a robot"
    # checkbox and never shows captcha challenges.
    SCORE = 1

    # Displays the "I'm not a robot" checkbox and may show captcha challenges
    # after it is checked.
    CHECKBOX = 2

    # Doesn't display the "I'm not a robot" checkbox, but may show captcha
    # challenges after risk analysis.
    INVISIBLE = 3
  end

  # Enum that represents the possible challenge frequency and difficulty
  # configurations for a web key.
  module ChallengeSecurityPreference
    # Default type that indicates this enum hasn't been specified.
    CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED = 0

    # Key tends to show fewer and easier challenges.
    USABILITY = 1

    # Key tends to show balanced (in amount and difficulty) challenges.
    BALANCE = 2

    # Key tends to show more and harder challenges.
    SECURITY = 3
  end
end

#allowed_domains ⇒ ::Array<::String>

Returns Optional. Domains or subdomains of websites allowed to use the key. All subdomains of an allowed domain are automatically allowed. A valid domain requires a host and must not include any path, port, query or fragment. Examples: 'example.com' or 'subdomain.example.com'.

Returns:

  • (::Array<::String>) —

    Optional. Domains or subdomains of websites allowed to use the key. All subdomains of an allowed domain are automatically allowed. A valid domain requires a host and must not include any path, port, query or fragment. Examples: 'example.com' or 'subdomain.example.com'



1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 1379

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

  # Enum that represents the integration types for web keys.
  module IntegrationType
    # Default type that indicates this enum hasn't been specified. This is not
    # a valid IntegrationType, one of the other types must be specified
    # instead.
    INTEGRATION_TYPE_UNSPECIFIED = 0

    # Only used to produce scores. It doesn't display the "I'm not a robot"
    # checkbox and never shows captcha challenges.
    SCORE = 1

    # Displays the "I'm not a robot" checkbox and may show captcha challenges
    # after it is checked.
    CHECKBOX = 2

    # Doesn't display the "I'm not a robot" checkbox, but may show captcha
    # challenges after risk analysis.
    INVISIBLE = 3
  end

  # Enum that represents the possible challenge frequency and difficulty
  # configurations for a web key.
  module ChallengeSecurityPreference
    # Default type that indicates this enum hasn't been specified.
    CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED = 0

    # Key tends to show fewer and easier challenges.
    USABILITY = 1

    # Key tends to show balanced (in amount and difficulty) challenges.
    BALANCE = 2

    # Key tends to show more and harder challenges.
    SECURITY = 3
  end
end

#challenge_security_preference ⇒ ::Google::Cloud::RecaptchaEnterprise::V1::WebKeySettings::ChallengeSecurityPreference

Returns Optional. Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE and SCORE_AND_CHALLENGE.

Returns:



1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 1379

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

  # Enum that represents the integration types for web keys.
  module IntegrationType
    # Default type that indicates this enum hasn't been specified. This is not
    # a valid IntegrationType, one of the other types must be specified
    # instead.
    INTEGRATION_TYPE_UNSPECIFIED = 0

    # Only used to produce scores. It doesn't display the "I'm not a robot"
    # checkbox and never shows captcha challenges.
    SCORE = 1

    # Displays the "I'm not a robot" checkbox and may show captcha challenges
    # after it is checked.
    CHECKBOX = 2

    # Doesn't display the "I'm not a robot" checkbox, but may show captcha
    # challenges after risk analysis.
    INVISIBLE = 3
  end

  # Enum that represents the possible challenge frequency and difficulty
  # configurations for a web key.
  module ChallengeSecurityPreference
    # Default type that indicates this enum hasn't been specified.
    CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED = 0

    # Key tends to show fewer and easier challenges.
    USABILITY = 1

    # Key tends to show balanced (in amount and difficulty) challenges.
    BALANCE = 2

    # Key tends to show more and harder challenges.
    SECURITY = 3
  end
end

#integration_type ⇒ ::Google::Cloud::RecaptchaEnterprise::V1::WebKeySettings::IntegrationType

Returns Required. Describes how this key is integrated with the website.

Returns:



1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 1379

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

  # Enum that represents the integration types for web keys.
  module IntegrationType
    # Default type that indicates this enum hasn't been specified. This is not
    # a valid IntegrationType, one of the other types must be specified
    # instead.
    INTEGRATION_TYPE_UNSPECIFIED = 0

    # Only used to produce scores. It doesn't display the "I'm not a robot"
    # checkbox and never shows captcha challenges.
    SCORE = 1

    # Displays the "I'm not a robot" checkbox and may show captcha challenges
    # after it is checked.
    CHECKBOX = 2

    # Doesn't display the "I'm not a robot" checkbox, but may show captcha
    # challenges after risk analysis.
    INVISIBLE = 3
  end

  # Enum that represents the possible challenge frequency and difficulty
  # configurations for a web key.
  module ChallengeSecurityPreference
    # Default type that indicates this enum hasn't been specified.
    CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED = 0

    # Key tends to show fewer and easier challenges.
    USABILITY = 1

    # Key tends to show balanced (in amount and difficulty) challenges.
    BALANCE = 2

    # Key tends to show more and harder challenges.
    SECURITY = 3
  end
end