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>

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 will be billed as CreateAssessment calls.</p>

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.

121

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

126

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

127

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

128

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

"A String",

],

},

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

133

"a_key": "A String",

134

},

135

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

136

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

137

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

138

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

139

},

140

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

141

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

142

"allowAmpTraffic": True or False, # Required. Whether this key can be used on AMP (Accelerated Mobile Pages) websites. This can only be set for the SCORE integration type.

143

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

144

"A String",

145

],

146

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

147

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

158

159

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

160

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

161

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

166

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

167

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

168

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

"A String",

],

},

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

173

"a_key": "A String",

174

},

175

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

176

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

177

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

178

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

179

},

180

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

181

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

182

"allowAmpTraffic": True or False, # Required. Whether this key can be used on AMP (Accelerated Mobile Pages) websites. This can only be set for the SCORE integration type.

183

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

184

"A String",

185

],

186

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

187

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

194

<pre>Deletes the specified key.

195

196

Args:

197

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

198

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

205

206

{ # 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>

212

<pre>Returns the specified key.

213

214

Args:

215

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

216

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

223

224

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

225

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

226

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

231

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

232

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

233

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

"A String",

],

},

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

238

"a_key": "A String",

239

},

240

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

241

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

242

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

243

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

244

},

245

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

246

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

247

"allowAmpTraffic": True or False, # Required. Whether this key can be used on AMP (Accelerated Mobile Pages) websites. This can only be set for the SCORE integration type.

248

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

249

"A String",

250

],

251

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

252

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

259

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

260

261

Args:

262

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

263

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

270

271

{ # Metrics for a single Key.

272

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

273

{ # Metrics related to challenges.

274

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

275

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

276

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

277

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

278

},

279

],

280

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

281

{ # Metrics related to scoring.

282

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

283

"a_key": { # Score distribution.

284

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

290

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

302

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

303

304

Args:

305

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

306

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

307

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

308

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

315

316

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

317

"keys": [ # Key details.

318

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

319

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

320

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

325

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

326

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

327

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

"A String",

],

},

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

332

"a_key": "A String",

333

},

334

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

335

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

336

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

337

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

338

},

339

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

340

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

341

"allowAmpTraffic": True or False, # Required. Whether this key can be used on AMP (Accelerated Mobile Pages) websites. This can only be set for the SCORE integration type.

342

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

343

"A String",

344

],

345

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

346

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

356

<pre>Retrieves the next page of results.

357

358

Args:

359

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

360

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

361

362

Returns:

363

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

364

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>

370

<pre>Migrates an existing key from reCAPTCHA to reCAPTCHA Enterprise. Once a key is migrated, it can be used from either product. SiteVerify requests will be billed as CreateAssessment calls.

371

372

Args:

373

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

374

body: object, The request body.

375

The object takes the form of:

376

377

{ # The migrate key request message.

378

}

379

380

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

387

388

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

389

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

390

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

395

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

396

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

397

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

"A String",

],

},

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

402

"a_key": "A String",

403

},

404

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

405

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

406

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

407

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

408

},

409

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

410

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

411

"allowAmpTraffic": True or False, # Required. Whether this key can be used on AMP (Accelerated Mobile Pages) websites. This can only be set for the SCORE integration type.

412

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

413

"A String",

414

],

415

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

416

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

423

<pre>Updates the specified key.

424

425

Args:

426

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

427

body: object, The request body.

428

The object takes the form of:

429

430

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

431

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

432

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

437

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

438

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

439

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

"A String",

],

},

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

444

"a_key": "A String",

445

},

446

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

447

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

448

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

449

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

450

},

451

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

452

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

453

"allowAmpTraffic": True or False, # Required. Whether this key can be used on AMP (Accelerated Mobile Pages) websites. This can only be set for the SCORE integration type.

454

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

455

"A String",

456

],

457

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

458

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

},

}

updateMask: string, Optional. The mask to control which field of the key get updated. If the mask is not present, all fields will be updated.

463

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

470

471

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

472

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

473

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

478

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

479

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

480

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

"A String",

],

},

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

485

"a_key": "A String",

486

},

487

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

488

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

489

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

490

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

491

},

492

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

493

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

494

"allowAmpTraffic": True or False, # Required. Whether this key can be used on AMP (Accelerated Mobile Pages) websites. This can only be set for the SCORE integration type.

495

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

496

"A String",

497

],

498

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

499

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

},

}</pre>

</div>

</body></html>