Class OrderTrackingSignal.Builder (0.2.0)

public static final class OrderTrackingSignal.Builder extends GeneratedMessageV3.Builder<OrderTrackingSignal.Builder> implements OrderTrackingSignalOrBuilder

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

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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllLineItems(Iterable<? extends OrderTrackingSignal.LineItemDetails> values)

public OrderTrackingSignal.Builder addAllLineItems(Iterable<? extends OrderTrackingSignal.LineItemDetails> values)

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
values Iterable<? extends com.google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal.LineItemDetails>
Returns
Type Description
OrderTrackingSignal.Builder

addAllShipmentLineItemMapping(Iterable<? extends OrderTrackingSignal.ShipmentLineItemMapping> values)

public OrderTrackingSignal.Builder addAllShipmentLineItemMapping(Iterable<? extends OrderTrackingSignal.ShipmentLineItemMapping> values)

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
values Iterable<? extends com.google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal.ShipmentLineItemMapping>
Returns
Type Description
OrderTrackingSignal.Builder

addAllShippingInfo(Iterable<? extends OrderTrackingSignal.ShippingInfo> values)

public OrderTrackingSignal.Builder addAllShippingInfo(Iterable<? extends OrderTrackingSignal.ShippingInfo> values)

Required. The shipping information for the order.

repeated .google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal.ShippingInfo shipping_info = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
values Iterable<? extends com.google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal.ShippingInfo>
Returns
Type Description
OrderTrackingSignal.Builder

addLineItems(OrderTrackingSignal.LineItemDetails value)

public OrderTrackingSignal.Builder addLineItems(OrderTrackingSignal.LineItemDetails value)

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
value OrderTrackingSignal.LineItemDetails
Returns
Type Description
OrderTrackingSignal.Builder

addLineItems(OrderTrackingSignal.LineItemDetails.Builder builderForValue)

public OrderTrackingSignal.Builder addLineItems(OrderTrackingSignal.LineItemDetails.Builder builderForValue)

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
builderForValue OrderTrackingSignal.LineItemDetails.Builder
Returns
Type Description
OrderTrackingSignal.Builder

addLineItems(int index, OrderTrackingSignal.LineItemDetails value)

public OrderTrackingSignal.Builder addLineItems(int index, OrderTrackingSignal.LineItemDetails value)

Required. Information about line items in the order.

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

Parameters
Name Description
index int
value OrderTrackingSignal.LineItemDetails
Returns
Type Description
OrderTrackingSignal.Builder

addLineItems(int index, OrderTrackingSignal.LineItemDetails.Builder builderForValue)

public OrderTrackingSignal.Builder addLineItems(int index, OrderTrackingSignal.LineItemDetails.Builder builderForValue)

Required. Information about line items in the order.

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

Parameters
Name Description
index int
builderForValue OrderTrackingSignal.LineItemDetails.Builder
Returns
Type Description
OrderTrackingSignal.Builder

addLineItemsBuilder()

public OrderTrackingSignal.LineItemDetails.Builder addLineItemsBuilder()

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
OrderTrackingSignal.LineItemDetails.Builder

addLineItemsBuilder(int index)

public OrderTrackingSignal.LineItemDetails.Builder addLineItemsBuilder(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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public OrderTrackingSignal.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
OrderTrackingSignal.Builder
Overrides

addShipmentLineItemMapping(OrderTrackingSignal.ShipmentLineItemMapping value)

public OrderTrackingSignal.Builder addShipmentLineItemMapping(OrderTrackingSignal.ShipmentLineItemMapping value)

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
value OrderTrackingSignal.ShipmentLineItemMapping
Returns
Type Description
OrderTrackingSignal.Builder

addShipmentLineItemMapping(OrderTrackingSignal.ShipmentLineItemMapping.Builder builderForValue)

public OrderTrackingSignal.Builder addShipmentLineItemMapping(OrderTrackingSignal.ShipmentLineItemMapping.Builder builderForValue)

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
builderForValue OrderTrackingSignal.ShipmentLineItemMapping.Builder
Returns
Type Description
OrderTrackingSignal.Builder

addShipmentLineItemMapping(int index, OrderTrackingSignal.ShipmentLineItemMapping value)

public OrderTrackingSignal.Builder addShipmentLineItemMapping(int index, OrderTrackingSignal.ShipmentLineItemMapping value)

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];

Parameters
Name Description
index int
value OrderTrackingSignal.ShipmentLineItemMapping
Returns
Type Description
OrderTrackingSignal.Builder

addShipmentLineItemMapping(int index, OrderTrackingSignal.ShipmentLineItemMapping.Builder builderForValue)

public OrderTrackingSignal.Builder addShipmentLineItemMapping(int index, OrderTrackingSignal.ShipmentLineItemMapping.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue OrderTrackingSignal.ShipmentLineItemMapping.Builder
Returns
Type Description
OrderTrackingSignal.Builder

addShipmentLineItemMappingBuilder()

public OrderTrackingSignal.ShipmentLineItemMapping.Builder addShipmentLineItemMappingBuilder()

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
OrderTrackingSignal.ShipmentLineItemMapping.Builder

addShipmentLineItemMappingBuilder(int index)

public OrderTrackingSignal.ShipmentLineItemMapping.Builder addShipmentLineItemMappingBuilder(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.Builder

addShippingInfo(OrderTrackingSignal.ShippingInfo value)

public OrderTrackingSignal.Builder addShippingInfo(OrderTrackingSignal.ShippingInfo value)

Required. The shipping information for the order.

repeated .google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal.ShippingInfo shipping_info = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value OrderTrackingSignal.ShippingInfo
Returns
Type Description
OrderTrackingSignal.Builder

addShippingInfo(OrderTrackingSignal.ShippingInfo.Builder builderForValue)

public OrderTrackingSignal.Builder addShippingInfo(OrderTrackingSignal.ShippingInfo.Builder builderForValue)

Required. The shipping information for the order.

repeated .google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal.ShippingInfo shipping_info = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue OrderTrackingSignal.ShippingInfo.Builder
Returns
Type Description
OrderTrackingSignal.Builder

addShippingInfo(int index, OrderTrackingSignal.ShippingInfo value)

public OrderTrackingSignal.Builder addShippingInfo(int index, OrderTrackingSignal.ShippingInfo value)

Required. The shipping information for the order.

repeated .google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal.ShippingInfo shipping_info = 3 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
value OrderTrackingSignal.ShippingInfo
Returns
Type Description
OrderTrackingSignal.Builder

addShippingInfo(int index, OrderTrackingSignal.ShippingInfo.Builder builderForValue)

public OrderTrackingSignal.Builder addShippingInfo(int index, OrderTrackingSignal.ShippingInfo.Builder builderForValue)

Required. The shipping information for the order.

repeated .google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal.ShippingInfo shipping_info = 3 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
builderForValue OrderTrackingSignal.ShippingInfo.Builder
Returns
Type Description
OrderTrackingSignal.Builder

addShippingInfoBuilder()

public OrderTrackingSignal.ShippingInfo.Builder addShippingInfoBuilder()

Required. The shipping information for the order.

repeated .google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal.ShippingInfo shipping_info = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
OrderTrackingSignal.ShippingInfo.Builder

addShippingInfoBuilder(int index)

public OrderTrackingSignal.ShippingInfo.Builder addShippingInfoBuilder(int index)

Required. The shipping information for the order.

repeated .google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal.ShippingInfo shipping_info = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
OrderTrackingSignal.ShippingInfo.Builder

build()

public OrderTrackingSignal build()
Returns
Type Description
OrderTrackingSignal

buildPartial()

public OrderTrackingSignal buildPartial()
Returns
Type Description
OrderTrackingSignal

clear()

public OrderTrackingSignal.Builder clear()
Returns
Type Description
OrderTrackingSignal.Builder
Overrides

clearCustomerShippingFee()

public OrderTrackingSignal.Builder clearCustomerShippingFee()

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
OrderTrackingSignal.Builder

clearDeliveryPostalCode()

public OrderTrackingSignal.Builder clearDeliveryPostalCode()

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
OrderTrackingSignal.Builder

This builder for chaining.

clearDeliveryRegionCode()

public OrderTrackingSignal.Builder clearDeliveryRegionCode()

Optional. The CLDR territory code for the shipping destination.

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

Returns
Type Description
OrderTrackingSignal.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public OrderTrackingSignal.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
OrderTrackingSignal.Builder
Overrides

clearLineItems()

public OrderTrackingSignal.Builder clearLineItems()

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
OrderTrackingSignal.Builder

clearMerchantId()

public OrderTrackingSignal.Builder clearMerchantId()

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
OrderTrackingSignal.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public OrderTrackingSignal.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
OrderTrackingSignal.Builder
Overrides

clearOrderCreatedTime()

public OrderTrackingSignal.Builder clearOrderCreatedTime()

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
OrderTrackingSignal.Builder

clearOrderId()

public OrderTrackingSignal.Builder clearOrderId()

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
OrderTrackingSignal.Builder

This builder for chaining.

clearOrderTrackingSignalId()

public OrderTrackingSignal.Builder clearOrderTrackingSignalId()

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
OrderTrackingSignal.Builder

This builder for chaining.

clearShipmentLineItemMapping()

public OrderTrackingSignal.Builder clearShipmentLineItemMapping()

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
OrderTrackingSignal.Builder

clearShippingInfo()

public OrderTrackingSignal.Builder clearShippingInfo()

Required. The shipping information for the order.

repeated .google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal.ShippingInfo shipping_info = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
OrderTrackingSignal.Builder

clone()

public OrderTrackingSignal.Builder clone()
Returns
Type Description
OrderTrackingSignal.Builder
Overrides

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.

getCustomerShippingFeeBuilder()

public Price.Builder getCustomerShippingFeeBuilder()

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.Builder

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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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

getLineItemsBuilder(int index)

public OrderTrackingSignal.LineItemDetails.Builder getLineItemsBuilder(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.Builder

getLineItemsBuilderList()

public List<OrderTrackingSignal.LineItemDetails.Builder> getLineItemsBuilderList()

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<Builder>

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.

getOrderCreatedTimeBuilder()

public DateTime.Builder getOrderCreatedTimeBuilder()

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.Builder

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.

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

getShipmentLineItemMappingBuilder(int index)

public OrderTrackingSignal.ShipmentLineItemMapping.Builder getShipmentLineItemMappingBuilder(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.Builder

getShipmentLineItemMappingBuilderList()

public List<OrderTrackingSignal.ShipmentLineItemMapping.Builder> getShipmentLineItemMappingBuilderList()

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<Builder>

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>

getShippingInfo(int index)

public OrderTrackingSignal.ShippingInfo getShippingInfo(int index)

Required. The shipping information for the order.

repeated .google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal.ShippingInfo shipping_info = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
OrderTrackingSignal.ShippingInfo

getShippingInfoBuilder(int index)

public OrderTrackingSignal.ShippingInfo.Builder getShippingInfoBuilder(int index)

Required. The shipping information for the order.

repeated .google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal.ShippingInfo shipping_info = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
OrderTrackingSignal.ShippingInfo.Builder

getShippingInfoBuilderList()

public List<OrderTrackingSignal.ShippingInfo.Builder> getShippingInfoBuilderList()

Required. The shipping information for the order.

repeated .google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal.ShippingInfo shipping_info = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<Builder>

getShippingInfoCount()

public int getShippingInfoCount()

Required. The shipping information for the order.

repeated .google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal.ShippingInfo shipping_info = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getShippingInfoList()

public List<OrderTrackingSignal.ShippingInfo> getShippingInfoList()

Required. The shipping information for the order.

repeated .google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal.ShippingInfo shipping_info = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<ShippingInfo>

getShippingInfoOrBuilder(int index)

public OrderTrackingSignal.ShippingInfoOrBuilder getShippingInfoOrBuilder(int index)

Required. The shipping information for the order.

repeated .google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal.ShippingInfo shipping_info = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
OrderTrackingSignal.ShippingInfoOrBuilder

getShippingInfoOrBuilderList()

public List<? extends OrderTrackingSignal.ShippingInfoOrBuilder> getShippingInfoOrBuilderList()

Required. The shipping information for the order.

repeated .google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal.ShippingInfo shipping_info = 3 [(.google.api.field_behavior) = REQUIRED];

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

hasCustomerShippingFee()

public boolean hasCustomerShippingFee()

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
boolean

Whether the customerShippingFee field is set.

hasOrderCreatedTime()

public boolean hasOrderCreatedTime()

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
boolean

Whether the orderCreatedTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCustomerShippingFee(Price value)

public OrderTrackingSignal.Builder mergeCustomerShippingFee(Price value)

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];

Parameter
Name Description
value com.google.shopping.type.Price
Returns
Type Description
OrderTrackingSignal.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public OrderTrackingSignal.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OrderTrackingSignal.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public OrderTrackingSignal.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
OrderTrackingSignal.Builder
Overrides

mergeFrom(OrderTrackingSignal other)

public OrderTrackingSignal.Builder mergeFrom(OrderTrackingSignal other)
Parameter
Name Description
other OrderTrackingSignal
Returns
Type Description
OrderTrackingSignal.Builder

mergeOrderCreatedTime(DateTime value)

public OrderTrackingSignal.Builder mergeOrderCreatedTime(DateTime value)

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];

Parameter
Name Description
value com.google.type.DateTime
Returns
Type Description
OrderTrackingSignal.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final OrderTrackingSignal.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
OrderTrackingSignal.Builder
Overrides

removeLineItems(int index)

public OrderTrackingSignal.Builder removeLineItems(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.Builder

removeShipmentLineItemMapping(int index)

public OrderTrackingSignal.Builder removeShipmentLineItemMapping(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.Builder

removeShippingInfo(int index)

public OrderTrackingSignal.Builder removeShippingInfo(int index)

Required. The shipping information for the order.

repeated .google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal.ShippingInfo shipping_info = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
OrderTrackingSignal.Builder

setCustomerShippingFee(Price value)

public OrderTrackingSignal.Builder setCustomerShippingFee(Price value)

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];

Parameter
Name Description
value com.google.shopping.type.Price
Returns
Type Description
OrderTrackingSignal.Builder

setCustomerShippingFee(Price.Builder builderForValue)

public OrderTrackingSignal.Builder setCustomerShippingFee(Price.Builder builderForValue)

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];

Parameter
Name Description
builderForValue com.google.shopping.type.Price.Builder
Returns
Type Description
OrderTrackingSignal.Builder

setDeliveryPostalCode(String value)

public OrderTrackingSignal.Builder setDeliveryPostalCode(String value)

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];

Parameter
Name Description
value String

The deliveryPostalCode to set.

Returns
Type Description
OrderTrackingSignal.Builder

This builder for chaining.

setDeliveryPostalCodeBytes(ByteString value)

public OrderTrackingSignal.Builder setDeliveryPostalCodeBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for deliveryPostalCode to set.

Returns
Type Description
OrderTrackingSignal.Builder

This builder for chaining.

setDeliveryRegionCode(String value)

public OrderTrackingSignal.Builder setDeliveryRegionCode(String value)

Optional. The CLDR territory code for the shipping destination.

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

Parameter
Name Description
value String

The deliveryRegionCode to set.

Returns
Type Description
OrderTrackingSignal.Builder

This builder for chaining.

setDeliveryRegionCodeBytes(ByteString value)

public OrderTrackingSignal.Builder setDeliveryRegionCodeBytes(ByteString value)

Optional. The CLDR territory code for the shipping destination.

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

Parameter
Name Description
value ByteString

The bytes for deliveryRegionCode to set.

Returns
Type Description
OrderTrackingSignal.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public OrderTrackingSignal.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
OrderTrackingSignal.Builder
Overrides

setLineItems(int index, OrderTrackingSignal.LineItemDetails value)

public OrderTrackingSignal.Builder setLineItems(int index, OrderTrackingSignal.LineItemDetails value)

Required. Information about line items in the order.

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

Parameters
Name Description
index int
value OrderTrackingSignal.LineItemDetails
Returns
Type Description
OrderTrackingSignal.Builder

setLineItems(int index, OrderTrackingSignal.LineItemDetails.Builder builderForValue)

public OrderTrackingSignal.Builder setLineItems(int index, OrderTrackingSignal.LineItemDetails.Builder builderForValue)

Required. Information about line items in the order.

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

Parameters
Name Description
index int
builderForValue OrderTrackingSignal.LineItemDetails.Builder
Returns
Type Description
OrderTrackingSignal.Builder

setMerchantId(long value)

public OrderTrackingSignal.Builder setMerchantId(long value)

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];

