Class Item (0.16.0)

0.16.0 (latest) 0.15.0 0.14.0 0.12.0 0.9.0 0.8.0 0.6.0 0.4.0 0.3.0 0.2.0 0.1.0

public final class Item extends GeneratedMessage implements ItemOrBuilder

Represents an item in the cart associated with the event.

Protobuf type google.ads.datamanager.v1.Item

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > Item

Implements

ItemOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ADDITIONAL_ITEM_PARAMETERS_FIELD_NUMBER

public static final int ADDITIONAL_ITEM_PARAMETERS_FIELD_NUMBER

Field Value
Type	Description
int

CONVERSION_VALUE_FIELD_NUMBER

public static final int CONVERSION_VALUE_FIELD_NUMBER

Field Value
Type	Description
int

CUSTOM_VARIABLES_FIELD_NUMBER

public static final int CUSTOM_VARIABLES_FIELD_NUMBER

Field Value
Type	Description
int

ITEM_ID_FIELD_NUMBER

public static final int ITEM_ID_FIELD_NUMBER

Field Value
Type	Description
int

MERCHANT_FEED_LABEL_FIELD_NUMBER

public static final int MERCHANT_FEED_LABEL_FIELD_NUMBER

Field Value
Type	Description
int

MERCHANT_FEED_LANGUAGE_CODE_FIELD_NUMBER

public static final int MERCHANT_FEED_LANGUAGE_CODE_FIELD_NUMBER

Field Value
Type	Description
int

MERCHANT_ID_FIELD_NUMBER

public static final int MERCHANT_ID_FIELD_NUMBER

Field Value
Type	Description
int

MERCHANT_PRODUCT_ID_FIELD_NUMBER

public static final int MERCHANT_PRODUCT_ID_FIELD_NUMBER

Field Value
Type	Description
int

QUANTITY_FIELD_NUMBER

public static final int QUANTITY_FIELD_NUMBER

Field Value
Type	Description
int

UNIT_PRICE_FIELD_NUMBER

public static final int UNIT_PRICE_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static Item getDefaultInstance()

Returns
Type	Description
Item

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static Item.Builder newBuilder()

Returns
Type	Description
Item.Builder

newBuilder(Item prototype)

public static Item.Builder newBuilder(Item prototype)

Parameter
Name	Description
prototype	Item

Returns
Type	Description
Item.Builder

parseDelimitedFrom(InputStream input)

public static Item parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
Item

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Item parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Item

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static Item parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
Item

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Item parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Item

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Item parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
Item

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Item parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Item

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Item parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
Item

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Item parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Item

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static Item parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
Item

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Item parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Item

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static Item parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
Item

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Item parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Item

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<Item> parser()

Returns
Type	Description
Parser<Item>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getAdditionalItemParameters(int index)

public ItemParameter getAdditionalItemParameters(int index)

Optional. A bucket of any event parameters related to an item to be included within the event that were not already specified using other structured fields.

repeated .google.ads.datamanager.v1.ItemParameter additional_item_parameters = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
ItemParameter

getAdditionalItemParametersCount()

public int getAdditionalItemParametersCount()

Optional. A bucket of any event parameters related to an item to be included within the event that were not already specified using other structured fields.

repeated .google.ads.datamanager.v1.ItemParameter additional_item_parameters = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getAdditionalItemParametersList()

public List<ItemParameter> getAdditionalItemParametersList()

Optional. A bucket of any event parameters related to an item to be included within the event that were not already specified using other structured fields.

repeated .google.ads.datamanager.v1.ItemParameter additional_item_parameters = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<ItemParameter>

getAdditionalItemParametersOrBuilder(int index)

public ItemParameterOrBuilder getAdditionalItemParametersOrBuilder(int index)

Optional. A bucket of any event parameters related to an item to be included within the event that were not already specified using other structured fields.

repeated .google.ads.datamanager.v1.ItemParameter additional_item_parameters = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
ItemParameterOrBuilder

getAdditionalItemParametersOrBuilderList()

public List<? extends ItemParameterOrBuilder> getAdditionalItemParametersOrBuilderList()

Optional. A bucket of any event parameters related to an item to be included within the event that were not already specified using other structured fields.

repeated .google.ads.datamanager.v1.ItemParameter additional_item_parameters = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<? extends com.google.ads.datamanager.v1.ItemParameterOrBuilder>

getConversionValue()

public double getConversionValue()

Optional. The conversion value associated with this item within the event, for cases where the conversion value is different for each item.

optional double conversion_value = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
double	The conversionValue.

getCustomVariables(int index)

public ItemCustomVariable getCustomVariables(int index)

Optional. Additional key/value pair information to send to the conversion containers (conversion action or Floodlight activity), when tracking per-item conversions.

repeated .google.ads.datamanager.v1.ItemCustomVariable custom_variables = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
ItemCustomVariable

getCustomVariablesCount()

public int getCustomVariablesCount()

Optional. Additional key/value pair information to send to the conversion containers (conversion action or Floodlight activity), when tracking per-item conversions.

repeated .google.ads.datamanager.v1.ItemCustomVariable custom_variables = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getCustomVariablesList()

public List<ItemCustomVariable> getCustomVariablesList()

Optional. Additional key/value pair information to send to the conversion containers (conversion action or Floodlight activity), when tracking per-item conversions.

repeated .google.ads.datamanager.v1.ItemCustomVariable custom_variables = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<ItemCustomVariable>

getCustomVariablesOrBuilder(int index)

public ItemCustomVariableOrBuilder getCustomVariablesOrBuilder(int index)

Optional. Additional key/value pair information to send to the conversion containers (conversion action or Floodlight activity), when tracking per-item conversions.

repeated .google.ads.datamanager.v1.ItemCustomVariable custom_variables = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
ItemCustomVariableOrBuilder

getCustomVariablesOrBuilderList()

public List<? extends ItemCustomVariableOrBuilder> getCustomVariablesOrBuilderList()

Optional. Additional key/value pair information to send to the conversion containers (conversion action or Floodlight activity), when tracking per-item conversions.

repeated .google.ads.datamanager.v1.ItemCustomVariable custom_variables = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<? extends com.google.ads.datamanager.v1.ItemCustomVariableOrBuilder>

getDefaultInstanceForType()

public Item getDefaultInstanceForType()

Returns
Type	Description
Item

getItemId()

public String getItemId()

Optional. A unique identifier to reference the item.

string item_id = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The itemId.

getItemIdBytes()

public ByteString getItemIdBytes()

Optional. A unique identifier to reference the item.

string item_id = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for itemId.

getMerchantFeedLabel()

public String getMerchantFeedLabel()

Optional. The feed label of the Merchant Center feed. If countries are still being used, the 2-letter country code in ISO-3166-1 alpha-2 can be used instead. For Store Sales events this will override the value set at the cart level. This field is ignored for other events.

string merchant_feed_label = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The merchantFeedLabel.

getMerchantFeedLabelBytes()

public ByteString getMerchantFeedLabelBytes()

Optional. The feed label of the Merchant Center feed. If countries are still being used, the 2-letter country code in ISO-3166-1 alpha-2 can be used instead. For Store Sales events this will override the value set at the cart level. This field is ignored for other events.

string merchant_feed_label = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for merchantFeedLabel.

getMerchantFeedLanguageCode()

public String getMerchantFeedLanguageCode()

Optional. The language code in ISO 639-1 associated with the Merchant Center feed where your items are uploaded.

string merchant_feed_language_code = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The merchantFeedLanguageCode.

getMerchantFeedLanguageCodeBytes()

public ByteString getMerchantFeedLanguageCodeBytes()

Optional. The language code in ISO 639-1 associated with the Merchant Center feed where your items are uploaded.

string merchant_feed_language_code = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for merchantFeedLanguageCode.

getMerchantId()

public String getMerchantId()

Optional. The Merchant Center ID associated with the item. For Store Sales events this will override the value set at the cart level. This field is ignored for other events.

string merchant_id = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The merchantId.

getMerchantIdBytes()

public ByteString getMerchantIdBytes()

Optional. The Merchant Center ID associated with the item. For Store Sales events this will override the value set at the cart level. This field is ignored for other events.

string merchant_id = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for merchantId.

getMerchantProductId()

public String getMerchantProductId()

Optional. The product ID within the Merchant Center account.

string merchant_product_id = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The merchantProductId.

getMerchantProductIdBytes()

public ByteString getMerchantProductIdBytes()

Optional. The product ID within the Merchant Center account.

string merchant_product_id = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for merchantProductId.

getParserForType()

public Parser<Item> getParserForType()

Returns
Type	Description
Parser<Item>

Overrides

GeneratedMessage.getParserForType()

getQuantity()

public long getQuantity()

Optional. The number of this item associated with the event.

int64 quantity = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
long	The quantity.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

getUnitPrice()

public double getUnitPrice()

Optional. The unit price excluding tax, shipping, and any transaction level discounts.

double unit_price = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
double	The unitPrice.

hasConversionValue()

public boolean hasConversionValue()

Optional. The conversion value associated with this item within the event, for cases where the conversion value is different for each item.

optional double conversion_value = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the conversionValue field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public Item.Builder newBuilderForType()

Returns
Type	Description
Item.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected Item.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
Item.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public Item.Builder toBuilder()

Returns
Type	Description
Item.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException