public interface ProductInputOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
getContentLanguage()
public abstract 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 abstract 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 abstract 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 |
getCustomAttributesCount()
public abstract 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 abstract 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 abstract 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 abstract 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> |
getFeedLabel()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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. |
getProductAttributesOrBuilder()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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. |