Parameter
Name Description
value long

The merchantId to set.

Returns
Type Description
OrderTrackingSignal.Builder

This builder for chaining.

setOrderCreatedTime(DateTime value)

public OrderTrackingSignal.Builder setOrderCreatedTime(DateTime value)

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];

Parameter
Name Description
value com.google.type.DateTime
Returns
Type Description
OrderTrackingSignal.Builder

setOrderCreatedTime(DateTime.Builder builderForValue)

public OrderTrackingSignal.Builder setOrderCreatedTime(DateTime.Builder builderForValue)

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];

Parameter
Name Description
builderForValue com.google.type.DateTime.Builder
Returns
Type Description
OrderTrackingSignal.Builder

setOrderId(String value)

public OrderTrackingSignal.Builder setOrderId(String value)

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];

Parameter
Name Description
value String

The orderId to set.

Returns
Type Description
OrderTrackingSignal.Builder

This builder for chaining.

setOrderIdBytes(ByteString value)

public OrderTrackingSignal.Builder setOrderIdBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for orderId to set.

Returns
Type Description
OrderTrackingSignal.Builder

This builder for chaining.

setOrderTrackingSignalId(long value)

public OrderTrackingSignal.Builder setOrderTrackingSignalId(long value)

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

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

Parameter
Name Description
value long

