class Google::Apis::ContentV2_1::OrderTrackingSignal

Represents a merchant trade from which signals are extracted, e.g. shipping.

Attributes

customer_shipping_fee[RW]

The price represented as a number and currency. Corresponds to the JSON property `customerShippingFee` @return [Google::Apis::ContentV2_1::PriceAmount]

delivery_postal_code[RW]

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. Corresponds to the JSON property `deliveryPostalCode` @return [String]

delivery_region_code[RW]

Required. The [CLDR territory code] (www.unicode.org/repos/cldr/tags/ latest/common/main/en.xml) for the shipping destination. Corresponds to the JSON property `deliveryRegionCode` @return [String]

line_items[RW]

Information about line items in the order. Corresponds to the JSON property `lineItems` @return [Array<Google::Apis::ContentV2_1::OrderTrackingSignalLineItemDetails>]

merchant_id[RW]

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). Corresponds to the JSON property `merchantId` @return [Fixnum]

order_created_time[RW]

Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year is 0, the DateTime is considered not to have a specific year. month and day must have valid, non- zero values. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. Corresponds to the JSON property `orderCreatedTime` @return [Google::Apis::ContentV2_1::DateTime]

order_id[RW]

Required. The ID of the order on the merchant side. This field will be hashed in returned OrderTrackingSignal creation response. Corresponds to the JSON property `orderId` @return [String]

order_tracking_signal_id[RW]

Output only. The ID that uniquely identifies this order tracking signal. Corresponds to the JSON property `orderTrackingSignalId` @return [Fixnum]

shipment_line_item_mapping[RW]

The mapping of the line items to the shipment information. Corresponds to the JSON property `shipmentLineItemMapping` @return [Array<Google::Apis::ContentV2_1::OrderTrackingSignalShipmentLineItemMapping>]

shipping_info[RW]

The shipping information for the order. Corresponds to the JSON property `shippingInfo` @return [Array<Google::Apis::ContentV2_1::OrderTrackingSignalShippingInfo>]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/content_v2_1/classes.rb, line 6796
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/content_v2_1/classes.rb, line 6801
def update!(**args)
  @customer_shipping_fee = args[:customer_shipping_fee] if args.key?(:customer_shipping_fee)
  @delivery_postal_code = args[:delivery_postal_code] if args.key?(:delivery_postal_code)
  @delivery_region_code = args[:delivery_region_code] if args.key?(:delivery_region_code)
  @line_items = args[:line_items] if args.key?(:line_items)
  @merchant_id = args[:merchant_id] if args.key?(:merchant_id)
  @order_created_time = args[:order_created_time] if args.key?(:order_created_time)
  @order_id = args[:order_id] if args.key?(:order_id)
  @order_tracking_signal_id = args[:order_tracking_signal_id] if args.key?(:order_tracking_signal_id)
  @shipment_line_item_mapping = args[:shipment_line_item_mapping] if args.key?(:shipment_line_item_mapping)
  @shipping_info = args[:shipping_info] if args.key?(:shipping_info)
end