public static final class ProductInput.Builder extends GeneratedMessageV3.Builder<ProductInput.Builder> implements ProductInputOrBuilder
This resource represents input data you submit for a product, not the processed product that you see in Merchant Center, in Shopping ads, or across Google surfaces. Product inputs, rules and supplemental data source data are combined to create the processed Product. For more information, see Manage products.
Required product input attributes to pass data validation checks are primarily defined in the Products Data Specification.
The following attributes are required: feedLabel, contentLanguage and offerId.
After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved.
All fields in the product input and its sub-messages match the English name of their corresponding attribute in the Products Data Specification with some exceptions. The following reference documentation lists the field names in the camelCase casing style while the Products Data Specification lists the names in the snake_case casing style.
Protobuf type google.shopping.merchant.products.v1.ProductInput
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ProductInput.BuilderImplements
ProductInputOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addAllCustomAttributes(Iterable<? extends CustomAttribute> values)
public ProductInput.Builder addAllCustomAttributes(Iterable<? extends CustomAttribute> values)
Optional. A list of custom (merchant-provided) attributes. It can also be
used for submitting any attribute of the data specification in its generic
form (for example,
{ "name": "size type", "value": "regular" }
).
This is useful for submitting attributes not explicitly exposed by the
API.
Maximum allowed number of characters for each
custom attribute is 10240 (represents sum of characters for name and
value). Maximum 2500 custom attributes can be set per product, with total
size of 102.4kB. Underscores in custom attribute names are replaced by
spaces upon insertion.
repeated .google.shopping.type.CustomAttribute custom_attributes = 9 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
values |
Iterable<? extends com.google.shopping.type.CustomAttribute> |
Returns | |
---|---|
Type | Description |
ProductInput.Builder |
addCustomAttributes(CustomAttribute value)
public ProductInput.Builder addCustomAttributes(CustomAttribute value)
Optional. A list of custom (merchant-provided) attributes. It can also be
used for submitting any attribute of the data specification in its generic
form (for example,
{ "name": "size type", "value": "regular" }
).
This is useful for submitting attributes not explicitly exposed by the
API.
Maximum allowed number of characters for each
custom attribute is 10240 (represents sum of characters for name and
value). Maximum 2500 custom attributes can be set per product, with total
size of 102.4kB. Underscores in custom attribute names are replaced by
spaces upon insertion.
repeated .google.shopping.type.CustomAttribute custom_attributes = 9 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
com.google.shopping.type.CustomAttribute |
Returns | |
---|---|
Type | Description |
ProductInput.Builder |
addCustomAttributes(CustomAttribute.Builder builderForValue)
public ProductInput.Builder addCustomAttributes(CustomAttribute.Builder builderForValue)
Optional. A list of custom (merchant-provided) attributes. It can also be
used for submitting any attribute of the data specification in its generic
form (for example,
{ "name": "size type", "value": "regular" }
).
This is useful for submitting attributes not explicitly exposed by the
API.
Maximum allowed number of characters for each
custom attribute is 10240 (represents sum of characters for name and
value). Maximum 2500 custom attributes can be set per product, with total
size of 102.4kB. Underscores in custom attribute names are replaced by
spaces upon insertion.
repeated .google.shopping.type.CustomAttribute custom_attributes = 9 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
builderForValue |
com.google.shopping.type.CustomAttribute.Builder |
Returns | |
---|---|
Type | Description |
ProductInput.Builder |
addCustomAttributes(int index, CustomAttribute value)
public ProductInput.Builder addCustomAttributes(int index, CustomAttribute value)
Optional. A list of custom (merchant-provided) attributes. It can also be
used for submitting any attribute of the data specification in its generic
form (for example,
{ "name": "size type", "value": "regular" }
).
This is useful for submitting attributes not explicitly exposed by the
API.
Maximum allowed number of characters for each
custom attribute is 10240 (represents sum of characters for name and
value). Maximum 2500 custom attributes can be set per product, with total
size of 102.4kB. Underscores in custom attribute names are replaced by
spaces upon insertion.
repeated .google.shopping.type.CustomAttribute custom_attributes = 9 [(.google.api.field_behavior) = OPTIONAL];
Parameters | |
---|---|
Name | Description |
index |
int |
value |
com.google.shopping.type.CustomAttribute |
Returns | |
---|---|
Type | Description |
ProductInput.Builder |
addCustomAttributes(int index, CustomAttribute.Builder builderForValue)
public ProductInput.Builder addCustomAttributes(int index, CustomAttribute.Builder builderForValue)
Optional. A list of custom (merchant-provided) attributes. It can also be
used for submitting any attribute of the data specification in its generic
form (for example,
{ "name": "size type", "value": "regular" }
).
This is useful for submitting attributes not explicitly exposed by the
API.
Maximum allowed number of characters for each
custom attribute is 10240 (represents sum of characters for name and
value). Maximum 2500 custom attributes can be set per product, with total
size of 102.4kB. Underscores in custom attribute names are replaced by
spaces upon insertion.
repeated .google.shopping.type.CustomAttribute custom_attributes = 9 [(.google.api.field_behavior) = OPTIONAL];
Parameters | |
---|---|
Name | Description |
index |
int |
builderForValue |
com.google.shopping.type.CustomAttribute.Builder |
Returns | |
---|---|
Type | Description |
ProductInput.Builder |
addCustomAttributesBuilder()
public CustomAttribute.Builder addCustomAttributesBuilder()
Optional. A list of custom (merchant-provided) attributes. It can also be
used for submitting any attribute of the data specification in its generic
form (for example,
{ "name": "size type", "value": "regular" }
).
This is useful for submitting attributes not explicitly exposed by the
API.
Maximum allowed number of characters for each
custom attribute is 10240 (represents sum of characters for name and
value). Maximum 2500 custom attributes can be set per product, with total
size of 102.4kB. Underscores in custom attribute names are replaced by
spaces upon insertion.
repeated .google.shopping.type.CustomAttribute custom_attributes = 9 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
com.google.shopping.type.CustomAttribute.Builder |
addCustomAttributesBuilder(int index)
public CustomAttribute.Builder addCustomAttributesBuilder(int index)
Optional. A list of custom (merchant-provided) attributes. It can also be
used for submitting any attribute of the data specification in its generic
form (for example,
{ "name": "size type", "value": "regular" }
).
This is useful for submitting attributes not explicitly exposed by the
API.
Maximum allowed number of characters for each
custom attribute is 10240 (represents sum of characters for name and
value). Maximum 2500 custom attributes can be set per product, with total
size of 102.4kB. Underscores in custom attribute names are replaced by
spaces upon insertion.
repeated .google.shopping.type.CustomAttribute custom_attributes = 9 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
com.google.shopping.type.CustomAttribute.Builder |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ProductInput.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
ProductInput.Builder |
build()
public ProductInput build()
Returns | |
---|---|
Type | Description |
ProductInput |
buildPartial()
public ProductInput buildPartial()
Returns | |
---|---|
Type | Description |
ProductInput |
clear()
public ProductInput.Builder clear()
Returns | |
---|---|
Type | Description |
ProductInput.Builder |
clearContentLanguage()
public ProductInput.Builder clearContentLanguage()
Required. Immutable. The two-letter ISO 639-1 language code for the product.
string content_language = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
Returns | |
---|---|
Type | Description |
ProductInput.Builder |
This builder for chaining. |
clearCustomAttributes()
public ProductInput.Builder clearCustomAttributes()
Optional. A list of custom (merchant-provided) attributes. It can also be
used for submitting any attribute of the data specification in its generic
form (for example,
{ "name": "size type", "value": "regular" }
).
This is useful for submitting attributes not explicitly exposed by the
API.
Maximum allowed number of characters for each
custom attribute is 10240 (represents sum of characters for name and
value). Maximum 2500 custom attributes can be set per product, with total
size of 102.4kB. Underscores in custom attribute names are replaced by
spaces upon insertion.
repeated .google.shopping.type.CustomAttribute custom_attributes = 9 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ProductInput.Builder |
clearFeedLabel()
public ProductInput.Builder clearFeedLabel()
Required. Immutable. The feed label that lets you categorize and identify
your products. The maximum allowed characters are 20, and the supported
characters are A-Z
, 0-9
, hyphen, and underscore. The feed label must
not include any spaces. For more information, see Using feed
labels.
string feed_label = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
Returns | |
---|---|
Type | Description |
ProductInput.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public ProductInput.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
ProductInput.Builder |
clearLegacyLocal()
public ProductInput.Builder clearLegacyLocal()
Immutable. Determines whether the product is only targeting
local destinations and whether the product name should be distinguished
with a local~
prefix. For example,
accounts/123/productInputs/local~en~US~sku123
. If a product that is not
legacy_local
is already targeting local destinations,
creating a legacy_local
product with an otherwise matching name will
fail.
bool legacy_local = 10 [(.google.api.field_behavior) = IMMUTABLE];
Returns | |
---|---|
Type | Description |
ProductInput.Builder |
This builder for chaining. |
clearName()
public ProductInput.Builder clearName()
Identifier. The name of the product input.
Format: accounts/{account}/productInputs/{productinput}
where the last section productinput
consists of:
content_language~feed_label~offer_id
example for product input name is
accounts/123/productInputs/en~US~sku123
. A legacy local product input
name would be accounts/123/productInputs/local~en~US~sku123
.
Note: For calls to the v1beta version, the productInput
section consists
of: channel~content_language~feed_label~offer_id
, for example:
accounts/123/productInputs/online~en~US~sku123
.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
Returns | |
---|---|
Type | Description |
ProductInput.Builder |
This builder for chaining. |
clearOfferId()
public ProductInput.Builder clearOfferId()
Required. Immutable. Your unique identifier for the product. This is the same for the product input and processed product. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. See the products data specification for details.
string offer_id = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
Returns | |
---|---|
Type | Description |
ProductInput.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ProductInput.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
ProductInput.Builder |
clearProduct()
public ProductInput.Builder clearProduct()
Output only. The name of the processed product.
Format: accounts/{account}/products/{product}
string product = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
ProductInput.Builder |
This builder for chaining. |
clearProductAttributes()
public ProductInput.Builder clearProductAttributes()
Optional. A list of strongly-typed product attributes.
.google.shopping.merchant.products.v1.ProductAttributes product_attributes = 11 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ProductInput.Builder |
clearVersionNumber()
public ProductInput.Builder clearVersionNumber()
Optional. Immutable. Represents the existing version (freshness) of the product, which can be used to preserve the right order when multiple updates are done at the same time.
If set, the insertion is prevented when version number is lower than
the current version number of the existing product. Re-insertion (for
example, product refresh after 30 days) can be performed with the current
version_number
.
Only supported for insertions into primary data sources. Do not set this field for updates. Do not set this field for insertions into supplemental data sources.
If the operation is prevented, the aborted exception will be thrown.
optional int64 version_number = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
Returns | |
---|---|
Type | Description |
ProductInput.Builder |
This builder for chaining. |
clone()
public ProductInput.Builder clone()
Returns | |
---|---|
Type | Description |
ProductInput.Builder |
getContentLanguage()
public String getContentLanguage()
Required. Immutable. The two-letter ISO 639-1 language code for the product.
string content_language = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
Returns | |
---|---|
Type | Description |
String |
The contentLanguage. |
getContentLanguageBytes()
public ByteString getContentLanguageBytes()
Required. Immutable. The two-letter ISO 639-1 language code for the product.
string content_language = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for contentLanguage. |
getCustomAttributes(int index)
public CustomAttribute getCustomAttributes(int index)
Optional. A list of custom (merchant-provided) attributes. It can also be
used for submitting any attribute of the data specification in its generic
form (for example,
{ "name": "size type", "value": "regular" }
).
This is useful for submitting attributes not explicitly exposed by the
API.
Maximum allowed number of characters for each
custom attribute is 10240 (represents sum of characters for name and
value). Maximum 2500 custom attributes can be set per product, with total
size of 102.4kB. Underscores in custom attribute names are replaced by
spaces upon insertion.
repeated .google.shopping.type.CustomAttribute custom_attributes = 9 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
com.google.shopping.type.CustomAttribute |
getCustomAttributesBuilder(int index)
public CustomAttribute.Builder getCustomAttributesBuilder(int index)
Optional. A list of custom (merchant-provided) attributes. It can also be
used for submitting any attribute of the data specification in its generic
form (for example,
{ "name": "size type", "value": "regular" }
).
This is useful for submitting attributes not explicitly exposed by the
API.
Maximum allowed number of characters for each
custom attribute is 10240 (represents sum of characters for name and
value). Maximum 2500 custom attributes can be set per product, with total
size of 102.4kB. Underscores in custom attribute names are replaced by
spaces upon insertion.
repeated .google.shopping.type.CustomAttribute custom_attributes = 9 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
com.google.shopping.type.CustomAttribute.Builder |
getCustomAttributesBuilderList()
public List<CustomAttribute.Builder> getCustomAttributesBuilderList()
Optional. A list of custom (merchant-provided) attributes. It can also be
used for submitting any attribute of the data specification in its generic
form (for example,
{ "name": "size type", "value": "regular" }
).
This is useful for submitting attributes not explicitly exposed by the
API.
Maximum allowed number of characters for each
custom attribute is 10240 (represents sum of characters for name and
value). Maximum 2500 custom attributes can be set per product, with total
size of 102.4kB. Underscores in custom attribute names are replaced by
spaces upon insertion.
repeated .google.shopping.type.CustomAttribute custom_attributes = 9 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
List<com.google.shopping.type.CustomAttribute.Builder> |
getCustomAttributesCount()
public int getCustomAttributesCount()
Optional. A list of custom (merchant-provided) attributes. It can also be
used for submitting any attribute of the data specification in its generic
form (for example,
{ "name": "size type", "value": "regular" }
).
This is useful for submitting attributes not explicitly exposed by the
API.
Maximum allowed number of characters for each
custom attribute is 10240 (represents sum of characters for name and
value). Maximum 2500 custom attributes can be set per product, with total
size of 102.4kB. Underscores in custom attribute names are replaced by
spaces upon insertion.
repeated .google.shopping.type.CustomAttribute custom_attributes = 9 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
int |
getCustomAttributesList()
public List<CustomAttribute> getCustomAttributesList()
Optional. A list of custom (merchant-provided) attributes. It can also be
used for submitting any attribute of the data specification in its generic
form (for example,
{ "name": "size type", "value": "regular" }
).
This is useful for submitting attributes not explicitly exposed by the
API.
Maximum allowed number of characters for each
custom attribute is 10240 (represents sum of characters for name and
value). Maximum 2500 custom attributes can be set per product, with total
size of 102.4kB. Underscores in custom attribute names are replaced by
spaces upon insertion.
repeated .google.shopping.type.CustomAttribute custom_attributes = 9 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
List<com.google.shopping.type.CustomAttribute> |
getCustomAttributesOrBuilder(int index)
public CustomAttributeOrBuilder getCustomAttributesOrBuilder(int index)
Optional. A list of custom (merchant-provided) attributes. It can also be
used for submitting any attribute of the data specification in its generic
form (for example,
{ "name": "size type", "value": "regular" }
).
This is useful for submitting attributes not explicitly exposed by the
API.
Maximum allowed number of characters for each
custom attribute is 10240 (represents sum of characters for name and
value). Maximum 2500 custom attributes can be set per product, with total
size of 102.4kB. Underscores in custom attribute names are replaced by
spaces upon insertion.
repeated .google.shopping.type.CustomAttribute custom_attributes = 9 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
com.google.shopping.type.CustomAttributeOrBuilder |
getCustomAttributesOrBuilderList()
public List<? extends CustomAttributeOrBuilder> getCustomAttributesOrBuilderList()
Optional. A list of custom (merchant-provided) attributes. It can also be
used for submitting any attribute of the data specification in its generic
form (for example,
{ "name": "size type", "value": "regular" }
).
This is useful for submitting attributes not explicitly exposed by the
API.
Maximum allowed number of characters for each
custom attribute is 10240 (represents sum of characters for name and
value). Maximum 2500 custom attributes can be set per product, with total
size of 102.4kB. Underscores in custom attribute names are replaced by
spaces upon insertion.
repeated .google.shopping.type.CustomAttribute custom_attributes = 9 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
List<? extends com.google.shopping.type.CustomAttributeOrBuilder> |
getDefaultInstanceForType()
public ProductInput getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
ProductInput |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getFeedLabel()
public String getFeedLabel()
Required. Immutable. The feed label that lets you categorize and identify
your products. The maximum allowed characters are 20, and the supported
characters are A-Z
, 0-9
, hyphen, and underscore. The feed label must
not include any spaces. For more information, see Using feed
labels.
string feed_label = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
Returns | |
---|---|
Type | Description |
String |
The feedLabel. |
getFeedLabelBytes()
public ByteString getFeedLabelBytes()
Required. Immutable. The feed label that lets you categorize and identify
your products. The maximum allowed characters are 20, and the supported
characters are A-Z
, 0-9
, hyphen, and underscore. The feed label must
not include any spaces. For more information, see Using feed
labels.
string feed_label = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for feedLabel. |
getLegacyLocal()
public boolean getLegacyLocal()
Immutable. Determines whether the product is only targeting
local destinations and whether the product name should be distinguished
with a local~
prefix. For example,
accounts/123/productInputs/local~en~US~sku123
. If a product that is not
legacy_local
is already targeting local destinations,
creating a legacy_local
product with an otherwise matching name will
fail.
bool legacy_local = 10 [(.google.api.field_behavior) = IMMUTABLE];
Returns | |
---|---|
Type | Description |
boolean |
The legacyLocal. |
getName()
public String getName()
Identifier. The name of the product input.
Format: accounts/{account}/productInputs/{productinput}
where the last section productinput
consists of:
content_language~feed_label~offer_id
example for product input name is
accounts/123/productInputs/en~US~sku123
. A legacy local product input
name would be accounts/123/productInputs/local~en~US~sku123
.
Note: For calls to the v1beta version, the productInput
section consists
of: channel~content_language~feed_label~offer_id
, for example:
accounts/123/productInputs/online~en~US~sku123
.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
Returns | |
---|---|
Type | Description |
String |
The name. |
getNameBytes()
public ByteString getNameBytes()
Identifier. The name of the product input.
Format: accounts/{account}/productInputs/{productinput}
where the last section productinput
consists of:
content_language~feed_label~offer_id
example for product input name is
accounts/123/productInputs/en~US~sku123
. A legacy local product input
name would be accounts/123/productInputs/local~en~US~sku123
.
Note: For calls to the v1beta version, the productInput
section consists
of: channel~content_language~feed_label~offer_id
, for example:
accounts/123/productInputs/online~en~US~sku123
.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for name. |
getOfferId()
public String getOfferId()
Required. Immutable. Your unique identifier for the product. This is the same for the product input and processed product. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. See the products data specification for details.
string offer_id = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
Returns | |
---|---|
Type | Description |
String |
The offerId. |
getOfferIdBytes()
public ByteString getOfferIdBytes()
Required. Immutable. Your unique identifier for the product. This is the same for the product input and processed product. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. See the products data specification for details.
string offer_id = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for offerId. |
getProduct()
public String getProduct()
Output only. The name of the processed product.
Format: accounts/{account}/products/{product}
string product = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
String |
The product. |
getProductAttributes()
public ProductAttributes getProductAttributes()
Optional. A list of strongly-typed product attributes.
.google.shopping.merchant.products.v1.ProductAttributes product_attributes = 11 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ProductAttributes |
The productAttributes. |
getProductAttributesBuilder()
public ProductAttributes.Builder getProductAttributesBuilder()
Optional. A list of strongly-typed product attributes.
.google.shopping.merchant.products.v1.ProductAttributes product_attributes = 11 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ProductAttributes.Builder |
getProductAttributesOrBuilder()
public ProductAttributesOrBuilder getProductAttributesOrBuilder()
Optional. A list of strongly-typed product attributes.
.google.shopping.merchant.products.v1.ProductAttributes product_attributes = 11 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ProductAttributesOrBuilder |
getProductBytes()
public ByteString getProductBytes()
Output only. The name of the processed product.
Format: accounts/{account}/products/{product}
string product = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for product. |
getVersionNumber()
public long getVersionNumber()
Optional. Immutable. Represents the existing version (freshness) of the product, which can be used to preserve the right order when multiple updates are done at the same time.
If set, the insertion is prevented when version number is lower than
the current version number of the existing product. Re-insertion (for
example, product refresh after 30 days) can be performed with the current
version_number
.
Only supported for insertions into primary data sources. Do not set this field for updates. Do not set this field for insertions into supplemental data sources.
If the operation is prevented, the aborted exception will be thrown.
optional int64 version_number = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
Returns | |
---|---|
Type | Description |
long |
The versionNumber. |
hasProductAttributes()
public boolean hasProductAttributes()
Optional. A list of strongly-typed product attributes.
.google.shopping.merchant.products.v1.ProductAttributes product_attributes = 11 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
boolean |
Whether the productAttributes field is set. |
hasVersionNumber()
public boolean hasVersionNumber()
Optional. Immutable. Represents the existing version (freshness) of the product, which can be used to preserve the right order when multiple updates are done at the same time.
If set, the insertion is prevented when version number is lower than
the current version number of the existing product. Re-insertion (for
example, product refresh after 30 days) can be performed with the current
version_number
.
Only supported for insertions into primary data sources. Do not set this field for updates. Do not set this field for insertions into supplemental data sources.
If the operation is prevented, the aborted exception will be thrown.
optional int64 version_number = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
Returns | |
---|---|
Type | Description |
boolean |
Whether the versionNumber field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ProductInput.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
ProductInput.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public ProductInput.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
ProductInput.Builder |
mergeFrom(ProductInput other)
public ProductInput.Builder mergeFrom(ProductInput other)
Parameter | |
---|---|
Name | Description |
other |
ProductInput |
Returns | |
---|---|
Type | Description |
ProductInput.Builder |
mergeProductAttributes(ProductAttributes value)
public ProductInput.Builder mergeProductAttributes(ProductAttributes value)
Optional. A list of strongly-typed product attributes.
.google.shopping.merchant.products.v1.ProductAttributes product_attributes = 11 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
ProductAttributes |
Returns | |
---|---|
Type | Description |
ProductInput.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ProductInput.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ProductInput.Builder |
removeCustomAttributes(int index)
public ProductInput.Builder removeCustomAttributes(int index)
Optional. A list of custom (merchant-provided) attributes. It can also be
used for submitting any attribute of the data specification in its generic
form (for example,
{ "name": "size type", "value": "regular" }
).
This is useful for submitting attributes not explicitly exposed by the
API.
Maximum allowed number of characters for each
custom attribute is 10240 (represents sum of characters for name and
value). Maximum 2500 custom attributes can be set per product, with total
size of 102.4kB. Underscores in custom attribute names are replaced by
spaces upon insertion.
repeated .google.shopping.type.CustomAttribute custom_attributes = 9 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
ProductInput.Builder |
setContentLanguage(String value)
public ProductInput.Builder setContentLanguage(String value)
Required. Immutable. The two-letter ISO 639-1 language code for the product.
string content_language = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
Parameter | |
---|---|
Name | Description |
value |
String The contentLanguage to set. |
Returns | |
---|---|
Type | Description |
ProductInput.Builder |
This builder for chaining. |
setContentLanguageBytes(ByteString value)
public ProductInput.Builder setContentLanguageBytes(ByteString value)
Required. Immutable. The two-letter ISO 639-1 language code for the product.
string content_language = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for contentLanguage to set. |
Returns | |
---|---|
Type | Description |
ProductInput.Builder |
This builder for chaining. |
setCustomAttributes(int index, CustomAttribute value)
public ProductInput.Builder setCustomAttributes(int index, CustomAttribute value)
Optional. A list of custom (merchant-provided) attributes. It can also be
used for submitting any attribute of the data specification in its generic
form (for example,
{ "name": "size type", "value": "regular" }
).
This is useful for submitting attributes not explicitly exposed by the
API.
Maximum allowed number of characters for each
custom attribute is 10240 (represents sum of characters for name and
value). Maximum 2500 custom attributes can be set per product, with total
size of 102.4kB. Underscores in custom attribute names are replaced by
spaces upon insertion.
repeated .google.shopping.type.CustomAttribute custom_attributes = 9 [(.google.api.field_behavior) = OPTIONAL];
Parameters | |
---|---|
Name | Description |
index |
int |
value |
com.google.shopping.type.CustomAttribute |
Returns | |
---|---|
Type | Description |
ProductInput.Builder |
setCustomAttributes(int index, CustomAttribute.Builder builderForValue)
public ProductInput.Builder setCustomAttributes(int index, CustomAttribute.Builder builderForValue)
Optional. A list of custom (merchant-provided) attributes. It can also be
used for submitting any attribute of the data specification in its generic
form (for example,
{ "name": "size type", "value": "regular" }
).
This is useful for submitting attributes not explicitly exposed by the
API.
Maximum allowed number of characters for each
custom attribute is 10240 (represents sum of characters for name and
value). Maximum 2500 custom attributes can be set per product, with total
size of 102.4kB. Underscores in custom attribute names are replaced by
spaces upon insertion.
repeated .google.shopping.type.CustomAttribute custom_attributes = 9 [(.google.api.field_behavior) = OPTIONAL];
Parameters | |
---|---|
Name | Description |
index |
int |
builderForValue |
com.google.shopping.type.CustomAttribute.Builder |
Returns | |
---|---|
Type | Description |
ProductInput.Builder |
setFeedLabel(String value)
public ProductInput.Builder setFeedLabel(String value)
Required. Immutable. The feed label that lets you categorize and identify
your products. The maximum allowed characters are 20, and the supported
characters are A-Z
, 0-9
, hyphen, and underscore. The feed label must
not include any spaces. For more information, see Using feed
labels.
string feed_label = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
Parameter | |
---|---|
Name | Description |
value |
String The feedLabel to set. |
Returns | |
---|---|
Type | Description |
ProductInput.Builder |
This builder for chaining. |
setFeedLabelBytes(ByteString value)
public ProductInput.Builder setFeedLabelBytes(ByteString value)
Required. Immutable. The feed label that lets you categorize and identify
your products. The maximum allowed characters are 20, and the supported
characters are A-Z
, 0-9
, hyphen, and underscore. The feed label must
not include any spaces. For more information, see Using feed
labels.
string feed_label = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for feedLabel to set. |
Returns | |
---|---|
Type | Description |
ProductInput.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public ProductInput.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
ProductInput.Builder |
setLegacyLocal(boolean value)
public ProductInput.Builder setLegacyLocal(boolean value)
Immutable. Determines whether the product is only targeting
local destinations and whether the product name should be distinguished
with a local~
prefix. For example,
accounts/123/productInputs/local~en~US~sku123
. If a product that is not
legacy_local
is already targeting local destinations,
creating a legacy_local
product with an otherwise matching name will
fail.
bool legacy_local = 10 [(.google.api.field_behavior) = IMMUTABLE];
Parameter | |
---|---|
Name | Description |
value |
boolean The legacyLocal to set. |
Returns | |
---|---|
Type | Description |
ProductInput.Builder |
This builder for chaining. |
setName(String value)
public ProductInput.Builder setName(String value)
Identifier. The name of the product input.
Format: accounts/{account}/productInputs/{productinput}
where the last section productinput
consists of:
content_language~feed_label~offer_id
example for product input name is
accounts/123/productInputs/en~US~sku123
. A legacy local product input
name would be accounts/123/productInputs/local~en~US~sku123
.
Note: For calls to the v1beta version, the productInput
section consists
of: channel~content_language~feed_label~offer_id
, for example:
accounts/123/productInputs/online~en~US~sku123
.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
Parameter | |
---|---|
Name | Description |
value |
String The name to set. |
Returns | |
---|---|
Type | Description |
ProductInput.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public ProductInput.Builder setNameBytes(ByteString value)
Identifier. The name of the product input.
Format: accounts/{account}/productInputs/{productinput}
where the last section productinput
consists of:
content_language~feed_label~offer_id
example for product input name is
accounts/123/productInputs/en~US~sku123
. A legacy local product input
name would be accounts/123/productInputs/local~en~US~sku123
.
Note: For calls to the v1beta version, the productInput
section consists
of: channel~content_language~feed_label~offer_id
, for example:
accounts/123/productInputs/online~en~US~sku123
.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for name to set. |
Returns | |
---|---|
Type | Description |
ProductInput.Builder |
This builder for chaining. |
setOfferId(String value)
public ProductInput.Builder setOfferId(String value)
Required. Immutable. Your unique identifier for the product. This is the same for the product input and processed product. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. See the products data specification for details.
string offer_id = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
Parameter | |
---|---|
Name | Description |
value |
String The offerId to set. |
Returns | |
---|---|
Type | Description |
ProductInput.Builder |
This builder for chaining. |
setOfferIdBytes(ByteString value)
public ProductInput.Builder setOfferIdBytes(ByteString value)
Required. Immutable. Your unique identifier for the product. This is the same for the product input and processed product. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. See the products data specification for details.
string offer_id = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for offerId to set. |
Returns | |
---|---|
Type | Description |
ProductInput.Builder |
This builder for chaining. |
setProduct(String value)
public ProductInput.Builder setProduct(String value)
Output only. The name of the processed product.
Format: accounts/{account}/products/{product}
string product = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
String The product to set. |
Returns | |
---|---|
Type | Description |
ProductInput.Builder |
This builder for chaining. |
setProductAttributes(ProductAttributes value)
public ProductInput.Builder setProductAttributes(ProductAttributes value)
Optional. A list of strongly-typed product attributes.
.google.shopping.merchant.products.v1.ProductAttributes product_attributes = 11 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
ProductAttributes |
Returns | |
---|---|
Type | Description |
ProductInput.Builder |
setProductAttributes(ProductAttributes.Builder builderForValue)
public ProductInput.Builder setProductAttributes(ProductAttributes.Builder builderForValue)
Optional. A list of strongly-typed product attributes.
.google.shopping.merchant.products.v1.ProductAttributes product_attributes = 11 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
builderForValue |
ProductAttributes.Builder |
Returns | |
---|---|
Type | Description |
ProductInput.Builder |
setProductBytes(ByteString value)
public ProductInput.Builder setProductBytes(ByteString value)
Output only. The name of the processed product.
Format: accounts/{account}/products/{product}
string product = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for product to set. |
Returns | |
---|---|
Type | Description |
ProductInput.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ProductInput.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
ProductInput.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final ProductInput.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ProductInput.Builder |
setVersionNumber(long value)
public ProductInput.Builder setVersionNumber(long value)
Optional. Immutable. Represents the existing version (freshness) of the product, which can be used to preserve the right order when multiple updates are done at the same time.
If set, the insertion is prevented when version number is lower than
the current version number of the existing product. Re-insertion (for
example, product refresh after 30 days) can be performed with the current
version_number
.
Only supported for insertions into primary data sources. Do not set this field for updates. Do not set this field for insertions into supplemental data sources.
If the operation is prevented, the aborted exception will be thrown.
optional int64 version_number = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
Parameter | |
---|---|
Name | Description |
value |
long The versionNumber to set. |
Returns | |
---|---|
Type | Description |
ProductInput.Builder |
This builder for chaining. |