public interface ProductOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getAttributes()
public abstract Attributes getAttributes()Output only. A list of product attributes.
.google.shopping.merchant.products.v1beta.Attributes attributes = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Attributes |
The attributes. |
getAttributesOrBuilder()
public abstract AttributesOrBuilder getAttributesOrBuilder()Output only. A list of product attributes.
.google.shopping.merchant.products.v1beta.Attributes attributes = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
AttributesOrBuilder |
|
getChannel()
public abstract Channel.ChannelEnum getChannel()Output only. The channel of the product.
.google.shopping.type.Channel.ChannelEnum channel = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
com.google.shopping.type.Channel.ChannelEnum |
The channel. |
getChannelValue()
public abstract int getChannelValue()Output only. The channel of the product.
.google.shopping.type.Channel.ChannelEnum channel = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for channel. |
getContentLanguage()
public abstract String getContentLanguage()Output only. The two-letter ISO 639-1 language code for the product.
string content_language = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The contentLanguage. |
getContentLanguageBytes()
public abstract ByteString getContentLanguageBytes()Output only. The two-letter ISO 639-1 language code for the product.
string content_language = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for contentLanguage. |
getCustomAttributes(int index)
public abstract CustomAttribute getCustomAttributes(int index) Output only. A list of custom (merchant-provided) attributes. It can also
be used to submit 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, such as additional attributes used for Buy on Google.
repeated .google.shopping.type.CustomAttribute custom_attributes = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.shopping.type.CustomAttribute |
|
getCustomAttributesCount()
public abstract int getCustomAttributesCount() Output only. A list of custom (merchant-provided) attributes. It can also
be used to submit 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, such as additional attributes used for Buy on Google.
repeated .google.shopping.type.CustomAttribute custom_attributes = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
|
getCustomAttributesList()
public abstract List<CustomAttribute> getCustomAttributesList() Output only. A list of custom (merchant-provided) attributes. It can also
be used to submit 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, such as additional attributes used for Buy on Google.
repeated .google.shopping.type.CustomAttribute custom_attributes = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
List<com.google.shopping.type.CustomAttribute> |
|
getCustomAttributesOrBuilder(int index)
public abstract CustomAttributeOrBuilder getCustomAttributesOrBuilder(int index) Output only. A list of custom (merchant-provided) attributes. It can also
be used to submit 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, such as additional attributes used for Buy on Google.
repeated .google.shopping.type.CustomAttribute custom_attributes = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.shopping.type.CustomAttributeOrBuilder |
|
getCustomAttributesOrBuilderList()
public abstract List<? extends CustomAttributeOrBuilder> getCustomAttributesOrBuilderList() Output only. A list of custom (merchant-provided) attributes. It can also
be used to submit 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, such as additional attributes used for Buy on Google.
repeated .google.shopping.type.CustomAttribute custom_attributes = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.shopping.type.CustomAttributeOrBuilder> |
|
getDataSource()
public abstract String getDataSource()Output only. The primary data source of the product.
string data_source = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The dataSource. |
getDataSourceBytes()
public abstract ByteString getDataSourceBytes()Output only. The primary data source of the product.
string data_source = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for dataSource. |
getFeedLabel()
public abstract String getFeedLabel()Output only. The feed label for the product.
string feed_label = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The feedLabel. |
getFeedLabelBytes()
public abstract ByteString getFeedLabelBytes()Output only. The feed label for the product.
string feed_label = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for feedLabel. |
getName()
public abstract String getName() The name of the product.
Format:
"{product.name=accounts/{account}/products/{product}}" where the last
section product consists of 4 parts:
channel~content_language~feed_label~offer_id
example for product name is "accounts/123/products/online~en~US~sku123"
string name = 1;
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public abstract ByteString getNameBytes() The name of the product.
Format:
"{product.name=accounts/{account}/products/{product}}" where the last
section product consists of 4 parts:
channel~content_language~feed_label~offer_id
example for product name is "accounts/123/products/online~en~US~sku123"
string name = 1;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getOfferId()
public abstract String getOfferId()Output only. 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 product data specification for details.
string offer_id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The offerId. |
getOfferIdBytes()
public abstract ByteString getOfferIdBytes()Output only. 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 product data specification for details.
string offer_id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for offerId. |
getProductStatus()
public abstract ProductStatus getProductStatus()Output only. The status of a product, data validation issues, that is, information about a product computed asynchronously.
.google.shopping.merchant.products.v1beta.ProductStatus product_status = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ProductStatus |
The productStatus. |
getProductStatusOrBuilder()
public abstract ProductStatusOrBuilder getProductStatusOrBuilder()Output only. The status of a product, data validation issues, that is, information about a product computed asynchronously.
.google.shopping.merchant.products.v1beta.ProductStatus product_status = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ProductStatusOrBuilder |
|
getVersionNumber()
public abstract long getVersionNumber()Output only. 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.
If the operation is prevented, the aborted exception will be thrown.
optional int64 version_number = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
long |
The versionNumber. |
hasAttributes()
public abstract boolean hasAttributes()Output only. A list of product attributes.
.google.shopping.merchant.products.v1beta.Attributes attributes = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the attributes field is set. |
hasProductStatus()
public abstract boolean hasProductStatus()Output only. The status of a product, data validation issues, that is, information about a product computed asynchronously.
.google.shopping.merchant.products.v1beta.ProductStatus product_status = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the productStatus field is set. |
hasVersionNumber()
public abstract boolean hasVersionNumber()Output only. 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.
If the operation is prevented, the aborted exception will be thrown.
optional int64 version_number = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the versionNumber field is set. |