public interface ListRegionalInventoriesRequestOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getPageSize()
public abstract int getPageSize() 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.
int32 page_size = 2;
| Returns | |
|---|---|
| Type | Description |
int |
The pageSize. |
getPageToken()
public abstract String getPageToken() 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
in the response to the previous request.
string page_token = 3;
| Returns | |
|---|---|
| Type | Description |
String |
The pageToken. |
getPageTokenBytes()
public abstract ByteString getPageTokenBytes() 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
in the response to the previous request.
string page_token = 3;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for pageToken. |
getParent()
public abstract String getParent() 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:
- Encoded Format: The
{product}segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in thecontent_language~feed_label~offer_idstructure. This encoding MUST be used if any part of the product identifier (likeoffer_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 isZW5-VVN-c2t1LzEyMw. The full resource name for the product would beaccounts/123/products/ZW5-VVN-c2t1LzEyMw.Plain Format: The
{product}segment is the tilde-separated stringcontent_language~feed_label~offer_id. This format is suitable only whencontent_language,feed_label, andoffer_iddo 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.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The parent. |
getParentBytes()
public abstract ByteString getParentBytes() 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:
- Encoded Format: The
{product}segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in thecontent_language~feed_label~offer_idstructure. This encoding MUST be used if any part of the product identifier (likeoffer_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 isZW5-VVN-c2t1LzEyMw. The full resource name for the product would beaccounts/123/products/ZW5-VVN-c2t1LzEyMw.Plain Format: The
{product}segment is the tilde-separated stringcontent_language~feed_label~offer_id. This format is suitable only whencontent_language,feed_label, andoffer_iddo 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.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for parent. |