target.apidocs.com.google.api.services.content.model.OrderTrackingSignal.html Maven / Gradle / Ivy

Go to download







OrderTrackingSignal (Content API for Shopping v2.1-rev20240609-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.content.model
Class OrderTrackingSignal



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


com.google.api.services.content.model.OrderTrackingSignal













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class OrderTrackingSignal
extends com.google.api.client.json.GenericJson
Represents a merchant trade from which signals are extracted, e.g. shipping.

  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 transmitted over HTTP when working with the Content API for Shopping. For a detailed explanation
 see:
 https://developers.google.com/api-client-library/java/google-http-java-client/json
 

Author:
Google, Inc.












Nested Class Summary




Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags





Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>





Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>








Constructor Summary

Constructors 

Constructor and Description


OrderTrackingSignal() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


OrderTrackingSignal
clone() 


PriceAmount
getCustomerShippingFee()
The shipping fee of the order; this value should be set to zero in the case of free shipping.



String
getDeliveryPostalCode()
Required.



String
getDeliveryRegionCode()
Required.



List<OrderTrackingSignalLineItemDetails>
getLineItems()
Information about line items in the order.



Long
getMerchantId()
The Google merchant ID of this order tracking signal.



DateTime
getOrderCreatedTime()
Required.



String
getOrderId()
Required.



Long
getOrderTrackingSignalId()
Output only.



List<OrderTrackingSignalShipmentLineItemMapping>
getShipmentLineItemMapping()
The mapping of the line items to the shipment information.



List<OrderTrackingSignalShippingInfo>
getShippingInfo()
The shipping information for the order.



OrderTrackingSignal
set(String fieldName,
   Object value) 


OrderTrackingSignal
setCustomerShippingFee(PriceAmount customerShippingFee)
The shipping fee of the order; this value should be set to zero in the case of free shipping.



OrderTrackingSignal
setDeliveryPostalCode(String deliveryPostalCode)
Required.



OrderTrackingSignal
setDeliveryRegionCode(String deliveryRegionCode)
Required.



OrderTrackingSignal
setLineItems(List<OrderTrackingSignalLineItemDetails> lineItems)
Information about line items in the order.



OrderTrackingSignal
setMerchantId(Long merchantId)
The Google merchant ID of this order tracking signal.



OrderTrackingSignal
setOrderCreatedTime(DateTime orderCreatedTime)
Required.



OrderTrackingSignal
setOrderId(String orderId)
Required.



OrderTrackingSignal
setOrderTrackingSignalId(Long orderTrackingSignalId)
Output only.



OrderTrackingSignal
setShipmentLineItemMapping(List<OrderTrackingSignalShipmentLineItemMapping> shipmentLineItemMapping)
The mapping of the line items to the shipment information.



OrderTrackingSignal
setShippingInfo(List<OrderTrackingSignalShippingInfo> shippingInfo)
The shipping information for the order.







Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString





Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys





Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values





Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait





Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll














Constructor Detail





OrderTrackingSignal
public OrderTrackingSignal()









Method Detail





getCustomerShippingFee
public PriceAmount getCustomerShippingFee()
The shipping fee of the order; this value should be set to zero in the case of free shipping.

Returns:
value or null for none








setCustomerShippingFee
public OrderTrackingSignal setCustomerShippingFee(PriceAmount customerShippingFee)
The shipping fee of the order; this value should be set to zero in the case of free shipping.

Parameters:
customerShippingFee - customerShippingFee or null for none








getDeliveryPostalCode
public String getDeliveryPostalCode()
Required. The delivery postal code, as a continuous string without spaces or dashes, e.g.
 "95016". This field will be anonymized in returned OrderTrackingSignal creation response.

Returns:
value or null for none








setDeliveryPostalCode
public OrderTrackingSignal setDeliveryPostalCode(String deliveryPostalCode)
Required. The delivery postal code, as a continuous string without spaces or dashes, e.g.
 "95016". This field will be anonymized in returned OrderTrackingSignal creation response.

Parameters:
deliveryPostalCode - deliveryPostalCode or null for none








getDeliveryRegionCode
public String getDeliveryRegionCode()
Required. The [CLDR territory code]
 (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) for the shipping
 destination.

Returns:
value or null for none








setDeliveryRegionCode
public OrderTrackingSignal setDeliveryRegionCode(String deliveryRegionCode)
Required. The [CLDR territory code]
 (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) for the shipping
 destination.

Parameters:
deliveryRegionCode - deliveryRegionCode or null for none








getLineItems
public List<OrderTrackingSignalLineItemDetails> getLineItems()
Information about line items in the order.

Returns:
value or null for none








setLineItems
public OrderTrackingSignal setLineItems(List<OrderTrackingSignalLineItemDetails> lineItems)
Information about line items in the order.

Parameters:
lineItems - lineItems or null for none








getMerchantId
public Long getMerchantId()
The Google merchant ID of this order tracking signal. This value is optional. If left unset,
 the caller's merchant ID is used. You must request access in order to provide data on behalf of
 another merchant. For more information, see [Submitting Order Tracking Signals](/shopping-
 content/guides/order-tracking-signals).

Returns:
value or null for none








setMerchantId
public OrderTrackingSignal setMerchantId(Long merchantId)
The Google merchant ID of this order tracking signal. This value is optional. If left unset,
 the caller's merchant ID is used. You must request access in order to provide data on behalf of
 another merchant. For more information, see [Submitting Order Tracking Signals](/shopping-
 content/guides/order-tracking-signals).

Parameters:
merchantId - merchantId or null for none








getOrderCreatedTime
public DateTime getOrderCreatedTime()
Required. The time when the order was created on the merchant side. Include the year and
 timezone string, if available.

Returns:
value or null for none








setOrderCreatedTime
public OrderTrackingSignal setOrderCreatedTime(DateTime orderCreatedTime)
Required. The time when the order was created on the merchant side. Include the year and
 timezone string, if available.

Parameters:
orderCreatedTime - orderCreatedTime or null for none








getOrderId
public String getOrderId()
Required. The ID of the order on the merchant side. This field will be hashed in returned
 OrderTrackingSignal creation response.

Returns:
value or null for none








setOrderId
public OrderTrackingSignal setOrderId(String orderId)
Required. The ID of the order on the merchant side. This field will be hashed in returned
 OrderTrackingSignal creation response.

Parameters:
orderId - orderId or null for none








getOrderTrackingSignalId
public Long getOrderTrackingSignalId()
Output only. The ID that uniquely identifies this order tracking signal.

Returns:
value or null for none








setOrderTrackingSignalId
public OrderTrackingSignal setOrderTrackingSignalId(Long orderTrackingSignalId)
Output only. The ID that uniquely identifies this order tracking signal.

Parameters:
orderTrackingSignalId - orderTrackingSignalId or null for none








getShipmentLineItemMapping
public List<OrderTrackingSignalShipmentLineItemMapping> getShipmentLineItemMapping()
The mapping of the line items to the shipment information.

Returns:
value or null for none








setShipmentLineItemMapping
public OrderTrackingSignal setShipmentLineItemMapping(List<OrderTrackingSignalShipmentLineItemMapping> shipmentLineItemMapping)
The mapping of the line items to the shipment information.

Parameters:
shipmentLineItemMapping - shipmentLineItemMapping or null for none








getShippingInfo
public List<OrderTrackingSignalShippingInfo> getShippingInfo()
The shipping information for the order.

Returns:
value or null for none








setShippingInfo
public OrderTrackingSignal setShippingInfo(List<OrderTrackingSignalShippingInfo> shippingInfo)
The shipping information for the order.

Parameters:
shippingInfo - shippingInfo or null for none








set
public OrderTrackingSignal set(String fieldName,
                               Object value)

Overrides:
set in class com.google.api.client.json.GenericJson








clone
public OrderTrackingSignal clone()

Overrides:
clone in class com.google.api.client.json.GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.

Modifier and Type	Method and Description
`OrderTrackingSignal`	`clone()`
`PriceAmount`	`getCustomerShippingFee()` The shipping fee of the order; this value should be set to zero in the case of free shipping.
`String`	`getDeliveryPostalCode()` Required.
`String`	`getDeliveryRegionCode()` Required.
`List<OrderTrackingSignalLineItemDetails>`	`getLineItems()` Information about line items in the order.
`Long`	`getMerchantId()` The Google merchant ID of this order tracking signal.
`DateTime`	`getOrderCreatedTime()` Required.
`String`	`getOrderId()` Required.
`Long`	`getOrderTrackingSignalId()` Output only.
`List<OrderTrackingSignalShipmentLineItemMapping>`	`getShipmentLineItemMapping()` The mapping of the line items to the shipment information.
`List<OrderTrackingSignalShippingInfo>`	`getShippingInfo()` The shipping information for the order.
`OrderTrackingSignal`	`set(String fieldName, Object value)`
`OrderTrackingSignal`	`setCustomerShippingFee(PriceAmount customerShippingFee)` The shipping fee of the order; this value should be set to zero in the case of free shipping.
`OrderTrackingSignal`	`setDeliveryPostalCode(String deliveryPostalCode)` Required.
`OrderTrackingSignal`	`setDeliveryRegionCode(String deliveryRegionCode)` Required.
`OrderTrackingSignal`	`setLineItems(List<OrderTrackingSignalLineItemDetails> lineItems)` Information about line items in the order.
`OrderTrackingSignal`	`setMerchantId(Long merchantId)` The Google merchant ID of this order tracking signal.
`OrderTrackingSignal`	`setOrderCreatedTime(DateTime orderCreatedTime)` Required.
`OrderTrackingSignal`	`setOrderId(String orderId)` Required.
`OrderTrackingSignal`	`setOrderTrackingSignalId(Long orderTrackingSignalId)` Output only.
`OrderTrackingSignal`	`setShipmentLineItemMapping(List<OrderTrackingSignalShipmentLineItemMapping> shipmentLineItemMapping)` The mapping of the line items to the shipment information.
`OrderTrackingSignal`	`setShippingInfo(List<OrderTrackingSignalShippingInfo> shippingInfo)` The shipping information for the order.