Class ListRegionalInventoriesRequest

Request message for the ListRegionalInventories method.

Inheritance
object
ListRegionalInventoriesRequest
Implements
Inherited Members
Namespace: Google.Shopping.Merchant.Inventories.V1
Assembly: Google.Shopping.Merchant.Inventories.V1.dll
Syntax
public sealed class ListRegionalInventoriesRequest : IMessage<ListRegionalInventoriesRequest>, IEquatable<ListRegionalInventoriesRequest>, IDeepCloneable<ListRegionalInventoriesRequest>, IBufferMessage, IMessage, IPageRequest

Constructors

ListRegionalInventoriesRequest()

Declaration
public ListRegionalInventoriesRequest()

ListRegionalInventoriesRequest(ListRegionalInventoriesRequest)

Declaration
public ListRegionalInventoriesRequest(ListRegionalInventoriesRequest other)
Parameters
Type Name Description
ListRegionalInventoriesRequest other

Properties

PageSize

The maximum number of RegionalInventory resources for the given product to return. The service returns fewer than this value if the number of inventories for the given product is less that than the pageSize. The default value is 25000. The maximum value is 100000; If a value higher than the maximum is specified, then the pageSize will default to the maximum.

Declaration
public int PageSize { get; set; }
Property Value
Type Description
int
Implements

PageToken

A page token, received from a previous ListRegionalInventories call. Provide the page token to retrieve the subsequent page.

When paginating, all other parameters provided to ListRegionalInventories must match the call that provided the page token. The token returned as [nextPageToken][google.shopping.merchant.inventories.v1.ListRegionalInventoriesResponse.next_page_token] in the response to the previous request.

Declaration
public string PageToken { get; set; }
Property Value
Type Description
string
Implements

Parent

Required. The name of the parent product to list RegionalInventory resources for. Format: accounts/{account}/products/{product}

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, the {product} segment must be the unpadded base64url encoding of this string, which is ZW5-VVN-c2t1LzEyMw. The full resource name for the product would be accounts/123/products/ZW5-VVN-c2t1LzEyMw.

  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
public string Parent { get; set; }
Property Value
Type Description
string

ParentAsProductName

ProductName-typed view over the Parent resource name property.

Declaration
public ProductName ParentAsProductName { get; set; }
Property Value
Type Description
ProductName