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_v2.html">Google Play Developer API</a> . <a href="androidpublisher_v2.inappproducts.html">inappproducts</a></h1> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="#batch">batch(body)</a></code></p> 79 <p class="firstline">A description of how to use this function</p> 80 <p class="toc_element"> 81 <code><a href="#delete">delete(packageName, sku)</a></code></p> 82 <p class="firstline">Delete an in-app product for an app.</p> 83 <p class="toc_element"> 84 <code><a href="#get">get(packageName, sku)</a></code></p> 85 <p class="firstline">Returns information about the in-app product specified.</p> 86 <p class="toc_element"> 87 <code><a href="#insert">insert(packageName, body, autoConvertMissingPrices=None)</a></code></p> 88 <p class="firstline">Creates a new in-app product for an app.</p> 89 <p class="toc_element"> 90 <code><a href="#list">list(packageName, token=None, maxResults=None, startIndex=None)</a></code></p> 91 <p class="firstline">List all the in-app products for an Android app, both subscriptions and managed in-app products..</p> 92 <p class="toc_element"> 93 <code><a href="#patch">patch(packageName, sku, body, autoConvertMissingPrices=None)</a></code></p> 94 <p class="firstline">Updates the details of an in-app product. This method supports patch semantics.</p> 95 <p class="toc_element"> 96 <code><a href="#update">update(packageName, sku, body, autoConvertMissingPrices=None)</a></code></p> 97 <p class="firstline">Updates the details of an in-app product.</p> 98 <h3>Method Details</h3> 99 <div class="method"> 100 <code class="details" id="batch">batch(body)</code> 101 <pre>A description of how to use this function 102 103 Args: 104 body: object, The request body. (required) 105 The object takes the form of: 106 107 { 108 "entrys": [ 109 { 110 "batchId": 42, 111 "inappproductsinsertrequest": { 112 "inappproduct": { 113 "sku": "A String", # The stock-keeping-unit (SKU) of the product, unique within an app. 114 "status": "A String", 115 "subscriptionPeriod": "A String", # Subscription period, specified in ISO 8601 format. Acceptable values are "P1W" (one week), "P1M" (one month), "P3M" (three months), "P6M" (six months), and "P1Y" (one year). 116 "season": { # Definition of a season for a seasonal subscription. Can be defined only for yearly subscriptions. 117 "prorations": [ # Optionally present list of prorations for the season. Each proration is a one-off discounted entry into a subscription. Each proration contains the first date on which the discount is available and the new pricing information. 118 { 119 "start": { # Defines the first day on which the price takes effect. 120 "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. 121 "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. 122 }, 123 "defaultPrice": { # Default price cannot be zero and must be less than the full subscription price. Default price is always in the developer's Checkout merchant currency. Targeted countries have their prices set automatically based on the default_price. 124 "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. 125 "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string. 126 }, 127 }, 128 ], 129 "end": { # Inclusive end date of the recurrence period. 130 "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. 131 "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. 132 }, 133 "start": { # Inclusive start date of the recurrence period. 134 "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. 135 "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. 136 }, 137 }, 138 "packageName": "A String", # The package name of the parent app. 139 "listings": { # List of localized title and description data. 140 "a_key": { # The language of the localized data, as defined by BCP 47. i.e.: "en-US", "en-GB". 141 "description": "A String", 142 "title": "A String", 143 }, 144 }, 145 "trialPeriod": "A String", # Trial period, specified in ISO 8601 format. Acceptable values are anything between "P7D" (seven days) and "P999D" (999 days). Seasonal subscriptions cannot have a trial period. 146 "purchaseType": "A String", # Purchase type enum value. Unmodifiable after creation. 147 "defaultLanguage": "A String", # The default language of the localized data, as defined by BCP 47. e.g. "en-US", "en-GB". 148 "prices": { # Prices per buyer region. None of these prices should be zero. In-app products can never be free. 149 "a_key": { # Region code, as defined by ISO 3166-2. 150 "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. 151 "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string. 152 }, 153 }, 154 "defaultPrice": { # Default price cannot be zero. In-app products can never be free. Default price is always in the developer's Checkout merchant currency. 155 "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. 156 "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string. 157 }, 158 }, 159 }, 160 "methodName": "A String", 161 "inappproductsupdaterequest": { 162 "inappproduct": { 163 "sku": "A String", # The stock-keeping-unit (SKU) of the product, unique within an app. 164 "status": "A String", 165 "subscriptionPeriod": "A String", # Subscription period, specified in ISO 8601 format. Acceptable values are "P1W" (one week), "P1M" (one month), "P3M" (three months), "P6M" (six months), and "P1Y" (one year). 166 "season": { # Definition of a season for a seasonal subscription. Can be defined only for yearly subscriptions. 167 "prorations": [ # Optionally present list of prorations for the season. Each proration is a one-off discounted entry into a subscription. Each proration contains the first date on which the discount is available and the new pricing information. 168 { 169 "start": { # Defines the first day on which the price takes effect. 170 "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. 171 "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. 172 }, 173 "defaultPrice": { # Default price cannot be zero and must be less than the full subscription price. Default price is always in the developer's Checkout merchant currency. Targeted countries have their prices set automatically based on the default_price. 174 "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. 175 "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string. 176 }, 177 }, 178 ], 179 "end": { # Inclusive end date of the recurrence period. 180 "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. 181 "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. 182 }, 183 "start": { # Inclusive start date of the recurrence period. 184 "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. 185 "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. 186 }, 187 }, 188 "packageName": "A String", # The package name of the parent app. 189 "listings": { # List of localized title and description data. 190 "a_key": { # The language of the localized data, as defined by BCP 47. i.e.: "en-US", "en-GB". 191 "description": "A String", 192 "title": "A String", 193 }, 194 }, 195 "trialPeriod": "A String", # Trial period, specified in ISO 8601 format. Acceptable values are anything between "P7D" (seven days) and "P999D" (999 days). Seasonal subscriptions cannot have a trial period. 196 "purchaseType": "A String", # Purchase type enum value. Unmodifiable after creation. 197 "defaultLanguage": "A String", # The default language of the localized data, as defined by BCP 47. e.g. "en-US", "en-GB". 198 "prices": { # Prices per buyer region. None of these prices should be zero. In-app products can never be free. 199 "a_key": { # Region code, as defined by ISO 3166-2. 200 "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. 201 "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string. 202 }, 203 }, 204 "defaultPrice": { # Default price cannot be zero. In-app products can never be free. Default price is always in the developer's Checkout merchant currency. 205 "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. 206 "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string. 207 }, 208 }, 209 }, 210 }, 211 ], 212 } 213 214 215 Returns: 216 An object of the form: 217 218 { 219 "entrys": [ 220 { 221 "batchId": 42, 222 "inappproductsupdateresponse": { 223 "inappproduct": { 224 "sku": "A String", # The stock-keeping-unit (SKU) of the product, unique within an app. 225 "status": "A String", 226 "subscriptionPeriod": "A String", # Subscription period, specified in ISO 8601 format. Acceptable values are "P1W" (one week), "P1M" (one month), "P3M" (three months), "P6M" (six months), and "P1Y" (one year). 227 "season": { # Definition of a season for a seasonal subscription. Can be defined only for yearly subscriptions. 228 "prorations": [ # Optionally present list of prorations for the season. Each proration is a one-off discounted entry into a subscription. Each proration contains the first date on which the discount is available and the new pricing information. 229 { 230 "start": { # Defines the first day on which the price takes effect. 231 "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. 232 "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. 233 }, 234 "defaultPrice": { # Default price cannot be zero and must be less than the full subscription price. Default price is always in the developer's Checkout merchant currency. Targeted countries have their prices set automatically based on the default_price. 235 "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. 236 "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string. 237 }, 238 }, 239 ], 240 "end": { # Inclusive end date of the recurrence period. 241 "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. 242 "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. 243 }, 244 "start": { # Inclusive start date of the recurrence period. 245 "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. 246 "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. 247 }, 248 }, 249 "packageName": "A String", # The package name of the parent app. 250 "listings": { # List of localized title and description data. 251 "a_key": { # The language of the localized data, as defined by BCP 47. i.e.: "en-US", "en-GB". 252 "description": "A String", 253 "title": "A String", 254 }, 255 }, 256 "trialPeriod": "A String", # Trial period, specified in ISO 8601 format. Acceptable values are anything between "P7D" (seven days) and "P999D" (999 days). Seasonal subscriptions cannot have a trial period. 257 "purchaseType": "A String", # Purchase type enum value. Unmodifiable after creation. 258 "defaultLanguage": "A String", # The default language of the localized data, as defined by BCP 47. e.g. "en-US", "en-GB". 259 "prices": { # Prices per buyer region. None of these prices should be zero. In-app products can never be free. 260 "a_key": { # Region code, as defined by ISO 3166-2. 261 "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. 262 "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string. 263 }, 264 }, 265 "defaultPrice": { # Default price cannot be zero. In-app products can never be free. Default price is always in the developer's Checkout merchant currency. 266 "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. 267 "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string. 268 }, 269 }, 270 }, 271 "inappproductsinsertresponse": { 272 "inappproduct": { 273 "sku": "A String", # The stock-keeping-unit (SKU) of the product, unique within an app. 274 "status": "A String", 275 "subscriptionPeriod": "A String", # Subscription period, specified in ISO 8601 format. Acceptable values are "P1W" (one week), "P1M" (one month), "P3M" (three months), "P6M" (six months), and "P1Y" (one year). 276 "season": { # Definition of a season for a seasonal subscription. Can be defined only for yearly subscriptions. 277 "prorations": [ # Optionally present list of prorations for the season. Each proration is a one-off discounted entry into a subscription. Each proration contains the first date on which the discount is available and the new pricing information. 278 { 279 "start": { # Defines the first day on which the price takes effect. 280 "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. 281 "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. 282 }, 283 "defaultPrice": { # Default price cannot be zero and must be less than the full subscription price. Default price is always in the developer's Checkout merchant currency. Targeted countries have their prices set automatically based on the default_price. 284 "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. 285 "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string. 286 }, 287 }, 288 ], 289 "end": { # Inclusive end date of the recurrence period. 290 "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. 291 "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. 292 }, 293 "start": { # Inclusive start date of the recurrence period. 294 "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. 295 "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. 296 }, 297 }, 298 "packageName": "A String", # The package name of the parent app. 299 "listings": { # List of localized title and description data. 300 "a_key": { # The language of the localized data, as defined by BCP 47. i.e.: "en-US", "en-GB". 301 "description": "A String", 302 "title": "A String", 303 }, 304 }, 305 "trialPeriod": "A String", # Trial period, specified in ISO 8601 format. Acceptable values are anything between "P7D" (seven days) and "P999D" (999 days). Seasonal subscriptions cannot have a trial period. 306 "purchaseType": "A String", # Purchase type enum value. Unmodifiable after creation. 307 "defaultLanguage": "A String", # The default language of the localized data, as defined by BCP 47. e.g. "en-US", "en-GB". 308 "prices": { # Prices per buyer region. None of these prices should be zero. In-app products can never be free. 309 "a_key": { # Region code, as defined by ISO 3166-2. 310 "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. 311 "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string. 312 }, 313 }, 314 "defaultPrice": { # Default price cannot be zero. In-app products can never be free. Default price is always in the developer's Checkout merchant currency. 315 "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. 316 "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string. 317 }, 318 }, 319 }, 320 }, 321 ], 322 "kind": "androidpublisher#inappproductsBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "androidpublisher#inappproductsBatchResponse". 323 }</pre> 324 </div> 325 326 <div class="method"> 327 <code class="details" id="delete">delete(packageName, sku)</code> 328 <pre>Delete an in-app product for an app. 329 330 Args: 331 packageName: string, Unique identifier for the Android app with the in-app product; for example, "com.spiffygame". (required) 332 sku: string, Unique identifier for the in-app product. (required) 333 </pre> 334 </div> 335 336 <div class="method"> 337 <code class="details" id="get">get(packageName, sku)</code> 338 <pre>Returns information about the in-app product specified. 339 340 Args: 341 packageName: string, A parameter (required) 342 sku: string, Unique identifier for the in-app product. (required) 343 344 Returns: 345 An object of the form: 346 347 { 348 "sku": "A String", # The stock-keeping-unit (SKU) of the product, unique within an app. 349 "status": "A String", 350 "subscriptionPeriod": "A String", # Subscription period, specified in ISO 8601 format. Acceptable values are "P1W" (one week), "P1M" (one month), "P3M" (three months), "P6M" (six months), and "P1Y" (one year). 351 "season": { # Definition of a season for a seasonal subscription. Can be defined only for yearly subscriptions. 352 "prorations": [ # Optionally present list of prorations for the season. Each proration is a one-off discounted entry into a subscription. Each proration contains the first date on which the discount is available and the new pricing information. 353 { 354 "start": { # Defines the first day on which the price takes effect. 355 "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. 356 "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. 357 }, 358 "defaultPrice": { # Default price cannot be zero and must be less than the full subscription price. Default price is always in the developer's Checkout merchant currency. Targeted countries have their prices set automatically based on the default_price. 359 "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. 360 "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string. 361 }, 362 }, 363 ], 364 "end": { # Inclusive end date of the recurrence period. 365 "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. 366 "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. 367 }, 368 "start": { # Inclusive start date of the recurrence period. 369 "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. 370 "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. 371 }, 372 }, 373 "packageName": "A String", # The package name of the parent app. 374 "listings": { # List of localized title and description data. 375 "a_key": { # The language of the localized data, as defined by BCP 47. i.e.: "en-US", "en-GB". 376 "description": "A String", 377 "title": "A String", 378 }, 379 }, 380 "trialPeriod": "A String", # Trial period, specified in ISO 8601 format. Acceptable values are anything between "P7D" (seven days) and "P999D" (999 days). Seasonal subscriptions cannot have a trial period. 381 "purchaseType": "A String", # Purchase type enum value. Unmodifiable after creation. 382 "defaultLanguage": "A String", # The default language of the localized data, as defined by BCP 47. e.g. "en-US", "en-GB". 383 "prices": { # Prices per buyer region. None of these prices should be zero. In-app products can never be free. 384 "a_key": { # Region code, as defined by ISO 3166-2. 385 "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. 386 "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string. 387 }, 388 }, 389 "defaultPrice": { # Default price cannot be zero. In-app products can never be free. Default price is always in the developer's Checkout merchant currency. 390 "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. 391 "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string. 392 }, 393 }</pre> 394 </div> 395 396 <div class="method"> 397 <code class="details" id="insert">insert(packageName, body, autoConvertMissingPrices=None)</code> 398 <pre>Creates a new in-app product for an app. 399 400 Args: 401 packageName: string, Unique identifier for the Android app; for example, "com.spiffygame". (required) 402 body: object, The request body. (required) 403 The object takes the form of: 404 405 { 406 "sku": "A String", # The stock-keeping-unit (SKU) of the product, unique within an app. 407 "status": "A String", 408 "subscriptionPeriod": "A String", # Subscription period, specified in ISO 8601 format. Acceptable values are "P1W" (one week), "P1M" (one month), "P3M" (three months), "P6M" (six months), and "P1Y" (one year). 409 "season": { # Definition of a season for a seasonal subscription. Can be defined only for yearly subscriptions. 410 "prorations": [ # Optionally present list of prorations for the season. Each proration is a one-off discounted entry into a subscription. Each proration contains the first date on which the discount is available and the new pricing information. 411 { 412 "start": { # Defines the first day on which the price takes effect. 413 "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. 414 "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. 415 }, 416 "defaultPrice": { # Default price cannot be zero and must be less than the full subscription price. Default price is always in the developer's Checkout merchant currency. Targeted countries have their prices set automatically based on the default_price. 417 "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. 418 "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string. 419 }, 420 }, 421 ], 422 "end": { # Inclusive end date of the recurrence period. 423 "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. 424 "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. 425 }, 426 "start": { # Inclusive start date of the recurrence period. 427 "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. 428 "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. 429 }, 430 }, 431 "packageName": "A String", # The package name of the parent app. 432 "listings": { # List of localized title and description data. 433 "a_key": { # The language of the localized data, as defined by BCP 47. i.e.: "en-US", "en-GB". 434 "description": "A String", 435 "title": "A String", 436 }, 437 }, 438 "trialPeriod": "A String", # Trial period, specified in ISO 8601 format. Acceptable values are anything between "P7D" (seven days) and "P999D" (999 days). Seasonal subscriptions cannot have a trial period. 439 "purchaseType": "A String", # Purchase type enum value. Unmodifiable after creation. 440 "defaultLanguage": "A String", # The default language of the localized data, as defined by BCP 47. e.g. "en-US", "en-GB". 441 "prices": { # Prices per buyer region. None of these prices should be zero. In-app products can never be free. 442 "a_key": { # Region code, as defined by ISO 3166-2. 443 "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. 444 "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string. 445 }, 446 }, 447 "defaultPrice": { # Default price cannot be zero. In-app products can never be free. Default price is always in the developer's Checkout merchant currency. 448 "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. 449 "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string. 450 }, 451 } 452 453 autoConvertMissingPrices: boolean, If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false. 454 455 Returns: 456 An object of the form: 457 458 { 459 "sku": "A String", # The stock-keeping-unit (SKU) of the product, unique within an app. 460 "status": "A String", 461 "subscriptionPeriod": "A String", # Subscription period, specified in ISO 8601 format. Acceptable values are "P1W" (one week), "P1M" (one month), "P3M" (three months), "P6M" (six months), and "P1Y" (one year). 462 "season": { # Definition of a season for a seasonal subscription. Can be defined only for yearly subscriptions. 463 "prorations": [ # Optionally present list of prorations for the season. Each proration is a one-off discounted entry into a subscription. Each proration contains the first date on which the discount is available and the new pricing information. 464 { 465 "start": { # Defines the first day on which the price takes effect. 466 "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. 467 "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. 468 }, 469 "defaultPrice": { # Default price cannot be zero and must be less than the full subscription price. Default price is always in the developer's Checkout merchant currency. Targeted countries have their prices set automatically based on the default_price. 470 "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. 471 "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string. 472 }, 473 }, 474 ], 475 "end": { # Inclusive end date of the recurrence period. 476 "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. 477 "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. 478 }, 479 "start": { # Inclusive start date of the recurrence period. 480 "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. 481 "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. 482 }, 483 }, 484 "packageName": "A String", # The package name of the parent app. 485 "listings": { # List of localized title and description data. 486 "a_key": { # The language of the localized data, as defined by BCP 47. i.e.: "en-US", "en-GB". 487 "description": "A String", 488 "title": "A String", 489 }, 490 }, 491 "trialPeriod": "A String", # Trial period, specified in ISO 8601 format. Acceptable values are anything between "P7D" (seven days) and "P999D" (999 days). Seasonal subscriptions cannot have a trial period. 492 "purchaseType": "A String", # Purchase type enum value. Unmodifiable after creation. 493 "defaultLanguage": "A String", # The default language of the localized data, as defined by BCP 47. e.g. "en-US", "en-GB". 494 "prices": { # Prices per buyer region. None of these prices should be zero. In-app products can never be free. 495 "a_key": { # Region code, as defined by ISO 3166-2. 496 "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. 497 "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string. 498 }, 499 }, 500 "defaultPrice": { # Default price cannot be zero. In-app products can never be free. Default price is always in the developer's Checkout merchant currency. 501 "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. 502 "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string. 503 }, 504 }</pre> 505 </div> 506 507 <div class="method"> 508 <code class="details" id="list">list(packageName, token=None, maxResults=None, startIndex=None)</code> 509 <pre>List all the in-app products for an Android app, both subscriptions and managed in-app products.. 510 511 Args: 512 packageName: string, Unique identifier for the Android app with in-app products; for example, "com.spiffygame". (required) 513 token: string, A parameter 514 maxResults: integer, A parameter 515 startIndex: integer, A parameter 516 517 Returns: 518 An object of the form: 519 520 { 521 "kind": "androidpublisher#inappproductsListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidpublisher#inappproductsListResponse". 522 "tokenPagination": { 523 "nextPageToken": "A String", 524 "previousPageToken": "A String", 525 }, 526 "pageInfo": { 527 "totalResults": 42, 528 "startIndex": 42, 529 "resultPerPage": 42, 530 }, 531 "inappproduct": [ 532 { 533 "sku": "A String", # The stock-keeping-unit (SKU) of the product, unique within an app. 534 "status": "A String", 535 "subscriptionPeriod": "A String", # Subscription period, specified in ISO 8601 format. Acceptable values are "P1W" (one week), "P1M" (one month), "P3M" (three months), "P6M" (six months), and "P1Y" (one year). 536 "season": { # Definition of a season for a seasonal subscription. Can be defined only for yearly subscriptions. 537 "prorations": [ # Optionally present list of prorations for the season. Each proration is a one-off discounted entry into a subscription. Each proration contains the first date on which the discount is available and the new pricing information. 538 { 539 "start": { # Defines the first day on which the price takes effect. 540 "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. 541 "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. 542 }, 543 "defaultPrice": { # Default price cannot be zero and must be less than the full subscription price. Default price is always in the developer's Checkout merchant currency. Targeted countries have their prices set automatically based on the default_price. 544 "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. 545 "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string. 546 }, 547 }, 548 ], 549 "end": { # Inclusive end date of the recurrence period. 550 "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. 551 "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. 552 }, 553 "start": { # Inclusive start date of the recurrence period. 554 "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. 555 "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. 556 }, 557 }, 558 "packageName": "A String", # The package name of the parent app. 559 "listings": { # List of localized title and description data. 560 "a_key": { # The language of the localized data, as defined by BCP 47. i.e.: "en-US", "en-GB". 561 "description": "A String", 562 "title": "A String", 563 }, 564 }, 565 "trialPeriod": "A String", # Trial period, specified in ISO 8601 format. Acceptable values are anything between "P7D" (seven days) and "P999D" (999 days). Seasonal subscriptions cannot have a trial period. 566 "purchaseType": "A String", # Purchase type enum value. Unmodifiable after creation. 567 "defaultLanguage": "A String", # The default language of the localized data, as defined by BCP 47. e.g. "en-US", "en-GB". 568 "prices": { # Prices per buyer region. None of these prices should be zero. In-app products can never be free. 569 "a_key": { # Region code, as defined by ISO 3166-2. 570 "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. 571 "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string. 572 }, 573 }, 574 "defaultPrice": { # Default price cannot be zero. In-app products can never be free. Default price is always in the developer's Checkout merchant currency. 575 "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. 576 "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string. 577 }, 578 }, 579 ], 580 }</pre> 581 </div> 582 583 <div class="method"> 584 <code class="details" id="patch">patch(packageName, sku, body, autoConvertMissingPrices=None)</code> 585 <pre>Updates the details of an in-app product. This method supports patch semantics. 586 587 Args: 588 packageName: string, Unique identifier for the Android app with the in-app product; for example, "com.spiffygame". (required) 589 sku: string, Unique identifier for the in-app product. (required) 590 body: object, The request body. (required) 591 The object takes the form of: 592 593 { 594 "sku": "A String", # The stock-keeping-unit (SKU) of the product, unique within an app. 595 "status": "A String", 596 "subscriptionPeriod": "A String", # Subscription period, specified in ISO 8601 format. Acceptable values are "P1W" (one week), "P1M" (one month), "P3M" (three months), "P6M" (six months), and "P1Y" (one year). 597 "season": { # Definition of a season for a seasonal subscription. Can be defined only for yearly subscriptions. 598 "prorations": [ # Optionally present list of prorations for the season. Each proration is a one-off discounted entry into a subscription. Each proration contains the first date on which the discount is available and the new pricing information. 599 { 600 "start": { # Defines the first day on which the price takes effect. 601 "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. 602 "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. 603 }, 604 "defaultPrice": { # Default price cannot be zero and must be less than the full subscription price. Default price is always in the developer's Checkout merchant currency. Targeted countries have their prices set automatically based on the default_price. 605 "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. 606 "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string. 607 }, 608 }, 609 ], 610 "end": { # Inclusive end date of the recurrence period. 611 "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. 612 "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. 613 }, 614 "start": { # Inclusive start date of the recurrence period. 615 "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. 616 "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. 617 }, 618 }, 619 "packageName": "A String", # The package name of the parent app. 620 "listings": { # List of localized title and description data. 621 "a_key": { # The language of the localized data, as defined by BCP 47. i.e.: "en-US", "en-GB". 622 "description": "A String", 623 "title": "A String", 624 }, 625 }, 626 "trialPeriod": "A String", # Trial period, specified in ISO 8601 format. Acceptable values are anything between "P7D" (seven days) and "P999D" (999 days). Seasonal subscriptions cannot have a trial period. 627 "purchaseType": "A String", # Purchase type enum value. Unmodifiable after creation. 628 "defaultLanguage": "A String", # The default language of the localized data, as defined by BCP 47. e.g. "en-US", "en-GB". 629 "prices": { # Prices per buyer region. None of these prices should be zero. In-app products can never be free. 630 "a_key": { # Region code, as defined by ISO 3166-2. 631 "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. 632 "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string. 633 }, 634 }, 635 "defaultPrice": { # Default price cannot be zero. In-app products can never be free. Default price is always in the developer's Checkout merchant currency. 636 "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. 637 "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string. 638 }, 639 } 640 641 autoConvertMissingPrices: boolean, If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false. 642 643 Returns: 644 An object of the form: 645 646 { 647 "sku": "A String", # The stock-keeping-unit (SKU) of the product, unique within an app. 648 "status": "A String", 649 "subscriptionPeriod": "A String", # Subscription period, specified in ISO 8601 format. Acceptable values are "P1W" (one week), "P1M" (one month), "P3M" (three months), "P6M" (six months), and "P1Y" (one year). 650 "season": { # Definition of a season for a seasonal subscription. Can be defined only for yearly subscriptions. 651 "prorations": [ # Optionally present list of prorations for the season. Each proration is a one-off discounted entry into a subscription. Each proration contains the first date on which the discount is available and the new pricing information. 652 { 653 "start": { # Defines the first day on which the price takes effect. 654 "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. 655 "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. 656 }, 657 "defaultPrice": { # Default price cannot be zero and must be less than the full subscription price. Default price is always in the developer's Checkout merchant currency. Targeted countries have their prices set automatically based on the default_price. 658 "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. 659 "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string. 660 }, 661 }, 662 ], 663 "end": { # Inclusive end date of the recurrence period. 664 "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. 665 "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. 666 }, 667 "start": { # Inclusive start date of the recurrence period. 668 "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. 669 "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. 670 }, 671 }, 672 "packageName": "A String", # The package name of the parent app. 673 "listings": { # List of localized title and description data. 674 "a_key": { # The language of the localized data, as defined by BCP 47. i.e.: "en-US", "en-GB". 675 "description": "A String", 676 "title": "A String", 677 }, 678 }, 679 "trialPeriod": "A String", # Trial period, specified in ISO 8601 format. Acceptable values are anything between "P7D" (seven days) and "P999D" (999 days). Seasonal subscriptions cannot have a trial period. 680 "purchaseType": "A String", # Purchase type enum value. Unmodifiable after creation. 681 "defaultLanguage": "A String", # The default language of the localized data, as defined by BCP 47. e.g. "en-US", "en-GB". 682 "prices": { # Prices per buyer region. None of these prices should be zero. In-app products can never be free. 683 "a_key": { # Region code, as defined by ISO 3166-2. 684 "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. 685 "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string. 686 }, 687 }, 688 "defaultPrice": { # Default price cannot be zero. In-app products can never be free. Default price is always in the developer's Checkout merchant currency. 689 "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. 690 "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string. 691 }, 692 }</pre> 693 </div> 694 695 <div class="method"> 696 <code class="details" id="update">update(packageName, sku, body, autoConvertMissingPrices=None)</code> 697 <pre>Updates the details of an in-app product. 698 699 Args: 700 packageName: string, Unique identifier for the Android app with the in-app product; for example, "com.spiffygame". (required) 701 sku: string, Unique identifier for the in-app product. (required) 702 body: object, The request body. (required) 703 The object takes the form of: 704 705 { 706 "sku": "A String", # The stock-keeping-unit (SKU) of the product, unique within an app. 707 "status": "A String", 708 "subscriptionPeriod": "A String", # Subscription period, specified in ISO 8601 format. Acceptable values are "P1W" (one week), "P1M" (one month), "P3M" (three months), "P6M" (six months), and "P1Y" (one year). 709 "season": { # Definition of a season for a seasonal subscription. Can be defined only for yearly subscriptions. 710 "prorations": [ # Optionally present list of prorations for the season. Each proration is a one-off discounted entry into a subscription. Each proration contains the first date on which the discount is available and the new pricing information. 711 { 712 "start": { # Defines the first day on which the price takes effect. 713 "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. 714 "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. 715 }, 716 "defaultPrice": { # Default price cannot be zero and must be less than the full subscription price. Default price is always in the developer's Checkout merchant currency. Targeted countries have their prices set automatically based on the default_price. 717 "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. 718 "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string. 719 }, 720 }, 721 ], 722 "end": { # Inclusive end date of the recurrence period. 723 "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. 724 "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. 725 }, 726 "start": { # Inclusive start date of the recurrence period. 727 "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. 728 "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. 729 }, 730 }, 731 "packageName": "A String", # The package name of the parent app. 732 "listings": { # List of localized title and description data. 733 "a_key": { # The language of the localized data, as defined by BCP 47. i.e.: "en-US", "en-GB". 734 "description": "A String", 735 "title": "A String", 736 }, 737 }, 738 "trialPeriod": "A String", # Trial period, specified in ISO 8601 format. Acceptable values are anything between "P7D" (seven days) and "P999D" (999 days). Seasonal subscriptions cannot have a trial period. 739 "purchaseType": "A String", # Purchase type enum value. Unmodifiable after creation. 740 "defaultLanguage": "A String", # The default language of the localized data, as defined by BCP 47. e.g. "en-US", "en-GB". 741 "prices": { # Prices per buyer region. None of these prices should be zero. In-app products can never be free. 742 "a_key": { # Region code, as defined by ISO 3166-2. 743 "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. 744 "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string. 745 }, 746 }, 747 "defaultPrice": { # Default price cannot be zero. In-app products can never be free. Default price is always in the developer's Checkout merchant currency. 748 "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. 749 "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string. 750 }, 751 } 752 753 autoConvertMissingPrices: boolean, If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false. 754 755 Returns: 756 An object of the form: 757 758 { 759 "sku": "A String", # The stock-keeping-unit (SKU) of the product, unique within an app. 760 "status": "A String", 761 "subscriptionPeriod": "A String", # Subscription period, specified in ISO 8601 format. Acceptable values are "P1W" (one week), "P1M" (one month), "P3M" (three months), "P6M" (six months), and "P1Y" (one year). 762 "season": { # Definition of a season for a seasonal subscription. Can be defined only for yearly subscriptions. 763 "prorations": [ # Optionally present list of prorations for the season. Each proration is a one-off discounted entry into a subscription. Each proration contains the first date on which the discount is available and the new pricing information. 764 { 765 "start": { # Defines the first day on which the price takes effect. 766 "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. 767 "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. 768 }, 769 "defaultPrice": { # Default price cannot be zero and must be less than the full subscription price. Default price is always in the developer's Checkout merchant currency. Targeted countries have their prices set automatically based on the default_price. 770 "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. 771 "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string. 772 }, 773 }, 774 ], 775 "end": { # Inclusive end date of the recurrence period. 776 "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. 777 "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. 778 }, 779 "start": { # Inclusive start date of the recurrence period. 780 "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. 781 "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. 782 }, 783 }, 784 "packageName": "A String", # The package name of the parent app. 785 "listings": { # List of localized title and description data. 786 "a_key": { # The language of the localized data, as defined by BCP 47. i.e.: "en-US", "en-GB". 787 "description": "A String", 788 "title": "A String", 789 }, 790 }, 791 "trialPeriod": "A String", # Trial period, specified in ISO 8601 format. Acceptable values are anything between "P7D" (seven days) and "P999D" (999 days). Seasonal subscriptions cannot have a trial period. 792 "purchaseType": "A String", # Purchase type enum value. Unmodifiable after creation. 793 "defaultLanguage": "A String", # The default language of the localized data, as defined by BCP 47. e.g. "en-US", "en-GB". 794 "prices": { # Prices per buyer region. None of these prices should be zero. In-app products can never be free. 795 "a_key": { # Region code, as defined by ISO 3166-2. 796 "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. 797 "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string. 798 }, 799 }, 800 "defaultPrice": { # Default price cannot be zero. In-app products can never be free. Default price is always in the developer's Checkout merchant currency. 801 "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. 802 "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string. 803 }, 804 }</pre> 805 </div> 806 807 </body></html>
