WebKeySettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)Settings specific to keys that can be used by websites.
Attributes | |
|---|---|
| Name | Description |
allow_all_domains |
bool
Optional. If set to true, it means allowed_domains will not be enforced. |
allowed_domains |
MutableSequence[str]
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' |
allow_amp_traffic |
bool
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. |
integration_type |
google.cloud.recaptchaenterprise_v1.types.WebKeySettings.IntegrationType
Required. Describes how this key is integrated with the website. |
challenge_security_preference |
google.cloud.recaptchaenterprise_v1.types.WebKeySettings.ChallengeSecurityPreference
Optional. Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE. |
Classes
ChallengeSecurityPreference
ChallengeSecurityPreference(value)Enum that represents the possible challenge frequency and difficulty configurations for a web key.
Values: CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED (0): Default type that indicates this enum hasn't been specified. USABILITY (1): Key tends to show fewer and easier challenges. BALANCE (2): Key tends to show balanced (in amount and difficulty) challenges. SECURITY (3): Key tends to show more and harder challenges.
IntegrationType
IntegrationType(value)Enum that represents the integration types for web keys.
Values: INTEGRATION_TYPE_UNSPECIFIED (0): 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. SCORE (1): Only used to produce scores. It doesn't display the "I'm not a robot" checkbox and never shows captcha challenges. CHECKBOX (2): Displays the "I'm not a robot" checkbox and may show captcha challenges after it is checked. INVISIBLE (3): Doesn't display the "I'm not a robot" checkbox, but may show captcha challenges after risk analysis.