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 If set to true, it means allowed_domains will not be enforced.

Returns:

  • (::Boolean) —

    If set to true, it means allowed_domains will not be enforced.



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 341

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 Required. Whether this key can be used on AMP (Accelerated Mobile Pages) websites.

Returns:

  • (::Boolean) —

    Required. Whether this key can be used on AMP (Accelerated Mobile Pages) websites.



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 341

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 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>) —

    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'



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 341

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 Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE.

Returns:



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 341

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:



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 341

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