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 messagegoogle.cloud.recaptchaenterprise.v1.WebKeySettings
Namespace
Google \ Cloud \ RecaptchaEnterprise \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ allow_all_domains
bool
Optional. If set to true, it means allowed_domains are not 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 and SCORE_AND_CHALLENGE.
getAllowAllDomains
Optional. If set to true, it means allowed_domains are not enforced.
Returns
Type
Description
bool
setAllowAllDomains
Optional. If set to true, it means allowed_domains are not enforced.
Parameter
Name
Description
var
bool
Returns
Type
Description
$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'
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'
Parameter
Name
Description
var
string[]
Returns
Type
Description
$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.
Returns
Type
Description
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.
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
getIntegrationType
Required. Describes how this key is integrated with the website.
Returns
Type
Description
int
setIntegrationType
Required. Describes how this key is integrated with the website.
Parameter
Name
Description
var
int
Returns
Type
Description
$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 and SCORE_AND_CHALLENGE.
Returns
Type
Description
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 and SCORE_AND_CHALLENGE.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Recaptcha Enterprise V1 Client - Class WebKeySettings (2.1.3)\n\nVersion latestkeyboard_arrow_down\n\n- [2.1.3 (latest)](/php/docs/reference/cloud-recaptcha-enterprise/latest/V1.WebKeySettings)\n- [2.1.2](/php/docs/reference/cloud-recaptcha-enterprise/2.1.2/V1.WebKeySettings)\n- [2.0.1](/php/docs/reference/cloud-recaptcha-enterprise/2.0.1/V1.WebKeySettings)\n- [1.17.2](/php/docs/reference/cloud-recaptcha-enterprise/1.17.2/V1.WebKeySettings)\n- [1.16.1](/php/docs/reference/cloud-recaptcha-enterprise/1.16.1/V1.WebKeySettings)\n- [1.15.0](/php/docs/reference/cloud-recaptcha-enterprise/1.15.0/V1.WebKeySettings)\n- [1.14.0](/php/docs/reference/cloud-recaptcha-enterprise/1.14.0/V1.WebKeySettings)\n- [1.13.0](/php/docs/reference/cloud-recaptcha-enterprise/1.13.0/V1.WebKeySettings)\n- [1.12.2](/php/docs/reference/cloud-recaptcha-enterprise/1.12.2/V1.WebKeySettings)\n- [1.8.0](/php/docs/reference/cloud-recaptcha-enterprise/1.8.0/V1.WebKeySettings)\n- [1.7.0](/php/docs/reference/cloud-recaptcha-enterprise/1.7.0/V1.WebKeySettings)\n- [1.6.0](/php/docs/reference/cloud-recaptcha-enterprise/1.6.0/V1.WebKeySettings)\n- [1.5.2](/php/docs/reference/cloud-recaptcha-enterprise/1.5.2/V1.WebKeySettings)\n- [1.4.2](/php/docs/reference/cloud-recaptcha-enterprise/1.4.2/V1.WebKeySettings)\n- [1.3.2](/php/docs/reference/cloud-recaptcha-enterprise/1.3.2/V1.WebKeySettings)\n- [1.2.6](/php/docs/reference/cloud-recaptcha-enterprise/1.2.6/V1.WebKeySettings) \nReference documentation and code samples for the Google Cloud Recaptcha Enterprise V1 Client class WebKeySettings.\n\nSettings specific to keys that can be used by websites.\n\nGenerated from protobuf message `google.cloud.recaptchaenterprise.v1.WebKeySettings`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ RecaptchaEnterprise \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getAllowAllDomains\n\nOptional. If set to true, it means allowed_domains are not enforced.\n\n### setAllowAllDomains\n\nOptional. If set to true, it means allowed_domains are not enforced.\n\n### getAllowedDomains\n\nOptional. Domains or subdomains of websites allowed to use the key. All\nsubdomains of an allowed domain are automatically allowed. A valid domain\nrequires a host and must not include any path, port, query or fragment.\n\nExamples: 'example.com' or 'subdomain.example.com'\n\n### setAllowedDomains\n\nOptional. Domains or subdomains of websites allowed to use the key. All\nsubdomains of an allowed domain are automatically allowed. A valid domain\nrequires a host and must not include any path, port, query or fragment.\n\nExamples: 'example.com' or 'subdomain.example.com'\n\n### getAllowAmpTraffic\n\nOptional. If set to true, the key can be used on AMP (Accelerated Mobile\nPages) websites. This is supported only for the SCORE integration type.\n\n### setAllowAmpTraffic\n\nOptional. If set to true, the key can be used on AMP (Accelerated Mobile\nPages) websites. This is supported only for the SCORE integration type.\n\n### getIntegrationType\n\nRequired. Describes how this key is integrated with the website.\n\n### setIntegrationType\n\nRequired. Describes how this key is integrated with the website.\n\n### getChallengeSecurityPreference\n\nOptional. Settings for the frequency and difficulty at which this key\ntriggers captcha challenges. This should only be specified for\nIntegrationTypes CHECKBOX and INVISIBLE and SCORE_AND_CHALLENGE.\n\n### setChallengeSecurityPreference\n\nOptional. Settings for the frequency and difficulty at which this key\ntriggers captcha challenges. This should only be specified for\nIntegrationTypes CHECKBOX and INVISIBLE and SCORE_AND_CHALLENGE."]]
