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
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ allow_all_domains |
bool
If set to true, it means allowed_domains will not be enforced. |
↳ allowed_domains |
array
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
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
Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE. |
getAllowAllDomains
If set to true, it means allowed_domains will not be enforced.
| Returns | |
|---|---|
| Type | Description |
bool | |
setAllowAllDomains
If set to true, it means allowed_domains will not be enforced.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAllowedDomains
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 | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setAllowedDomains
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
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
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
Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE.
| Returns | |
|---|---|
| Type | Description |
int | |
setChallengeSecurityPreference
Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |