reCAPTCHA Enterprise V1 API - Class Google::Cloud::RecaptchaEnterprise::V1::WebKeySettings (v1.11.0)

Reference documentation and code samples for the reCAPTCHA Enterprise V1 API class Google::Cloud::RecaptchaEnterprise::V1::WebKeySettings.

Settings specific to keys that can be used by websites.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#allow_all_domains

def allow_all_domains() -> ::Boolean
Returns
  • (::Boolean) — Optional. If set to true, it means allowed_domains are not enforced.

#allow_all_domains=

def allow_all_domains=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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.

#allow_amp_traffic

def allow_amp_traffic() -> ::Boolean
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.

#allow_amp_traffic=

def allow_amp_traffic=(value) -> ::Boolean
Parameter
  • value (::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.
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.

#allowed_domains

def allowed_domains() -> ::Array<::String>
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' Each key supports a maximum of 250 domains. To use a key on more domains, set allow_all_domains to true. When this is set, you are responsible for validating the hostname by checking the token_properties.hostname field in each assessment response against your list of allowed domains.

#allowed_domains=

def allowed_domains=(value) -> ::Array<::String>
Parameter
  • value (::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' Each key supports a maximum of 250 domains. To use a key on more domains, set allow_all_domains to true. When this is set, you are responsible for validating the hostname by checking the token_properties.hostname field in each assessment response against your list of allowed domains.
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' Each key supports a maximum of 250 domains. To use a key on more domains, set allow_all_domains to true. When this is set, you are responsible for validating the hostname by checking the token_properties.hostname field in each assessment response against your list of allowed domains.

#challenge_security_preference

def challenge_security_preference() -> ::Google::Cloud::RecaptchaEnterprise::V1::WebKeySettings::ChallengeSecurityPreference
Returns

#challenge_security_preference=

def challenge_security_preference=(value) -> ::Google::Cloud::RecaptchaEnterprise::V1::WebKeySettings::ChallengeSecurityPreference
Parameter
Returns

#challenge_settings

def challenge_settings() -> ::Google::Cloud::RecaptchaEnterprise::V1::WebKeySettings::ChallengeSettings
Returns

#challenge_settings=

def challenge_settings=(value) -> ::Google::Cloud::RecaptchaEnterprise::V1::WebKeySettings::ChallengeSettings
Parameter
Returns

#integration_type

def integration_type() -> ::Google::Cloud::RecaptchaEnterprise::V1::WebKeySettings::IntegrationType
Returns

#integration_type=

def integration_type=(value) -> ::Google::Cloud::RecaptchaEnterprise::V1::WebKeySettings::IntegrationType
Parameter
Returns