Adds an IP override to a key. The following restrictions hold: * The maximum number of IP overrides per key is 100. * For any conflict (such as IP already exists or IP part of an existing IP range), an error is returned.

Get some aggregated metrics for a Key. This data can be used to build dashboards.

Migrates an existing key from reCAPTCHA to reCAPTCHA Enterprise. Once a key is migrated, it can be used from either product. SiteVerify requests are billed as CreateAssessment calls. You must be authenticated as one of the current owners of the reCAPTCHA Key, and your user must have the reCAPTCHA Enterprise Admin IAM role in the destination project.

Removes an IP override from a key. The following restrictions hold: * If the IP isn't found in an existing IP override, a `NOT_FOUND` error is returned. * If the IP is found in an existing IP override, but the override type does not match, a `NOT_FOUND` error is returned.

Returns the secret key related to the specified public key. You must use the legacy secret key only in a 3rd party integration with legacy reCAPTCHA.

Method Details

addIpOverride(name, body=None, x__xgafv=None)

Adds an IP override to a key. The following restrictions hold: * The maximum number of IP overrides per key is 100. * For any conflict (such as IP already exists or IP part of an existing IP range), an error is returned.

Args:
  name: string, Required. The name of the key to which the IP override is added, in the format `projects/{project}/keys/{key}`. (required)
  body: object, The request body.
    The object takes the form of:

