blob: 0de6d54d3d222f0fa14ecaf62b193a483f79847f [file]
<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.productdeliverytime.html">productdeliverytime</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(merchantId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates or updates the delivery time of a product.</p>
<p class="toc_element">
<code><a href="#delete">delete(merchantId, productId, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes the delivery time of a product.</p>
<p class="toc_element">
<code><a href="#get">get(merchantId, productId, x__xgafv=None)</a></code></p>
<p class="firstline">Gets `productDeliveryTime` by `productId`.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(merchantId, body=None, x__xgafv=None)</code>
<pre>Creates or updates the delivery time of a product.
Args:
merchantId: string, The Google merchant ID of the account that contains the product. This account cannot be a multi-client account. (required)
body: object, The request body.
The object takes the form of:
{ # The estimated days to deliver a product after an order is placed. Only authorized shipping signals partners working with a merchant can use this resource. Merchants should use the [`products`](https://developers.google.com/shopping-content/reference/rest/v2.1/products#productshipping) resource instead.
&quot;areaDeliveryTimes&quot;: [ # Required. A set of associations between `DeliveryArea` and `DeliveryTime` entries. The total number of `areaDeliveryTimes` can be at most 100.
{ # A pairing of `DeliveryArea` associated with a `DeliveryTime` for this product.
&quot;deliveryArea&quot;: { # A delivery area for the product. Only one of `countryCode` or `postalCodeRange` must be set. # Required. The delivery area associated with `deliveryTime` for this product.
&quot;countryCode&quot;: &quot;A String&quot;, # Required. The country that the product can be delivered to. Submit a [unicode CLDR region](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) such as `US` or `CH`.
&quot;postalCodeRange&quot;: { # A range of postal codes that defines the delivery area. Only set `firstPostalCode` when specifying a single postal code. # A postal code, postal code range or postal code prefix that defines this area. Limited to US and AUS.
&quot;firstPostalCode&quot;: &quot;A String&quot;, # Required. A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: `&quot;94108&quot;`, `&quot;9410*&quot;`, `&quot;9*&quot;`.
&quot;lastPostalCode&quot;: &quot;A String&quot;, # A postal code or a pattern of the form prefix* denoting the inclusive upper bound of the range defining the area (for example [070* - 078*] results in the range [07000 - 07899]). It must have the same length as `firstPostalCode`: if `firstPostalCode` is a postal code then `lastPostalCode` must be a postal code too; if firstPostalCode is a pattern then `lastPostalCode` must be a pattern with the same prefix length. Ignored if not set, then the area is defined as being all the postal codes matching `firstPostalCode`.
},
&quot;regionCode&quot;: &quot;A String&quot;, # A state, territory, or prefecture. This is supported for the United States, Australia, and Japan. Provide a subdivision code from the ISO 3166-2 code tables ([US](https://en.wikipedia.org/wiki/ISO_3166-2:US), [AU](https://en.wikipedia.org/wiki/ISO_3166-2:AU), or [JP](https://en.wikipedia.org/wiki/ISO_3166-2:JP)) without country prefix (for example, `&quot;NY&quot;`, `&quot;NSW&quot;`, `&quot;03&quot;`).
},
&quot;deliveryTime&quot;: { # A delivery time for this product. # Required. The delivery time associated with `deliveryArea` for this product.
&quot;maxHandlingTimeDays&quot;: 42, # Required. The maximum number of business days (inclusive) between when an order is placed and when the product ships. If a product ships in the same day, set this value to 0.
&quot;maxTransitTimeDays&quot;: 42, # Required. The maximum number of business days (inclusive) between when the product ships and when the product is delivered.
&quot;minHandlingTimeDays&quot;: 42, # Required. The minimum number of business days (inclusive) between when an order is placed and when the product ships. If a product ships in the same day, set this value to 0.
&quot;minTransitTimeDays&quot;: 42, # Required. The minimum number of business days (inclusive) between when the product ships and when the product is delivered.
},
},
],
&quot;productId&quot;: { # The Content API ID of the product. # Required. The `id` of the product.
&quot;productId&quot;: &quot;A String&quot;, # The Content API ID of the product, in the form `channel:contentLanguage:targetCountry:offerId`.
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The estimated days to deliver a product after an order is placed. Only authorized shipping signals partners working with a merchant can use this resource. Merchants should use the [`products`](https://developers.google.com/shopping-content/reference/rest/v2.1/products#productshipping) resource instead.
&quot;areaDeliveryTimes&quot;: [ # Required. A set of associations between `DeliveryArea` and `DeliveryTime` entries. The total number of `areaDeliveryTimes` can be at most 100.
{ # A pairing of `DeliveryArea` associated with a `DeliveryTime` for this product.
&quot;deliveryArea&quot;: { # A delivery area for the product. Only one of `countryCode` or `postalCodeRange` must be set. # Required. The delivery area associated with `deliveryTime` for this product.
&quot;countryCode&quot;: &quot;A String&quot;, # Required. The country that the product can be delivered to. Submit a [unicode CLDR region](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) such as `US` or `CH`.
&quot;postalCodeRange&quot;: { # A range of postal codes that defines the delivery area. Only set `firstPostalCode` when specifying a single postal code. # A postal code, postal code range or postal code prefix that defines this area. Limited to US and AUS.
&quot;firstPostalCode&quot;: &quot;A String&quot;, # Required. A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: `&quot;94108&quot;`, `&quot;9410*&quot;`, `&quot;9*&quot;`.
&quot;lastPostalCode&quot;: &quot;A String&quot;, # A postal code or a pattern of the form prefix* denoting the inclusive upper bound of the range defining the area (for example [070* - 078*] results in the range [07000 - 07899]). It must have the same length as `firstPostalCode`: if `firstPostalCode` is a postal code then `lastPostalCode` must be a postal code too; if firstPostalCode is a pattern then `lastPostalCode` must be a pattern with the same prefix length. Ignored if not set, then the area is defined as being all the postal codes matching `firstPostalCode`.
},
&quot;regionCode&quot;: &quot;A String&quot;, # A state, territory, or prefecture. This is supported for the United States, Australia, and Japan. Provide a subdivision code from the ISO 3166-2 code tables ([US](https://en.wikipedia.org/wiki/ISO_3166-2:US), [AU](https://en.wikipedia.org/wiki/ISO_3166-2:AU), or [JP](https://en.wikipedia.org/wiki/ISO_3166-2:JP)) without country prefix (for example, `&quot;NY&quot;`, `&quot;NSW&quot;`, `&quot;03&quot;`).
},
&quot;deliveryTime&quot;: { # A delivery time for this product. # Required. The delivery time associated with `deliveryArea` for this product.
&quot;maxHandlingTimeDays&quot;: 42, # Required. The maximum number of business days (inclusive) between when an order is placed and when the product ships. If a product ships in the same day, set this value to 0.
&quot;maxTransitTimeDays&quot;: 42, # Required. The maximum number of business days (inclusive) between when the product ships and when the product is delivered.
&quot;minHandlingTimeDays&quot;: 42, # Required. The minimum number of business days (inclusive) between when an order is placed and when the product ships. If a product ships in the same day, set this value to 0.
&quot;minTransitTimeDays&quot;: 42, # Required. The minimum number of business days (inclusive) between when the product ships and when the product is delivered.
},
},
],
&quot;productId&quot;: { # The Content API ID of the product. # Required. The `id` of the product.
&quot;productId&quot;: &quot;A String&quot;, # The Content API ID of the product, in the form `channel:contentLanguage:targetCountry:offerId`.
},
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(merchantId, productId, x__xgafv=None)</code>
<pre>Deletes the delivery time of a product.
Args:
merchantId: string, Required. The Google merchant ID of the account that contains the product. This account cannot be a multi-client account. (required)
productId: string, Required. The Content API ID of the product, in the form `channel:contentLanguage:targetCountry:offerId`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</pre>
</div>
<div class="method">
<code class="details" id="get">get(merchantId, productId, x__xgafv=None)</code>
<pre>Gets `productDeliveryTime` by `productId`.
Args:
merchantId: string, Required. The Google merchant ID of the account that contains the product. This account cannot be a multi-client account. (required)
productId: string, Required. The Content API ID of the product, in the form `channel:contentLanguage:targetCountry:offerId`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The estimated days to deliver a product after an order is placed. Only authorized shipping signals partners working with a merchant can use this resource. Merchants should use the [`products`](https://developers.google.com/shopping-content/reference/rest/v2.1/products#productshipping) resource instead.
&quot;areaDeliveryTimes&quot;: [ # Required. A set of associations between `DeliveryArea` and `DeliveryTime` entries. The total number of `areaDeliveryTimes` can be at most 100.
{ # A pairing of `DeliveryArea` associated with a `DeliveryTime` for this product.
&quot;deliveryArea&quot;: { # A delivery area for the product. Only one of `countryCode` or `postalCodeRange` must be set. # Required. The delivery area associated with `deliveryTime` for this product.
&quot;countryCode&quot;: &quot;A String&quot;, # Required. The country that the product can be delivered to. Submit a [unicode CLDR region](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) such as `US` or `CH`.
&quot;postalCodeRange&quot;: { # A range of postal codes that defines the delivery area. Only set `firstPostalCode` when specifying a single postal code. # A postal code, postal code range or postal code prefix that defines this area. Limited to US and AUS.
&quot;firstPostalCode&quot;: &quot;A String&quot;, # Required. A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: `&quot;94108&quot;`, `&quot;9410*&quot;`, `&quot;9*&quot;`.
&quot;lastPostalCode&quot;: &quot;A String&quot;, # A postal code or a pattern of the form prefix* denoting the inclusive upper bound of the range defining the area (for example [070* - 078*] results in the range [07000 - 07899]). It must have the same length as `firstPostalCode`: if `firstPostalCode` is a postal code then `lastPostalCode` must be a postal code too; if firstPostalCode is a pattern then `lastPostalCode` must be a pattern with the same prefix length. Ignored if not set, then the area is defined as being all the postal codes matching `firstPostalCode`.
},
&quot;regionCode&quot;: &quot;A String&quot;, # A state, territory, or prefecture. This is supported for the United States, Australia, and Japan. Provide a subdivision code from the ISO 3166-2 code tables ([US](https://en.wikipedia.org/wiki/ISO_3166-2:US), [AU](https://en.wikipedia.org/wiki/ISO_3166-2:AU), or [JP](https://en.wikipedia.org/wiki/ISO_3166-2:JP)) without country prefix (for example, `&quot;NY&quot;`, `&quot;NSW&quot;`, `&quot;03&quot;`).
},
&quot;deliveryTime&quot;: { # A delivery time for this product. # Required. The delivery time associated with `deliveryArea` for this product.
&quot;maxHandlingTimeDays&quot;: 42, # Required. The maximum number of business days (inclusive) between when an order is placed and when the product ships. If a product ships in the same day, set this value to 0.
&quot;maxTransitTimeDays&quot;: 42, # Required. The maximum number of business days (inclusive) between when the product ships and when the product is delivered.
&quot;minHandlingTimeDays&quot;: 42, # Required. The minimum number of business days (inclusive) between when an order is placed and when the product ships. If a product ships in the same day, set this value to 0.
&quot;minTransitTimeDays&quot;: 42, # Required. The minimum number of business days (inclusive) between when the product ships and when the product is delivered.
},
},
],
&quot;productId&quot;: { # The Content API ID of the product. # Required. The `id` of the product.
&quot;productId&quot;: &quot;A String&quot;, # The Content API ID of the product, in the form `channel:contentLanguage:targetCountry:offerId`.
},
}</pre>
</div>
</body></html>