Class OrderTrackingSignal (0.2.0)
Stay organized with collections Save and categorize content based on your preferences.

public final class OrderTrackingSignal extends GeneratedMessageV3 implements OrderTrackingSignalOrBuilder

Represents a business trade from which signals are extracted, such as shipping.

Protobuf type google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > OrderTrackingSignal

Implements

OrderTrackingSignalOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

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

AbstractMessage.hashLong(long)

AbstractMessage.toString()

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

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

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

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

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

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

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

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

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

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

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

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

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

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

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

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

CUSTOMER_SHIPPING_FEE_FIELD_NUMBER

public static final int CUSTOMER_SHIPPING_FEE_FIELD_NUMBER

Field Value
Type	Description
`int`

DELIVERY_POSTAL_CODE_FIELD_NUMBER

public static final int DELIVERY_POSTAL_CODE_FIELD_NUMBER

Field Value
Type	Description
`int`

DELIVERY_REGION_CODE_FIELD_NUMBER

public static final int DELIVERY_REGION_CODE_FIELD_NUMBER

Field Value
Type	Description
`int`

LINE_ITEMS_FIELD_NUMBER

public static final int LINE_ITEMS_FIELD_NUMBER

Field Value
Type	Description
`int`

MERCHANT_ID_FIELD_NUMBER

public static final int MERCHANT_ID_FIELD_NUMBER

Field Value
Type	Description
`int`

ORDER_CREATED_TIME_FIELD_NUMBER

public static final int ORDER_CREATED_TIME_FIELD_NUMBER

Field Value
Type	Description
`int`

ORDER_ID_FIELD_NUMBER

public static final int ORDER_ID_FIELD_NUMBER

Field Value
Type	Description
`int`

ORDER_TRACKING_SIGNAL_ID_FIELD_NUMBER

public static final int ORDER_TRACKING_SIGNAL_ID_FIELD_NUMBER

Field Value
Type	Description
`int`

SHIPMENT_LINE_ITEM_MAPPING_FIELD_NUMBER

public static final int SHIPMENT_LINE_ITEM_MAPPING_FIELD_NUMBER

Field Value
Type	Description
`int`

SHIPPING_INFO_FIELD_NUMBER

public static final int SHIPPING_INFO_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static OrderTrackingSignal getDefaultInstance()

Returns
Type	Description
`OrderTrackingSignal`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static OrderTrackingSignal.Builder newBuilder()

Returns
Type	Description
`OrderTrackingSignal.Builder`

newBuilder(OrderTrackingSignal prototype)

public static OrderTrackingSignal.Builder newBuilder(OrderTrackingSignal prototype)

Parameter
Name	Description
`prototype`	`OrderTrackingSignal`

Returns
Type	Description
`OrderTrackingSignal.Builder`

parseDelimitedFrom(InputStream input)

public static OrderTrackingSignal parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`OrderTrackingSignal`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static OrderTrackingSignal parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`OrderTrackingSignal`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static OrderTrackingSignal parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`OrderTrackingSignal`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`OrderTrackingSignal`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static OrderTrackingSignal parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`OrderTrackingSignal`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static OrderTrackingSignal parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`OrderTrackingSignal`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static OrderTrackingSignal parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`OrderTrackingSignal`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static OrderTrackingSignal parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`OrderTrackingSignal`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static OrderTrackingSignal parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`OrderTrackingSignal`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static OrderTrackingSignal parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`OrderTrackingSignal`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static OrderTrackingSignal parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`OrderTrackingSignal`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static OrderTrackingSignal parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`OrderTrackingSignal`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<OrderTrackingSignal> parser()

