Content API for Shopping . regionalinventory

Instance Methods

close()

Close httplib2 connections.

custombatch(body=None, x__xgafv=None)

Updates regional inventory for multiple products or regions in a single request.

insert(merchantId, productId, body=None, x__xgafv=None)

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.

Method Details

close()
Close httplib2 connections.
custombatch(body=None, x__xgafv=None)
Updates regional inventory for multiple products or regions in a single request.

Args:
  body: object, The request body.
    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.
      "merchantId": "A String", # The ID of the managing account.
      "method": "A String", # Method of the batch request entry. Acceptable values are: - "`insert`"
      "productId": "A String", # The ID of the product for which to update price and availability.
      "regionalInventory": { # Regional inventory resource. contains the regional name and all attributes which are overridden for the specified region. # Price and availability of the product.
        "availability": "A String", # The availability of the product.
        "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.
          },
        ],
        "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#regionalInventory`".
        "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 uniquely identifying each region.
        "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.
        },
        "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.
      },
    },
  ],
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "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.
      "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed.
        "code": 42, # The HTTP status of the first error in `errors`.
        "errors": [ # A list of errors.
          { # An error returned by the API.
            "domain": "A String", # The domain of the error.
            "message": "A String", # A description of the error.
            "reason": "A String", # The error code.
          },
        ],
        "message": "A String", # The message of the first error in `errors`.
      },
      "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#regionalinventoryCustomBatchResponseEntry`".
      "regionalInventory": { # Regional inventory resource. contains the regional name and all attributes which are overridden for the specified region. # Price and availability of the product.
        "availability": "A String", # The availability of the product.
        "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.
          },
        ],
        "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#regionalInventory`".
        "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 uniquely identifying each region.
        "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.
        },
        "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.
      },
    },
  ],
  "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#regionalinventoryCustomBatchResponse`".
}
insert(merchantId, productId, body=None, x__xgafv=None)
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.
    The object takes the form of:

{ # Regional inventory resource. contains the regional name and all attributes which are overridden for the specified region.
  "availability": "A String", # The availability of the product.
  "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.
    },
  ],
  "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#regionalInventory`".
  "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 uniquely identifying each region.
  "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.
  },
  "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.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Regional inventory resource. contains the regional name and all attributes which are overridden for the specified region.
  "availability": "A String", # The availability of the product.
  "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.
    },
  ],
  "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#regionalInventory`".
  "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 uniquely identifying each region.
  "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.
  },
  "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.
}