Class RegionalInventory

Regional inventory information for the product. Represents specific information like price and availability for a given product in a specific region. For a list of all accepted attribute values, see the regional product inventory data specification.

Inheritance
object
RegionalInventory
Implements
Inherited Members
Namespace: Google.Apis.Merchant.inventories_v1.Data
Assembly: Google.Apis.Merchant.inventories_v1.dll
Syntax
public class RegionalInventory : IDirectResponseSchema

Properties

Account

Output only. The account that owns the product. This field will be ignored if set by the client.

Declaration
[JsonProperty("account")]
public virtual long? Account { get; set; }
Property Value
Type Description
long?

Base64EncodedName

Output only. The unpadded base64url encoded name of the RegionalInventory resource. Format: accounts/{account}/products/{product}/regionalInventories/{region} where the {product} segment is the unpadded base64url encoded value of the identifier of the form content_language~feed_label~offer_id. Example: accounts/123/products/ZW5-VVN-c2t1LzEyMw/regionalInventories/region123 for the decoded product ID en~US~sku/123 and region "region123". Can be used directly as input to the API methods that require the product identifier within the regional inventory name to be encoded if it contains special characters, for example GetRegionalInventory.

Declaration
[JsonProperty("base64EncodedName")]
public virtual string Base64EncodedName { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

Name

Output only. The name of the RegionalInventory resource. Format: accounts/{account}/products/{product}/regionalInventories/{region} The {product} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: content_language~feed_label~offer_id. Example: en~US~sku123 For legacy local products, the structure is: local~content_language~feed_label~offer_id. Example: local~en~US~sku123 The format of the {product} segment in the URL is automatically detected by the server, supporting two options: 1. Encoded Format: The {product} segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the content_language~feed_label~offer_id structure. This encoding MUST be used if any part of the product identifier (like offer_id) contains characters such as /, %, or ~. * Example: To represent the product ID en~US~sku/123 for region "region123", the {product} segment must be the unpadded base64url encoding of this string, which is ZW5-VVN-c2t1LzEyMw. The full resource name for the regional inventory would be accounts/123/products/ZW5-VVN-c2t1LzEyMw/regionalInventories/region123. 2. Plain Format: The {product} segment is the tilde-separated string content_language~feed_label~offer_id. This format is suitable only when content_language, feed_label, and offer_id do not contain URL-problematic characters like /, %, or ~. We recommend using the Encoded Format for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (~) characters in the {product} segment is used to differentiate between the two formats.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

Region

Required. Immutable. ID of the region for this RegionalInventory resource. See the Regional availability and pricing for more details.

Declaration
[JsonProperty("region")]
public virtual string Region { get; set; }
Property Value
Type Description
string

RegionalInventoryAttributes

Optional. A list of regional inventory attributes.

Declaration
[JsonProperty("regionalInventoryAttributes")]
public virtual RegionalInventoryAttributes RegionalInventoryAttributes { get; set; }
Property Value
Type Description
RegionalInventoryAttributes

Implements