{ # The AddIpOverride request message.
  "ipOverrideData": { # Information about the IP or IP range override. # Required. IP override added to the key.
    "ip": "A String", # Required. The IP address to override (can be IPv4, IPv6 or CIDR). The IP override must be a valid IPv4 or IPv6 address, or a CIDR range. The IP override must be a public IP address. Example of IPv4: 168.192.5.6 Example of IPv6: 2001:0000:130F:0000:0000:09C0:876A:130B Example of IPv4 with CIDR: 168.192.5.0/24 Example of IPv6 with CIDR: 2001:0DB8:1234::/48
    "overrideType": "A String", # Required. Describes the type of IP override.
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for AddIpOverride.
}

close()

Close httplib2 connections.

create(parent, body=None, x__xgafv=None)

Creates a new reCAPTCHA Enterprise key.

Args:
  parent: string, Required. The name of the project in which the key is created, in the format `projects/{project}`. (required)
  body: object, The request body.
    The object takes the form of:

{ # A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.
  "androidSettings": { # Settings specific to keys that can be used by Android apps. # Settings for keys that can be used by Android apps.
    "allowAllPackageNames": True or False, # Optional. If set to true, allowed_package_names are not enforced.
    "allowedPackageNames": [ # Optional. Android package names of apps allowed to use the key. Example: 'com.companyname.appname'
      "A String",
    ],
    "supportNonGoogleAppStoreDistribution": True or False, # Optional. Set to true for keys that are used in an Android application that is available for download in app stores in addition to the Google Play Store.
  },
  "createTime": "A String", # Output only. The timestamp corresponding to the creation of this key.
  "displayName": "A String", # Required. Human-readable display name of this key. Modifiable by user.
  "expressSettings": { # Settings specific to keys that can be used for reCAPTCHA Express. # Settings for keys that can be used by reCAPTCHA Express.
  },
  "iosSettings": { # Settings specific to keys that can be used by iOS apps. # Settings for keys that can be used by iOS apps.
    "allowAllBundleIds": True or False, # Optional. If set to true, allowed_bundle_ids are not enforced.
    "allowedBundleIds": [ # Optional. iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'
      "A String",
    ],
    "appleDeveloperId": { # Contains fields that are required to perform Apple-specific integrity checks. # Optional. Apple Developer account details for the app that is protected by the reCAPTCHA Key. reCAPTCHA leverages platform-specific checks like Apple App Attest and Apple DeviceCheck to protect your app from abuse. Providing these fields allows reCAPTCHA to get a better assessment of the integrity of your app.
      "keyId": "A String", # Required. The Apple developer key ID (10-character string).
      "privateKey": "A String", # Required. Input only. A private key (downloaded as a text file with a .p8 file extension) generated for your Apple Developer account. Ensure that Apple DeviceCheck is enabled for the private key.
      "teamId": "A String", # Required. The Apple team ID (10-character string) owning the provisioning profile used to build your application.
    },
  },
  "labels": { # Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha/docs/labels).
    "a_key": "A String",
  },
  "name": "A String", # Identifier. The resource name for the Key in the format `projects/{project}/keys/{key}`.
  "testingOptions": { # Options for user acceptance testing. # Optional. Options for user acceptance testing.
    "testingChallenge": "A String", # Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE.
    "testingScore": 3.14, # Optional. All assessments for this Key return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.
  },
  "wafSettings": { # Settings specific to keys that can be used for WAF (Web Application Firewall). # Optional. Settings for WAF
    "wafFeature": "A String", # Required. The WAF feature for which this key is enabled.
    "wafService": "A String", # Required. The WAF service that uses this key.
  },
  "webSettings": { # Settings specific to keys that can be used by websites. # Settings for keys that can be used by websites.
    "allowAllDomains": True or False, # Optional. If set to true, it means allowed_domains are not enforced.
    "allowAmpTraffic": True or 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.
    "allowedDomains": [ # 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'
      "A String",
    ],
    "challengeSecurityPreference": "A String", # 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.
    "integrationType": "A String", # Required. Describes how this key is integrated with the website.
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.
  "androidSettings": { # Settings specific to keys that can be used by Android apps. # Settings for keys that can be used by Android apps.
    "allowAllPackageNames": True or False, # Optional. If set to true, allowed_package_names are not enforced.
    "allowedPackageNames": [ # Optional. Android package names of apps allowed to use the key. Example: 'com.companyname.appname'
      "A String",
    ],
    "supportNonGoogleAppStoreDistribution": True or False, # Optional. Set to true for keys that are used in an Android application that is available for download in app stores in addition to the Google Play Store.
  },
  "createTime": "A String", # Output only. The timestamp corresponding to the creation of this key.
  "displayName": "A String", # Required. Human-readable display name of this key. Modifiable by user.
  "expressSettings": { # Settings specific to keys that can be used for reCAPTCHA Express. # Settings for keys that can be used by reCAPTCHA Express.
  },
  "iosSettings": { # Settings specific to keys that can be used by iOS apps. # Settings for keys that can be used by iOS apps.
    "allowAllBundleIds": True or False, # Optional. If set to true, allowed_bundle_ids are not enforced.
    "allowedBundleIds": [ # Optional. iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'
      "A String",
    ],
    "appleDeveloperId": { # Contains fields that are required to perform Apple-specific integrity checks. # Optional. Apple Developer account details for the app that is protected by the reCAPTCHA Key. reCAPTCHA leverages platform-specific checks like Apple App Attest and Apple DeviceCheck to protect your app from abuse. Providing these fields allows reCAPTCHA to get a better assessment of the integrity of your app.
      "keyId": "A String", # Required. The Apple developer key ID (10-character string).
      "privateKey": "A String", # Required. Input only. A private key (downloaded as a text file with a .p8 file extension) generated for your Apple Developer account. Ensure that Apple DeviceCheck is enabled for the private key.
      "teamId": "A String", # Required. The Apple team ID (10-character string) owning the provisioning profile used to build your application.
    },
  },
  "labels": { # Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha/docs/labels).
    "a_key": "A String",
  },
  "name": "A String", # Identifier. The resource name for the Key in the format `projects/{project}/keys/{key}`.
  "testingOptions": { # Options for user acceptance testing. # Optional. Options for user acceptance testing.
    "testingChallenge": "A String", # Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE.
    "testingScore": 3.14, # Optional. All assessments for this Key return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.
  },
  "wafSettings": { # Settings specific to keys that can be used for WAF (Web Application Firewall). # Optional. Settings for WAF
    "wafFeature": "A String", # Required. The WAF feature for which this key is enabled.
    "wafService": "A String", # Required. The WAF service that uses this key.
  },
  "webSettings": { # Settings specific to keys that can be used by websites. # Settings for keys that can be used by websites.
    "allowAllDomains": True or False, # Optional. If set to true, it means allowed_domains are not enforced.
    "allowAmpTraffic": True or 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.
    "allowedDomains": [ # 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'
      "A String",
    ],
    "challengeSecurityPreference": "A String", # 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.
    "integrationType": "A String", # Required. Describes how this key is integrated with the website.
  },
}

delete(name, x__xgafv=None)

Deletes the specified key.

Args:
  name: string, Required. The name of the key to be deleted, in the format `projects/{project}/keys/{key}`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

get(name, x__xgafv=None)

Returns the specified key.

Args:
  name: string, Required. The name of the requested key, in the format `projects/{project}/keys/{key}`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.
  "androidSettings": { # Settings specific to keys that can be used by Android apps. # Settings for keys that can be used by Android apps.
    "allowAllPackageNames": True or False, # Optional. If set to true, allowed_package_names are not enforced.
    "allowedPackageNames": [ # Optional. Android package names of apps allowed to use the key. Example: 'com.companyname.appname'
      "A String",
    ],
    "supportNonGoogleAppStoreDistribution": True or False, # Optional. Set to true for keys that are used in an Android application that is available for download in app stores in addition to the Google Play Store.
  },
  "createTime": "A String", # Output only. The timestamp corresponding to the creation of this key.
  "displayName": "A String", # Required. Human-readable display name of this key. Modifiable by user.
  "expressSettings": { # Settings specific to keys that can be used for reCAPTCHA Express. # Settings for keys that can be used by reCAPTCHA Express.
  },
  "iosSettings": { # Settings specific to keys that can be used by iOS apps. # Settings for keys that can be used by iOS apps.
    "allowAllBundleIds": True or False, # Optional. If set to true, allowed_bundle_ids are not enforced.
    "allowedBundleIds": [ # Optional. iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'
      "A String",
    ],
    "appleDeveloperId": { # Contains fields that are required to perform Apple-specific integrity checks. # Optional. Apple Developer account details for the app that is protected by the reCAPTCHA Key. reCAPTCHA leverages platform-specific checks like Apple App Attest and Apple DeviceCheck to protect your app from abuse. Providing these fields allows reCAPTCHA to get a better assessment of the integrity of your app.
      "keyId": "A String", # Required. The Apple developer key ID (10-character string).
      "privateKey": "A String", # Required. Input only. A private key (downloaded as a text file with a .p8 file extension) generated for your Apple Developer account. Ensure that Apple DeviceCheck is enabled for the private key.
      "teamId": "A String", # Required. The Apple team ID (10-character string) owning the provisioning profile used to build your application.
    },
  },
  "labels": { # Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha/docs/labels).
    "a_key": "A String",
  },
  "name": "A String", # Identifier. The resource name for the Key in the format `projects/{project}/keys/{key}`.
  "testingOptions": { # Options for user acceptance testing. # Optional. Options for user acceptance testing.
    "testingChallenge": "A String", # Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE.
    "testingScore": 3.14, # Optional. All assessments for this Key return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.
  },
  "wafSettings": { # Settings specific to keys that can be used for WAF (Web Application Firewall). # Optional. Settings for WAF
    "wafFeature": "A String", # Required. The WAF feature for which this key is enabled.
    "wafService": "A String", # Required. The WAF service that uses this key.
  },
  "webSettings": { # Settings specific to keys that can be used by websites. # Settings for keys that can be used by websites.
    "allowAllDomains": True or False, # Optional. If set to true, it means allowed_domains are not enforced.
    "allowAmpTraffic": True or 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.
    "allowedDomains": [ # 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'
      "A String",
    ],
    "challengeSecurityPreference": "A String", # 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.
    "integrationType": "A String", # Required. Describes how this key is integrated with the website.
  },
}

getMetrics(name, x__xgafv=None)

Get some aggregated metrics for a Key. This data can be used to build dashboards.

Args:
  name: string, Required. The name of the requested metrics, in the format `projects/{project}/keys/{key}/metrics`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Metrics for a single Key.
  "challengeMetrics": [ # Metrics are continuous and in order by dates, and in the granularity of day. Only challenge-based keys (CHECKBOX, INVISIBLE) have challenge-based data.
    { # Metrics related to challenges.
      "failedCount": "A String", # Count of submitted challenge solutions that were incorrect or otherwise deemed suspicious such that a subsequent challenge was triggered.
      "nocaptchaCount": "A String", # Count of nocaptchas (successful verification without a challenge) issued.
      "pageloadCount": "A String", # Count of reCAPTCHA checkboxes or badges rendered. This is mostly equivalent to a count of pageloads for pages that include reCAPTCHA.
      "passedCount": "A String", # Count of nocaptchas (successful verification without a challenge) plus submitted challenge solutions that were correct and resulted in verification.
    },
  ],
  "name": "A String", # Output only. Identifier. The name of the metrics, in the format `projects/{project}/keys/{key}/metrics`.
  "scoreMetrics": [ # Metrics are continuous and in order by dates, and in the granularity of day. All Key types should have score-based data.
    { # Metrics related to scoring.
      "actionMetrics": { # Action-based metrics. The map key is the action name which specified by the site owners at time of the "execute" client-side call.
        "a_key": { # Score distribution.
          "scoreBuckets": { # Map key is score value multiplied by 100. The scores are discrete values between [0, 1]. The maximum number of buckets is on order of a few dozen, but typically much lower (ie. 10).
            "a_key": "A String",
          },
        },
      },
      "overallMetrics": { # Score distribution. # Aggregated score metrics for all traffic.
        "scoreBuckets": { # Map key is score value multiplied by 100. The scores are discrete values between [0, 1]. The maximum number of buckets is on order of a few dozen, but typically much lower (ie. 10).
          "a_key": "A String",
        },
      },
    },
  ],
  "startTime": "A String", # Inclusive start time aligned to a day (UTC).
}

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

Returns the list of all keys that belong to a project.

Args:
  parent: string, Required. The name of the project that contains the keys that is listed, in the format `projects/{project}`. (required)
  pageSize: integer, Optional. The maximum number of keys to return. Default is 10. Max limit is 1000.
  pageToken: string, Optional. The next_page_token value returned from a previous. ListKeysRequest, if any.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response to request to list keys in a project.
  "keys": [ # Key details.
    { # A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.
      "androidSettings": { # Settings specific to keys that can be used by Android apps. # Settings for keys that can be used by Android apps.
        "allowAllPackageNames": True or False, # Optional. If set to true, allowed_package_names are not enforced.
        "allowedPackageNames": [ # Optional. Android package names of apps allowed to use the key. Example: 'com.companyname.appname'
          "A String",
        ],
        "supportNonGoogleAppStoreDistribution": True or False, # Optional. Set to true for keys that are used in an Android application that is available for download in app stores in addition to the Google Play Store.
      },
      "createTime": "A String", # Output only. The timestamp corresponding to the creation of this key.
      "displayName": "A String", # Required. Human-readable display name of this key. Modifiable by user.
      "expressSettings": { # Settings specific to keys that can be used for reCAPTCHA Express. # Settings for keys that can be used by reCAPTCHA Express.
      },
      "iosSettings": { # Settings specific to keys that can be used by iOS apps. # Settings for keys that can be used by iOS apps.
        "allowAllBundleIds": True or False, # Optional. If set to true, allowed_bundle_ids are not enforced.
        "allowedBundleIds": [ # Optional. iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'
          "A String",
        ],
        "appleDeveloperId": { # Contains fields that are required to perform Apple-specific integrity checks. # Optional. Apple Developer account details for the app that is protected by the reCAPTCHA Key. reCAPTCHA leverages platform-specific checks like Apple App Attest and Apple DeviceCheck to protect your app from abuse. Providing these fields allows reCAPTCHA to get a better assessment of the integrity of your app.
          "keyId": "A String", # Required. The Apple developer key ID (10-character string).
          "privateKey": "A String", # Required. Input only. A private key (downloaded as a text file with a .p8 file extension) generated for your Apple Developer account. Ensure that Apple DeviceCheck is enabled for the private key.
          "teamId": "A String", # Required. The Apple team ID (10-character string) owning the provisioning profile used to build your application.
        },
      },
      "labels": { # Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha/docs/labels).
        "a_key": "A String",
      },
      "name": "A String", # Identifier. The resource name for the Key in the format `projects/{project}/keys/{key}`.
      "testingOptions": { # Options for user acceptance testing. # Optional. Options for user acceptance testing.
        "testingChallenge": "A String", # Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE.
        "testingScore": 3.14, # Optional. All assessments for this Key return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.
      },
      "wafSettings": { # Settings specific to keys that can be used for WAF (Web Application Firewall). # Optional. Settings for WAF
        "wafFeature": "A String", # Required. The WAF feature for which this key is enabled.
        "wafService": "A String", # Required. The WAF service that uses this key.
      },
      "webSettings": { # Settings specific to keys that can be used by websites. # Settings for keys that can be used by websites.
        "allowAllDomains": True or False, # Optional. If set to true, it means allowed_domains are not enforced.
        "allowAmpTraffic": True or 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.
        "allowedDomains": [ # 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'
          "A String",
        ],
        "challengeSecurityPreference": "A String", # 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.
        "integrationType": "A String", # Required. Describes how this key is integrated with the website.
      },
    },
  ],
  "nextPageToken": "A String", # Token to retrieve the next page of results. It is set to empty if no keys remain in results.
}

listIpOverrides(parent, pageSize=None, pageToken=None, x__xgafv=None)

Lists all IP overrides for a key.

Args:
  parent: string, Required. The parent key for which the IP overrides are listed, in the format `projects/{project}/keys/{key}`. (required)
  pageSize: integer, Optional. The maximum number of overrides to return. Default is 10. Max limit is 100. If the number of overrides is less than the page_size, all overrides are returned. If the page size is more than 100, it is coerced to 100.
  pageToken: string, Optional. The next_page_token value returned from a previous ListIpOverridesRequest, if any.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for ListIpOverrides.
  "ipOverrides": [ # IP Overrides details.
    { # Information about the IP or IP range override.
      "ip": "A String", # Required. The IP address to override (can be IPv4, IPv6 or CIDR). The IP override must be a valid IPv4 or IPv6 address, or a CIDR range. The IP override must be a public IP address. Example of IPv4: 168.192.5.6 Example of IPv6: 2001:0000:130F:0000:0000:09C0:876A:130B Example of IPv4 with CIDR: 168.192.5.0/24 Example of IPv6 with CIDR: 2001:0DB8:1234::/48
      "overrideType": "A String", # Required. Describes the type of IP override.
    },
  ],
  "nextPageToken": "A String", # Token to retrieve the next page of results. If this field is empty, no keys remain in the results.
}

listIpOverrides_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.

migrate(name, body=None, x__xgafv=None)

Args:
name: string, Required. The name of the key to be migrated, in the format `projects/{project}/keys/{key}`. (required)
body: object, The request body.
The object takes the form of:

{ # The migrate key request message.
"skipBillingCheck": True or False, # Optional. If true, skips the billing check. A reCAPTCHA Enterprise key or migrated key behaves differently than a reCAPTCHA (non-Enterprise version) key when you reach a quota limit (see https://cloud.google.com/recaptcha/quotas#quota_limit). To avoid any disruption of your usage, we check that a billing account is present. If your usage of reCAPTCHA is under the free quota, you can safely skip the billing check and proceed with the migration. See https://cloud.google.com/recaptcha/docs/billing-information.
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.
"androidSettings": { # Settings specific to keys that can be used by Android apps. # Settings for keys that can be used by Android apps.
"allowAllPackageNames": True or False, # Optional. If set to true, allowed_package_names are not enforced.
"allowedPackageNames": [ # Optional. Android package names of apps allowed to use the key. Example: 'com.companyname.appname'
"A String",
],
"supportNonGoogleAppStoreDistribution": True or False, # Optional. Set to true for keys that are used in an Android application that is available for download in app stores in addition to the Google Play Store.
},
"createTime": "A String", # Output only. The timestamp corresponding to the creation of this key.
"displayName": "A String", # Required. Human-readable display name of this key. Modifiable by user.
"expressSettings": { # Settings specific to keys that can be used for reCAPTCHA Express. # Settings for keys that can be used by reCAPTCHA Express.
},
"iosSettings": { # Settings specific to keys that can be used by iOS apps. # Settings for keys that can be used by iOS apps.
"allowAllBundleIds": True or False, # Optional. If set to true, allowed_bundle_ids are not enforced.
"allowedBundleIds": [ # Optional. iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'
"A String",
],
"appleDeveloperId": { # Contains fields that are required to perform Apple-specific integrity checks. # Optional. Apple Developer account details for the app that is protected by the reCAPTCHA Key. reCAPTCHA leverages platform-specific checks like Apple App Attest and Apple DeviceCheck to protect your app from abuse. Providing these fields allows reCAPTCHA to get a better assessment of the integrity of your app.
"keyId": "A String", # Required. The Apple developer key ID (10-character string).
"privateKey": "A String", # Required. Input only. A private key (downloaded as a text file with a .p8 file extension) generated for your Apple Developer account. Ensure that Apple DeviceCheck is enabled for the private key.
"teamId": "A String", # Required. The Apple team ID (10-character string) owning the provisioning profile used to build your application.
},
},
"labels": { # Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha/docs/labels).
"a_key": "A String",
},
"name": "A String", # Identifier. The resource name for the Key in the format `projects/{project}/keys/{key}`.
"testingOptions": { # Options for user acceptance testing. # Optional. Options for user acceptance testing.
"testingChallenge": "A String", # Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE.
"testingScore": 3.14, # Optional. All assessments for this Key return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.
},
"wafSettings": { # Settings specific to keys that can be used for WAF (Web Application Firewall). # Optional. Settings for WAF
"wafFeature": "A String", # Required. The WAF feature for which this key is enabled.
"wafService": "A String", # Required. The WAF service that uses this key.
},
"webSettings": { # Settings specific to keys that can be used by websites. # Settings for keys that can be used by websites.
"allowAllDomains": True or False, # Optional. If set to true, it means allowed_domains are not enforced.
"allowAmpTraffic": True or 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.
"allowedDomains": [ # 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'
"A String",
],
"challengeSecurityPreference": "A String", # 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.
"integrationType": "A String", # Required. Describes how this key is integrated with the website.
},
}

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates the specified key.

