PHPFUI/InstaDoc
 
Copied!

Settings specific to keys that can be used by websites.

Generated from protobuf message google.cloud.recaptchaenterprise.v1.WebKeySettings

CloneableInstantiable
Methods
public __construct( $data = NULL)
 

Constructor.

  • param array $data { Optional. Data for populating the Message object. 
    @type bool $allow_all_domains
      Optional. If set to true, it means allowed_domains are not enforced.
@type string[] $allowed_domains
      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.
@type bool $allow_amp_traffic
      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.
@type int $integration_type
      Required. Describes how this key is integrated with the website.
@type int $challenge_security_preference
      Optional. Settings for the frequency and difficulty at which this key
      triggers captcha challenges. This should only be specified for
      `IntegrationType` CHECKBOX, INVISIBLE or POLICY_BASED_CHALLENGE.
@type \Google\Cloud\RecaptchaEnterprise\V1\WebKeySettings\ChallengeSettings $challenge_settings
      Optional. Challenge settings.
    }
public Google\Protobuf\Internal\Message::__debugInfo()
public Google\Protobuf\Internal\Message::byteSize()
 
  • ignore
public Google\Protobuf\Internal\Message::clear()
 

Clear all containing fields.

  • return null
public clearChallengeSettings()
public Google\Protobuf\Internal\Message::discardUnknownFields()
 

Clear all unknown fields previously parsed.

  • return null
public getAllowAllDomains()
 

Optional. If set to true, it means allowed_domains are not enforced.

Generated from protobuf field bool allow_all_domains = 3 [(.google.api.field_behavior) = OPTIONAL];

  • return bool
public 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.

Generated from protobuf field bool allow_amp_traffic = 2 [(.google.api.field_behavior) = OPTIONAL];

  • return bool
public 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' 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.

Generated from protobuf field repeated string allowed_domains = 1 [(.google.api.field_behavior) = OPTIONAL];

  • return \RepeatedField<string>
public getChallengeSecurityPreference()
 

Optional. Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationType CHECKBOX, INVISIBLE or POLICY_BASED_CHALLENGE.

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.WebKeySettings.ChallengeSecurityPreference challenge_security_preference = 5 [(.google.api.field_behavior) = OPTIONAL];

  • return int
public getChallengeSettings()
 

Optional. Challenge settings.

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.WebKeySettings.ChallengeSettings challenge_settings = 6 [(.google.api.field_behavior) = OPTIONAL];

  • return \Google\Cloud\RecaptchaEnterprise\V1\WebKeySettings\ChallengeSettings|null
public getIntegrationType()
 

Required. Describes how this key is integrated with the website.

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.WebKeySettings.IntegrationType integration_type = 4 [(.google.api.field_behavior) = REQUIRED];

  • return int
public hasChallengeSettings()
public Google\Protobuf\Internal\Message::jsonByteSize( $options = 0)
 
  • ignore
public Google\Protobuf\Internal\Message::mergeFrom( $msg)
 

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Map fields key-value pairs are overwritten. Singular/Oneof sub-messages are recursively merged. All overwritten sub-messages are deep-copied.

  • param object $msg Protobuf message to be merged from.
  • return null
public Google\Protobuf\Internal\Message::mergeFromJsonString( $data, $ignore_unknown = false)
 

Parses a json string to protobuf message.

This function takes a string in the json wire format, matching the encoding output by serializeToJsonString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.

  • param string $data Json protobuf data.
  • param bool $ignore_unknown
  • return null
  • throws \Exception Invalid data.
public Google\Protobuf\Internal\Message::mergeFromString( $data)
 

Parses a protocol buffer contained in a string.

This function takes a string in the (non-human-readable) binary wire format, matching the encoding output by serializeToString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.

  • param string $data Binary protobuf data.
  • return null
  • throws \Exception Invalid data.
public Google\Protobuf\Internal\Message::parseFromJsonStream( $input, $ignore_unknown)
 
  • ignore
public Google\Protobuf\Internal\Message::parseFromStream( $input)
 
  • ignore
public Google\Protobuf\Internal\Message::serializeToJsonStream( $output)
 
  • ignore
public Google\Protobuf\Internal\Message::serializeToJsonString( $options = 0)
 

Serialize the message to json string.

  • return string Serialized json protobuf data.