Returns
Type	Description
`Parser<OrderTrackingSignal>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getCustomerShippingFee()

public Price getCustomerShippingFee()

Optional. The shipping fee of the order; this value should be set to zero in the case of free shipping.

optional .google.shopping.type.Price customer_shipping_fee = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`com.google.shopping.type.Price`	The customerShippingFee.

getCustomerShippingFeeOrBuilder()

public PriceOrBuilder getCustomerShippingFeeOrBuilder()

Optional. The shipping fee of the order; this value should be set to zero in the case of free shipping.

optional .google.shopping.type.Price customer_shipping_fee = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`com.google.shopping.type.PriceOrBuilder`

getDefaultInstanceForType()

public OrderTrackingSignal getDefaultInstanceForType()

Returns
Type	Description
`OrderTrackingSignal`

getDeliveryPostalCode()

public String getDeliveryPostalCode()

Optional. The delivery postal code, as a continuous string without spaces or dashes, for example "95016". This field will be anonymized in returned OrderTrackingSignal creation response.

string delivery_postal_code = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The deliveryPostalCode.

getDeliveryPostalCodeBytes()

public ByteString getDeliveryPostalCodeBytes()

Optional. The delivery postal code, as a continuous string without spaces or dashes, for example "95016". This field will be anonymized in returned OrderTrackingSignal creation response.

string delivery_postal_code = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for deliveryPostalCode.

getDeliveryRegionCode()

public String getDeliveryRegionCode()

Optional. The CLDR territory code for the shipping destination.

string delivery_region_code = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The deliveryRegionCode.

getDeliveryRegionCodeBytes()

public ByteString getDeliveryRegionCodeBytes()

Optional. The CLDR territory code for the shipping destination.

string delivery_region_code = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for deliveryRegionCode.

getLineItems(int index)

public OrderTrackingSignal.LineItemDetails getLineItems(int index)

Required. Information about line items in the order.

repeated .google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal.LineItemDetails line_items = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`OrderTrackingSignal.LineItemDetails`

getLineItemsCount()

public int getLineItemsCount()

Required. Information about line items in the order.

repeated .google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal.LineItemDetails line_items = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`int`

getLineItemsList()

public List<OrderTrackingSignal.LineItemDetails> getLineItemsList()

Required. Information about line items in the order.

repeated .google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal.LineItemDetails line_items = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`List<LineItemDetails>`

getLineItemsOrBuilder(int index)

public OrderTrackingSignal.LineItemDetailsOrBuilder getLineItemsOrBuilder(int index)

Required. Information about line items in the order.

repeated .google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal.LineItemDetails line_items = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`OrderTrackingSignal.LineItemDetailsOrBuilder`

getLineItemsOrBuilderList()

public List<? extends OrderTrackingSignal.LineItemDetailsOrBuilder> getLineItemsOrBuilderList()

Required. Information about line items in the order.

repeated .google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal.LineItemDetails line_items = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`List<? extends com.google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal.LineItemDetailsOrBuilder>`

getMerchantId()

public long getMerchantId()

Optional. The Google Merchant Center ID of this order tracking signal. This value is optional. If left unset, the caller's Merchant Center ID is used. You must request access in order to provide data on behalf of another business. For more information, see Submitting Order Tracking Signals.

int64 merchant_id = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`long`	The merchantId.

getOrderCreatedTime()

public DateTime getOrderCreatedTime()

Required. The time when the order was created on the businesses side. Include the year and timezone string, if available.

.google.type.DateTime order_created_time = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`com.google.type.DateTime`	The orderCreatedTime.

getOrderCreatedTimeOrBuilder()

public DateTimeOrBuilder getOrderCreatedTimeOrBuilder()

Required. The time when the order was created on the businesses side. Include the year and timezone string, if available.

.google.type.DateTime order_created_time = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`com.google.type.DateTimeOrBuilder`

getOrderId()

public String getOrderId()

Required. The ID of the order on the businesses side. This field will be hashed in returned OrderTrackingSignal creation response.

string order_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`String`	The orderId.

getOrderIdBytes()

public ByteString getOrderIdBytes()

Required. The ID of the order on the businesses side. This field will be hashed in returned OrderTrackingSignal creation response.

string order_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`ByteString`	The bytes for orderId.

getOrderTrackingSignalId()

public long getOrderTrackingSignalId()

Output only. The ID that uniquely identifies this order tracking signal.

int64 order_tracking_signal_id = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`long`	The orderTrackingSignalId.

getParserForType()

public Parser<OrderTrackingSignal> getParserForType()

Returns
Type	Description
`Parser<OrderTrackingSignal>`

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

getShipmentLineItemMapping(int index)

public OrderTrackingSignal.ShipmentLineItemMapping getShipmentLineItemMapping(int index)

Optional. The mapping of the line items to the shipment information.

repeated .google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal.ShipmentLineItemMapping shipment_line_item_mapping = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`OrderTrackingSignal.ShipmentLineItemMapping`

getShipmentLineItemMappingCount()

public int getShipmentLineItemMappingCount()

Optional. The mapping of the line items to the shipment information.

repeated .google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal.ShipmentLineItemMapping shipment_line_item_mapping = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`

getShipmentLineItemMappingList()

public List<OrderTrackingSignal.ShipmentLineItemMapping> getShipmentLineItemMappingList()

Optional. The mapping of the line items to the shipment information.

repeated .google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal.ShipmentLineItemMapping shipment_line_item_mapping = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<ShipmentLineItemMapping>`

getShipmentLineItemMappingOrBuilder(int index)

public OrderTrackingSignal.ShipmentLineItemMappingOrBuilder getShipmentLineItemMappingOrBuilder(int index)

Optional. The mapping of the line items to the shipment information.

repeated .google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal.ShipmentLineItemMapping shipment_line_item_mapping = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`OrderTrackingSignal.ShipmentLineItemMappingOrBuilder`

getShipmentLineItemMappingOrBuilderList()

public List<? extends OrderTrackingSignal.ShipmentLineItemMappingOrBuilder> getShipmentLineItemMappingOrBuilderList()

Optional. The mapping of the line items to the shipment information.

repeated .google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal.ShipmentLineItemMapping shipment_line_item_mapping = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<? extends com.google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal.ShipmentLineItemMappingOrBuilder>`