Args:
  name: string, Identifier. The resource name for the Key in the format `projects/{project}/keys/{key}`. (required)
  body: object, The request body.
    The object takes the form of:

{ # A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.
  "androidSettings": { # Settings specific to keys that can be used by Android apps. # Settings for keys that can be used by Android apps.
    "allowAllPackageNames": True or False, # Optional. If set to true, allowed_package_names are not enforced.
    "allowedPackageNames": [ # Optional. Android package names of apps allowed to use the key. Example: 'com.companyname.appname'
      "A String",
    ],
    "supportNonGoogleAppStoreDistribution": True or False, # Optional. Set to true for keys that are used in an Android application that is available for download in app stores in addition to the Google Play Store.
  },
  "createTime": "A String", # Output only. The timestamp corresponding to the creation of this key.
  "displayName": "A String", # Required. Human-readable display name of this key. Modifiable by user.
  "expressSettings": { # Settings specific to keys that can be used for reCAPTCHA Express. # Settings for keys that can be used by reCAPTCHA Express.
  },
  "iosSettings": { # Settings specific to keys that can be used by iOS apps. # Settings for keys that can be used by iOS apps.
    "allowAllBundleIds": True or False, # Optional. If set to true, allowed_bundle_ids are not enforced.
    "allowedBundleIds": [ # Optional. iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'
      "A String",
    ],
    "appleDeveloperId": { # Contains fields that are required to perform Apple-specific integrity checks. # Optional. Apple Developer account details for the app that is protected by the reCAPTCHA Key. reCAPTCHA leverages platform-specific checks like Apple App Attest and Apple DeviceCheck to protect your app from abuse. Providing these fields allows reCAPTCHA to get a better assessment of the integrity of your app.
      "keyId": "A String", # Required. The Apple developer key ID (10-character string).
      "privateKey": "A String", # Required. Input only. A private key (downloaded as a text file with a .p8 file extension) generated for your Apple Developer account. Ensure that Apple DeviceCheck is enabled for the private key.
      "teamId": "A String", # Required. The Apple team ID (10-character string) owning the provisioning profile used to build your application.
    },
  },
  "labels": { # Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha/docs/labels).
    "a_key": "A String",
  },
  "name": "A String", # Identifier. The resource name for the Key in the format `projects/{project}/keys/{key}`.
  "testingOptions": { # Options for user acceptance testing. # Optional. Options for user acceptance testing.
    "testingChallenge": "A String", # Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE.
    "testingScore": 3.14, # Optional. All assessments for this Key return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.
  },
  "wafSettings": { # Settings specific to keys that can be used for WAF (Web Application Firewall). # Optional. Settings for WAF
    "wafFeature": "A String", # Required. The WAF feature for which this key is enabled.
    "wafService": "A String", # Required. The WAF service that uses this key.
  },
  "webSettings": { # Settings specific to keys that can be used by websites. # Settings for keys that can be used by websites.
    "allowAllDomains": True or False, # Optional. If set to true, it means allowed_domains are not enforced.
    "allowAmpTraffic": True or 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.
    "allowedDomains": [ # 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'
      "A String",
    ],
    "challengeSecurityPreference": "A String", # 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.
    "integrationType": "A String", # Required. Describes how this key is integrated with the website.
  },
}

  updateMask: string, Optional. The mask to control which fields of the key get updated. If the mask is not present, all fields are updated.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.
  "androidSettings": { # Settings specific to keys that can be used by Android apps. # Settings for keys that can be used by Android apps.
    "allowAllPackageNames": True or False, # Optional. If set to true, allowed_package_names are not enforced.
    "allowedPackageNames": [ # Optional. Android package names of apps allowed to use the key. Example: 'com.companyname.appname'
      "A String",
    ],
    "supportNonGoogleAppStoreDistribution": True or False, # Optional. Set to true for keys that are used in an Android application that is available for download in app stores in addition to the Google Play Store.
  },
  "createTime": "A String", # Output only. The timestamp corresponding to the creation of this key.
  "displayName": "A String", # Required. Human-readable display name of this key. Modifiable by user.
  "expressSettings": { # Settings specific to keys that can be used for reCAPTCHA Express. # Settings for keys that can be used by reCAPTCHA Express.
  },
  "iosSettings": { # Settings specific to keys that can be used by iOS apps. # Settings for keys that can be used by iOS apps.
    "allowAllBundleIds": True or False, # Optional. If set to true, allowed_bundle_ids are not enforced.
    "allowedBundleIds": [ # Optional. iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'
      "A String",
    ],
    "appleDeveloperId": { # Contains fields that are required to perform Apple-specific integrity checks. # Optional. Apple Developer account details for the app that is protected by the reCAPTCHA Key. reCAPTCHA leverages platform-specific checks like Apple App Attest and Apple DeviceCheck to protect your app from abuse. Providing these fields allows reCAPTCHA to get a better assessment of the integrity of your app.
      "keyId": "A String", # Required. The Apple developer key ID (10-character string).
      "privateKey": "A String", # Required. Input only. A private key (downloaded as a text file with a .p8 file extension) generated for your Apple Developer account. Ensure that Apple DeviceCheck is enabled for the private key.
      "teamId": "A String", # Required. The Apple team ID (10-character string) owning the provisioning profile used to build your application.
    },
  },
  "labels": { # Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha/docs/labels).
    "a_key": "A String",
  },
  "name": "A String", # Identifier. The resource name for the Key in the format `projects/{project}/keys/{key}`.
  "testingOptions": { # Options for user acceptance testing. # Optional. Options for user acceptance testing.
    "testingChallenge": "A String", # Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE.
    "testingScore": 3.14, # Optional. All assessments for this Key return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.
  },
  "wafSettings": { # Settings specific to keys that can be used for WAF (Web Application Firewall). # Optional. Settings for WAF
    "wafFeature": "A String", # Required. The WAF feature for which this key is enabled.
    "wafService": "A String", # Required. The WAF service that uses this key.
  },
  "webSettings": { # Settings specific to keys that can be used by websites. # Settings for keys that can be used by websites.
    "allowAllDomains": True or False, # Optional. If set to true, it means allowed_domains are not enforced.
    "allowAmpTraffic": True or 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.
    "allowedDomains": [ # 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'
      "A String",
    ],
    "challengeSecurityPreference": "A String", # 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.
    "integrationType": "A String", # Required. Describes how this key is integrated with the website.
  },
}

reCAPTCHA Enterprise API . projects . keys

Instance Methods

Method Details