File: androidpublisher_v3.edits.tracks.html

package info (click to toggle)
python-googleapi 2.180.0-1
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 527,124 kB
  • sloc: python: 11,076; javascript: 249; sh: 114; makefile: 59
file content (393 lines) | stat: -rw-r--r-- 24,032 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="androidpublisher_v3.html">Google Play Android Developer API</a> . <a href="androidpublisher_v3.edits.html">edits</a> . <a href="androidpublisher_v3.edits.tracks.html">tracks</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#create">create(packageName, editId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new track.</p>
<p class="toc_element">
  <code><a href="#get">get(packageName, editId, track, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a track.</p>
<p class="toc_element">
  <code><a href="#list">list(packageName, editId, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all tracks.</p>
<p class="toc_element">
  <code><a href="#patch">patch(packageName, editId, track, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Patches a track.</p>
<p class="toc_element">
  <code><a href="#update">update(packageName, editId, track, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a track.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="create">create(packageName, editId, body=None, x__xgafv=None)</code>
  <pre>Creates a new track.

Args:
  packageName: string, Required. Package name of the app. (required)
  editId: string, Required. Identifier of the edit. (required)
  body: object, The request body.
    The object takes the form of:

{ # Configurations of the new track.
  &quot;formFactor&quot;: &quot;A String&quot;, # Required. Form factor of the new track. Defaults to the default track.
  &quot;track&quot;: &quot;A String&quot;, # Required. Identifier of the new track. For default tracks, this field consists of the track alias only. Form factor tracks have a special prefix as an identifier, for example `wear:production`, `automotive:production`. This prefix must match the value of the `form_factor` field, if it is not a default track. [More on track name](https://developers.google.com/android-publisher/tracks#ff-track-name)
  &quot;type&quot;: &quot;A String&quot;, # Required. Type of the new track. Currently, the only supported value is closedTesting.
}

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

Returns:
  An object of the form:

    { # A track configuration. The resource for TracksService.
  &quot;releases&quot;: [ # In a read request, represents all active releases in the track. In an update request, represents desired changes.
    { # A release within a track.
      &quot;countryTargeting&quot;: { # Country targeting specification. # Restricts a release to a specific set of countries. Note this is only allowed to be set for inProgress releases in the production track.
        &quot;countries&quot;: [ # Countries to target, specified as two letter [CLDR codes](https://unicode.org/cldr/charts/latest/supplemental/territory_containment_un_m_49.html).
          &quot;A String&quot;,
        ],
        &quot;includeRestOfWorld&quot;: True or False, # Include &quot;rest of world&quot; as well as explicitly targeted countries.
      },
      &quot;inAppUpdatePriority&quot;: 42, # In-app update priority of the release. All newly added APKs in the release will be considered at this priority. Can take values in the range [0, 5], with 5 the highest priority. Defaults to 0. in_app_update_priority can not be updated once the release is rolled out. See https://developer.android.com/guide/playcore/in-app-updates.
      &quot;name&quot;: &quot;A String&quot;, # The release name. Not required to be unique. If not set, the name is generated from the APK&#x27;s version_name. If the release contains multiple APKs, the name is generated from the date.
      &quot;releaseNotes&quot;: [ # A description of what is new in this release.
        { # Localized text in given language.
          &quot;language&quot;: &quot;A String&quot;, # Language localization code (a BCP-47 language tag; for example, &quot;de-AT&quot; for Austrian German).
          &quot;text&quot;: &quot;A String&quot;, # The text in the given language.
        },
      ],
      &quot;status&quot;: &quot;A String&quot;, # The status of the release.
      &quot;userFraction&quot;: 3.14, # Fraction of users who are eligible for a staged release. 0 &lt; fraction &lt; 1. Can only be set when status is &quot;inProgress&quot; or &quot;halted&quot;.
      &quot;versionCodes&quot;: [ # Version codes of all APKs in the release. Must include version codes to retain from previous releases.
        &quot;A String&quot;,
      ],
    },
  ],
  &quot;track&quot;: &quot;A String&quot;, # Identifier of the track. Form factor tracks have a special prefix as an identifier, for example `wear:production`, `automotive:production`. [More on track name](https://developers.google.com/android-publisher/tracks#ff-track-name)
}</pre>
</div>

<div class="method">
    <code class="details" id="get">get(packageName, editId, track, x__xgafv=None)</code>
  <pre>Gets a track.

Args:
  packageName: string, Package name of the app. (required)
  editId: string, Identifier of the edit. (required)
  track: string, Identifier of the track. [More on track name](https://developers.google.com/android-publisher/tracks#ff-track-name) (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A track configuration. The resource for TracksService.
  &quot;releases&quot;: [ # In a read request, represents all active releases in the track. In an update request, represents desired changes.
    { # A release within a track.
      &quot;countryTargeting&quot;: { # Country targeting specification. # Restricts a release to a specific set of countries. Note this is only allowed to be set for inProgress releases in the production track.
        &quot;countries&quot;: [ # Countries to target, specified as two letter [CLDR codes](https://unicode.org/cldr/charts/latest/supplemental/territory_containment_un_m_49.html).
          &quot;A String&quot;,
        ],
        &quot;includeRestOfWorld&quot;: True or False, # Include &quot;rest of world&quot; as well as explicitly targeted countries.
      },
      &quot;inAppUpdatePriority&quot;: 42, # In-app update priority of the release. All newly added APKs in the release will be considered at this priority. Can take values in the range [0, 5], with 5 the highest priority. Defaults to 0. in_app_update_priority can not be updated once the release is rolled out. See https://developer.android.com/guide/playcore/in-app-updates.
      &quot;name&quot;: &quot;A String&quot;, # The release name. Not required to be unique. If not set, the name is generated from the APK&#x27;s version_name. If the release contains multiple APKs, the name is generated from the date.
      &quot;releaseNotes&quot;: [ # A description of what is new in this release.
        { # Localized text in given language.
          &quot;language&quot;: &quot;A String&quot;, # Language localization code (a BCP-47 language tag; for example, &quot;de-AT&quot; for Austrian German).
          &quot;text&quot;: &quot;A String&quot;, # The text in the given language.
        },
      ],
      &quot;status&quot;: &quot;A String&quot;, # The status of the release.
      &quot;userFraction&quot;: 3.14, # Fraction of users who are eligible for a staged release. 0 &lt; fraction &lt; 1. Can only be set when status is &quot;inProgress&quot; or &quot;halted&quot;.
      &quot;versionCodes&quot;: [ # Version codes of all APKs in the release. Must include version codes to retain from previous releases.
        &quot;A String&quot;,
      ],
    },
  ],
  &quot;track&quot;: &quot;A String&quot;, # Identifier of the track. Form factor tracks have a special prefix as an identifier, for example `wear:production`, `automotive:production`. [More on track name](https://developers.google.com/android-publisher/tracks#ff-track-name)
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(packageName, editId, x__xgafv=None)</code>
  <pre>Lists all tracks.

Args:
  packageName: string, Package name of the app. (required)
  editId: string, Identifier of the edit. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response listing all tracks.
  &quot;kind&quot;: &quot;A String&quot;, # The kind of this response (&quot;androidpublisher#tracksListResponse&quot;).
  &quot;tracks&quot;: [ # All tracks (including tracks with no releases).
    { # A track configuration. The resource for TracksService.
      &quot;releases&quot;: [ # In a read request, represents all active releases in the track. In an update request, represents desired changes.
        { # A release within a track.
          &quot;countryTargeting&quot;: { # Country targeting specification. # Restricts a release to a specific set of countries. Note this is only allowed to be set for inProgress releases in the production track.
            &quot;countries&quot;: [ # Countries to target, specified as two letter [CLDR codes](https://unicode.org/cldr/charts/latest/supplemental/territory_containment_un_m_49.html).
              &quot;A String&quot;,
            ],
            &quot;includeRestOfWorld&quot;: True or False, # Include &quot;rest of world&quot; as well as explicitly targeted countries.
          },
          &quot;inAppUpdatePriority&quot;: 42, # In-app update priority of the release. All newly added APKs in the release will be considered at this priority. Can take values in the range [0, 5], with 5 the highest priority. Defaults to 0. in_app_update_priority can not be updated once the release is rolled out. See https://developer.android.com/guide/playcore/in-app-updates.
          &quot;name&quot;: &quot;A String&quot;, # The release name. Not required to be unique. If not set, the name is generated from the APK&#x27;s version_name. If the release contains multiple APKs, the name is generated from the date.
          &quot;releaseNotes&quot;: [ # A description of what is new in this release.
            { # Localized text in given language.
              &quot;language&quot;: &quot;A String&quot;, # Language localization code (a BCP-47 language tag; for example, &quot;de-AT&quot; for Austrian German).
              &quot;text&quot;: &quot;A String&quot;, # The text in the given language.
            },
          ],
          &quot;status&quot;: &quot;A String&quot;, # The status of the release.
          &quot;userFraction&quot;: 3.14, # Fraction of users who are eligible for a staged release. 0 &lt; fraction &lt; 1. Can only be set when status is &quot;inProgress&quot; or &quot;halted&quot;.
          &quot;versionCodes&quot;: [ # Version codes of all APKs in the release. Must include version codes to retain from previous releases.
            &quot;A String&quot;,
          ],
        },
      ],
      &quot;track&quot;: &quot;A String&quot;, # Identifier of the track. Form factor tracks have a special prefix as an identifier, for example `wear:production`, `automotive:production`. [More on track name](https://developers.google.com/android-publisher/tracks#ff-track-name)
    },
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="patch">patch(packageName, editId, track, body=None, x__xgafv=None)</code>
  <pre>Patches a track.

Args:
  packageName: string, Package name of the app. (required)
  editId: string, Identifier of the edit. (required)
  track: string, Identifier of the track. [More on track name](https://developers.google.com/android-publisher/tracks#ff-track-name) (required)
  body: object, The request body.
    The object takes the form of:

{ # A track configuration. The resource for TracksService.
  &quot;releases&quot;: [ # In a read request, represents all active releases in the track. In an update request, represents desired changes.
    { # A release within a track.
      &quot;countryTargeting&quot;: { # Country targeting specification. # Restricts a release to a specific set of countries. Note this is only allowed to be set for inProgress releases in the production track.
        &quot;countries&quot;: [ # Countries to target, specified as two letter [CLDR codes](https://unicode.org/cldr/charts/latest/supplemental/territory_containment_un_m_49.html).
          &quot;A String&quot;,
        ],
        &quot;includeRestOfWorld&quot;: True or False, # Include &quot;rest of world&quot; as well as explicitly targeted countries.
      },
      &quot;inAppUpdatePriority&quot;: 42, # In-app update priority of the release. All newly added APKs in the release will be considered at this priority. Can take values in the range [0, 5], with 5 the highest priority. Defaults to 0. in_app_update_priority can not be updated once the release is rolled out. See https://developer.android.com/guide/playcore/in-app-updates.
      &quot;name&quot;: &quot;A String&quot;, # The release name. Not required to be unique. If not set, the name is generated from the APK&#x27;s version_name. If the release contains multiple APKs, the name is generated from the date.
      &quot;releaseNotes&quot;: [ # A description of what is new in this release.
        { # Localized text in given language.
          &quot;language&quot;: &quot;A String&quot;, # Language localization code (a BCP-47 language tag; for example, &quot;de-AT&quot; for Austrian German).
          &quot;text&quot;: &quot;A String&quot;, # The text in the given language.
        },
      ],
      &quot;status&quot;: &quot;A String&quot;, # The status of the release.
      &quot;userFraction&quot;: 3.14, # Fraction of users who are eligible for a staged release. 0 &lt; fraction &lt; 1. Can only be set when status is &quot;inProgress&quot; or &quot;halted&quot;.
      &quot;versionCodes&quot;: [ # Version codes of all APKs in the release. Must include version codes to retain from previous releases.
        &quot;A String&quot;,
      ],
    },
  ],
  &quot;track&quot;: &quot;A String&quot;, # Identifier of the track. Form factor tracks have a special prefix as an identifier, for example `wear:production`, `automotive:production`. [More on track name](https://developers.google.com/android-publisher/tracks#ff-track-name)
}

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

Returns:
  An object of the form:

    { # A track configuration. The resource for TracksService.
  &quot;releases&quot;: [ # In a read request, represents all active releases in the track. In an update request, represents desired changes.
    { # A release within a track.
      &quot;countryTargeting&quot;: { # Country targeting specification. # Restricts a release to a specific set of countries. Note this is only allowed to be set for inProgress releases in the production track.
        &quot;countries&quot;: [ # Countries to target, specified as two letter [CLDR codes](https://unicode.org/cldr/charts/latest/supplemental/territory_containment_un_m_49.html).
          &quot;A String&quot;,
        ],
        &quot;includeRestOfWorld&quot;: True or False, # Include &quot;rest of world&quot; as well as explicitly targeted countries.
      },
      &quot;inAppUpdatePriority&quot;: 42, # In-app update priority of the release. All newly added APKs in the release will be considered at this priority. Can take values in the range [0, 5], with 5 the highest priority. Defaults to 0. in_app_update_priority can not be updated once the release is rolled out. See https://developer.android.com/guide/playcore/in-app-updates.
      &quot;name&quot;: &quot;A String&quot;, # The release name. Not required to be unique. If not set, the name is generated from the APK&#x27;s version_name. If the release contains multiple APKs, the name is generated from the date.
      &quot;releaseNotes&quot;: [ # A description of what is new in this release.
        { # Localized text in given language.
          &quot;language&quot;: &quot;A String&quot;, # Language localization code (a BCP-47 language tag; for example, &quot;de-AT&quot; for Austrian German).
          &quot;text&quot;: &quot;A String&quot;, # The text in the given language.
        },
      ],
      &quot;status&quot;: &quot;A String&quot;, # The status of the release.
      &quot;userFraction&quot;: 3.14, # Fraction of users who are eligible for a staged release. 0 &lt; fraction &lt; 1. Can only be set when status is &quot;inProgress&quot; or &quot;halted&quot;.
      &quot;versionCodes&quot;: [ # Version codes of all APKs in the release. Must include version codes to retain from previous releases.
        &quot;A String&quot;,
      ],
    },
  ],
  &quot;track&quot;: &quot;A String&quot;, # Identifier of the track. Form factor tracks have a special prefix as an identifier, for example `wear:production`, `automotive:production`. [More on track name](https://developers.google.com/android-publisher/tracks#ff-track-name)
}</pre>
</div>

<div class="method">
    <code class="details" id="update">update(packageName, editId, track, body=None, x__xgafv=None)</code>
  <pre>Updates a track.

Args:
  packageName: string, Package name of the app. (required)
  editId: string, Identifier of the edit. (required)
  track: string, Identifier of the track. [More on track name](https://developers.google.com/android-publisher/tracks#ff-track-name) (required)
  body: object, The request body.
    The object takes the form of:

{ # A track configuration. The resource for TracksService.
  &quot;releases&quot;: [ # In a read request, represents all active releases in the track. In an update request, represents desired changes.
    { # A release within a track.
      &quot;countryTargeting&quot;: { # Country targeting specification. # Restricts a release to a specific set of countries. Note this is only allowed to be set for inProgress releases in the production track.
        &quot;countries&quot;: [ # Countries to target, specified as two letter [CLDR codes](https://unicode.org/cldr/charts/latest/supplemental/territory_containment_un_m_49.html).
          &quot;A String&quot;,
        ],
        &quot;includeRestOfWorld&quot;: True or False, # Include &quot;rest of world&quot; as well as explicitly targeted countries.
      },
      &quot;inAppUpdatePriority&quot;: 42, # In-app update priority of the release. All newly added APKs in the release will be considered at this priority. Can take values in the range [0, 5], with 5 the highest priority. Defaults to 0. in_app_update_priority can not be updated once the release is rolled out. See https://developer.android.com/guide/playcore/in-app-updates.
      &quot;name&quot;: &quot;A String&quot;, # The release name. Not required to be unique. If not set, the name is generated from the APK&#x27;s version_name. If the release contains multiple APKs, the name is generated from the date.
      &quot;releaseNotes&quot;: [ # A description of what is new in this release.
        { # Localized text in given language.
          &quot;language&quot;: &quot;A String&quot;, # Language localization code (a BCP-47 language tag; for example, &quot;de-AT&quot; for Austrian German).
          &quot;text&quot;: &quot;A String&quot;, # The text in the given language.
        },
      ],
      &quot;status&quot;: &quot;A String&quot;, # The status of the release.
      &quot;userFraction&quot;: 3.14, # Fraction of users who are eligible for a staged release. 0 &lt; fraction &lt; 1. Can only be set when status is &quot;inProgress&quot; or &quot;halted&quot;.
      &quot;versionCodes&quot;: [ # Version codes of all APKs in the release. Must include version codes to retain from previous releases.
        &quot;A String&quot;,
      ],
    },
  ],
  &quot;track&quot;: &quot;A String&quot;, # Identifier of the track. Form factor tracks have a special prefix as an identifier, for example `wear:production`, `automotive:production`. [More on track name](https://developers.google.com/android-publisher/tracks#ff-track-name)
}

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

Returns:
  An object of the form:

    { # A track configuration. The resource for TracksService.
  &quot;releases&quot;: [ # In a read request, represents all active releases in the track. In an update request, represents desired changes.
    { # A release within a track.
      &quot;countryTargeting&quot;: { # Country targeting specification. # Restricts a release to a specific set of countries. Note this is only allowed to be set for inProgress releases in the production track.
        &quot;countries&quot;: [ # Countries to target, specified as two letter [CLDR codes](https://unicode.org/cldr/charts/latest/supplemental/territory_containment_un_m_49.html).
          &quot;A String&quot;,
        ],
        &quot;includeRestOfWorld&quot;: True or False, # Include &quot;rest of world&quot; as well as explicitly targeted countries.
      },
      &quot;inAppUpdatePriority&quot;: 42, # In-app update priority of the release. All newly added APKs in the release will be considered at this priority. Can take values in the range [0, 5], with 5 the highest priority. Defaults to 0. in_app_update_priority can not be updated once the release is rolled out. See https://developer.android.com/guide/playcore/in-app-updates.
      &quot;name&quot;: &quot;A String&quot;, # The release name. Not required to be unique. If not set, the name is generated from the APK&#x27;s version_name. If the release contains multiple APKs, the name is generated from the date.
      &quot;releaseNotes&quot;: [ # A description of what is new in this release.
        { # Localized text in given language.
          &quot;language&quot;: &quot;A String&quot;, # Language localization code (a BCP-47 language tag; for example, &quot;de-AT&quot; for Austrian German).
          &quot;text&quot;: &quot;A String&quot;, # The text in the given language.
        },
      ],
      &quot;status&quot;: &quot;A String&quot;, # The status of the release.
      &quot;userFraction&quot;: 3.14, # Fraction of users who are eligible for a staged release. 0 &lt; fraction &lt; 1. Can only be set when status is &quot;inProgress&quot; or &quot;halted&quot;.
      &quot;versionCodes&quot;: [ # Version codes of all APKs in the release. Must include version codes to retain from previous releases.
        &quot;A String&quot;,
      ],
    },
  ],
  &quot;track&quot;: &quot;A String&quot;, # Identifier of the track. Form factor tracks have a special prefix as an identifier, for example `wear:production`, `automotive:production`. [More on track name](https://developers.google.com/android-publisher/tracks#ff-track-name)
}</pre>
</div>

</body></html>