Show / Hide Table of Contents

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
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Merchant.inventories_v1beta.Data
Assembly: Google.Apis.Merchant.inventories_v1beta.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?

Availability

Availability of the product in this region. For accepted attribute values, see the regional product inventory data specification.

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

CustomAttributes

A list of custom (merchant-provided) attributes. You can also use CustomAttribute to submit any attribute of the data specification in its generic form.

Declaration
[JsonProperty("customAttributes")]
public virtual IList<CustomAttribute> CustomAttributes { get; set; }
Property Value
Type Description
IList<CustomAttribute>

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 base64url encoding of this string, which is ZW5-VVMtc2t1LzEyMw. The full resource name for the regional inventory would be accounts/123/products/ZW5-VVMtc2t1LzEyMw/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. Note: For calls to the v1beta version, the plain format for the product segment is channel~content_language~feed_label~offer_id. For example, the full resource name for a regional inventory in region "region123" would be: accounts/123/products/online~en~US~sku123/regionalInventories/region123.

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

Price

Optional. Price of the product in this region.

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

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

SalePrice

Optional. Sale price of the product in this region. Mandatory if salePriceEffectiveDate is defined.

Declaration
[JsonProperty("salePrice")]
public virtual Price SalePrice { get; set; }
Property Value
Type Description
Price

SalePriceEffectiveDate

Optional. The TimePeriod of the sale price in this region.

Declaration
[JsonProperty("salePriceEffectiveDate")]
public virtual Interval SalePriceEffectiveDate { get; set; }
Property Value
Type Description
Interval

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX