Content API for Shopping . productdeliverytime

Instance Methods

close()

Close httplib2 connections.

create(merchantId, body=None, x__xgafv=None)

Creates or updates the delivery time of a product.

delete(merchantId, productId, x__xgafv=None)

Deletes the delivery time of a product.

get(merchantId, productId, x__xgafv=None)

Gets `productDeliveryTime` by `productId`.

Method Details

close()
Close httplib2 connections.
create(merchantId, body=None, x__xgafv=None)
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.
  "areaDeliveryTimes": [ # 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.
      "deliveryArea": { # 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.
        "countryCode": "A String", # 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`.
        "postalCodeRange": { # 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.
          "firstPostalCode": "A String", # Required. A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: `"94108"`, `"9410*"`, `"9*"`.
          "lastPostalCode": "A String", # 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`.
        },
        "regionCode": "A String", # 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, `"NY"`, `"NSW"`, `"03"`).
      },
      "deliveryTime": { # A delivery time for this product. # Required. The delivery time associated with `deliveryArea` for this product.
        "maxHandlingTimeDays": 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.
        "maxTransitTimeDays": 42, # Required. The maximum number of business days (inclusive) between when the product ships and when the product is delivered.
        "minHandlingTimeDays": 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.
        "minTransitTimeDays": 42, # Required. The minimum number of business days (inclusive) between when the product ships and when the product is delivered.
      },
    },
  ],
  "productId": { # The Content API ID of the product. # Required. The `id` of the product.
    "productId": "A String", # 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.
  "areaDeliveryTimes": [ # 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.
      "deliveryArea": { # 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.
        "countryCode": "A String", # 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`.
        "postalCodeRange": { # 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.
          "firstPostalCode": "A String", # Required. A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: `"94108"`, `"9410*"`, `"9*"`.
          "lastPostalCode": "A String", # 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`.
        },
        "regionCode": "A String", # 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, `"NY"`, `"NSW"`, `"03"`).
      },
      "deliveryTime": { # A delivery time for this product. # Required. The delivery time associated with `deliveryArea` for this product.
        "maxHandlingTimeDays": 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.
        "maxTransitTimeDays": 42, # Required. The maximum number of business days (inclusive) between when the product ships and when the product is delivered.
        "minHandlingTimeDays": 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.
        "minTransitTimeDays": 42, # Required. The minimum number of business days (inclusive) between when the product ships and when the product is delivered.
      },
    },
  ],
  "productId": { # The Content API ID of the product. # Required. The `id` of the product.
    "productId": "A String", # The Content API ID of the product, in the form `channel:contentLanguage:targetCountry:offerId`.
  },
}
delete(merchantId, productId, x__xgafv=None)
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
get(merchantId, productId, x__xgafv=None)
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.
  "areaDeliveryTimes": [ # 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.
      "deliveryArea": { # 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.
        "countryCode": "A String", # 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`.
        "postalCodeRange": { # 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.
          "firstPostalCode": "A String", # Required. A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: `"94108"`, `"9410*"`, `"9*"`.
          "lastPostalCode": "A String", # 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`.
        },
        "regionCode": "A String", # 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, `"NY"`, `"NSW"`, `"03"`).
      },
      "deliveryTime": { # A delivery time for this product. # Required. The delivery time associated with `deliveryArea` for this product.
        "maxHandlingTimeDays": 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.
        "maxTransitTimeDays": 42, # Required. The maximum number of business days (inclusive) between when the product ships and when the product is delivered.
        "minHandlingTimeDays": 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.
        "minTransitTimeDays": 42, # Required. The minimum number of business days (inclusive) between when the product ships and when the product is delivered.
      },
    },
  ],
  "productId": { # The Content API ID of the product. # Required. The `id` of the product.
    "productId": "A String", # The Content API ID of the product, in the form `channel:contentLanguage:targetCountry:offerId`.
  },
}