| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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="androidpublisher_v3.html">Google Play Developer API</a> . <a href="androidpublisher_v3.edits.html">edits</a> . <a href="androidpublisher_v3.edits.tracks.html">tracks</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#get">get(packageName, editId, track)</a></code></p> |
| 79 | <p class="firstline">Fetches the track configuration for the specified track type. Includes the APK version codes that are in this track.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#list">list(packageName, editId)</a></code></p> |
| 82 | <p class="firstline">Lists all the track configurations for this edit.</p> |
| 83 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 84 | <code><a href="#patch">patch(packageName, editId, track, body=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 85 | <p class="firstline">Updates the track configuration for the specified track type. This method supports patch semantics.</p> |
| 86 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 87 | <code><a href="#update">update(packageName, editId, track, body=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 88 | <p class="firstline">Updates the track configuration for the specified track type.</p> |
| 89 | <h3>Method Details</h3> |
| 90 | <div class="method"> |
| 91 | <code class="details" id="get">get(packageName, editId, track)</code> |
| 92 | <pre>Fetches the track configuration for the specified track type. Includes the APK version codes that are in this track. |
| 93 | |
| 94 | Args: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 95 | packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 96 | editId: string, Unique identifier for this edit. (required) |
| 97 | track: string, The track to read or modify. (required) |
| 98 | |
| 99 | Returns: |
| 100 | An object of the form: |
| 101 | |
| 102 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 103 | "releases": [ # A list of all active releases in this track during a read request. On an update request, it represents desired changes. |
| 104 | { |
| 105 | "controls": [ |
| 106 | { |
| 107 | "modRanges": [ |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 108 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 109 | "end": "A String", |
| 110 | "start": "A String", |
| 111 | }, |
| 112 | ], |
| 113 | "stratifiedSamplings": [ |
| 114 | { |
| 115 | "modRanges": [ |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 116 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 117 | "end": "A String", |
| 118 | "start": "A String", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 119 | }, |
| 120 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 121 | "stratum": { |
| 122 | "brand": "A String", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 123 | }, |
| 124 | }, |
| 125 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 126 | "versionCodes": [ |
| 127 | "A String", |
| 128 | ], |
| 129 | }, |
| 130 | ], |
| 131 | "countryTargeting": { |
| 132 | "countries": [ |
| 133 | "A String", |
| 134 | ], |
| 135 | "includeRestOfWorld": True or False, |
| 136 | }, |
| 137 | "inAppUpdatePriority": 42, # In-app update priority of the release. All newly added APKs in the release will be considered at this priority. in_app_update_priority can take values between [0, 5]. 5 is the highest priority. Default priority is 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. |
| 138 | "name": "A String", # The release name, used to identify this release in the Play Console UI. Not required to be unique. This is optional, if not set it will be generated from the version_name in the APKs. |
| 139 | "pinnedVersions": [ |
| 140 | { |
| 141 | "targetings": [ |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 142 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 143 | "countryCodes": [ |
| 144 | "A String", |
| 145 | ], |
| 146 | "devices": [ |
| 147 | { |
| 148 | "brand": "A String", |
| 149 | "device": "A String", |
| 150 | "product": "A String", |
| 151 | }, |
| 152 | ], |
| 153 | "phoneskyVersions": [ |
| 154 | "A String", |
| 155 | ], |
| 156 | "sdkVersions": [ |
| 157 | 42, |
| 158 | ], |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 159 | }, |
| 160 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 161 | "versionCodes": [ |
| 162 | "A String", |
| 163 | ], |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 164 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 165 | ], |
| 166 | "releaseNotes": [ # The description of what is new in the app in this release. |
| 167 | { |
| 168 | "language": "A String", # The language code, in BCP 47 format (eg "en-US"). |
| 169 | "text": "A String", # The text in the given `language`. |
| 170 | }, |
| 171 | ], |
| 172 | "rollbackEnabled": True or False, |
| 173 | "sampling": { |
| 174 | "modRanges": [ |
| 175 | { |
| 176 | "end": "A String", |
| 177 | "start": "A String", |
| 178 | }, |
| 179 | ], |
| 180 | "modulus": "A String", |
| 181 | "salt": 42, |
| 182 | "stratifiedSamplings": [ |
| 183 | { |
| 184 | "modRanges": [ |
| 185 | { |
| 186 | "end": "A String", |
| 187 | "start": "A String", |
| 188 | }, |
| 189 | ], |
| 190 | "stratum": { |
| 191 | "brand": "A String", |
| 192 | }, |
| 193 | }, |
| 194 | ], |
| 195 | "useAndroidId": True or False, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 196 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 197 | "status": "A String", # The desired status of this release. |
| 198 | "userFraction": 3.14, # Fraction of users who are eligible to receive the release. 0 < fraction < 1. To be set, release status must be "inProgress" or "halted". |
| 199 | "versionCodes": [ # A list of all version codes of APKs that will be exposed to the users of this track when this release is rolled out. Note that this list should contain all versions you wish to be active, including those you wish to retain from previous releases. |
| 200 | "A String", |
| 201 | ], |
| 202 | }, |
| 203 | ], |
| 204 | "track": "A String", # Identifier for this track. |
| 205 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 206 | </div> |
| 207 | |
| 208 | <div class="method"> |
| 209 | <code class="details" id="list">list(packageName, editId)</code> |
| 210 | <pre>Lists all the track configurations for this edit. |
| 211 | |
| 212 | Args: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 213 | packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 214 | editId: string, Unique identifier for this edit. (required) |
| 215 | |
| 216 | Returns: |
| 217 | An object of the form: |
| 218 | |
| 219 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 220 | "kind": "androidpublisher#tracksListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidpublisher#tracksListResponse". |
| 221 | "tracks": [ |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 222 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 223 | "releases": [ # A list of all active releases in this track during a read request. On an update request, it represents desired changes. |
| 224 | { |
| 225 | "controls": [ |
| 226 | { |
| 227 | "modRanges": [ |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 228 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 229 | "end": "A String", |
| 230 | "start": "A String", |
| 231 | }, |
| 232 | ], |
| 233 | "stratifiedSamplings": [ |
| 234 | { |
| 235 | "modRanges": [ |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 236 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 237 | "end": "A String", |
| 238 | "start": "A String", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 239 | }, |
| 240 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 241 | "stratum": { |
| 242 | "brand": "A String", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 243 | }, |
| 244 | }, |
| 245 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 246 | "versionCodes": [ |
| 247 | "A String", |
| 248 | ], |
| 249 | }, |
| 250 | ], |
| 251 | "countryTargeting": { |
| 252 | "countries": [ |
| 253 | "A String", |
| 254 | ], |
| 255 | "includeRestOfWorld": True or False, |
| 256 | }, |
| 257 | "inAppUpdatePriority": 42, # In-app update priority of the release. All newly added APKs in the release will be considered at this priority. in_app_update_priority can take values between [0, 5]. 5 is the highest priority. Default priority is 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. |
| 258 | "name": "A String", # The release name, used to identify this release in the Play Console UI. Not required to be unique. This is optional, if not set it will be generated from the version_name in the APKs. |
| 259 | "pinnedVersions": [ |
| 260 | { |
| 261 | "targetings": [ |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 262 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 263 | "countryCodes": [ |
| 264 | "A String", |
| 265 | ], |
| 266 | "devices": [ |
| 267 | { |
| 268 | "brand": "A String", |
| 269 | "device": "A String", |
| 270 | "product": "A String", |
| 271 | }, |
| 272 | ], |
| 273 | "phoneskyVersions": [ |
| 274 | "A String", |
| 275 | ], |
| 276 | "sdkVersions": [ |
| 277 | 42, |
| 278 | ], |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 279 | }, |
| 280 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 281 | "versionCodes": [ |
| 282 | "A String", |
| 283 | ], |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 284 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 285 | ], |
| 286 | "releaseNotes": [ # The description of what is new in the app in this release. |
| 287 | { |
| 288 | "language": "A String", # The language code, in BCP 47 format (eg "en-US"). |
| 289 | "text": "A String", # The text in the given `language`. |
| 290 | }, |
| 291 | ], |
| 292 | "rollbackEnabled": True or False, |
| 293 | "sampling": { |
| 294 | "modRanges": [ |
| 295 | { |
| 296 | "end": "A String", |
| 297 | "start": "A String", |
| 298 | }, |
| 299 | ], |
| 300 | "modulus": "A String", |
| 301 | "salt": 42, |
| 302 | "stratifiedSamplings": [ |
| 303 | { |
| 304 | "modRanges": [ |
| 305 | { |
| 306 | "end": "A String", |
| 307 | "start": "A String", |
| 308 | }, |
| 309 | ], |
| 310 | "stratum": { |
| 311 | "brand": "A String", |
| 312 | }, |
| 313 | }, |
| 314 | ], |
| 315 | "useAndroidId": True or False, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 316 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 317 | "status": "A String", # The desired status of this release. |
| 318 | "userFraction": 3.14, # Fraction of users who are eligible to receive the release. 0 < fraction < 1. To be set, release status must be "inProgress" or "halted". |
| 319 | "versionCodes": [ # A list of all version codes of APKs that will be exposed to the users of this track when this release is rolled out. Note that this list should contain all versions you wish to be active, including those you wish to retain from previous releases. |
| 320 | "A String", |
| 321 | ], |
| 322 | }, |
| 323 | ], |
| 324 | "track": "A String", # Identifier for this track. |
| 325 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 326 | ], |
| 327 | }</pre> |
| 328 | </div> |
| 329 | |
| 330 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 331 | <code class="details" id="patch">patch(packageName, editId, track, body=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 332 | <pre>Updates the track configuration for the specified track type. This method supports patch semantics. |
| 333 | |
| 334 | Args: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 335 | packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 336 | editId: string, Unique identifier for this edit. (required) |
| 337 | track: string, The track to read or modify. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 338 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 339 | The object takes the form of: |
| 340 | |
| 341 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 342 | "releases": [ # A list of all active releases in this track during a read request. On an update request, it represents desired changes. |
| 343 | { |
| 344 | "controls": [ |
| 345 | { |
| 346 | "modRanges": [ |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 347 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 348 | "end": "A String", |
| 349 | "start": "A String", |
| 350 | }, |
| 351 | ], |
| 352 | "stratifiedSamplings": [ |
| 353 | { |
| 354 | "modRanges": [ |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 355 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 356 | "end": "A String", |
| 357 | "start": "A String", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 358 | }, |
| 359 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 360 | "stratum": { |
| 361 | "brand": "A String", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 362 | }, |
| 363 | }, |
| 364 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 365 | "versionCodes": [ |
| 366 | "A String", |
| 367 | ], |
| 368 | }, |
| 369 | ], |
| 370 | "countryTargeting": { |
| 371 | "countries": [ |
| 372 | "A String", |
| 373 | ], |
| 374 | "includeRestOfWorld": True or False, |
| 375 | }, |
| 376 | "inAppUpdatePriority": 42, # In-app update priority of the release. All newly added APKs in the release will be considered at this priority. in_app_update_priority can take values between [0, 5]. 5 is the highest priority. Default priority is 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. |
| 377 | "name": "A String", # The release name, used to identify this release in the Play Console UI. Not required to be unique. This is optional, if not set it will be generated from the version_name in the APKs. |
| 378 | "pinnedVersions": [ |
| 379 | { |
| 380 | "targetings": [ |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 381 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 382 | "countryCodes": [ |
| 383 | "A String", |
| 384 | ], |
| 385 | "devices": [ |
| 386 | { |
| 387 | "brand": "A String", |
| 388 | "device": "A String", |
| 389 | "product": "A String", |
| 390 | }, |
| 391 | ], |
| 392 | "phoneskyVersions": [ |
| 393 | "A String", |
| 394 | ], |
| 395 | "sdkVersions": [ |
| 396 | 42, |
| 397 | ], |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 398 | }, |
| 399 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 400 | "versionCodes": [ |
| 401 | "A String", |
| 402 | ], |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 403 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 404 | ], |
| 405 | "releaseNotes": [ # The description of what is new in the app in this release. |
| 406 | { |
| 407 | "language": "A String", # The language code, in BCP 47 format (eg "en-US"). |
| 408 | "text": "A String", # The text in the given `language`. |
| 409 | }, |
| 410 | ], |
| 411 | "rollbackEnabled": True or False, |
| 412 | "sampling": { |
| 413 | "modRanges": [ |
| 414 | { |
| 415 | "end": "A String", |
| 416 | "start": "A String", |
| 417 | }, |
| 418 | ], |
| 419 | "modulus": "A String", |
| 420 | "salt": 42, |
| 421 | "stratifiedSamplings": [ |
| 422 | { |
| 423 | "modRanges": [ |
| 424 | { |
| 425 | "end": "A String", |
| 426 | "start": "A String", |
| 427 | }, |
| 428 | ], |
| 429 | "stratum": { |
| 430 | "brand": "A String", |
| 431 | }, |
| 432 | }, |
| 433 | ], |
| 434 | "useAndroidId": True or False, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 435 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 436 | "status": "A String", # The desired status of this release. |
| 437 | "userFraction": 3.14, # Fraction of users who are eligible to receive the release. 0 < fraction < 1. To be set, release status must be "inProgress" or "halted". |
| 438 | "versionCodes": [ # A list of all version codes of APKs that will be exposed to the users of this track when this release is rolled out. Note that this list should contain all versions you wish to be active, including those you wish to retain from previous releases. |
| 439 | "A String", |
| 440 | ], |
| 441 | }, |
| 442 | ], |
| 443 | "track": "A String", # Identifier for this track. |
| 444 | } |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 445 | |
| 446 | |
| 447 | Returns: |
| 448 | An object of the form: |
| 449 | |
| 450 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 451 | "releases": [ # A list of all active releases in this track during a read request. On an update request, it represents desired changes. |
| 452 | { |
| 453 | "controls": [ |
| 454 | { |
| 455 | "modRanges": [ |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 456 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 457 | "end": "A String", |
| 458 | "start": "A String", |
| 459 | }, |
| 460 | ], |
| 461 | "stratifiedSamplings": [ |
| 462 | { |
| 463 | "modRanges": [ |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 464 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 465 | "end": "A String", |
| 466 | "start": "A String", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 467 | }, |
| 468 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 469 | "stratum": { |
| 470 | "brand": "A String", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 471 | }, |
| 472 | }, |
| 473 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 474 | "versionCodes": [ |
| 475 | "A String", |
| 476 | ], |
| 477 | }, |
| 478 | ], |
| 479 | "countryTargeting": { |
| 480 | "countries": [ |
| 481 | "A String", |
| 482 | ], |
| 483 | "includeRestOfWorld": True or False, |
| 484 | }, |
| 485 | "inAppUpdatePriority": 42, # In-app update priority of the release. All newly added APKs in the release will be considered at this priority. in_app_update_priority can take values between [0, 5]. 5 is the highest priority. Default priority is 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. |
| 486 | "name": "A String", # The release name, used to identify this release in the Play Console UI. Not required to be unique. This is optional, if not set it will be generated from the version_name in the APKs. |
| 487 | "pinnedVersions": [ |
| 488 | { |
| 489 | "targetings": [ |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 490 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 491 | "countryCodes": [ |
| 492 | "A String", |
| 493 | ], |
| 494 | "devices": [ |
| 495 | { |
| 496 | "brand": "A String", |
| 497 | "device": "A String", |
| 498 | "product": "A String", |
| 499 | }, |
| 500 | ], |
| 501 | "phoneskyVersions": [ |
| 502 | "A String", |
| 503 | ], |
| 504 | "sdkVersions": [ |
| 505 | 42, |
| 506 | ], |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 507 | }, |
| 508 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 509 | "versionCodes": [ |
| 510 | "A String", |
| 511 | ], |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 512 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 513 | ], |
| 514 | "releaseNotes": [ # The description of what is new in the app in this release. |
| 515 | { |
| 516 | "language": "A String", # The language code, in BCP 47 format (eg "en-US"). |
| 517 | "text": "A String", # The text in the given `language`. |
| 518 | }, |
| 519 | ], |
| 520 | "rollbackEnabled": True or False, |
| 521 | "sampling": { |
| 522 | "modRanges": [ |
| 523 | { |
| 524 | "end": "A String", |
| 525 | "start": "A String", |
| 526 | }, |
| 527 | ], |
| 528 | "modulus": "A String", |
| 529 | "salt": 42, |
| 530 | "stratifiedSamplings": [ |
| 531 | { |
| 532 | "modRanges": [ |
| 533 | { |
| 534 | "end": "A String", |
| 535 | "start": "A String", |
| 536 | }, |
| 537 | ], |
| 538 | "stratum": { |
| 539 | "brand": "A String", |
| 540 | }, |
| 541 | }, |
| 542 | ], |
| 543 | "useAndroidId": True or False, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 544 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 545 | "status": "A String", # The desired status of this release. |
| 546 | "userFraction": 3.14, # Fraction of users who are eligible to receive the release. 0 < fraction < 1. To be set, release status must be "inProgress" or "halted". |
| 547 | "versionCodes": [ # A list of all version codes of APKs that will be exposed to the users of this track when this release is rolled out. Note that this list should contain all versions you wish to be active, including those you wish to retain from previous releases. |
| 548 | "A String", |
| 549 | ], |
| 550 | }, |
| 551 | ], |
| 552 | "track": "A String", # Identifier for this track. |
| 553 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 554 | </div> |
| 555 | |
| 556 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 557 | <code class="details" id="update">update(packageName, editId, track, body=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 558 | <pre>Updates the track configuration for the specified track type. |
| 559 | |
| 560 | Args: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 561 | packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 562 | editId: string, Unique identifier for this edit. (required) |
| 563 | track: string, The track to read or modify. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 564 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 565 | The object takes the form of: |
| 566 | |
| 567 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 568 | "releases": [ # A list of all active releases in this track during a read request. On an update request, it represents desired changes. |
| 569 | { |
| 570 | "controls": [ |
| 571 | { |
| 572 | "modRanges": [ |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 573 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 574 | "end": "A String", |
| 575 | "start": "A String", |
| 576 | }, |
| 577 | ], |
| 578 | "stratifiedSamplings": [ |
| 579 | { |
| 580 | "modRanges": [ |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 581 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 582 | "end": "A String", |
| 583 | "start": "A String", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 584 | }, |
| 585 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 586 | "stratum": { |
| 587 | "brand": "A String", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 588 | }, |
| 589 | }, |
| 590 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 591 | "versionCodes": [ |
| 592 | "A String", |
| 593 | ], |
| 594 | }, |
| 595 | ], |
| 596 | "countryTargeting": { |
| 597 | "countries": [ |
| 598 | "A String", |
| 599 | ], |
| 600 | "includeRestOfWorld": True or False, |
| 601 | }, |
| 602 | "inAppUpdatePriority": 42, # In-app update priority of the release. All newly added APKs in the release will be considered at this priority. in_app_update_priority can take values between [0, 5]. 5 is the highest priority. Default priority is 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. |
| 603 | "name": "A String", # The release name, used to identify this release in the Play Console UI. Not required to be unique. This is optional, if not set it will be generated from the version_name in the APKs. |
| 604 | "pinnedVersions": [ |
| 605 | { |
| 606 | "targetings": [ |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 607 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 608 | "countryCodes": [ |
| 609 | "A String", |
| 610 | ], |
| 611 | "devices": [ |
| 612 | { |
| 613 | "brand": "A String", |
| 614 | "device": "A String", |
| 615 | "product": "A String", |
| 616 | }, |
| 617 | ], |
| 618 | "phoneskyVersions": [ |
| 619 | "A String", |
| 620 | ], |
| 621 | "sdkVersions": [ |
| 622 | 42, |
| 623 | ], |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 624 | }, |
| 625 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 626 | "versionCodes": [ |
| 627 | "A String", |
| 628 | ], |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 629 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 630 | ], |
| 631 | "releaseNotes": [ # The description of what is new in the app in this release. |
| 632 | { |
| 633 | "language": "A String", # The language code, in BCP 47 format (eg "en-US"). |
| 634 | "text": "A String", # The text in the given `language`. |
| 635 | }, |
| 636 | ], |
| 637 | "rollbackEnabled": True or False, |
| 638 | "sampling": { |
| 639 | "modRanges": [ |
| 640 | { |
| 641 | "end": "A String", |
| 642 | "start": "A String", |
| 643 | }, |
| 644 | ], |
| 645 | "modulus": "A String", |
| 646 | "salt": 42, |
| 647 | "stratifiedSamplings": [ |
| 648 | { |
| 649 | "modRanges": [ |
| 650 | { |
| 651 | "end": "A String", |
| 652 | "start": "A String", |
| 653 | }, |
| 654 | ], |
| 655 | "stratum": { |
| 656 | "brand": "A String", |
| 657 | }, |
| 658 | }, |
| 659 | ], |
| 660 | "useAndroidId": True or False, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 661 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 662 | "status": "A String", # The desired status of this release. |
| 663 | "userFraction": 3.14, # Fraction of users who are eligible to receive the release. 0 < fraction < 1. To be set, release status must be "inProgress" or "halted". |
| 664 | "versionCodes": [ # A list of all version codes of APKs that will be exposed to the users of this track when this release is rolled out. Note that this list should contain all versions you wish to be active, including those you wish to retain from previous releases. |
| 665 | "A String", |
| 666 | ], |
| 667 | }, |
| 668 | ], |
| 669 | "track": "A String", # Identifier for this track. |
| 670 | } |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 671 | |
| 672 | |
| 673 | Returns: |
| 674 | An object of the form: |
| 675 | |
| 676 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 677 | "releases": [ # A list of all active releases in this track during a read request. On an update request, it represents desired changes. |
| 678 | { |
| 679 | "controls": [ |
| 680 | { |
| 681 | "modRanges": [ |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 682 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 683 | "end": "A String", |
| 684 | "start": "A String", |
| 685 | }, |
| 686 | ], |
| 687 | "stratifiedSamplings": [ |
| 688 | { |
| 689 | "modRanges": [ |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 690 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 691 | "end": "A String", |
| 692 | "start": "A String", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 693 | }, |
| 694 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 695 | "stratum": { |
| 696 | "brand": "A String", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 697 | }, |
| 698 | }, |
| 699 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 700 | "versionCodes": [ |
| 701 | "A String", |
| 702 | ], |
| 703 | }, |
| 704 | ], |
| 705 | "countryTargeting": { |
| 706 | "countries": [ |
| 707 | "A String", |
| 708 | ], |
| 709 | "includeRestOfWorld": True or False, |
| 710 | }, |
| 711 | "inAppUpdatePriority": 42, # In-app update priority of the release. All newly added APKs in the release will be considered at this priority. in_app_update_priority can take values between [0, 5]. 5 is the highest priority. Default priority is 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. |
| 712 | "name": "A String", # The release name, used to identify this release in the Play Console UI. Not required to be unique. This is optional, if not set it will be generated from the version_name in the APKs. |
| 713 | "pinnedVersions": [ |
| 714 | { |
| 715 | "targetings": [ |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 716 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 717 | "countryCodes": [ |
| 718 | "A String", |
| 719 | ], |
| 720 | "devices": [ |
| 721 | { |
| 722 | "brand": "A String", |
| 723 | "device": "A String", |
| 724 | "product": "A String", |
| 725 | }, |
| 726 | ], |
| 727 | "phoneskyVersions": [ |
| 728 | "A String", |
| 729 | ], |
| 730 | "sdkVersions": [ |
| 731 | 42, |
| 732 | ], |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 733 | }, |
| 734 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 735 | "versionCodes": [ |
| 736 | "A String", |
| 737 | ], |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 738 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 739 | ], |
| 740 | "releaseNotes": [ # The description of what is new in the app in this release. |
| 741 | { |
| 742 | "language": "A String", # The language code, in BCP 47 format (eg "en-US"). |
| 743 | "text": "A String", # The text in the given `language`. |
| 744 | }, |
| 745 | ], |
| 746 | "rollbackEnabled": True or False, |
| 747 | "sampling": { |
| 748 | "modRanges": [ |
| 749 | { |
| 750 | "end": "A String", |
| 751 | "start": "A String", |
| 752 | }, |
| 753 | ], |
| 754 | "modulus": "A String", |
| 755 | "salt": 42, |
| 756 | "stratifiedSamplings": [ |
| 757 | { |
| 758 | "modRanges": [ |
| 759 | { |
| 760 | "end": "A String", |
| 761 | "start": "A String", |
| 762 | }, |
| 763 | ], |
| 764 | "stratum": { |
| 765 | "brand": "A String", |
| 766 | }, |
| 767 | }, |
| 768 | ], |
| 769 | "useAndroidId": True or False, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 770 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 771 | "status": "A String", # The desired status of this release. |
| 772 | "userFraction": 3.14, # Fraction of users who are eligible to receive the release. 0 < fraction < 1. To be set, release status must be "inProgress" or "halted". |
| 773 | "versionCodes": [ # A list of all version codes of APKs that will be exposed to the users of this track when this release is rolled out. Note that this list should contain all versions you wish to be active, including those you wish to retain from previous releases. |
| 774 | "A String", |
| 775 | ], |
| 776 | }, |
| 777 | ], |
| 778 | "track": "A String", # Identifier for this track. |
| 779 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 780 | </div> |
| 781 | |
| 782 | </body></html> |