Interface InsertLocalInventoryRequestOrBuilder (1.19.0) 

public interface InsertLocalInventoryRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getLocalInventory()

public abstract LocalInventory getLocalInventory()

Required. Local inventory information of the product. If the product already has a LocalInventory resource for the same storeCode, full replacement of the LocalInventory resource is performed.

.google.shopping.merchant.inventories.v1.LocalInventory local_inventory = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
LocalInventory

The localInventory.

getLocalInventoryOrBuilder()

public abstract LocalInventoryOrBuilder getLocalInventoryOrBuilder()

Required. Local inventory information of the product. If the product already has a LocalInventory resource for the same storeCode, full replacement of the LocalInventory resource is performed.

.google.shopping.merchant.inventories.v1.LocalInventory local_inventory = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
LocalInventoryOrBuilder

getParent()

public abstract String getParent()

Required. The account and product where this inventory will be inserted. 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 ~.

  2. 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.

  3. 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.

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 account and product where this inventory will be inserted. 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 ~.

  2. 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.

  3. 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.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

hasLocalInventory()

public abstract boolean hasLocalInventory()

Required. Local inventory information of the product. If the product already has a LocalInventory resource for the same storeCode, full replacement of the LocalInventory resource is performed.

.google.shopping.merchant.inventories.v1.LocalInventory local_inventory = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the localInventory field is set.