public Google\Protobuf\Internal\Message::serializeToStream( $output)
 
  • ignore
public Google\Protobuf\Internal\Message::serializeToString()
 

Serialize the message to string.

  • return string Serialized binary protobuf data.
public setAllowAllDomains( $var)
 

Optional. If set to true, it means allowed_domains are not enforced.

Generated from protobuf field bool allow_all_domains = 3 [(.google.api.field_behavior) = OPTIONAL];

  • param bool $var
  • return $this
public setAllowAmpTraffic( $var)
 

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.

Generated from protobuf field bool allow_amp_traffic = 2 [(.google.api.field_behavior) = OPTIONAL];

  • param bool $var
  • return $this
public setAllowedDomains( $var)
 

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.

Generated from protobuf field repeated string allowed_domains = 1 [(.google.api.field_behavior) = OPTIONAL];

  • param string[] $var
  • return $this
public setChallengeSecurityPreference( $var)
 

Optional. Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationType CHECKBOX, INVISIBLE or POLICY_BASED_CHALLENGE.

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.WebKeySettings.ChallengeSecurityPreference challenge_security_preference = 5 [(.google.api.field_behavior) = OPTIONAL];

  • param int $var
  • return $this
public setChallengeSettings( $var)
 

Optional. Challenge settings.

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.WebKeySettings.ChallengeSettings challenge_settings = 6 [(.google.api.field_behavior) = OPTIONAL];

  • param \Google\Cloud\RecaptchaEnterprise\V1\WebKeySettings\ChallengeSettings $var
  • return $this
public setIntegrationType( $var)
 

Required. Describes how this key is integrated with the website.

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.WebKeySettings.IntegrationType integration_type = 4 [(.google.api.field_behavior) = REQUIRED];

  • param int $var
  • return $this
Properties
protected $allow_all_domains = false
 

Optional. If set to true, it means allowed_domains are not enforced.

Generated from protobuf field bool allow_all_domains = 3 [(.google.api.field_behavior) = OPTIONAL];

protected $allow_amp_traffic = false
 

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.

Generated from protobuf field bool allow_amp_traffic = 2 [(.google.api.field_behavior) = OPTIONAL];

protected $challenge_security_preference = 0
 

Optional. Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationType CHECKBOX, INVISIBLE or POLICY_BASED_CHALLENGE.

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.WebKeySettings.ChallengeSecurityPreference challenge_security_preference = 5 [(.google.api.field_behavior) = OPTIONAL];

protected $challenge_settings = NULL
 

Optional. Challenge settings.

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.WebKeySettings.ChallengeSettings challenge_settings = 6 [(.google.api.field_behavior) = OPTIONAL];

protected $integration_type = 0
 

Required. Describes how this key is integrated with the website.

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.WebKeySettings.IntegrationType integration_type = 4 [(.google.api.field_behavior) = REQUIRED];

Methods
protected Google\Protobuf\Internal\Message::hasOneof( $number)
protected Google\Protobuf\Internal\Message::mergeFromArray(array $array)
 

Populates the message from a user-supplied PHP array. Array keys correspond to Message properties and nested message properties.

Example:

$message->mergeFromArray([
    'name' => 'This is a message name',
    'interval' => [
         'startTime' => time() - 60,
         'endTime' => time(),
    ]
]);

This method will trigger an error if it is passed data that cannot be converted to the correct type. For example, a StringValue field must receive data that is either a string or a StringValue object.

  • param array $array An array containing message properties and values.
  • return null
protected Google\Protobuf\Internal\Message::mergeFromJsonArray( $array, $ignore_unknown)
protected Google\Protobuf\Internal\Message::readOneof( $number)
protected Google\Protobuf\Internal\Message::readWrapperValue( $member)
protected Google\Protobuf\Internal\Message::whichOneof( $oneof_name)
protected Google\Protobuf\Internal\Message::writeOneof( $number, $value)
protected Google\Protobuf\Internal\Message::writeWrapperValue( $member, $value)
Properties
private $allowed_domains = NULL
 

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.

Generated from protobuf field repeated string allowed_domains = 1 [(.google.api.field_behavior) = OPTIONAL];

© 2026 Bruce Wells
Search Namespaces \ Classes
Configuration