Class: Google::Apis::ContentV2_1::OrderTrackingSignal

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/content_v2_1/classes.rb,
lib/google/apis/content_v2_1/representations.rb,
lib/google/apis/content_v2_1/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ OrderTrackingSignal

Returns a new instance of OrderTrackingSignal.



7227
7228
7229
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 7227

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#customer_shipping_fee ⇒ Google::Apis::ContentV2_1::PriceAmount

The price represented as a number and currency. Corresponds to the JSON property customerShippingFee

Returns:



7159
7160
7161
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 7159

def customer_shipping_fee
  @customer_shipping_fee
end

#delivery_postal_code ⇒ String

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

Returns:

  • (String) 


7166
7167
7168
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 7166

def delivery_postal_code
  @delivery_postal_code
end

#delivery_region_code ⇒ String

Required. The CLDR territory code for the shipping destination. Corresponds to the JSON property deliveryRegionCode

Returns:

  • (String) 


7172
7173
7174
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 7172

def delivery_region_code
  @delivery_region_code
end

#line_items ⇒ Array<Google::Apis::ContentV2_1::OrderTrackingSignalLineItemDetails>

Information about line items in the order. Corresponds to the JSON property lineItems

Returns:



7177
7178
7179
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 7177

def line_items
  @line_items
end

#merchant_id ⇒ Fixnum

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. Corresponds to the JSON property merchantId

Returns:

  • (Fixnum) 


7186
7187
7188
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 7186

def merchant_id
  @merchant_id
end

#order_created_time ⇒ Google::Apis::ContentV2_1::DateTime

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, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. 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

Returns:



7204
7205
7206
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 7204

def order_created_time
  @order_created_time
end

#order_id ⇒ String

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

Returns:

  • (String) 


7210
7211
7212
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 7210

def order_id
  @order_id
end

#order_tracking_signal_id ⇒ Fixnum

Output only. The ID that uniquely identifies this order tracking signal. Corresponds to the JSON property orderTrackingSignalId

Returns:

  • (Fixnum) 


7215
7216
7217
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 7215

def order_tracking_signal_id
  @order_tracking_signal_id
end

#shipment_line_item_mapping ⇒ Array<Google::Apis::ContentV2_1::OrderTrackingSignalShipmentLineItemMapping>

The mapping of the line items to the shipment information. Corresponds to the JSON property shipmentLineItemMapping

Returns:



7220
7221
7222
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 7220

def shipment_line_item_mapping
  @shipment_line_item_mapping
end

#shipping_info ⇒ Array<Google::Apis::ContentV2_1::OrderTrackingSignalShippingInfo>

The shipping information for the order. Corresponds to the JSON property shippingInfo

Returns:



7225
7226
7227
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 7225

def shipping_info
  @shipping_info
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 7232

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