Blame - docs/dyn/recaptchaenterprise_v1.projects.keys.html - platform/external/python/google-api-python-client

<h1><a href="recaptchaenterprise_v1.html">reCAPTCHA Enterprise API</a> . <a href="recaptchaenterprise_v1.projects.html">projects</a> . <a href="recaptchaenterprise_v1.projects.keys.html">keys</a></h1>

76

<h2>Instance Methods</h2>

77

78

<code><a href="#close">close()</a></code></p>

79

<p class="firstline">Close httplib2 connections.</p>

80

81

<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>

82

<p class="firstline">Creates a new reCAPTCHA Enterprise key.</p>

83

84

<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>

85

<p class="firstline">Deletes the specified key.</p>

86

87

<code><a href="#get">get(name, x__xgafv=None)</a></code></p>

88

<p class="firstline">Returns the specified key.</p>

89

90

<code><a href="#getMetrics">getMetrics(name, x__xgafv=None)</a></code></p>

91

<p class="firstline">Get some aggregated metrics for a Key. This data can be used to build dashboards.</p>

92

93

<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>

94

<p class="firstline">Returns the list of all keys that belong to a project.</p>

95

96

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

97

<p class="firstline">Retrieves the next page of results.</p>

98

99

<code><a href="#migrate">migrate(name, body=None, x__xgafv=None)</a></code></p>

yoshi-code-bot

7700bbf

2021-05-20 04:44:03 -0700

[diff] [blame]

100

<p class="firstline">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.</p>

yoshi-code-bot

c2cd326

2021-05-16 02:16:04 -0700

[diff] [blame]

101

102

<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>

103

<p class="firstline">Updates the specified key.</p>

104

<h3>Method Details</h3>

105

106

<code class="details" id="close">close()</code>

107

<pre>Close httplib2 connections.</pre>

</div>

<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>

112

<pre>Creates a new reCAPTCHA Enterprise key.

113

114

Args:

115

parent: string, Required. The name of the project in which the key will be created, in the format "projects/{project}". (required)

116

body: object, The request body.

117

The object takes the form of:

118

119

