blob: b51536ed064d38bb80411e7a7426059093528c80 [file] [log] [blame]
yoshi-code-botc2cd3262021-05-16 02:16:04 -07001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<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<p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
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<p class="toc_element">
84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
85<p class="firstline">Deletes the specified key.</p>
86<p class="toc_element">
87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
88<p class="firstline">Returns the specified key.</p>
89<p class="toc_element">
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<p class="toc_element">
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<p class="toc_element">
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<p class="toc_element">
99 <code><a href="#migrate">migrate(name, body=None, x__xgafv=None)</a></code></p>
yoshi-code-bot7700bbf2021-05-20 04:44:03 -0700100<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-botc2cd3262021-05-16 02:16:04 -0700101<p class="toc_element">
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<div class="method">
106 <code class="details" id="close">close()</code>
107 <pre>Close httplib2 connections.</pre>
108</div>
109
110<div class="method">
111 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
112 <pre>Creates a new reCAPTCHA Enterprise key.
113
114Args:
115 parent: string, Required. The name of the project in which the key will be created, in the format &quot;projects/{project}&quot;. (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 &quot;androidSettings&quot;: { # Settings specific to keys that can be used by Android apps. # Settings for keys that can be used by Android apps.
121 &quot;allowedPackageNames&quot;: [ # Android package names of apps allowed to use the key. Example: &#x27;com.companyname.appname&#x27;
122 &quot;A String&quot;,
123 ],
124 },
125 &quot;createTime&quot;: &quot;A String&quot;, # The timestamp corresponding to the creation of this Key.
126 &quot;displayName&quot;: &quot;A String&quot;, # Human-readable display name of this key. Modifiable by user.
127 &quot;iosSettings&quot;: { # Settings specific to keys that can be used by iOS apps. # Settings for keys that can be used by iOS apps.
128 &quot;allowedBundleIds&quot;: [ # iOS bundle ids of apps allowed to use the key. Example: &#x27;com.companyname.productname.appname&#x27;
129 &quot;A String&quot;,
130 ],
131 },
132 &quot;labels&quot;: { # See Creating and managing labels.
133 &quot;a_key&quot;: &quot;A String&quot;,
134 },
135 &quot;name&quot;: &quot;A String&quot;, # The resource name for the Key in the format &quot;projects/{project}/keys/{key}&quot;.
136 &quot;testingOptions&quot;: { # Options for user acceptance testing. # Options for user acceptance testing.
137 &quot;testingChallenge&quot;: &quot;A String&quot;, # 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 &quot;testingScore&quot;: 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 &quot;webSettings&quot;: { # Settings specific to keys that can be used by websites. # Settings for keys that can be used by websites.
141 &quot;allowAllDomains&quot;: True or False, # If set to true, it means allowed_domains will not be enforced.
142 &quot;allowAmpTraffic&quot;: 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 &quot;allowedDomains&quot;: [ # 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: &#x27;example.com&#x27; or &#x27;subdomain.example.com&#x27;
144 &quot;A String&quot;,
145 ],
146 &quot;challengeSecurityPreference&quot;: &quot;A String&quot;, # Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE.
147 &quot;integrationType&quot;: &quot;A String&quot;, # Required. Describes how this key is integrated with the website.
148 },
149}
150
151 x__xgafv: string, V1 error format.
152 Allowed values
153 1 - v1 error format
154 2 - v2 error format
155
156Returns:
157 An object of the form:
158
159 { # A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.
160 &quot;androidSettings&quot;: { # Settings specific to keys that can be used by Android apps. # Settings for keys that can be used by Android apps.
161 &quot;allowedPackageNames&quot;: [ # Android package names of apps allowed to use the key. Example: &#x27;com.companyname.appname&#x27;
162 &quot;A String&quot;,
163 ],
164 },
165 &quot;createTime&quot;: &quot;A String&quot;, # The timestamp corresponding to the creation of this Key.
166 &quot;displayName&quot;: &quot;A String&quot;, # Human-readable display name of this key. Modifiable by user.
167 &quot;iosSettings&quot;: { # Settings specific to keys that can be used by iOS apps. # Settings for keys that can be used by iOS apps.
168 &quot;allowedBundleIds&quot;: [ # iOS bundle ids of apps allowed to use the key. Example: &#x27;com.companyname.productname.appname&#x27;
169 &quot;A String&quot;,
170 ],
171 },
172 &quot;labels&quot;: { # See Creating and managing labels.
173 &quot;a_key&quot;: &quot;A String&quot;,
174 },
175 &quot;name&quot;: &quot;A String&quot;, # The resource name for the Key in the format &quot;projects/{project}/keys/{key}&quot;.
176 &quot;testingOptions&quot;: { # Options for user acceptance testing. # Options for user acceptance testing.
177 &quot;testingChallenge&quot;: &quot;A String&quot;, # 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 &quot;testingScore&quot;: 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 &quot;webSettings&quot;: { # Settings specific to keys that can be used by websites. # Settings for keys that can be used by websites.
181 &quot;allowAllDomains&quot;: True or False, # If set to true, it means allowed_domains will not be enforced.
182 &quot;allowAmpTraffic&quot;: 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 &quot;allowedDomains&quot;: [ # 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: &#x27;example.com&#x27; or &#x27;subdomain.example.com&#x27;
184 &quot;A String&quot;,
185 ],
186 &quot;challengeSecurityPreference&quot;: &quot;A String&quot;, # Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE.
187 &quot;integrationType&quot;: &quot;A String&quot;, # Required. Describes how this key is integrated with the website.
188 },
189}</pre>
190</div>
191
192<div class="method">
193 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
194 <pre>Deletes the specified key.
195
196Args:
197 name: string, Required. The name of the key to be deleted, in the format &quot;projects/{project}/keys/{key}&quot;. (required)
198 x__xgafv: string, V1 error format.
199 Allowed values
200 1 - v1 error format
201 2 - v2 error format
202
203Returns:
204 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 `{}`.
207}</pre>
208</div>
209
210<div class="method">
211 <code class="details" id="get">get(name, x__xgafv=None)</code>
212 <pre>Returns the specified key.
213
214Args:
215 name: string, Required. The name of the requested key, in the format &quot;projects/{project}/keys/{key}&quot;. (required)
216 x__xgafv: string, V1 error format.
217 Allowed values
218 1 - v1 error format
219 2 - v2 error format
220
221Returns:
222 An object of the form:
223
224 { # A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.
225 &quot;androidSettings&quot;: { # Settings specific to keys that can be used by Android apps. # Settings for keys that can be used by Android apps.
226 &quot;allowedPackageNames&quot;: [ # Android package names of apps allowed to use the key. Example: &#x27;com.companyname.appname&#x27;
227 &quot;A String&quot;,
228 ],
229 },
230 &quot;createTime&quot;: &quot;A String&quot;, # The timestamp corresponding to the creation of this Key.
231 &quot;displayName&quot;: &quot;A String&quot;, # Human-readable display name of this key. Modifiable by user.
232 &quot;iosSettings&quot;: { # Settings specific to keys that can be used by iOS apps. # Settings for keys that can be used by iOS apps.
233 &quot;allowedBundleIds&quot;: [ # iOS bundle ids of apps allowed to use the key. Example: &#x27;com.companyname.productname.appname&#x27;
234 &quot;A String&quot;,
235 ],
236 },
237 &quot;labels&quot;: { # See Creating and managing labels.
238 &quot;a_key&quot;: &quot;A String&quot;,
239 },
240 &quot;name&quot;: &quot;A String&quot;, # The resource name for the Key in the format &quot;projects/{project}/keys/{key}&quot;.
241 &quot;testingOptions&quot;: { # Options for user acceptance testing. # Options for user acceptance testing.
242 &quot;testingChallenge&quot;: &quot;A String&quot;, # 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 &quot;testingScore&quot;: 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 &quot;webSettings&quot;: { # Settings specific to keys that can be used by websites. # Settings for keys that can be used by websites.
246 &quot;allowAllDomains&quot;: True or False, # If set to true, it means allowed_domains will not be enforced.
247 &quot;allowAmpTraffic&quot;: 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 &quot;allowedDomains&quot;: [ # 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: &#x27;example.com&#x27; or &#x27;subdomain.example.com&#x27;
249 &quot;A String&quot;,
250 ],
251 &quot;challengeSecurityPreference&quot;: &quot;A String&quot;, # Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE.
252 &quot;integrationType&quot;: &quot;A String&quot;, # Required. Describes how this key is integrated with the website.
253 },
254}</pre>
255</div>
256
257<div class="method">
258 <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
261Args:
262 name: string, Required. The name of the requested metrics, in the format &quot;projects/{project}/keys/{key}/metrics&quot;. (required)
263 x__xgafv: string, V1 error format.
264 Allowed values
265 1 - v1 error format
266 2 - v2 error format
267
268Returns:
269 An object of the form:
270
271 { # Metrics for a single Key.
272 &quot;challengeMetrics&quot;: [ # 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 &quot;failedCount&quot;: &quot;A String&quot;, # Count of submitted challenge solutions that were incorrect or otherwise deemed suspicious such that a subsequent challenge was triggered.
275 &quot;nocaptchaCount&quot;: &quot;A String&quot;, # Count of nocaptchas (successful verification without a challenge) issued.
276 &quot;pageloadCount&quot;: &quot;A String&quot;, # Count of reCAPTCHA checkboxes or badges rendered. This is mostly equivalent to a count of pageloads for pages that include reCAPTCHA.
277 &quot;passedCount&quot;: &quot;A String&quot;, # Count of nocaptchas (successful verification without a challenge) plus submitted challenge solutions that were correct and resulted in verification.
278 },
279 ],
280 &quot;scoreMetrics&quot;: [ # 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 &quot;actionMetrics&quot;: { # Action-based metrics. The map key is the action name which specified by the site owners at time of the &quot;execute&quot; client-side call. Populated only for SCORE keys.
283 &quot;a_key&quot;: { # Score distribution.
284 &quot;scoreBuckets&quot;: { # 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).
285 &quot;a_key&quot;: &quot;A String&quot;,
286 },
287 },
288 },
289 &quot;overallMetrics&quot;: { # Score distribution. # Aggregated score metrics for all traffic.
290 &quot;scoreBuckets&quot;: { # 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).
291 &quot;a_key&quot;: &quot;A String&quot;,
292 },
293 },
294 },
295 ],
296 &quot;startTime&quot;: &quot;A String&quot;, # Inclusive start time aligned to a day (UTC).
297}</pre>
298</div>
299
300<div class="method">
301 <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
304Args:
305 parent: string, Required. The name of the project that contains the keys that will be listed, in the format &quot;projects/{project}&quot;. (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.
309 Allowed values
310 1 - v1 error format
311 2 - v2 error format
312
313Returns:
314 An object of the form:
315
316 { # Response to request to list keys in a project.
317 &quot;keys&quot;: [ # Key details.
318 { # A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.
319 &quot;androidSettings&quot;: { # Settings specific to keys that can be used by Android apps. # Settings for keys that can be used by Android apps.
320 &quot;allowedPackageNames&quot;: [ # Android package names of apps allowed to use the key. Example: &#x27;com.companyname.appname&#x27;
321 &quot;A String&quot;,
322 ],
323 },
324 &quot;createTime&quot;: &quot;A String&quot;, # The timestamp corresponding to the creation of this Key.
325 &quot;displayName&quot;: &quot;A String&quot;, # Human-readable display name of this key. Modifiable by user.
326 &quot;iosSettings&quot;: { # Settings specific to keys that can be used by iOS apps. # Settings for keys that can be used by iOS apps.
327 &quot;allowedBundleIds&quot;: [ # iOS bundle ids of apps allowed to use the key. Example: &#x27;com.companyname.productname.appname&#x27;
328 &quot;A String&quot;,
329 ],
330 },
331 &quot;labels&quot;: { # See Creating and managing labels.
332 &quot;a_key&quot;: &quot;A String&quot;,
333 },
334 &quot;name&quot;: &quot;A String&quot;, # The resource name for the Key in the format &quot;projects/{project}/keys/{key}&quot;.
335 &quot;testingOptions&quot;: { # Options for user acceptance testing. # Options for user acceptance testing.
336 &quot;testingChallenge&quot;: &quot;A String&quot;, # 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 &quot;testingScore&quot;: 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 &quot;webSettings&quot;: { # Settings specific to keys that can be used by websites. # Settings for keys that can be used by websites.
340 &quot;allowAllDomains&quot;: True or False, # If set to true, it means allowed_domains will not be enforced.
341 &quot;allowAmpTraffic&quot;: 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 &quot;allowedDomains&quot;: [ # 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: &#x27;example.com&#x27; or &#x27;subdomain.example.com&#x27;
343 &quot;A String&quot;,
344 ],
345 &quot;challengeSecurityPreference&quot;: &quot;A String&quot;, # Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE.
346 &quot;integrationType&quot;: &quot;A String&quot;, # Required. Describes how this key is integrated with the website.
347 },
348 },
349 ],
350 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results. It is set to empty if no keys remain in results.
351}</pre>
352</div>
353
354<div class="method">
355 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
356 <pre>Retrieves the next page of results.
357
358Args:
359 previous_request: The request for the previous page. (required)
360 previous_response: The response from the request for the previous page. (required)
361
362Returns:
363 A request object that you can call &#x27;execute()&#x27; on to request the next
364 page. Returns None if there are no more items in the collection.
365 </pre>
366</div>
367
368<div class="method">
369 <code class="details" id="migrate">migrate(name, body=None, x__xgafv=None)</code>
yoshi-code-bot7700bbf2021-05-20 04:44:03 -0700370 <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-botc2cd3262021-05-16 02:16:04 -0700371
372Args:
373 name: string, Required. The name of the key to be migrated, in the format &quot;projects/{project}/keys/{key}&quot;. (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.
381 Allowed values
382 1 - v1 error format
383 2 - v2 error format
384
385Returns:
386 An object of the form:
387
388 { # A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.
389 &quot;androidSettings&quot;: { # Settings specific to keys that can be used by Android apps. # Settings for keys that can be used by Android apps.
390 &quot;allowedPackageNames&quot;: [ # Android package names of apps allowed to use the key. Example: &#x27;com.companyname.appname&#x27;
391 &quot;A String&quot;,
392 ],
393 },
394 &quot;createTime&quot;: &quot;A String&quot;, # The timestamp corresponding to the creation of this Key.
395 &quot;displayName&quot;: &quot;A String&quot;, # Human-readable display name of this key. Modifiable by user.
396 &quot;iosSettings&quot;: { # Settings specific to keys that can be used by iOS apps. # Settings for keys that can be used by iOS apps.
397 &quot;allowedBundleIds&quot;: [ # iOS bundle ids of apps allowed to use the key. Example: &#x27;com.companyname.productname.appname&#x27;
398 &quot;A String&quot;,
399 ],
400 },
401 &quot;labels&quot;: { # See Creating and managing labels.
402 &quot;a_key&quot;: &quot;A String&quot;,
403 },
404 &quot;name&quot;: &quot;A String&quot;, # The resource name for the Key in the format &quot;projects/{project}/keys/{key}&quot;.
405 &quot;testingOptions&quot;: { # Options for user acceptance testing. # Options for user acceptance testing.
406 &quot;testingChallenge&quot;: &quot;A String&quot;, # 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 &quot;testingScore&quot;: 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 &quot;webSettings&quot;: { # Settings specific to keys that can be used by websites. # Settings for keys that can be used by websites.
410 &quot;allowAllDomains&quot;: True or False, # If set to true, it means allowed_domains will not be enforced.
411 &quot;allowAmpTraffic&quot;: 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 &quot;allowedDomains&quot;: [ # 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: &#x27;example.com&#x27; or &#x27;subdomain.example.com&#x27;
413 &quot;A String&quot;,
414 ],
415 &quot;challengeSecurityPreference&quot;: &quot;A String&quot;, # Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE.
416 &quot;integrationType&quot;: &quot;A String&quot;, # Required. Describes how this key is integrated with the website.
417 },
418}</pre>
419</div>
420
421<div class="method">
422 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
423 <pre>Updates the specified key.
424
425Args:
426 name: string, The resource name for the Key in the format &quot;projects/{project}/keys/{key}&quot;. (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 &quot;androidSettings&quot;: { # Settings specific to keys that can be used by Android apps. # Settings for keys that can be used by Android apps.
432 &quot;allowedPackageNames&quot;: [ # Android package names of apps allowed to use the key. Example: &#x27;com.companyname.appname&#x27;
433 &quot;A String&quot;,
434 ],
435 },
436 &quot;createTime&quot;: &quot;A String&quot;, # The timestamp corresponding to the creation of this Key.
437 &quot;displayName&quot;: &quot;A String&quot;, # Human-readable display name of this key. Modifiable by user.
438 &quot;iosSettings&quot;: { # Settings specific to keys that can be used by iOS apps. # Settings for keys that can be used by iOS apps.
439 &quot;allowedBundleIds&quot;: [ # iOS bundle ids of apps allowed to use the key. Example: &#x27;com.companyname.productname.appname&#x27;
440 &quot;A String&quot;,
441 ],
442 },
443 &quot;labels&quot;: { # See Creating and managing labels.
444 &quot;a_key&quot;: &quot;A String&quot;,
445 },
446 &quot;name&quot;: &quot;A String&quot;, # The resource name for the Key in the format &quot;projects/{project}/keys/{key}&quot;.
447 &quot;testingOptions&quot;: { # Options for user acceptance testing. # Options for user acceptance testing.
448 &quot;testingChallenge&quot;: &quot;A String&quot;, # 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 &quot;testingScore&quot;: 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 &quot;webSettings&quot;: { # Settings specific to keys that can be used by websites. # Settings for keys that can be used by websites.
452 &quot;allowAllDomains&quot;: True or False, # If set to true, it means allowed_domains will not be enforced.
453 &quot;allowAmpTraffic&quot;: 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 &quot;allowedDomains&quot;: [ # 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: &#x27;example.com&#x27; or &#x27;subdomain.example.com&#x27;
455 &quot;A String&quot;,
456 ],
457 &quot;challengeSecurityPreference&quot;: &quot;A String&quot;, # Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE.
458 &quot;integrationType&quot;: &quot;A String&quot;, # Required. Describes how this key is integrated with the website.
459 },
460}
461
yoshi-code-bot7700bbf2021-05-20 04:44:03 -0700462 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-botc2cd3262021-05-16 02:16:04 -0700463 x__xgafv: string, V1 error format.
464 Allowed values
465 1 - v1 error format
466 2 - v2 error format
467
468Returns:
469 An object of the form:
470
471 { # A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.
472 &quot;androidSettings&quot;: { # Settings specific to keys that can be used by Android apps. # Settings for keys that can be used by Android apps.
473 &quot;allowedPackageNames&quot;: [ # Android package names of apps allowed to use the key. Example: &#x27;com.companyname.appname&#x27;
474 &quot;A String&quot;,
475 ],
476 },
477 &quot;createTime&quot;: &quot;A String&quot;, # The timestamp corresponding to the creation of this Key.
478 &quot;displayName&quot;: &quot;A String&quot;, # Human-readable display name of this key. Modifiable by user.
479 &quot;iosSettings&quot;: { # Settings specific to keys that can be used by iOS apps. # Settings for keys that can be used by iOS apps.
480 &quot;allowedBundleIds&quot;: [ # iOS bundle ids of apps allowed to use the key. Example: &#x27;com.companyname.productname.appname&#x27;
481 &quot;A String&quot;,
482 ],
483 },
484 &quot;labels&quot;: { # See Creating and managing labels.
485 &quot;a_key&quot;: &quot;A String&quot;,
486 },
487 &quot;name&quot;: &quot;A String&quot;, # The resource name for the Key in the format &quot;projects/{project}/keys/{key}&quot;.
488 &quot;testingOptions&quot;: { # Options for user acceptance testing. # Options for user acceptance testing.
489 &quot;testingChallenge&quot;: &quot;A String&quot;, # 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 &quot;testingScore&quot;: 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 &quot;webSettings&quot;: { # Settings specific to keys that can be used by websites. # Settings for keys that can be used by websites.
493 &quot;allowAllDomains&quot;: True or False, # If set to true, it means allowed_domains will not be enforced.
494 &quot;allowAmpTraffic&quot;: 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 &quot;allowedDomains&quot;: [ # 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: &#x27;example.com&#x27; or &#x27;subdomain.example.com&#x27;
496 &quot;A String&quot;,
497 ],
498 &quot;challengeSecurityPreference&quot;: &quot;A String&quot;, # Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE.
499 &quot;integrationType&quot;: &quot;A String&quot;, # Required. Describes how this key is integrated with the website.
500 },
501}</pre>
502</div>
503
504</body></html>