public final class TitleExample extends GeneratedMessageV3 implements TitleExampleOrBuilder
A hand-crafted example of a product title improvement. These examples are
provided to the AI to improve its quality and guide it towards required
outputs.
Protobuf type google.shopping.merchant.productstudio.v1alpha.TitleExample
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int CATEGORY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int FINAL_PRODUCT_INFO_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int PRODUCT_INFO_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int TITLE_FORMAT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static TitleExample getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static TitleExample.Builder newBuilder()
public static TitleExample.Builder newBuilder(TitleExample prototype)
public static TitleExample parseDelimitedFrom(InputStream input)
public static TitleExample parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static TitleExample parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static TitleExample parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static TitleExample parseFrom(ByteString data)
public static TitleExample parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TitleExample parseFrom(CodedInputStream input)
public static TitleExample parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static TitleExample parseFrom(InputStream input)
public static TitleExample parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static TitleExample parseFrom(ByteBuffer data)
public static TitleExample parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<TitleExample> parser()
Methods
public boolean containsFinalProductInfo(String key)
Required. A map in the same format as product_info but with all
improvements included. For example, {"brand": "Dresses4All", "product":
"dress", "color": "red", ...}. The order of attributes in this map may be
used to guide the order in which they appear in the final generated title.
For instance, the above will become: Dresses4All dress | red
map<string, string> final_product_info = 4 [(.google.api.field_behavior) = REQUIRED];
| Parameter |
| Name |
Description |
key |
String
|
public boolean containsProductInfo(String key)
Required. A map containing all existing product information. For example:
{"title": "dress", "description": "A red dress", "brand": "Dresses4All"}
Any information that you might use to populate your product feed.
map<string, string> product_info = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter |
| Name |
Description |
key |
String
|
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
public String getCategory()
Required. The product's category. This helps the AI understand when certain
examples are more relevant than others.
optional string category = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
String |
The category.
|
public ByteString getCategoryBytes()
Required. The product's category. This helps the AI understand when certain
examples are more relevant than others.
optional string category = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
ByteString |
The bytes for category.
|
public TitleExample getDefaultInstanceForType()
public Map<String,String> getFinalProductInfo()
public int getFinalProductInfoCount()
Required. A map in the same format as product_info but with all
improvements included. For example, {"brand": "Dresses4All", "product":
"dress", "color": "red", ...}. The order of attributes in this map may be
used to guide the order in which they appear in the final generated title.
For instance, the above will become: Dresses4All dress | red
map<string, string> final_product_info = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
int |
|
public Map<String,String> getFinalProductInfoMap()
Required. A map in the same format as product_info but with all
improvements included. For example, {"brand": "Dresses4All", "product":
"dress", "color": "red", ...}. The order of attributes in this map may be
used to guide the order in which they appear in the final generated title.
For instance, the above will become: Dresses4All dress | red
map<string, string> final_product_info = 4 [(.google.api.field_behavior) = REQUIRED];
public String getFinalProductInfoOrDefault(String key, String defaultValue)
Required. A map in the same format as product_info but with all
improvements included. For example, {"brand": "Dresses4All", "product":
"dress", "color": "red", ...}. The order of attributes in this map may be
used to guide the order in which they appear in the final generated title.
For instance, the above will become: Dresses4All dress | red
map<string, string> final_product_info = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
String |
|
public String getFinalProductInfoOrThrow(String key)
Required. A map in the same format as product_info but with all
improvements included. For example, {"brand": "Dresses4All", "product":
"dress", "color": "red", ...}. The order of attributes in this map may be
used to guide the order in which they appear in the final generated title.
For instance, the above will become: Dresses4All dress | red
map<string, string> final_product_info = 4 [(.google.api.field_behavior) = REQUIRED];
| Parameter |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
String |
|
public Parser<TitleExample> getParserForType()
Overrides
public Map<String,String> getProductInfo()
public int getProductInfoCount()
Required. A map containing all existing product information. For example:
{"title": "dress", "description": "A red dress", "brand": "Dresses4All"}
Any information that you might use to populate your product feed.
map<string, string> product_info = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
int |
|
public Map<String,String> getProductInfoMap()
Required. A map containing all existing product information. For example:
{"title": "dress", "description": "A red dress", "brand": "Dresses4All"}
Any information that you might use to populate your product feed.
map<string, string> product_info = 1 [(.google.api.field_behavior) = REQUIRED];
public String getProductInfoOrDefault(String key, String defaultValue)
Required. A map containing all existing product information. For example:
{"title": "dress", "description": "A red dress", "brand": "Dresses4All"}
Any information that you might use to populate your product feed.
map<string, string> product_info = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
String |
|
public String getProductInfoOrThrow(String key)
Required. A map containing all existing product information. For example:
{"title": "dress", "description": "A red dress", "brand": "Dresses4All"}
Any information that you might use to populate your product feed.
map<string, string> product_info = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
String |
|
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
public String getTitleFormat()
Required. The attributes or approximate attributes that make up the title.
For example, title "Google GShoe M" title_format can be "brand | product |
size".
optional string title_format = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
String |
The titleFormat.
|
public ByteString getTitleFormatBytes()
Required. The attributes or approximate attributes that make up the title.
For example, title "Google GShoe M" title_format can be "brand | product |
size".
optional string title_format = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
ByteString |
The bytes for titleFormat.
|
public boolean hasCategory()
Required. The product's category. This helps the AI understand when certain
examples are more relevant than others.
optional string category = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
boolean |
Whether the category field is set.
|
public boolean hasTitleFormat()
Required. The attributes or approximate attributes that make up the title.
For example, title "Google GShoe M" title_format can be "brand | product |
size".
optional string title_format = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
boolean |
Whether the titleFormat field is set.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
public final boolean isInitialized()
Overrides
public TitleExample.Builder newBuilderForType()
protected TitleExample.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public TitleExample.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
