public static final class TitleExample.Builder extends GeneratedMessageV3.Builder<TitleExample.Builder> 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.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
public static final Descriptors.Descriptor getDescriptor()
Methods
public TitleExample.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
public TitleExample build()
public TitleExample buildPartial()
public TitleExample.Builder clear()
Overrides
public TitleExample.Builder clearCategory()
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];
public TitleExample.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
public TitleExample.Builder clearFinalProductInfo()
public TitleExample.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
public TitleExample.Builder clearProductInfo()
public TitleExample.Builder clearTitleFormat()
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];
public TitleExample.Builder clone()
Overrides
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 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 Descriptors.Descriptor getDescriptorForType()
Overrides
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 Map<String,String> getMutableFinalProductInfo()
Use alternate mutation accessors instead.
public Map<String,String> getMutableProductInfo()
Use alternate mutation accessors instead.
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 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.
|
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.Builder.internalGetMapFieldReflection(int)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
public final boolean isInitialized()
Overrides
public TitleExample.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
public TitleExample.Builder mergeFrom(Message other)
| Parameter |
| Name |
Description |
other |
Message
|
Overrides
public TitleExample.Builder mergeFrom(TitleExample other)
public final TitleExample.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
public TitleExample.Builder putAllFinalProductInfo(Map<String,String> values)
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 TitleExample.Builder putAllProductInfo(Map<String,String> values)
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 TitleExample.Builder putFinalProductInfo(String key, String value)
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 TitleExample.Builder putProductInfo(String key, String value)
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 TitleExample.Builder removeFinalProductInfo(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 TitleExample.Builder removeProductInfo(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 TitleExample.Builder setCategory(String value)
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];
| Parameter |
| Name |
Description |
value |
String
The category to set.
|
public TitleExample.Builder setCategoryBytes(ByteString value)
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];
| Parameter |
| Name |
Description |
value |
ByteString
The bytes for category to set.
|
public TitleExample.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
public TitleExample.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
public TitleExample.Builder setTitleFormat(String value)
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];
| Parameter |
| Name |
Description |
value |
String
The titleFormat to set.
|
public TitleExample.Builder setTitleFormatBytes(ByteString value)
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];
| Parameter |
| Name |
Description |
value |
ByteString
The bytes for titleFormat to set.
|
public final TitleExample.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
