docs/dyn/content_v2_1.regionalinventory.html - platform/external/python/google-api-python-client - Git at Google

 <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="content_v2_1.html">Content API for Shopping</a> . <a href="content_v2_1.regionalinventory.html">regionalinventory</a></h1>
 <h2>Instance Methods</h2>
 <p class="toc_element">
   <code><a href="#custombatch">custombatch(body)</a></code></p>
 <p class="firstline">Updates regional inventory for multiple products or regions in a single request.</p>
 <p class="toc_element">
   <code><a href="#insert">insert(merchantId, productId, body)</a></code></p>
 <p class="firstline">Update the regional inventory of a product in your Merchant Center account. If a regional inventory with the same region ID already exists, this method updates that entry.</p>
 <h3>Method Details</h3>
 <div class="method">
     <code class="details" id="custombatch">custombatch(body)</code>
   <pre>Updates regional inventory for multiple products or regions in a single request.

 Args:
   body: object, The request body. (required)
     The object takes the form of:

 {
     "entries": [ # The request entries to be processed in the batch.
       { # A batch entry encoding a single non-batch regional inventory request.
         "batchId": 42, # An entry ID, unique within the batch request.
         "regionalInventory": { # Regional inventory resource. contains the regional name and all attributes which are overridden for the specified region. # Price and availability of the product.
             "kind": "content#regionalInventory", # Identifies what kind of resource this is. Value: the fixed string "content#regionalInventory".
             "salePriceEffectiveDate": "A String", # A date range represented by a pair of ISO 8601 dates separated by a space, comma, or slash. Both dates might be specified as 'null' if undecided.
             "price": { # The price of the product.
               "currency": "A String", # The currency of the price.
               "value": "A String", # The price represented as a number.
             },
             "regionId": "A String", # The ID (name) of the region.
             "customAttributes": [ # A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form.
               {
                 "groupValues": [ # Subattributes within this attribute group. Exactly one of value or groupValues must be provided.
                   # Object with schema name: CustomAttribute
                 ],
                 "name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion.
                 "value": "A String", # The value of the attribute.
               },
             ],
             "salePrice": { # The sale price of the product. Mandatory if sale_price_effective_date is defined.
               "currency": "A String", # The currency of the price.
               "value": "A String", # The price represented as a number.
             },
             "availability": "A String", # The availability of the product.
           },
         "productId": "A String", # The ID of the product for which to update price and availability.
         "merchantId": "A String", # The ID of the managing account.
         "method": "A String",
       },
     ],
   }


 Returns:
   An object of the form:

     {
     "kind": "content#regionalinventoryCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#regionalinventoryCustomBatchResponse".
     "entries": [ # The result of the execution of the batch requests.
       { # A batch entry encoding a single non-batch regional inventory response.
         "batchId": 42, # The ID of the request entry this entry responds to.
         "regionalInventory": { # Regional inventory resource. contains the regional name and all attributes which are overridden for the specified region. # Price and availability of the product.
             "kind": "content#regionalInventory", # Identifies what kind of resource this is. Value: the fixed string "content#regionalInventory".
             "salePriceEffectiveDate": "A String", # A date range represented by a pair of ISO 8601 dates separated by a space, comma, or slash. Both dates might be specified as 'null' if undecided.
             "price": { # The price of the product.
               "currency": "A String", # The currency of the price.
               "value": "A String", # The price represented as a number.
             },
             "regionId": "A String", # The ID (name) of the region.
             "customAttributes": [ # A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form.
               {
                 "groupValues": [ # Subattributes within this attribute group. Exactly one of value or groupValues must be provided.
                   # Object with schema name: CustomAttribute
                 ],
                 "name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion.
                 "value": "A String", # The value of the attribute.
               },
             ],
             "salePrice": { # The sale price of the product. Mandatory if sale_price_effective_date is defined.
               "currency": "A String", # The currency of the price.
               "value": "A String", # The price represented as a number.
             },
             "availability": "A String", # The availability of the product.
           },
         "kind": "content#regionalinventoryCustomBatchResponseEntry", # Identifies what kind of resource this is. Value: the fixed string "content#regionalinventoryCustomBatchResponseEntry".
         "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed.
           "message": "A String", # The message of the first error in errors.
           "code": 42, # The HTTP status of the first error in errors.
           "errors": [ # A list of errors.
             { # An error returned by the API.
               "reason": "A String", # The error code.
               "domain": "A String", # The domain of the error.
               "message": "A String", # A description of the error.
             },
           ],
         },
       },
     ],
   }</pre>
 </div>

 <div class="method">
     <code class="details" id="insert">insert(merchantId, productId, body)</code>
   <pre>Update the regional inventory of a product in your Merchant Center account. If a regional inventory with the same region ID already exists, this method updates that entry.

 Args:
   merchantId: string, The ID of the account that contains the product. This account cannot be a multi-client account. (required)
   productId: string, The REST ID of the product for which to update the regional inventory. (required)
   body: object, The request body. (required)
     The object takes the form of:

 { # Regional inventory resource. contains the regional name and all attributes which are overridden for the specified region.
     "kind": "content#regionalInventory", # Identifies what kind of resource this is. Value: the fixed string "content#regionalInventory".
     "salePriceEffectiveDate": "A String", # A date range represented by a pair of ISO 8601 dates separated by a space, comma, or slash. Both dates might be specified as 'null' if undecided.
     "price": { # The price of the product.
       "currency": "A String", # The currency of the price.
       "value": "A String", # The price represented as a number.
     },
     "regionId": "A String", # The ID (name) of the region.
     "customAttributes": [ # A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form.
       {
         "groupValues": [ # Subattributes within this attribute group. Exactly one of value or groupValues must be provided.
           # Object with schema name: CustomAttribute
         ],
         "name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion.
         "value": "A String", # The value of the attribute.
       },
     ],
     "salePrice": { # The sale price of the product. Mandatory if sale_price_effective_date is defined.
       "currency": "A String", # The currency of the price.
       "value": "A String", # The price represented as a number.
     },
     "availability": "A String", # The availability of the product.
   }


 Returns:
   An object of the form:

     { # Regional inventory resource. contains the regional name and all attributes which are overridden for the specified region.
       "kind": "content#regionalInventory", # Identifies what kind of resource this is. Value: the fixed string "content#regionalInventory".
       "salePriceEffectiveDate": "A String", # A date range represented by a pair of ISO 8601 dates separated by a space, comma, or slash. Both dates might be specified as 'null' if undecided.
       "price": { # The price of the product.
         "currency": "A String", # The currency of the price.
         "value": "A String", # The price represented as a number.
       },
       "regionId": "A String", # The ID (name) of the region.
       "customAttributes": [ # A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form.
         {
           "groupValues": [ # Subattributes within this attribute group. Exactly one of value or groupValues must be provided.
             # Object with schema name: CustomAttribute
           ],
           "name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion.
           "value": "A String", # The value of the attribute.
         },
       ],
       "salePrice": { # The sale price of the product. Mandatory if sale_price_effective_date is defined.
         "currency": "A String", # The currency of the price.
         "value": "A String", # The price represented as a number.
       },
       "availability": "A String", # The availability of the product.
     }</pre>
 </div>

 </body></html>
	<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="content_v2_1.html">Content API for Shopping</a> . <a href="content_v2_1.regionalinventory.html">regionalinventory</a></h1>
	<h2>Instance Methods</h2>
	<p class="toc_element">
	<code><a href="#custombatch">custombatch(body)</a></code></p>
	<p class="firstline">Updates regional inventory for multiple products or regions in a single request.</p>
	<p class="toc_element">
	<code><a href="#insert">insert(merchantId, productId, body)</a></code></p>
	<p class="firstline">Update the regional inventory of a product in your Merchant Center account. If a regional inventory with the same region ID already exists, this method updates that entry.</p>
	<h3>Method Details</h3>
	<div class="method">
	<code class="details" id="custombatch">custombatch(body)</code>
	<pre>Updates regional inventory for multiple products or regions in a single request.

	Args:
	body: object, The request body. (required)
	The object takes the form of:

	{
	"entries": [ # The request entries to be processed in the batch.
	{ # A batch entry encoding a single non-batch regional inventory request.
	"batchId": 42, # An entry ID, unique within the batch request.
	"regionalInventory": { # Regional inventory resource. contains the regional name and all attributes which are overridden for the specified region. # Price and availability of the product.
	"kind": "content#regionalInventory", # Identifies what kind of resource this is. Value: the fixed string "content#regionalInventory".
	"salePriceEffectiveDate": "A String", # A date range represented by a pair of ISO 8601 dates separated by a space, comma, or slash. Both dates might be specified as 'null' if undecided.
	"price": { # The price of the product.
	"currency": "A String", # The currency of the price.
	"value": "A String", # The price represented as a number.
	},
	"regionId": "A String", # The ID (name) of the region.
	"customAttributes": [ # A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form.
	{
	"groupValues": [ # Subattributes within this attribute group. Exactly one of value or groupValues must be provided.
	# Object with schema name: CustomAttribute
	],
	"name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion.
	"value": "A String", # The value of the attribute.
	},
	],
	"salePrice": { # The sale price of the product. Mandatory if sale_price_effective_date is defined.
	"currency": "A String", # The currency of the price.
	"value": "A String", # The price represented as a number.
	},
	"availability": "A String", # The availability of the product.
	},
	"productId": "A String", # The ID of the product for which to update price and availability.
	"merchantId": "A String", # The ID of the managing account.
	"method": "A String",
	},
	],
	}


	Returns:
	An object of the form:

	{
	"kind": "content#regionalinventoryCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#regionalinventoryCustomBatchResponse".
	"entries": [ # The result of the execution of the batch requests.
	{ # A batch entry encoding a single non-batch regional inventory response.
	"batchId": 42, # The ID of the request entry this entry responds to.
	"regionalInventory": { # Regional inventory resource. contains the regional name and all attributes which are overridden for the specified region. # Price and availability of the product.
	"kind": "content#regionalInventory", # Identifies what kind of resource this is. Value: the fixed string "content#regionalInventory".
	"salePriceEffectiveDate": "A String", # A date range represented by a pair of ISO 8601 dates separated by a space, comma, or slash. Both dates might be specified as 'null' if undecided.
	"price": { # The price of the product.
	"currency": "A String", # The currency of the price.
	"value": "A String", # The price represented as a number.
	},
	"regionId": "A String", # The ID (name) of the region.
	"customAttributes": [ # A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form.
	{
	"groupValues": [ # Subattributes within this attribute group. Exactly one of value or groupValues must be provided.
	# Object with schema name: CustomAttribute
	],
	"name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion.
	"value": "A String", # The value of the attribute.
	},
	],
	"salePrice": { # The sale price of the product. Mandatory if sale_price_effective_date is defined.
	"currency": "A String", # The currency of the price.
	"value": "A String", # The price represented as a number.
	},
	"availability": "A String", # The availability of the product.
	},
	"kind": "content#regionalinventoryCustomBatchResponseEntry", # Identifies what kind of resource this is. Value: the fixed string "content#regionalinventoryCustomBatchResponseEntry".
	"errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed.
	"message": "A String", # The message of the first error in errors.
	"code": 42, # The HTTP status of the first error in errors.
	"errors": [ # A list of errors.
	{ # An error returned by the API.
	"reason": "A String", # The error code.
	"domain": "A String", # The domain of the error.
	"message": "A String", # A description of the error.
	},
	],
	},
	},
	],
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="insert">insert(merchantId, productId, body)</code>
	<pre>Update the regional inventory of a product in your Merchant Center account. If a regional inventory with the same region ID already exists, this method updates that entry.

	Args:
	merchantId: string, The ID of the account that contains the product. This account cannot be a multi-client account. (required)
	productId: string, The REST ID of the product for which to update the regional inventory. (required)
	body: object, The request body. (required)
	The object takes the form of:

	{ # Regional inventory resource. contains the regional name and all attributes which are overridden for the specified region.
	"kind": "content#regionalInventory", # Identifies what kind of resource this is. Value: the fixed string "content#regionalInventory".
	"salePriceEffectiveDate": "A String", # A date range represented by a pair of ISO 8601 dates separated by a space, comma, or slash. Both dates might be specified as 'null' if undecided.
	"price": { # The price of the product.
	"currency": "A String", # The currency of the price.
	"value": "A String", # The price represented as a number.
	},
	"regionId": "A String", # The ID (name) of the region.
	"customAttributes": [ # A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form.
	{
	"groupValues": [ # Subattributes within this attribute group. Exactly one of value or groupValues must be provided.
	# Object with schema name: CustomAttribute
	],
	"name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion.
	"value": "A String", # The value of the attribute.
	},
	],
	"salePrice": { # The sale price of the product. Mandatory if sale_price_effective_date is defined.
	"currency": "A String", # The currency of the price.
	"value": "A String", # The price represented as a number.
	},
	"availability": "A String", # The availability of the product.
	}


	Returns:
	An object of the form:

	{ # Regional inventory resource. contains the regional name and all attributes which are overridden for the specified region.
	"kind": "content#regionalInventory", # Identifies what kind of resource this is. Value: the fixed string "content#regionalInventory".
	"salePriceEffectiveDate": "A String", # A date range represented by a pair of ISO 8601 dates separated by a space, comma, or slash. Both dates might be specified as 'null' if undecided.
	"price": { # The price of the product.
	"currency": "A String", # The currency of the price.
	"value": "A String", # The price represented as a number.
	},
	"regionId": "A String", # The ID (name) of the region.
	"customAttributes": [ # A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form.
	{
	"groupValues": [ # Subattributes within this attribute group. Exactly one of value or groupValues must be provided.
	# Object with schema name: CustomAttribute
	],
	"name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion.
	"value": "A String", # The value of the attribute.
	},
	],
	"salePrice": { # The sale price of the product. Mandatory if sale_price_effective_date is defined.
	"currency": "A String", # The currency of the price.
	"value": "A String", # The price represented as a number.
	},
	"availability": "A String", # The availability of the product.
	}</pre>
	</div>

	</body></html>