The orderTrackingSignalId to set.

Returns
Type Description
OrderTrackingSignal.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public OrderTrackingSignal.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
OrderTrackingSignal.Builder
Overrides

setShipmentLineItemMapping(int index, OrderTrackingSignal.ShipmentLineItemMapping value)

public OrderTrackingSignal.Builder setShipmentLineItemMapping(int index, OrderTrackingSignal.ShipmentLineItemMapping value)

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];

Parameters
Name Description
index int
value OrderTrackingSignal.ShipmentLineItemMapping
Returns
Type Description
OrderTrackingSignal.Builder

setShipmentLineItemMapping(int index, OrderTrackingSignal.ShipmentLineItemMapping.Builder builderForValue)

public OrderTrackingSignal.Builder setShipmentLineItemMapping(int index, OrderTrackingSignal.ShipmentLineItemMapping.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue OrderTrackingSignal.ShipmentLineItemMapping.Builder
Returns
Type Description
OrderTrackingSignal.Builder

setShippingInfo(int index, OrderTrackingSignal.ShippingInfo value)

public OrderTrackingSignal.Builder setShippingInfo(int index, OrderTrackingSignal.ShippingInfo value)

Required. The shipping information for the order.

repeated .google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal.ShippingInfo shipping_info = 3 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
value OrderTrackingSignal.ShippingInfo
Returns
Type Description
OrderTrackingSignal.Builder

setShippingInfo(int index, OrderTrackingSignal.ShippingInfo.Builder builderForValue)

public OrderTrackingSignal.Builder setShippingInfo(int index, OrderTrackingSignal.ShippingInfo.Builder builderForValue)

Required. The shipping information for the order.

repeated .google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal.ShippingInfo shipping_info = 3 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
builderForValue OrderTrackingSignal.ShippingInfo.Builder
Returns
Type Description
OrderTrackingSignal.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final OrderTrackingSignal.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
OrderTrackingSignal.Builder
Overrides