{ # A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.

120

"androidSettings": { # Settings specific to keys that can be used by Android apps. # Settings for keys that can be used by Android apps.

yoshi-code-bot

a41c7b9

2021-11-02 00:26:17 -0700

[diff] [blame^]

121

"allowAllPackageNames": True or False, # If set to true, allowed_package_names are not enforced.

yoshi-code-bot

c2cd326

2021-05-16 02:16:04 -0700

[diff] [blame]

122

"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.

127

"displayName": "A String", # Human-readable display name of this key. Modifiable by user.

128

"iosSettings": { # Settings specific to keys that can be used by iOS apps. # Settings for keys that can be used by iOS apps.

yoshi-code-bot

a41c7b9

2021-11-02 00:26:17 -0700

[diff] [blame^]

129

"allowAllBundleIds": True or False, # If set to true, allowed_bundle_ids are not enforced.

yoshi-code-bot

c2cd326

2021-05-16 02:16:04 -0700

[diff] [blame]

130

"allowedBundleIds": [ # iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'

"A String",

],

},

"labels": { # See Creating and managing labels.

135

"a_key": "A String",

136

},

137

"name": "A String", # The resource name for the Key in the format "projects/{project}/keys/{key}".

138

"testingOptions": { # Options for user acceptance testing. # Options for user acceptance testing.

139

"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.

140

"testingScore": 3.14, # All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.

141

},

142

"webSettings": { # Settings specific to keys that can be used by websites. # Settings for keys that can be used by websites.

143

"allowAllDomains": True or False, # If set to true, it means allowed_domains will not be enforced.

yoshi-code-bot

a41c7b9

2021-11-02 00:26:17 -0700

[diff] [blame^]

144

"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.

yoshi-code-bot

c2cd326

2021-05-16 02:16:04 -0700

[diff] [blame]

145

"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'

146

"A String",

147

],

148

"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.

149

"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:

160

161

{ # A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.

162

"androidSettings": { # Settings specific to keys that can be used by Android apps. # Settings for keys that can be used by Android apps.

yoshi-code-bot

a41c7b9

2021-11-02 00:26:17 -0700

[diff] [blame^]

163

"allowAllPackageNames": True or False, # If set to true, allowed_package_names are not enforced.

yoshi-code-bot

c2cd326

2021-05-16 02:16:04 -0700

[diff] [blame]

164

"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.

169

"displayName": "A String", # Human-readable display name of this key. Modifiable by user.

170

"iosSettings": { # Settings specific to keys that can be used by iOS apps. # Settings for keys that can be used by iOS apps.

yoshi-code-bot

a41c7b9

2021-11-02 00:26:17 -0700

[diff] [blame^]

171

"allowAllBundleIds": True or False, # If set to true, allowed_bundle_ids are not enforced.

yoshi-code-bot

c2cd326

2021-05-16 02:16:04 -0700

[diff] [blame]

172

"allowedBundleIds": [ # iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'

"A String",

],

},

"labels": { # See Creating and managing labels.

177

"a_key": "A String",

178

},

179

"name": "A String", # The resource name for the Key in the format "projects/{project}/keys/{key}".

180

"testingOptions": { # Options for user acceptance testing. # Options for user acceptance testing.

181

"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.

182

"testingScore": 3.14, # All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.

183

},

184

"webSettings": { # Settings specific to keys that can be used by websites. # Settings for keys that can be used by websites.

185

"allowAllDomains": True or False, # If set to true, it means allowed_domains will not be enforced.

yoshi-code-bot

a41c7b9

2021-11-02 00:26:17 -0700

[diff] [blame^]

186

"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.

yoshi-code-bot

c2cd326

2021-05-16 02:16:04 -0700

[diff] [blame]

187

"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'

188

"A String",

189

],

190

"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.

191

"integrationType": "A String", # Required. Describes how this key is integrated with the website.

},

}</pre>

</div>

<code class="details" id="delete">delete(name, x__xgafv=None)</code>

198

<pre>Deletes the specified key.

199

200

Args:

201

name: string, Required. The name of the key to be deleted, in the format "projects/{project}/keys/{key}". (required)

202

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

209

210

{ # 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 `{}`.

}</pre>

</div>

<code class="details" id="get">get(name, x__xgafv=None)</code>

216

<pre>Returns the specified key.

217

218

Args:

219

name: string, Required. The name of the requested key, in the format "projects/{project}/keys/{key}". (required)

220

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

227

228

{ # A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.

229

"androidSettings": { # Settings specific to keys that can be used by Android apps. # Settings for keys that can be used by Android apps.

yoshi-code-bot

a41c7b9

2021-11-02 00:26:17 -0700

[diff] [blame^]

230

"allowAllPackageNames": True or False, # If set to true, allowed_package_names are not enforced.

yoshi-code-bot

c2cd326

2021-05-16 02:16:04 -0700

[diff] [blame]

231

"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.

236

"displayName": "A String", # Human-readable display name of this key. Modifiable by user.

237

"iosSettings": { # Settings specific to keys that can be used by iOS apps. # Settings for keys that can be used by iOS apps.

yoshi-code-bot

a41c7b9

2021-11-02 00:26:17 -0700

[diff] [blame^]

238

"allowAllBundleIds": True or False, # If set to true, allowed_bundle_ids are not enforced.

yoshi-code-bot

c2cd326

2021-05-16 02:16:04 -0700

[diff] [blame]

239

"allowedBundleIds": [ # iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'

"A String",

],

},

"labels": { # See Creating and managing labels.

244

"a_key": "A String",

245

},

246

"name": "A String", # The resource name for the Key in the format "projects/{project}/keys/{key}".

247

"testingOptions": { # Options for user acceptance testing. # Options for user acceptance testing.

248

"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.

249

"testingScore": 3.14, # All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.

250

},

251

"webSettings": { # Settings specific to keys that can be used by websites. # Settings for keys that can be used by websites.

252

"allowAllDomains": True or False, # If set to true, it means allowed_domains will not be enforced.

yoshi-code-bot

a41c7b9

2021-11-02 00:26:17 -0700

[diff] [blame^]

253

"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.

yoshi-code-bot

c2cd326

2021-05-16 02:16:04 -0700

[diff] [blame]

254

"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'

255

"A String",

256

],

257

"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.

258

"integrationType": "A String", # Required. Describes how this key is integrated with the website.

},

}</pre>

</div>

<code class="details" id="getMetrics">getMetrics(name, x__xgafv=None)</code>

265

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

266

267

Args:

268

name: string, Required. The name of the requested metrics, in the format "projects/{project}/keys/{key}/metrics". (required)

269

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

276

277

{ # Metrics for a single Key.

278

"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.

279

{ # Metrics related to challenges.

280

"failedCount": "A String", # Count of submitted challenge solutions that were incorrect or otherwise deemed suspicious such that a subsequent challenge was triggered.

281

"nocaptchaCount": "A String", # Count of nocaptchas (successful verification without a challenge) issued.

282

"pageloadCount": "A String", # Count of reCAPTCHA checkboxes or badges rendered. This is mostly equivalent to a count of pageloads for pages that include reCAPTCHA.

283

"passedCount": "A String", # Count of nocaptchas (successful verification without a challenge) plus submitted challenge solutions that were correct and resulted in verification.

284

},

285

],

yoshi-code-bot

3e4b5db

2021-08-10 00:22:29 -0700

[diff] [blame]

286

"name": "A String", # Output only. The name of the metrics, in the format "projects/{project}/keys/{key}/metrics".

yoshi-code-bot

c2cd326

2021-05-16 02:16:04 -0700

[diff] [blame]

287

"scoreMetrics": [ # Metrics will be continuous and in order by dates, and in the granularity of day. All Key types should have score-based data.

288

{ # Metrics related to scoring.

289

"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.

290

"a_key": { # Score distribution.

291

"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.

297

"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).

}</pre>

</div>

<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>

309

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

310

311

Args:

312

parent: string, Required. The name of the project that contains the keys that will be listed, in the format "projects/{project}". (required)

313

pageSize: integer, Optional. The maximum number of keys to return. Default is 10. Max limit is 1000.

314

pageToken: string, Optional. The next_page_token value returned from a previous. ListKeysRequest, if any.

315

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

322

323

{ # Response to request to list keys in a project.

324

"keys": [ # Key details.

325

{ # A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.

326

"androidSettings": { # Settings specific to keys that can be used by Android apps. # Settings for keys that can be used by Android apps.

yoshi-code-bot

a41c7b9

2021-11-02 00:26:17 -0700

[diff] [blame^]

327

"allowAllPackageNames": True or False, # If set to true, allowed_package_names are not enforced.

yoshi-code-bot

c2cd326

2021-05-16 02:16:04 -0700

[diff] [blame]

328

"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.

333

"displayName": "A String", # Human-readable display name of this key. Modifiable by user.

334

"iosSettings": { # Settings specific to keys that can be used by iOS apps. # Settings for keys that can be used by iOS apps.

yoshi-code-bot

a41c7b9

2021-11-02 00:26:17 -0700

[diff] [blame^]

335

"allowAllBundleIds": True or False, # If set to true, allowed_bundle_ids are not enforced.

yoshi-code-bot

c2cd326

2021-05-16 02:16:04 -0700

[diff] [blame]

336

"allowedBundleIds": [ # iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'

"A String",

],

},

"labels": { # See Creating and managing labels.

341

"a_key": "A String",

342

},

343

"name": "A String", # The resource name for the Key in the format "projects/{project}/keys/{key}".

344

"testingOptions": { # Options for user acceptance testing. # Options for user acceptance testing.

345

"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.

346

"testingScore": 3.14, # All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.

347

},

348

"webSettings": { # Settings specific to keys that can be used by websites. # Settings for keys that can be used by websites.

349

"allowAllDomains": True or False, # If set to true, it means allowed_domains will not be enforced.

yoshi-code-bot

a41c7b9

2021-11-02 00:26:17 -0700

[diff] [blame^]

350

"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.

yoshi-code-bot

c2cd326

2021-05-16 02:16:04 -0700

[diff] [blame]

351

"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'

352

"A String",

353

],

354

"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.

355

"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.

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

365

<pre>Retrieves the next page of results.

366

367

Args:

368

previous_request: The request for the previous page. (required)

369

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

370

371

Returns:

372

A request object that you can call 'execute()' on to request the next

373

page. Returns None if there are no more items in the collection.

</pre>

</div>

<code class="details" id="migrate">migrate(name, body=None, x__xgafv=None)</code>

yoshi-code-bot

7700bbf

2021-05-20 04:44:03 -0700

[diff] [blame]

379

<pre>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.

yoshi-code-bot

c2cd326

2021-05-16 02:16:04 -0700

[diff] [blame]

380

381

Args:

382

name: string, Required. The name of the key to be migrated, in the format "projects/{project}/keys/{key}". (required)

383

body: object, The request body.

384

The object takes the form of:

385

386

{ # The migrate key request message.

387

}

388

389

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

396

397

{ # A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.

398

"androidSettings": { # Settings specific to keys that can be used by Android apps. # Settings for keys that can be used by Android apps.

yoshi-code-bot

a41c7b9

2021-11-02 00:26:17 -0700

[diff] [blame^]

399

"allowAllPackageNames": True or False, # If set to true, allowed_package_names are not enforced.

yoshi-code-bot

c2cd326

2021-05-16 02:16:04 -0700

[diff] [blame]

400

"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.

405

"displayName": "A String", # Human-readable display name of this key. Modifiable by user.

406

"iosSettings": { # Settings specific to keys that can be used by iOS apps. # Settings for keys that can be used by iOS apps.

yoshi-code-bot

a41c7b9

2021-11-02 00:26:17 -0700

[diff] [blame^]

407

"allowAllBundleIds": True or False, # If set to true, allowed_bundle_ids are not enforced.

yoshi-code-bot

c2cd326

2021-05-16 02:16:04 -0700

[diff] [blame]

408

"allowedBundleIds": [ # iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'

"A String",

],

},

"labels": { # See Creating and managing labels.

413

"a_key": "A String",

414

},

415

"name": "A String", # The resource name for the Key in the format "projects/{project}/keys/{key}".

416

"testingOptions": { # Options for user acceptance testing. # Options for user acceptance testing.

417

"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.

418

"testingScore": 3.14, # All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.

419

},

420

"webSettings": { # Settings specific to keys that can be used by websites. # Settings for keys that can be used by websites.

421

"allowAllDomains": True or False, # If set to true, it means allowed_domains will not be enforced.

yoshi-code-bot

a41c7b9

2021-11-02 00:26:17 -0700

[diff] [blame^]

422

"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.

yoshi-code-bot

c2cd326

2021-05-16 02:16:04 -0700

[diff] [blame]

423

"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'

424

"A String",

425

],

426

"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.

427

"integrationType": "A String", # Required. Describes how this key is integrated with the website.

},

}</pre>

</div>

<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>

434

<pre>Updates the specified key.

435

436

Args:

437

name: string, The resource name for the Key in the format "projects/{project}/keys/{key}". (required)

438

body: object, The request body.

439

The object takes the form of:

440

441

{ # A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.

442

"androidSettings": { # Settings specific to keys that can be used by Android apps. # Settings for keys that can be used by Android apps.

yoshi-code-bot

a41c7b9

2021-11-02 00:26:17 -0700

[diff] [blame^]

443

"allowAllPackageNames": True or False, # If set to true, allowed_package_names are not enforced.

yoshi-code-bot

c2cd326

2021-05-16 02:16:04 -0700

[diff] [blame]

444

"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.

449

"displayName": "A String", # Human-readable display name of this key. Modifiable by user.

450

"iosSettings": { # Settings specific to keys that can be used by iOS apps. # Settings for keys that can be used by iOS apps.

yoshi-code-bot

a41c7b9

2021-11-02 00:26:17 -0700

[diff] [blame^]

451

"allowAllBundleIds": True or False, # If set to true, allowed_bundle_ids are not enforced.

yoshi-code-bot

c2cd326

2021-05-16 02:16:04 -0700

[diff] [blame]

452

"allowedBundleIds": [ # iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'

"A String",

],

},

"labels": { # See Creating and managing labels.

457

"a_key": "A String",

458

},

459

"name": "A String", # The resource name for the Key in the format "projects/{project}/keys/{key}".

460

"testingOptions": { # Options for user acceptance testing. # Options for user acceptance testing.

461

"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.

462

"testingScore": 3.14, # All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.

463

},

464

"webSettings": { # Settings specific to keys that can be used by websites. # Settings for keys that can be used by websites.

465

"allowAllDomains": True or False, # If set to true, it means allowed_domains will not be enforced.

yoshi-code-bot

a41c7b9

2021-11-02 00:26:17 -0700

[diff] [blame^]

466

"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.

yoshi-code-bot

c2cd326

2021-05-16 02:16:04 -0700

[diff] [blame]

467

"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'

468

"A String",

469

],

470

"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.

471

"integrationType": "A String", # Required. Describes how this key is integrated with the website.

},

}

yoshi-code-bot

2021-05-20 04:44:03 -0700

[diff] [blame]

475

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.

yoshi-code-bot

c2cd326

2021-05-16 02:16:04 -0700

[diff] [blame]

476

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

483

484

{ # A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.

485

"androidSettings": { # Settings specific to keys that can be used by Android apps. # Settings for keys that can be used by Android apps.

yoshi-code-bot

a41c7b9

2021-11-02 00:26:17 -0700

[diff] [blame^]

486

"allowAllPackageNames": True or False, # If set to true, allowed_package_names are not enforced.

yoshi-code-bot

c2cd326

2021-05-16 02:16:04 -0700

[diff] [blame]

487

"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.

492

"displayName": "A String", # Human-readable display name of this key. Modifiable by user.

493

"iosSettings": { # Settings specific to keys that can be used by iOS apps. # Settings for keys that can be used by iOS apps.

yoshi-code-bot

a41c7b9

2021-11-02 00:26:17 -0700

[diff] [blame^]

494

"allowAllBundleIds": True or False, # If set to true, allowed_bundle_ids are not enforced.

yoshi-code-bot

c2cd326

2021-05-16 02:16:04 -0700

[diff] [blame]

495

"allowedBundleIds": [ # iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'

"A String",

],

},

"labels": { # See Creating and managing labels.

500

"a_key": "A String",

501

},

502

"name": "A String", # The resource name for the Key in the format "projects/{project}/keys/{key}".

503

"testingOptions": { # Options for user acceptance testing. # Options for user acceptance testing.

504

"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.

505

"testingScore": 3.14, # All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.

506

},

507

"webSettings": { # Settings specific to keys that can be used by websites. # Settings for keys that can be used by websites.

508

"allowAllDomains": True or False, # If set to true, it means allowed_domains will not be enforced.

yoshi-code-bot

a41c7b9

2021-11-02 00:26:17 -0700

[diff] [blame^]

509

"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.

yoshi-code-bot

c2cd326

2021-05-16 02:16:04 -0700

[diff] [blame]

510

"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'

511

"A String",

512

],

513

"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.

514

"integrationType": "A String", # Required. Describes how this key is integrated with the website.

},

}</pre>

</div>

</body></html>