Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
Creates a new reCAPTCHA Enterprise key.
Deletes the specified key.
Returns the specified key.
getMetrics(name, x__xgafv=None)
Get some aggregated metrics for a Key. This data can be used to build dashboards.
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Returns the list of all keys that belong to a project.
list_next(previous_request, previous_response)
Retrieves the next page of results.
migrate(name, body=None, x__xgafv=None)
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 Site Key, and your user must have the reCAPTCHA Enterprise Admin IAM role in the destination project.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates the specified key.
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 will be 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, # If set to true, allowed_package_names are not enforced.
"allowedPackageNames": [ # Android package names of apps allowed to use the key. Example: 'com.companyname.appname'
"A String",
],
},
"createTime": "A String", # The timestamp corresponding to the creation of this Key.
"displayName": "A String", # Human-readable display name of this key. Modifiable by user.
"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, # If set to true, allowed_bundle_ids are not enforced.
"allowedBundleIds": [ # iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'
"A String",
],
},
"labels": { # See Creating and managing labels.
"a_key": "A String",
},
"name": "A String", # The resource name for the Key in the format "projects/{project}/keys/{key}".
"testingOptions": { # Options for user acceptance testing. # Options for user acceptance testing.
"testingChallenge": "A String", # For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site will return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE.
"testingScore": 3.14, # All assessments for this Key will 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). # 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, # If set to true, it means allowed_domains will not be enforced.
"allowAmpTraffic": True or False, # 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": [ # 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", # Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE.
"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, # If set to true, allowed_package_names are not enforced.
"allowedPackageNames": [ # Android package names of apps allowed to use the key. Example: 'com.companyname.appname'
"A String",
],
},
"createTime": "A String", # The timestamp corresponding to the creation of this Key.
"displayName": "A String", # Human-readable display name of this key. Modifiable by user.
"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, # If set to true, allowed_bundle_ids are not enforced.
"allowedBundleIds": [ # iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'
"A String",
],
},
"labels": { # See Creating and managing labels.
"a_key": "A String",
},
"name": "A String", # The resource name for the Key in the format "projects/{project}/keys/{key}".
"testingOptions": { # Options for user acceptance testing. # Options for user acceptance testing.
"testingChallenge": "A String", # For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site will return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE.
"testingScore": 3.14, # All assessments for this Key will 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). # 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, # If set to true, it means allowed_domains will not be enforced.
"allowAmpTraffic": True or False, # 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": [ # 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", # Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE.
"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); } The JSON representation for `Empty` is empty JSON object `{}`.
}
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, # If set to true, allowed_package_names are not enforced.
"allowedPackageNames": [ # Android package names of apps allowed to use the key. Example: 'com.companyname.appname'
"A String",
],
},
"createTime": "A String", # The timestamp corresponding to the creation of this Key.
"displayName": "A String", # Human-readable display name of this key. Modifiable by user.
"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, # If set to true, allowed_bundle_ids are not enforced.
"allowedBundleIds": [ # iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'
"A String",
],
},
"labels": { # See Creating and managing labels.
"a_key": "A String",
},
"name": "A String", # The resource name for the Key in the format "projects/{project}/keys/{key}".
"testingOptions": { # Options for user acceptance testing. # Options for user acceptance testing.
"testingChallenge": "A String", # For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site will return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE.
"testingScore": 3.14, # All assessments for this Key will 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). # 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, # If set to true, it means allowed_domains will not be enforced.
"allowAmpTraffic": True or False, # 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": [ # 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", # Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE.
"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 will be continuous and in order by dates, and in the granularity of day. Only challenge-based keys (CHECKBOX, INVISIBLE), will 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. The name of the metrics, in the format "projects/{project}/keys/{key}/metrics".
"scoreMetrics": [ # Metrics will be 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. Populated only for SCORE keys.
"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 will be 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, # If set to true, allowed_package_names are not enforced.
"allowedPackageNames": [ # Android package names of apps allowed to use the key. Example: 'com.companyname.appname'
"A String",
],
},
"createTime": "A String", # The timestamp corresponding to the creation of this Key.
"displayName": "A String", # Human-readable display name of this key. Modifiable by user.
"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, # If set to true, allowed_bundle_ids are not enforced.
"allowedBundleIds": [ # iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'
"A String",
],
},
"labels": { # See Creating and managing labels.
"a_key": "A String",
},
"name": "A String", # The resource name for the Key in the format "projects/{project}/keys/{key}".
"testingOptions": { # Options for user acceptance testing. # Options for user acceptance testing.
"testingChallenge": "A String", # For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site will return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE.
"testingScore": 3.14, # All assessments for this Key will 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). # 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, # If set to true, it means allowed_domains will not be enforced.
"allowAmpTraffic": True or False, # 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": [ # 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", # Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE.
"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.
}
list_next(previous_request, previous_response)
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)
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 Site Key, and your user must have the reCAPTCHA Enterprise Admin IAM role in the destination project.
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.
}
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, # If set to true, allowed_package_names are not enforced.
"allowedPackageNames": [ # Android package names of apps allowed to use the key. Example: 'com.companyname.appname'
"A String",
],
},
"createTime": "A String", # The timestamp corresponding to the creation of this Key.
"displayName": "A String", # Human-readable display name of this key. Modifiable by user.
"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, # If set to true, allowed_bundle_ids are not enforced.
"allowedBundleIds": [ # iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'
"A String",
],
},
"labels": { # See Creating and managing labels.
"a_key": "A String",
},
"name": "A String", # The resource name for the Key in the format "projects/{project}/keys/{key}".
"testingOptions": { # Options for user acceptance testing. # Options for user acceptance testing.
"testingChallenge": "A String", # For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site will return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE.
"testingScore": 3.14, # All assessments for this Key will 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). # 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, # If set to true, it means allowed_domains will not be enforced.
"allowAmpTraffic": True or False, # 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": [ # 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", # Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE.
"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, 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, # If set to true, allowed_package_names are not enforced.
"allowedPackageNames": [ # Android package names of apps allowed to use the key. Example: 'com.companyname.appname'
"A String",
],
},
"createTime": "A String", # The timestamp corresponding to the creation of this Key.
"displayName": "A String", # Human-readable display name of this key. Modifiable by user.
"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, # If set to true, allowed_bundle_ids are not enforced.
"allowedBundleIds": [ # iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'
"A String",
],
},
"labels": { # See Creating and managing labels.
"a_key": "A String",
},
"name": "A String", # The resource name for the Key in the format "projects/{project}/keys/{key}".
"testingOptions": { # Options for user acceptance testing. # Options for user acceptance testing.
"testingChallenge": "A String", # For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site will return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE.
"testingScore": 3.14, # All assessments for this Key will 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). # 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, # If set to true, it means allowed_domains will not be enforced.
"allowAmpTraffic": True or False, # 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": [ # 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", # Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE.
"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 will be 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, # If set to true, allowed_package_names are not enforced.
"allowedPackageNames": [ # Android package names of apps allowed to use the key. Example: 'com.companyname.appname'
"A String",
],
},
"createTime": "A String", # The timestamp corresponding to the creation of this Key.
"displayName": "A String", # Human-readable display name of this key. Modifiable by user.
"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, # If set to true, allowed_bundle_ids are not enforced.
"allowedBundleIds": [ # iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'
"A String",
],
},
"labels": { # See Creating and managing labels.
"a_key": "A String",
},
"name": "A String", # The resource name for the Key in the format "projects/{project}/keys/{key}".
"testingOptions": { # Options for user acceptance testing. # Options for user acceptance testing.
"testingChallenge": "A String", # For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site will return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE.
"testingScore": 3.14, # All assessments for this Key will 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). # 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, # If set to true, it means allowed_domains will not be enforced.
"allowAmpTraffic": True or False, # 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": [ # 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", # Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE.
"integrationType": "A String", # Required. Describes how this key is integrated with the website.
},
}