docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/content_v2.pos.html b/docs/dyn/content_v2.pos.html
index 1a00951..2297ad7 100644
--- a/docs/dyn/content_v2.pos.html
+++ b/docs/dyn/content_v2.pos.html
@@ -105,54 +105,54 @@
The object takes the form of:
{
- "entries": [ # The request entries to be processed in the batch.
+ "entries": [ # The request entries to be processed in the batch.
{
- "storeCode": "A String", # The store code. Set this only if the method is `delete` or `get`.
- "targetMerchantId": "A String", # The ID of the account for which to get/submit data.
- "sale": { # The change of the available quantity of an item at the given store. # The sale information to submit. Set this only if the method is `sale`.
- "itemId": "A String", # Required. A unique identifier for the item.
- "storeCode": "A String", # Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.
- "kind": "content#posSale", # Identifies what kind of resource this is. Value: the fixed string "`content#posSale`"
- "contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
- "timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 format.
- "price": { # Required. The price of the item.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
+ "batchId": 42, # An entry ID, unique within the batch request.
+ "inventory": { # The absolute quantity of an item available at the given store. # The inventory to submit. Set this only if the method is `inventory`.
+ "contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
+ "gtin": "A String", # Global Trade Item Number.
+ "itemId": "A String", # Required. A unique identifier for the item.
+ "kind": "content#posInventory", # Identifies what kind of resource this is. Value: the fixed string "`content#posInventory`"
+ "price": { # Required. The current price of the item.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
},
- "targetCountry": "A String", # Required. The CLDR territory code for the item.
- "gtin": "A String", # Global Trade Item Number.
- "saleId": "A String", # A unique ID to group items from the same sale event.
- "quantity": "A String", # Required. The relative change of the available quantity. Negative for items returned.
+ "quantity": "A String", # Required. The available quantity of the item.
+ "storeCode": "A String", # Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.
+ "targetCountry": "A String", # Required. The CLDR territory code for the item.
+ "timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 format.
},
- "merchantId": "A String", # The ID of the POS data provider.
- "batchId": 42, # An entry ID, unique within the batch request.
- "inventory": { # The absolute quantity of an item available at the given store. # The inventory to submit. Set this only if the method is `inventory`.
- "itemId": "A String", # Required. A unique identifier for the item.
- "storeCode": "A String", # Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.
- "kind": "content#posInventory", # Identifies what kind of resource this is. Value: the fixed string "`content#posInventory`"
- "contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
- "timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 format.
- "price": { # Required. The current price of the item.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
- },
- "targetCountry": "A String", # Required. The CLDR territory code for the item.
- "gtin": "A String", # Global Trade Item Number.
- "quantity": "A String", # Required. The available quantity of the item.
- },
- "method": "A String", # The method of the batch entry.
+ "merchantId": "A String", # The ID of the POS data provider.
+ "method": "A String", # The method of the batch entry.
#
# Acceptable values are:
- # - "`delete`"
- # - "`get`"
- # - "`insert`"
- # - "`inventory`"
- # - "`sale`"
- "store": { # Store resource. # The store information to submit. Set this only if the method is `insert`.
- "storeAddress": "A String", # Required. The street address of the store.
- "kind": "content#posStore", # Identifies what kind of resource this is. Value: the fixed string "`content#posStore`"
- "storeCode": "A String", # Required. A store identifier that is unique for the given merchant.
+ # - "`delete`"
+ # - "`get`"
+ # - "`insert`"
+ # - "`inventory`"
+ # - "`sale`"
+ "sale": { # The change of the available quantity of an item at the given store. # The sale information to submit. Set this only if the method is `sale`.
+ "contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
+ "gtin": "A String", # Global Trade Item Number.
+ "itemId": "A String", # Required. A unique identifier for the item.
+ "kind": "content#posSale", # Identifies what kind of resource this is. Value: the fixed string "`content#posSale`"
+ "price": { # Required. The price of the item.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
},
+ "quantity": "A String", # Required. The relative change of the available quantity. Negative for items returned.
+ "saleId": "A String", # A unique ID to group items from the same sale event.
+ "storeCode": "A String", # Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.
+ "targetCountry": "A String", # Required. The CLDR territory code for the item.
+ "timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 format.
+ },
+ "store": { # Store resource. # The store information to submit. Set this only if the method is `insert`.
+ "kind": "content#posStore", # Identifies what kind of resource this is. Value: the fixed string "`content#posStore`"
+ "storeAddress": "A String", # Required. The street address of the store.
+ "storeCode": "A String", # Required. A store identifier that is unique for the given merchant.
+ },
+ "storeCode": "A String", # The store code. Set this only if the method is `delete` or `get`.
+ "targetMerchantId": "A String", # The ID of the account for which to get/submit data.
},
],
}
@@ -163,58 +163,58 @@
An object of the form:
{
- "kind": "content#posCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#posCustomBatchResponse".
- "entries": [ # The result of the execution of the batch requests.
+ "entries": [ # The result of the execution of the batch requests.
{
- "kind": "content#posCustomBatchResponseEntry", # Identifies what kind of resource this is. Value: the fixed string "`content#posCustomBatchResponseEntry`"
- "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.
+ "batchId": 42, # The ID of the request entry to which this entry responds.
+ "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.
- "reason": "A String", # The error code.
- "domain": "A String", # The domain of the error.
- "message": "A String", # A description of the error.
+ "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`.
},
- "sale": { # The change of the available quantity of an item at the given store. # The updated sale information.
- "itemId": "A String", # Required. A unique identifier for the item.
- "storeCode": "A String", # Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.
- "kind": "content#posSale", # Identifies what kind of resource this is. Value: the fixed string "`content#posSale`"
- "contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
- "timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 format.
- "price": { # Required. The price of the item.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
+ "inventory": { # The absolute quantity of an item available at the given store. # The updated inventory information.
+ "contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
+ "gtin": "A String", # Global Trade Item Number.
+ "itemId": "A String", # Required. A unique identifier for the item.
+ "kind": "content#posInventory", # Identifies what kind of resource this is. Value: the fixed string "`content#posInventory`"
+ "price": { # Required. The current price of the item.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
},
- "targetCountry": "A String", # Required. The CLDR territory code for the item.
- "gtin": "A String", # Global Trade Item Number.
- "saleId": "A String", # A unique ID to group items from the same sale event.
- "quantity": "A String", # Required. The relative change of the available quantity. Negative for items returned.
+ "quantity": "A String", # Required. The available quantity of the item.
+ "storeCode": "A String", # Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.
+ "targetCountry": "A String", # Required. The CLDR territory code for the item.
+ "timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 format.
},
- "batchId": 42, # The ID of the request entry to which this entry responds.
- "inventory": { # The absolute quantity of an item available at the given store. # The updated inventory information.
- "itemId": "A String", # Required. A unique identifier for the item.
- "storeCode": "A String", # Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.
- "kind": "content#posInventory", # Identifies what kind of resource this is. Value: the fixed string "`content#posInventory`"
- "contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
- "timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 format.
- "price": { # Required. The current price of the item.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
+ "kind": "content#posCustomBatchResponseEntry", # Identifies what kind of resource this is. Value: the fixed string "`content#posCustomBatchResponseEntry`"
+ "sale": { # The change of the available quantity of an item at the given store. # The updated sale information.
+ "contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
+ "gtin": "A String", # Global Trade Item Number.
+ "itemId": "A String", # Required. A unique identifier for the item.
+ "kind": "content#posSale", # Identifies what kind of resource this is. Value: the fixed string "`content#posSale`"
+ "price": { # Required. The price of the item.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
},
- "targetCountry": "A String", # Required. The CLDR territory code for the item.
- "gtin": "A String", # Global Trade Item Number.
- "quantity": "A String", # Required. The available quantity of the item.
+ "quantity": "A String", # Required. The relative change of the available quantity. Negative for items returned.
+ "saleId": "A String", # A unique ID to group items from the same sale event.
+ "storeCode": "A String", # Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.
+ "targetCountry": "A String", # Required. The CLDR territory code for the item.
+ "timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 format.
},
- "store": { # Store resource. # The retrieved or updated store information.
- "storeAddress": "A String", # Required. The street address of the store.
- "kind": "content#posStore", # Identifies what kind of resource this is. Value: the fixed string "`content#posStore`"
- "storeCode": "A String", # Required. A store identifier that is unique for the given merchant.
- },
+ "store": { # Store resource. # The retrieved or updated store information.
+ "kind": "content#posStore", # Identifies what kind of resource this is. Value: the fixed string "`content#posStore`"
+ "storeAddress": "A String", # Required. The street address of the store.
+ "storeCode": "A String", # Required. A store identifier that is unique for the given merchant.
+ },
},
],
+ "kind": "content#posCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#posCustomBatchResponse".
}</pre>
</div>
@@ -243,10 +243,10 @@
An object of the form:
{ # Store resource.
- "storeAddress": "A String", # Required. The street address of the store.
- "kind": "content#posStore", # Identifies what kind of resource this is. Value: the fixed string "`content#posStore`"
- "storeCode": "A String", # Required. A store identifier that is unique for the given merchant.
- }</pre>
+ "kind": "content#posStore", # Identifies what kind of resource this is. Value: the fixed string "`content#posStore`"
+ "storeAddress": "A String", # Required. The street address of the store.
+ "storeCode": "A String", # Required. A store identifier that is unique for the given merchant.
+ }</pre>
</div>
<div class="method">
@@ -260,10 +260,10 @@
The object takes the form of:
{ # Store resource.
- "storeAddress": "A String", # Required. The street address of the store.
- "kind": "content#posStore", # Identifies what kind of resource this is. Value: the fixed string "`content#posStore`"
- "storeCode": "A String", # Required. A store identifier that is unique for the given merchant.
- }
+ "kind": "content#posStore", # Identifies what kind of resource this is. Value: the fixed string "`content#posStore`"
+ "storeAddress": "A String", # Required. The street address of the store.
+ "storeCode": "A String", # Required. A store identifier that is unique for the given merchant.
+}
dryRun: boolean, Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
@@ -271,10 +271,10 @@
An object of the form:
{ # Store resource.
- "storeAddress": "A String", # Required. The street address of the store.
- "kind": "content#posStore", # Identifies what kind of resource this is. Value: the fixed string "`content#posStore`"
- "storeCode": "A String", # Required. A store identifier that is unique for the given merchant.
- }</pre>
+ "kind": "content#posStore", # Identifies what kind of resource this is. Value: the fixed string "`content#posStore`"
+ "storeAddress": "A String", # Required. The street address of the store.
+ "storeCode": "A String", # Required. A store identifier that is unique for the given merchant.
+ }</pre>
</div>
<div class="method">
@@ -288,17 +288,17 @@
The object takes the form of:
{
- "itemId": "A String", # Required. A unique identifier for the item.
- "storeCode": "A String", # Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.
- "targetCountry": "A String", # Required. The CLDR territory code for the item.
- "contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
- "timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 format.
- "price": { # Required. The current price of the item.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
+ "contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
+ "gtin": "A String", # Global Trade Item Number.
+ "itemId": "A String", # Required. A unique identifier for the item.
+ "price": { # Required. The current price of the item.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
},
- "gtin": "A String", # Global Trade Item Number.
- "quantity": "A String", # Required. The available quantity of the item.
+ "quantity": "A String", # Required. The available quantity of the item.
+ "storeCode": "A String", # Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.
+ "targetCountry": "A String", # Required. The CLDR territory code for the item.
+ "timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 format.
}
dryRun: boolean, Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
@@ -307,18 +307,18 @@
An object of the form:
{
- "itemId": "A String", # Required. A unique identifier for the item.
- "storeCode": "A String", # Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.
- "kind": "content#posInventoryResponse", # Identifies what kind of resource this is. Value: the fixed string "content#posInventoryResponse".
- "contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
- "timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 format.
- "price": { # Required. The current price of the item.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
+ "contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
+ "gtin": "A String", # Global Trade Item Number.
+ "itemId": "A String", # Required. A unique identifier for the item.
+ "kind": "content#posInventoryResponse", # Identifies what kind of resource this is. Value: the fixed string "content#posInventoryResponse".
+ "price": { # Required. The current price of the item.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
},
- "targetCountry": "A String", # Required. The CLDR territory code for the item.
- "gtin": "A String", # Global Trade Item Number.
- "quantity": "A String", # Required. The available quantity of the item.
+ "quantity": "A String", # Required. The available quantity of the item.
+ "storeCode": "A String", # Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.
+ "targetCountry": "A String", # Required. The CLDR territory code for the item.
+ "timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 format.
}</pre>
</div>
@@ -334,13 +334,13 @@
An object of the form:
{
- "kind": "content#posListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#posListResponse".
- "resources": [
+ "kind": "content#posListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#posListResponse".
+ "resources": [
{ # Store resource.
- "storeAddress": "A String", # Required. The street address of the store.
- "kind": "content#posStore", # Identifies what kind of resource this is. Value: the fixed string "`content#posStore`"
- "storeCode": "A String", # Required. A store identifier that is unique for the given merchant.
- },
+ "kind": "content#posStore", # Identifies what kind of resource this is. Value: the fixed string "`content#posStore`"
+ "storeAddress": "A String", # Required. The street address of the store.
+ "storeCode": "A String", # Required. A store identifier that is unique for the given merchant.
+ },
],
}</pre>
</div>
@@ -356,18 +356,18 @@
The object takes the form of:
{
- "itemId": "A String", # Required. A unique identifier for the item.
- "storeCode": "A String", # Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.
- "targetCountry": "A String", # Required. The CLDR territory code for the item.
- "contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
- "timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 format.
- "price": { # Required. The price of the item.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
+ "contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
+ "gtin": "A String", # Global Trade Item Number.
+ "itemId": "A String", # Required. A unique identifier for the item.
+ "price": { # Required. The price of the item.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
},
- "saleId": "A String", # A unique ID to group items from the same sale event.
- "gtin": "A String", # Global Trade Item Number.
- "quantity": "A String", # Required. The relative change of the available quantity. Negative for items returned.
+ "quantity": "A String", # Required. The relative change of the available quantity. Negative for items returned.
+ "saleId": "A String", # A unique ID to group items from the same sale event.
+ "storeCode": "A String", # Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.
+ "targetCountry": "A String", # Required. The CLDR territory code for the item.
+ "timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 format.
}
dryRun: boolean, Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
@@ -376,19 +376,19 @@
An object of the form:
{
- "itemId": "A String", # Required. A unique identifier for the item.
- "storeCode": "A String", # Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.
- "kind": "content#posSaleResponse", # Identifies what kind of resource this is. Value: the fixed string "content#posSaleResponse".
- "contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
- "timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 format.
- "price": { # Required. The price of the item.
- "currency": "A String", # The currency of the price.
- "value": "A String", # The price represented as a number.
+ "contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
+ "gtin": "A String", # Global Trade Item Number.
+ "itemId": "A String", # Required. A unique identifier for the item.
+ "kind": "content#posSaleResponse", # Identifies what kind of resource this is. Value: the fixed string "content#posSaleResponse".
+ "price": { # Required. The price of the item.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
},
- "targetCountry": "A String", # Required. The CLDR territory code for the item.
- "gtin": "A String", # Global Trade Item Number.
- "saleId": "A String", # A unique ID to group items from the same sale event.
- "quantity": "A String", # Required. The relative change of the available quantity. Negative for items returned.
+ "quantity": "A String", # Required. The relative change of the available quantity. Negative for items returned.
+ "saleId": "A String", # A unique ID to group items from the same sale event.
+ "storeCode": "A String", # Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.
+ "targetCountry": "A String", # Required. The CLDR territory code for the item.
+ "timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 format.
}</pre>
</div>