Class: Google::Apis::ContentV2_1::OrderTrackingSignalShippingInfo

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

The shipping information for the order.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ OrderTrackingSignalShippingInfo

Returns a new instance of OrderTrackingSignalShippingInfo.



6873
6874
6875
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 6873

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

Instance Attribute Details

#actual_delivery_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 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 actualDeliveryTime

Returns:



6774
6775
6776
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 6774

def actual_delivery_time
  @actual_delivery_time
end

#carrier_name ⇒ String

The name of the shipping carrier for the delivery. This field is required if one of the following fields is absent: earliest_delivery_promise_time, latest_delivery_promise_time, and actual_delivery_time. Corresponds to the JSON property carrierName

Returns:

  • (String) 


6781
6782
6783
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 6781

def carrier_name
  @carrier_name
end

#carrier_service_name ⇒ String

The service type for fulfillment, e.g., GROUND, FIRST_CLASS, etc. Corresponds to the JSON property carrierServiceName

Returns:

  • (String) 


6786
6787
6788
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 6786

def carrier_service_name
  @carrier_service_name
end

#earliest_delivery_promise_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 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 earliestDeliveryPromiseTime

Returns:



6804
6805
6806
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 6804

def earliest_delivery_promise_time
  @earliest_delivery_promise_time
end

#latest_delivery_promise_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 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 latestDeliveryPromiseTime

Returns:



6822
6823
6824
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 6822

def latest_delivery_promise_time
  @latest_delivery_promise_time
end

#origin_postal_code ⇒ String

The origin 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 originPostalCode

Returns:

  • (String) 


6829
6830
6831
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 6829

def origin_postal_code
  @origin_postal_code
end

#origin_region_code ⇒ String

The CLDR territory code for the shipping origin. Corresponds to the JSON property originRegionCode

Returns:

  • (String) 


6835
6836
6837
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 6835

def origin_region_code
  @origin_region_code
end

#shipment_id ⇒ String

Required. The shipment ID. This field will be hashed in returned OrderTrackingSignal creation response. Corresponds to the JSON property shipmentId

Returns:

  • (String) 


6841
6842
6843
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 6841

def shipment_id
  @shipment_id
end

#shipped_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 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 shippedTime

Returns:



6859
6860
6861
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 6859

def shipped_time
  @shipped_time
end

#shipping_status ⇒ String

The status of the shipment. Corresponds to the JSON property shippingStatus

Returns:

  • (String) 


6864
6865
6866
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 6864

def shipping_status
  @shipping_status
end

#tracking_id ⇒ String

The tracking ID of the shipment. This field is required if one of the following fields is absent: earliest_delivery_promise_time, latest_delivery_promise_time, and actual_delivery_time. Corresponds to the JSON property trackingId

Returns:

  • (String) 


6871
6872
6873
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 6871

def tracking_id
  @tracking_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 6878

def update!(**args)
  @actual_delivery_time = args[:actual_delivery_time] if args.key?(:actual_delivery_time)
  @carrier_name = args[:carrier_name] if args.key?(:carrier_name)
  @carrier_service_name = args[:carrier_service_name] if args.key?(:carrier_service_name)
  @earliest_delivery_promise_time = args[:earliest_delivery_promise_time] if args.key?(:earliest_delivery_promise_time)
  @latest_delivery_promise_time = args[:latest_delivery_promise_time] if args.key?(:latest_delivery_promise_time)
  @origin_postal_code = args[:origin_postal_code] if args.key?(:origin_postal_code)
  @origin_region_code = args[:origin_region_code] if args.key?(:origin_region_code)
  @shipment_id = args[:shipment_id] if args.key?(:shipment_id)
  @shipped_time = args[:shipped_time] if args.key?(:shipped_time)
  @shipping_status = args[:shipping_status] if args.key?(:shipping_status)
  @tracking_id = args[:tracking_id] if args.key?(:tracking_id)
end