Class InsertLocalInventoryRequest (1.19.0)

public final class InsertLocalInventoryRequest extends GeneratedMessage implements InsertLocalInventoryRequestOrBuilder

Request message for the InsertLocalInventory method.

Protobuf type google.shopping.merchant.inventories.v1.InsertLocalInventoryRequest

Static Fields

LOCAL_INVENTORY_FIELD_NUMBER

public static final int LOCAL_INVENTORY_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static InsertLocalInventoryRequest getDefaultInstance()
Returns
Type Description
InsertLocalInventoryRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static InsertLocalInventoryRequest.Builder newBuilder()
Returns
Type Description
InsertLocalInventoryRequest.Builder

newBuilder(InsertLocalInventoryRequest prototype)

public static InsertLocalInventoryRequest.Builder newBuilder(InsertLocalInventoryRequest prototype)
Parameter
Name Description
prototype InsertLocalInventoryRequest
Returns
Type Description
InsertLocalInventoryRequest.Builder

parseDelimitedFrom(InputStream input)

public static InsertLocalInventoryRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
InsertLocalInventoryRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static InsertLocalInventoryRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
InsertLocalInventoryRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static InsertLocalInventoryRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
InsertLocalInventoryRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static InsertLocalInventoryRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
InsertLocalInventoryRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static InsertLocalInventoryRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
InsertLocalInventoryRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static InsertLocalInventoryRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
InsertLocalInventoryRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static InsertLocalInventoryRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
InsertLocalInventoryRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static InsertLocalInventoryRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
InsertLocalInventoryRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static InsertLocalInventoryRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
InsertLocalInventoryRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static InsertLocalInventoryRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
InsertLocalInventoryRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static InsertLocalInventoryRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
InsertLocalInventoryRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static InsertLocalInventoryRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
InsertLocalInventoryRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<InsertLocalInventoryRequest> parser()
Returns
Type Description
Parser<InsertLocalInventoryRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public InsertLocalInventoryRequest getDefaultInstanceForType()
Returns
Type Description
InsertLocalInventoryRequest

getLocalInventory()

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

getParserForType()

public Parser<InsertLocalInventoryRequest> getParserForType()
Returns
Type Description
Parser<InsertLocalInventoryRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasLocalInventory()

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

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public InsertLocalInventoryRequest.Builder newBuilderForType()
Returns
Type Description
InsertLocalInventoryRequest.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected InsertLocalInventoryRequest.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
InsertLocalInventoryRequest.Builder
Overrides

toBuilder()

public InsertLocalInventoryRequest.Builder toBuilder()
Returns
Type Description
InsertLocalInventoryRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException