public interface OrderTrackingSignalOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getCustomerShippingFee()
public abstract 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 abstract 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 |
|
getDeliveryPostalCode()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 |
|
getShippingInfoCount()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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. |