Reference documentation and code samples for the Google Cloud Recaptcha Enterprise V1 Client class WebKeySettings.
Settings specific to keys that can be used by websites.
Generated from protobuf message google.cloud.recaptchaenterprise.v1.WebKeySettings
Namespace
Google \ Cloud \ RecaptchaEnterprise \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ allow_all_domains
bool
Optional. If set to true, it means allowed_domains will not be enforced.
↳ allowed_domains
array
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
int
Required. Describes how this key is integrated with the website.
↳ challenge_security_preference
int
Optional. Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE.
getAllowAllDomains
Optional. If set to true, it means allowed_domains will not be enforced.
bool
setAllowAllDomains
Optional. If set to true, it means allowed_domains will not be enforced.
var
bool
$this
getAllowedDomains
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'
setAllowedDomains
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'
var
string[]
$this
getAllowAmpTraffic
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.
bool
setAllowAmpTraffic
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.
var
bool
$this
getIntegrationType
Required. Describes how this key is integrated with the website.
int
setIntegrationType
Required. Describes how this key is integrated with the website.
var
int
$this
getChallengeSecurityPreference
Optional. Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE.
int
setChallengeSecurityPreference
Optional. Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE.
var
int
$this