Class: Google::Shopping::Merchant::OrderTracking::V1beta::OrderTrackingSignal

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/shopping/merchant/ordertracking/v1beta/order_tracking_signals.rb

Overview

Represents a business trade from which signals are extracted, such as shipping.

Defined Under Namespace

Classes: LineItemDetails, ShipmentLineItemMapping, ShippingInfo

Instance Attribute Summary collapse

Instance Attribute Details

#customer_shipping_fee ⇒ ::Google::Shopping::Type::Price

Returns Optional. The shipping fee of the order; this value should be set to zero in the case of free shipping.

Returns:



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'proto_docs/google/shopping/merchant/ordertracking/v1beta/order_tracking_signals.rb', line 86

class OrderTrackingSignal
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The shipping information for the order.
  # @!attribute [rw] shipment_id
  #   @return [::String]
  #     Required. The shipment ID. This field will be hashed in returned
  #     OrderTrackingSignal creation response.
  # @!attribute [rw] tracking_id
  #   @return [::String]
  #     Optional. 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.
  # @!attribute [rw] carrier
  #   @return [::String]
  #     Optional. 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.
  # @!attribute [rw] carrier_service
  #   @return [::String]
  #     Optional. The service type for fulfillment, such as GROUND, FIRST_CLASS,
  #     etc.
  # @!attribute [rw] shipped_time
  #   @return [::Google::Type::DateTime]
  #     Optional. The time when the shipment was shipped.
  #     Include the year and timezone string, if available.
  # @!attribute [rw] earliest_delivery_promise_time
  #   @return [::Google::Type::DateTime]
  #     Optional. The earliest delivery promised time.
  #     Include the year and timezone string, if available.
  #     This field is required, if one of the following fields is absent:
  #     tracking_id or carrier_name.
  # @!attribute [rw] latest_delivery_promise_time
  #   @return [::Google::Type::DateTime]
  #     Optional. The latest delivery promised time.
  #     Include the year and timezone string, if available.
  #     This field is required, if one of the following fields is absent:
  #     tracking_id or carrier_name.
  # @!attribute [rw] actual_delivery_time
  #   @return [::Google::Type::DateTime]
  #     Optional. The time when the shipment was actually delivered.
  #     Include the year and timezone string, if available.
  #     This field is required, if one of the following fields is absent:
  #     tracking_id or carrier_name.
  # @!attribute [rw] shipping_status
  #   @return [::Google::Shopping::Merchant::OrderTracking::V1beta::OrderTrackingSignal::ShippingInfo::ShippingState]
  #     Required. The status of the shipment.
  # @!attribute [rw] origin_postal_code
  #   @return [::String]
  #     Required. The origin postal code, as a continuous string without spaces
  #     or dashes, for example "95016". This field will be anonymized in returned
  #     OrderTrackingSignal creation response.
  # @!attribute [rw] origin_region_code
  #   @return [::String]
  #     Required. The [CLDR territory code]
  #     (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) for
  #     the shipping origin.
  class ShippingInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The current status of the shipments.
    module ShippingState
      # The shipping status is not known to business.
      SHIPPING_STATE_UNSPECIFIED = 0

      # All items are shipped.
      SHIPPED = 1

      # The shipment is already delivered.
      DELIVERED = 2
    end
  end

  # The line items of the order.
  # @!attribute [rw] line_item_id
  #   @return [::String]
  #     Required. The ID for this line item.
  # @!attribute [rw] product_id
  #   @return [::String]
  #     Required. The Content API REST ID of the product, in the
  #     form channel:contentLanguage:targetCountry:offerId.
  # @!attribute [rw] gtin
  #   @return [::String]
  #     Optional. The Global Trade Item Number.
  # @!attribute [rw] mpn
  #   @return [::String]
  #     Optional. The manufacturer part number.
  # @!attribute [rw] product_title
  #   @return [::String]
  #     Optional. Plain text title of this product.
  # @!attribute [rw] brand
  #   @return [::String]
  #     Optional. Brand of the product.
  # @!attribute [rw] quantity
  #   @return [::Integer]
  #     Required. The quantity of the line item in the order.
  class LineItemDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents how many items are in the shipment for the given shipment_id
  # and line_item_id.
  # @!attribute [rw] shipment_id
  #   @return [::String]
  #     Required. The shipment ID. This field will be hashed in returned
  #     OrderTrackingSignal creation response.
  # @!attribute [rw] line_item_id
  #   @return [::String]
  #     Required. The line item ID.
  # @!attribute [rw] quantity
  #   @return [::Integer]
  #     Required. The line item quantity in the shipment.
  class ShipmentLineItemMapping
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#delivery_postal_code ⇒ ::String

Returns 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.

Returns:

  • (::String) —

    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.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'proto_docs/google/shopping/merchant/ordertracking/v1beta/order_tracking_signals.rb', line 86

class OrderTrackingSignal
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The shipping information for the order.
  # @!attribute [rw] shipment_id
  #   @return [::String]
  #     Required. The shipment ID. This field will be hashed in returned
  #     OrderTrackingSignal creation response.
  # @!attribute [rw] tracking_id
  #   @return [::String]
  #     Optional. 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.
  # @!attribute [rw] carrier
  #   @return [::String]
  #     Optional. 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.
  # @!attribute [rw] carrier_service
  #   @return [::String]
  #     Optional. The service type for fulfillment, such as GROUND, FIRST_CLASS,
  #     etc.
  # @!attribute [rw] shipped_time
  #   @return [::Google::Type::DateTime]
  #     Optional. The time when the shipment was shipped.
  #     Include the year and timezone string, if available.
  # @!attribute [rw] earliest_delivery_promise_time
  #   @return [::Google::Type::DateTime]
  #     Optional. The earliest delivery promised time.
  #     Include the year and timezone string, if available.
  #     This field is required, if one of the following fields is absent:
  #     tracking_id or carrier_name.
  # @!attribute [rw] latest_delivery_promise_time
  #   @return [::Google::Type::DateTime]
  #     Optional. The latest delivery promised time.
  #     Include the year and timezone string, if available.
  #     This field is required, if one of the following fields is absent:
  #     tracking_id or carrier_name.
  # @!attribute [rw] actual_delivery_time
  #   @return [::Google::Type::DateTime]
  #     Optional. The time when the shipment was actually delivered.
  #     Include the year and timezone string, if available.
  #     This field is required, if one of the following fields is absent:
  #     tracking_id or carrier_name.
  # @!attribute [rw] shipping_status
  #   @return [::Google::Shopping::Merchant::OrderTracking::V1beta::OrderTrackingSignal::ShippingInfo::ShippingState]
  #     Required. The status of the shipment.
  # @!attribute [rw] origin_postal_code
  #   @return [::String]
  #     Required. The origin postal code, as a continuous string without spaces
  #     or dashes, for example "95016". This field will be anonymized in returned
  #     OrderTrackingSignal creation response.
  # @!attribute [rw] origin_region_code
  #   @return [::String]
  #     Required. The [CLDR territory code]
  #     (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) for
  #     the shipping origin.
  class ShippingInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The current status of the shipments.
    module ShippingState
      # The shipping status is not known to business.
      SHIPPING_STATE_UNSPECIFIED = 0

      # All items are shipped.
      SHIPPED = 1

      # The shipment is already delivered.
      DELIVERED = 2
    end
  end

  # The line items of the order.
  # @!attribute [rw] line_item_id
  #   @return [::String]
  #     Required. The ID for this line item.
  # @!attribute [rw] product_id
  #   @return [::String]
  #     Required. The Content API REST ID of the product, in the
  #     form channel:contentLanguage:targetCountry:offerId.
  # @!attribute [rw] gtin
  #   @return [::String]
  #     Optional. The Global Trade Item Number.
  # @!attribute [rw] mpn
  #   @return [::String]
  #     Optional. The manufacturer part number.
  # @!attribute [rw] product_title
  #   @return [::String]
  #     Optional. Plain text title of this product.
  # @!attribute [rw] brand
  #   @return [::String]
  #     Optional. Brand of the product.
  # @!attribute [rw] quantity
  #   @return [::Integer]
  #     Required. The quantity of the line item in the order.
  class LineItemDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents how many items are in the shipment for the given shipment_id
  # and line_item_id.
  # @!attribute [rw] shipment_id
  #   @return [::String]
  #     Required. The shipment ID. This field will be hashed in returned
  #     OrderTrackingSignal creation response.
  # @!attribute [rw] line_item_id
  #   @return [::String]
  #     Required. The line item ID.
  # @!attribute [rw] quantity
  #   @return [::Integer]
  #     Required. The line item quantity in the shipment.
  class ShipmentLineItemMapping
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#delivery_region_code ⇒ ::String

Returns Optional. The CLDR territory code for the shipping destination.

Returns:



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'proto_docs/google/shopping/merchant/ordertracking/v1beta/order_tracking_signals.rb', line 86

class OrderTrackingSignal
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The shipping information for the order.
  # @!attribute [rw] shipment_id
  #   @return [::String]
  #     Required. The shipment ID. This field will be hashed in returned
  #     OrderTrackingSignal creation response.
  # @!attribute [rw] tracking_id
  #   @return [::String]
  #     Optional. 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.
  # @!attribute [rw] carrier
  #   @return [::String]
  #     Optional. 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.
  # @!attribute [rw] carrier_service
  #   @return [::String]
  #     Optional. The service type for fulfillment, such as GROUND, FIRST_CLASS,
  #     etc.
  # @!attribute [rw] shipped_time
  #   @return [::Google::Type::DateTime]
  #     Optional. The time when the shipment was shipped.
  #     Include the year and timezone string, if available.
  # @!attribute [rw] earliest_delivery_promise_time
  #   @return [::Google::Type::DateTime]
  #     Optional. The earliest delivery promised time.
  #     Include the year and timezone string, if available.
  #     This field is required, if one of the following fields is absent:
  #     tracking_id or carrier_name.
  # @!attribute [rw] latest_delivery_promise_time
  #   @return [::Google::Type::DateTime]
  #     Optional. The latest delivery promised time.
  #     Include the year and timezone string, if available.
  #     This field is required, if one of the following fields is absent:
  #     tracking_id or carrier_name.
  # @!attribute [rw] actual_delivery_time
  #   @return [::Google::Type::DateTime]
  #     Optional. The time when the shipment was actually delivered.
  #     Include the year and timezone string, if available.
  #     This field is required, if one of the following fields is absent:
  #     tracking_id or carrier_name.
  # @!attribute [rw] shipping_status
  #   @return [::Google::Shopping::Merchant::OrderTracking::V1beta::OrderTrackingSignal::ShippingInfo::ShippingState]
  #     Required. The status of the shipment.
  # @!attribute [rw] origin_postal_code
  #   @return [::String]
  #     Required. The origin postal code, as a continuous string without spaces
  #     or dashes, for example "95016". This field will be anonymized in returned
  #     OrderTrackingSignal creation response.
  # @!attribute [rw] origin_region_code
  #   @return [::String]
  #     Required. The [CLDR territory code]
  #     (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) for
  #     the shipping origin.
  class ShippingInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The current status of the shipments.
    module ShippingState
      # The shipping status is not known to business.
      SHIPPING_STATE_UNSPECIFIED = 0

      # All items are shipped.
      SHIPPED = 1

      # The shipment is already delivered.
      DELIVERED = 2
    end
  end

  # The line items of the order.
  # @!attribute [rw] line_item_id
  #   @return [::String]
  #     Required. The ID for this line item.
  # @!attribute [rw] product_id
  #   @return [::String]
  #     Required. The Content API REST ID of the product, in the
  #     form channel:contentLanguage:targetCountry:offerId.
  # @!attribute [rw] gtin
  #   @return [::String]
  #     Optional. The Global Trade Item Number.
  # @!attribute [rw] mpn
  #   @return [::String]
  #     Optional. The manufacturer part number.
  # @!attribute [rw] product_title
  #   @return [::String]
  #     Optional. Plain text title of this product.
  # @!attribute [rw] brand
  #   @return [::String]
  #     Optional. Brand of the product.
  # @!attribute [rw] quantity
  #   @return [::Integer]
  #     Required. The quantity of the line item in the order.
  class LineItemDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents how many items are in the shipment for the given shipment_id
  # and line_item_id.
  # @!attribute [rw] shipment_id
  #   @return [::String]
  #     Required. The shipment ID. This field will be hashed in returned
  #     OrderTrackingSignal creation response.
  # @!attribute [rw] line_item_id
  #   @return [::String]
  #     Required. The line item ID.
  # @!attribute [rw] quantity
  #   @return [::Integer]
  #     Required. The line item quantity in the shipment.
  class ShipmentLineItemMapping
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#line_items ⇒ ::Array<::Google::Shopping::Merchant::OrderTracking::V1beta::OrderTrackingSignal::LineItemDetails>

Returns Required. Information about line items in the order.

Returns:



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'proto_docs/google/shopping/merchant/ordertracking/v1beta/order_tracking_signals.rb', line 86

class OrderTrackingSignal
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The shipping information for the order.
  # @!attribute [rw] shipment_id
  #   @return [::String]
  #     Required. The shipment ID. This field will be hashed in returned
  #     OrderTrackingSignal creation response.
  # @!attribute [rw] tracking_id
  #   @return [::String]
  #     Optional. 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.
  # @!attribute [rw] carrier
  #   @return [::String]
  #     Optional. 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.
  # @!attribute [rw] carrier_service
  #   @return [::String]
  #     Optional. The service type for fulfillment, such as GROUND, FIRST_CLASS,
  #     etc.
  # @!attribute [rw] shipped_time
  #   @return [::Google::Type::DateTime]
  #     Optional. The time when the shipment was shipped.
  #     Include the year and timezone string, if available.
  # @!attribute [rw] earliest_delivery_promise_time
  #   @return [::Google::Type::DateTime]
  #     Optional. The earliest delivery promised time.
  #     Include the year and timezone string, if available.
  #     This field is required, if one of the following fields is absent:
  #     tracking_id or carrier_name.
  # @!attribute [rw] latest_delivery_promise_time
  #   @return [::Google::Type::DateTime]
  #     Optional. The latest delivery promised time.
  #     Include the year and timezone string, if available.
  #     This field is required, if one of the following fields is absent:
  #     tracking_id or carrier_name.
  # @!attribute [rw] actual_delivery_time
  #   @return [::Google::Type::DateTime]
  #     Optional. The time when the shipment was actually delivered.
  #     Include the year and timezone string, if available.
  #     This field is required, if one of the following fields is absent:
  #     tracking_id or carrier_name.
  # @!attribute [rw] shipping_status
  #   @return [::Google::Shopping::Merchant::OrderTracking::V1beta::OrderTrackingSignal::ShippingInfo::ShippingState]
  #     Required. The status of the shipment.
  # @!attribute [rw] origin_postal_code
  #   @return [::String]
  #     Required. The origin postal code, as a continuous string without spaces
  #     or dashes, for example "95016". This field will be anonymized in returned
  #     OrderTrackingSignal creation response.
  # @!attribute [rw] origin_region_code
  #   @return [::String]
  #     Required. The [CLDR territory code]
  #     (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) for
  #     the shipping origin.
  class ShippingInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The current status of the shipments.
    module ShippingState
      # The shipping status is not known to business.
      SHIPPING_STATE_UNSPECIFIED = 0

      # All items are shipped.
      SHIPPED = 1

      # The shipment is already delivered.
      DELIVERED = 2
    end
  end

  # The line items of the order.
  # @!attribute [rw] line_item_id
  #   @return [::String]
  #     Required. The ID for this line item.
  # @!attribute [rw] product_id
  #   @return [::String]
  #     Required. The Content API REST ID of the product, in the
  #     form channel:contentLanguage:targetCountry:offerId.
  # @!attribute [rw] gtin
  #   @return [::String]
  #     Optional. The Global Trade Item Number.
  # @!attribute [rw] mpn
  #   @return [::String]
  #     Optional. The manufacturer part number.
  # @!attribute [rw] product_title
  #   @return [::String]
  #     Optional. Plain text title of this product.
  # @!attribute [rw] brand
  #   @return [::String]
  #     Optional. Brand of the product.
  # @!attribute [rw] quantity
  #   @return [::Integer]
  #     Required. The quantity of the line item in the order.
  class LineItemDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents how many items are in the shipment for the given shipment_id
  # and line_item_id.
  # @!attribute [rw] shipment_id
  #   @return [::String]
  #     Required. The shipment ID. This field will be hashed in returned
  #     OrderTrackingSignal creation response.
  # @!attribute [rw] line_item_id
  #   @return [::String]
  #     Required. The line item ID.
  # @!attribute [rw] quantity
  #   @return [::Integer]
  #     Required. The line item quantity in the shipment.
  class ShipmentLineItemMapping
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#merchant_id ⇒ ::Integer

Returns 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.

Returns:

  • (::Integer) —

    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.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'proto_docs/google/shopping/merchant/ordertracking/v1beta/order_tracking_signals.rb', line 86

class OrderTrackingSignal
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The shipping information for the order.
  # @!attribute [rw] shipment_id
  #   @return [::String]
  #     Required. The shipment ID. This field will be hashed in returned
  #     OrderTrackingSignal creation response.
  # @!attribute [rw] tracking_id
  #   @return [::String]
  #     Optional. 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.
  # @!attribute [rw] carrier
  #   @return [::String]
  #     Optional. 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.
  # @!attribute [rw] carrier_service
  #   @return [::String]
  #     Optional. The service type for fulfillment, such as GROUND, FIRST_CLASS,
  #     etc.
  # @!attribute [rw] shipped_time
  #   @return [::Google::Type::DateTime]
  #     Optional. The time when the shipment was shipped.
  #     Include the year and timezone string, if available.
  # @!attribute [rw] earliest_delivery_promise_time
  #   @return [::Google::Type::DateTime]
  #     Optional. The earliest delivery promised time.
  #     Include the year and timezone string, if available.
  #     This field is required, if one of the following fields is absent:
  #     tracking_id or carrier_name.
  # @!attribute [rw] latest_delivery_promise_time
  #   @return [::Google::Type::DateTime]
  #     Optional. The latest delivery promised time.
  #     Include the year and timezone string, if available.
  #     This field is required, if one of the following fields is absent:
  #     tracking_id or carrier_name.
  # @!attribute [rw] actual_delivery_time
  #   @return [::Google::Type::DateTime]
  #     Optional. The time when the shipment was actually delivered.
  #     Include the year and timezone string, if available.
  #     This field is required, if one of the following fields is absent:
  #     tracking_id or carrier_name.
  # @!attribute [rw] shipping_status
  #   @return [::Google::Shopping::Merchant::OrderTracking::V1beta::OrderTrackingSignal::ShippingInfo::ShippingState]
  #     Required. The status of the shipment.
  # @!attribute [rw] origin_postal_code
  #   @return [::String]
  #     Required. The origin postal code, as a continuous string without spaces
  #     or dashes, for example "95016". This field will be anonymized in returned
  #     OrderTrackingSignal creation response.
  # @!attribute [rw] origin_region_code
  #   @return [::String]
  #     Required. The [CLDR territory code]
  #     (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) for
  #     the shipping origin.
  class ShippingInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The current status of the shipments.
    module ShippingState
      # The shipping status is not known to business.
      SHIPPING_STATE_UNSPECIFIED = 0

      # All items are shipped.
      SHIPPED = 1

      # The shipment is already delivered.
      DELIVERED = 2
    end
  end

  # The line items of the order.
  # @!attribute [rw] line_item_id
  #   @return [::String]
  #     Required. The ID for this line item.
  # @!attribute [rw] product_id
  #   @return [::String]
  #     Required. The Content API REST ID of the product, in the
  #     form channel:contentLanguage:targetCountry:offerId.
  # @!attribute [rw] gtin
  #   @return [::String]
  #     Optional. The Global Trade Item Number.
  # @!attribute [rw] mpn
  #   @return [::String]
  #     Optional. The manufacturer part number.
  # @!attribute [rw] product_title
  #   @return [::String]
  #     Optional. Plain text title of this product.
  # @!attribute [rw] brand
  #   @return [::String]
  #     Optional. Brand of the product.
  # @!attribute [rw] quantity
  #   @return [::Integer]
  #     Required. The quantity of the line item in the order.
  class LineItemDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents how many items are in the shipment for the given shipment_id
  # and line_item_id.
  # @!attribute [rw] shipment_id
  #   @return [::String]
  #     Required. The shipment ID. This field will be hashed in returned
  #     OrderTrackingSignal creation response.
  # @!attribute [rw] line_item_id
  #   @return [::String]
  #     Required. The line item ID.
  # @!attribute [rw] quantity
  #   @return [::Integer]
  #     Required. The line item quantity in the shipment.
  class ShipmentLineItemMapping
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#order_created_time ⇒ ::Google::Type::DateTime

Returns Required. The time when the order was created on the businesses side. Include the year and timezone string, if available.

Returns:

  • (::Google::Type::DateTime) —

    Required. The time when the order was created on the businesses side. Include the year and timezone string, if available.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'proto_docs/google/shopping/merchant/ordertracking/v1beta/order_tracking_signals.rb', line 86

class OrderTrackingSignal
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The shipping information for the order.
  # @!attribute [rw] shipment_id
  #   @return [::String]
  #     Required. The shipment ID. This field will be hashed in returned
  #     OrderTrackingSignal creation response.
  # @!attribute [rw] tracking_id
  #   @return [::String]
  #     Optional. 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.
  # @!attribute [rw] carrier
  #   @return [::String]
  #     Optional. 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.
  # @!attribute [rw] carrier_service
  #   @return [::String]
  #     Optional. The service type for fulfillment, such as GROUND, FIRST_CLASS,
  #     etc.
  # @!attribute [rw] shipped_time
  #   @return [::Google::Type::DateTime]
  #     Optional. The time when the shipment was shipped.
  #     Include the year and timezone string, if available.
  # @!attribute [rw] earliest_delivery_promise_time
  #   @return [::Google::Type::DateTime]
  #     Optional. The earliest delivery promised time.
  #     Include the year and timezone string, if available.
  #     This field is required, if one of the following fields is absent:
  #     tracking_id or carrier_name.
  # @!attribute [rw] latest_delivery_promise_time
  #   @return [::Google::Type::DateTime]
  #     Optional. The latest delivery promised time.
  #     Include the year and timezone string, if available.
  #     This field is required, if one of the following fields is absent:
  #     tracking_id or carrier_name.
  # @!attribute [rw] actual_delivery_time
  #   @return [::Google::Type::DateTime]
  #     Optional. The time when the shipment was actually delivered.
  #     Include the year and timezone string, if available.
  #     This field is required, if one of the following fields is absent:
  #     tracking_id or carrier_name.
  # @!attribute [rw] shipping_status
  #   @return [::Google::Shopping::Merchant::OrderTracking::V1beta::OrderTrackingSignal::ShippingInfo::ShippingState]
  #     Required. The status of the shipment.
  # @!attribute [rw] origin_postal_code
  #   @return [::String]
  #     Required. The origin postal code, as a continuous string without spaces
  #     or dashes, for example "95016". This field will be anonymized in returned
  #     OrderTrackingSignal creation response.
  # @!attribute [rw] origin_region_code
  #   @return [::String]
  #     Required. The [CLDR territory code]
  #     (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) for
  #     the shipping origin.
  class ShippingInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The current status of the shipments.
    module ShippingState
      # The shipping status is not known to business.
      SHIPPING_STATE_UNSPECIFIED = 0

      # All items are shipped.
      SHIPPED = 1

      # The shipment is already delivered.
      DELIVERED = 2
    end
  end

  # The line items of the order.
  # @!attribute [rw] line_item_id
  #   @return [::String]
  #     Required. The ID for this line item.
  # @!attribute [rw] product_id
  #   @return [::String]
  #     Required. The Content API REST ID of the product, in the
  #     form channel:contentLanguage:targetCountry:offerId.
  # @!attribute [rw] gtin
  #   @return [::String]
  #     Optional. The Global Trade Item Number.
  # @!attribute [rw] mpn
  #   @return [::String]
  #     Optional. The manufacturer part number.
  # @!attribute [rw] product_title
  #   @return [::String]
  #     Optional. Plain text title of this product.
  # @!attribute [rw] brand
  #   @return [::String]
  #     Optional. Brand of the product.
  # @!attribute [rw] quantity
  #   @return [::Integer]
  #     Required. The quantity of the line item in the order.
  class LineItemDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents how many items are in the shipment for the given shipment_id
  # and line_item_id.
  # @!attribute [rw] shipment_id
  #   @return [::String]
  #     Required. The shipment ID. This field will be hashed in returned
  #     OrderTrackingSignal creation response.
  # @!attribute [rw] line_item_id
  #   @return [::String]
  #     Required. The line item ID.
  # @!attribute [rw] quantity
  #   @return [::Integer]
  #     Required. The line item quantity in the shipment.
  class ShipmentLineItemMapping
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#order_id ⇒ ::String

Returns Required. The ID of the order on the businesses side. This field will be hashed in returned OrderTrackingSignal creation response.

Returns:

  • (::String) —

    Required. The ID of the order on the businesses side. This field will be hashed in returned OrderTrackingSignal creation response.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'proto_docs/google/shopping/merchant/ordertracking/v1beta/order_tracking_signals.rb', line 86

class OrderTrackingSignal
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The shipping information for the order.
  # @!attribute [rw] shipment_id
  #   @return [::String]
  #     Required. The shipment ID. This field will be hashed in returned
  #     OrderTrackingSignal creation response.
  # @!attribute [rw] tracking_id
  #   @return [::String]
  #     Optional. 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.
  # @!attribute [rw] carrier
  #   @return [::String]
  #     Optional. 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.
  # @!attribute [rw] carrier_service
  #   @return [::String]
  #     Optional. The service type for fulfillment, such as GROUND, FIRST_CLASS,
  #     etc.
  # @!attribute [rw] shipped_time
  #   @return [::Google::Type::DateTime]
  #     Optional. The time when the shipment was shipped.
  #     Include the year and timezone string, if available.
  # @!attribute [rw] earliest_delivery_promise_time
  #   @return [::Google::Type::DateTime]
  #     Optional. The earliest delivery promised time.
  #     Include the year and timezone string, if available.
  #     This field is required, if one of the following fields is absent:
  #     tracking_id or carrier_name.
  # @!attribute [rw] latest_delivery_promise_time
  #   @return [::Google::Type::DateTime]
  #     Optional. The latest delivery promised time.
  #     Include the year and timezone string, if available.
  #     This field is required, if one of the following fields is absent:
  #     tracking_id or carrier_name.
  # @!attribute [rw] actual_delivery_time
  #   @return [::Google::Type::DateTime]
  #     Optional. The time when the shipment was actually delivered.
  #     Include the year and timezone string, if available.
  #     This field is required, if one of the following fields is absent:
  #     tracking_id or carrier_name.
  # @!attribute [rw] shipping_status
  #   @return [::Google::Shopping::Merchant::OrderTracking::V1beta::OrderTrackingSignal::ShippingInfo::ShippingState]
  #     Required. The status of the shipment.
  # @!attribute [rw] origin_postal_code
  #   @return [::String]
  #     Required. The origin postal code, as a continuous string without spaces
  #     or dashes, for example "95016". This field will be anonymized in returned
  #     OrderTrackingSignal creation response.
  # @!attribute [rw] origin_region_code
  #   @return [::String]
  #     Required. The [CLDR territory code]
  #     (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) for
  #     the shipping origin.
  class ShippingInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The current status of the shipments.
    module ShippingState
      # The shipping status is not known to business.
      SHIPPING_STATE_UNSPECIFIED = 0

      # All items are shipped.
      SHIPPED = 1

      # The shipment is already delivered.
      DELIVERED = 2
    end
  end

  # The line items of the order.
  # @!attribute [rw] line_item_id
  #   @return [::String]
  #     Required. The ID for this line item.
  # @!attribute [rw] product_id
  #   @return [::String]
  #     Required. The Content API REST ID of the product, in the
  #     form channel:contentLanguage:targetCountry:offerId.
  # @!attribute [rw] gtin
  #   @return [::String]
  #     Optional. The Global Trade Item Number.
  # @!attribute [rw] mpn
  #   @return [::String]
  #     Optional. The manufacturer part number.
  # @!attribute [rw] product_title
  #   @return [::String]
  #     Optional. Plain text title of this product.
  # @!attribute [rw] brand
  #   @return [::String]
  #     Optional. Brand of the product.
  # @!attribute [rw] quantity
  #   @return [::Integer]
  #     Required. The quantity of the line item in the order.
  class LineItemDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents how many items are in the shipment for the given shipment_id
  # and line_item_id.
  # @!attribute [rw] shipment_id
  #   @return [::String]
  #     Required. The shipment ID. This field will be hashed in returned
  #     OrderTrackingSignal creation response.
  # @!attribute [rw] line_item_id
  #   @return [::String]
  #     Required. The line item ID.
  # @!attribute [rw] quantity
  #   @return [::Integer]
  #     Required. The line item quantity in the shipment.
  class ShipmentLineItemMapping
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#order_tracking_signal_id ⇒ ::Integer (readonly)

Returns Output only. The ID that uniquely identifies this order tracking signal.

Returns:

  • (::Integer) —

    Output only. The ID that uniquely identifies this order tracking signal.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'proto_docs/google/shopping/merchant/ordertracking/v1beta/order_tracking_signals.rb', line 86

class OrderTrackingSignal
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The shipping information for the order.
  # @!attribute [rw] shipment_id
  #   @return [::String]
  #     Required. The shipment ID. This field will be hashed in returned
  #     OrderTrackingSignal creation response.
  # @!attribute [rw] tracking_id
  #   @return [::String]
  #     Optional. 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.
  # @!attribute [rw] carrier
  #   @return [::String]
  #     Optional. 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.
  # @!attribute [rw] carrier_service
  #   @return [::String]
  #     Optional. The service type for fulfillment, such as GROUND, FIRST_CLASS,
  #     etc.
  # @!attribute [rw] shipped_time
  #   @return [::Google::Type::DateTime]
  #     Optional. The time when the shipment was shipped.
  #     Include the year and timezone string, if available.
  # @!attribute [rw] earliest_delivery_promise_time
  #   @return [::Google::Type::DateTime]
  #     Optional. The earliest delivery promised time.
  #     Include the year and timezone string, if available.
  #     This field is required, if one of the following fields is absent:
  #     tracking_id or carrier_name.
  # @!attribute [rw] latest_delivery_promise_time
  #   @return [::Google::Type::DateTime]
  #     Optional. The latest delivery promised time.
  #     Include the year and timezone string, if available.
  #     This field is required, if one of the following fields is absent:
  #     tracking_id or carrier_name.
  # @!attribute [rw] actual_delivery_time
  #   @return [::Google::Type::DateTime]
  #     Optional. The time when the shipment was actually delivered.
  #     Include the year and timezone string, if available.
  #     This field is required, if one of the following fields is absent:
  #     tracking_id or carrier_name.
  # @!attribute [rw] shipping_status
  #   @return [::Google::Shopping::Merchant::OrderTracking::V1beta::OrderTrackingSignal::ShippingInfo::ShippingState]
  #     Required. The status of the shipment.
  # @!attribute [rw] origin_postal_code
  #   @return [::String]
  #     Required. The origin postal code, as a continuous string without spaces
  #     or dashes, for example "95016". This field will be anonymized in returned
  #     OrderTrackingSignal creation response.
  # @!attribute [rw] origin_region_code
  #   @return [::String]
  #     Required. The [CLDR territory code]
  #     (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) for
  #     the shipping origin.
  class ShippingInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The current status of the shipments.
    module ShippingState
      # The shipping status is not known to business.
      SHIPPING_STATE_UNSPECIFIED = 0

      # All items are shipped.
      SHIPPED = 1

      # The shipment is already delivered.
      DELIVERED = 2
    end
  end

  # The line items of the order.
  # @!attribute [rw] line_item_id
  #   @return [::String]
  #     Required. The ID for this line item.
  # @!attribute [rw] product_id
  #   @return [::String]
  #     Required. The Content API REST ID of the product, in the
  #     form channel:contentLanguage:targetCountry:offerId.
  # @!attribute [rw] gtin
  #   @return [::String]
  #     Optional. The Global Trade Item Number.
  # @!attribute [rw] mpn
  #   @return [::String]
  #     Optional. The manufacturer part number.
  # @!attribute [rw] product_title
  #   @return [::String]
  #     Optional. Plain text title of this product.
  # @!attribute [rw] brand
  #   @return [::String]
  #     Optional. Brand of the product.
  # @!attribute [rw] quantity
  #   @return [::Integer]
  #     Required. The quantity of the line item in the order.
  class LineItemDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents how many items are in the shipment for the given shipment_id
  # and line_item_id.
  # @!attribute [rw] shipment_id
  #   @return [::String]
  #     Required. The shipment ID. This field will be hashed in returned
  #     OrderTrackingSignal creation response.
  # @!attribute [rw] line_item_id
  #   @return [::String]
  #     Required. The line item ID.
  # @!attribute [rw] quantity
  #   @return [::Integer]
  #     Required. The line item quantity in the shipment.
  class ShipmentLineItemMapping
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#shipment_line_item_mapping ⇒ ::Array<::Google::Shopping::Merchant::OrderTracking::V1beta::OrderTrackingSignal::ShipmentLineItemMapping>

Returns Optional. The mapping of the line items to the shipment information.

Returns:



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'proto_docs/google/shopping/merchant/ordertracking/v1beta/order_tracking_signals.rb', line 86

class OrderTrackingSignal
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The shipping information for the order.
  # @!attribute [rw] shipment_id
  #   @return [::String]
  #     Required. The shipment ID. This field will be hashed in returned
  #     OrderTrackingSignal creation response.
  # @!attribute [rw] tracking_id
  #   @return [::String]
  #     Optional. 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.
  # @!attribute [rw] carrier
  #   @return [::String]
  #     Optional. 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.
  # @!attribute [rw] carrier_service
  #   @return [::String]
  #     Optional. The service type for fulfillment, such as GROUND, FIRST_CLASS,
  #     etc.
  # @!attribute [rw] shipped_time
  #   @return [::Google::Type::DateTime]
  #     Optional. The time when the shipment was shipped.
  #     Include the year and timezone string, if available.
  # @!attribute [rw] earliest_delivery_promise_time
  #   @return [::Google::Type::DateTime]
  #     Optional. The earliest delivery promised time.
  #     Include the year and timezone string, if available.
  #     This field is required, if one of the following fields is absent:
  #     tracking_id or carrier_name.
  # @!attribute [rw] latest_delivery_promise_time
  #   @return [::Google::Type::DateTime]
  #     Optional. The latest delivery promised time.
  #     Include the year and timezone string, if available.
  #     This field is required, if one of the following fields is absent:
  #     tracking_id or carrier_name.
  # @!attribute [rw] actual_delivery_time
  #   @return [::Google::Type::DateTime]
  #     Optional. The time when the shipment was actually delivered.
  #     Include the year and timezone string, if available.
  #     This field is required, if one of the following fields is absent:
  #     tracking_id or carrier_name.
  # @!attribute [rw] shipping_status
  #   @return [::Google::Shopping::Merchant::OrderTracking::V1beta::OrderTrackingSignal::ShippingInfo::ShippingState]
  #     Required. The status of the shipment.
  # @!attribute [rw] origin_postal_code
  #   @return [::String]
  #     Required. The origin postal code, as a continuous string without spaces
  #     or dashes, for example "95016". This field will be anonymized in returned
  #     OrderTrackingSignal creation response.
  # @!attribute [rw] origin_region_code
  #   @return [::String]
  #     Required. The [CLDR territory code]
  #     (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) for
  #     the shipping origin.
  class ShippingInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The current status of the shipments.
    module ShippingState
      # The shipping status is not known to business.
      SHIPPING_STATE_UNSPECIFIED = 0

      # All items are shipped.
      SHIPPED = 1

      # The shipment is already delivered.
      DELIVERED = 2
    end
  end

  # The line items of the order.
  # @!attribute [rw] line_item_id
  #   @return [::String]
  #     Required. The ID for this line item.
  # @!attribute [rw] product_id
  #   @return [::String]
  #     Required. The Content API REST ID of the product, in the
  #     form channel:contentLanguage:targetCountry:offerId.
  # @!attribute [rw] gtin
  #   @return [::String]
  #     Optional. The Global Trade Item Number.
  # @!attribute [rw] mpn
  #   @return [::String]
  #     Optional. The manufacturer part number.
  # @!attribute [rw] product_title
  #   @return [::String]
  #     Optional. Plain text title of this product.
  # @!attribute [rw] brand
  #   @return [::String]
  #     Optional. Brand of the product.
  # @!attribute [rw] quantity
  #   @return [::Integer]
  #     Required. The quantity of the line item in the order.
  class LineItemDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents how many items are in the shipment for the given shipment_id
  # and line_item_id.
  # @!attribute [rw] shipment_id
  #   @return [::String]
  #     Required. The shipment ID. This field will be hashed in returned
  #     OrderTrackingSignal creation response.
  # @!attribute [rw] line_item_id
  #   @return [::String]
  #     Required. The line item ID.
  # @!attribute [rw] quantity
  #   @return [::Integer]
  #     Required. The line item quantity in the shipment.
  class ShipmentLineItemMapping
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#shipping_info ⇒ ::Array<::Google::Shopping::Merchant::OrderTracking::V1beta::OrderTrackingSignal::ShippingInfo>

Returns Required. The shipping information for the order.

Returns:



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'proto_docs/google/shopping/merchant/ordertracking/v1beta/order_tracking_signals.rb', line 86

class OrderTrackingSignal
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The shipping information for the order.
  # @!attribute [rw] shipment_id
  #   @return [::String]
  #     Required. The shipment ID. This field will be hashed in returned
  #     OrderTrackingSignal creation response.
  # @!attribute [rw] tracking_id
  #   @return [::String]
  #     Optional. 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.
  # @!attribute [rw] carrier
  #   @return [::String]
  #     Optional. 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.
  # @!attribute [rw] carrier_service
  #   @return [::String]
  #     Optional. The service type for fulfillment, such as GROUND, FIRST_CLASS,
  #     etc.
  # @!attribute [rw] shipped_time
  #   @return [::Google::Type::DateTime]
  #     Optional. The time when the shipment was shipped.
  #     Include the year and timezone string, if available.
  # @!attribute [rw] earliest_delivery_promise_time
  #   @return [::Google::Type::DateTime]
  #     Optional. The earliest delivery promised time.
  #     Include the year and timezone string, if available.
  #     This field is required, if one of the following fields is absent:
  #     tracking_id or carrier_name.
  # @!attribute [rw] latest_delivery_promise_time
  #   @return [::Google::Type::DateTime]
  #     Optional. The latest delivery promised time.
  #     Include the year and timezone string, if available.
  #     This field is required, if one of the following fields is absent:
  #     tracking_id or carrier_name.
  # @!attribute [rw] actual_delivery_time
  #   @return [::Google::Type::DateTime]
  #     Optional. The time when the shipment was actually delivered.
  #     Include the year and timezone string, if available.
  #     This field is required, if one of the following fields is absent:
  #     tracking_id or carrier_name.
  # @!attribute [rw] shipping_status
  #   @return [::Google::Shopping::Merchant::OrderTracking::V1beta::OrderTrackingSignal::ShippingInfo::ShippingState]
  #     Required. The status of the shipment.
  # @!attribute [rw] origin_postal_code
  #   @return [::String]
  #     Required. The origin postal code, as a continuous string without spaces
  #     or dashes, for example "95016". This field will be anonymized in returned
  #     OrderTrackingSignal creation response.
  # @!attribute [rw] origin_region_code
  #   @return [::String]
  #     Required. The [CLDR territory code]
  #     (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) for
  #     the shipping origin.
  class ShippingInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The current status of the shipments.
    module ShippingState
      # The shipping status is not known to business.
      SHIPPING_STATE_UNSPECIFIED = 0

      # All items are shipped.
      SHIPPED = 1

      # The shipment is already delivered.
      DELIVERED = 2
    end
  end

  # The line items of the order.
  # @!attribute [rw] line_item_id
  #   @return [::String]
  #     Required. The ID for this line item.
  # @!attribute [rw] product_id
  #   @return [::String]
  #     Required. The Content API REST ID of the product, in the
  #     form channel:contentLanguage:targetCountry:offerId.
  # @!attribute [rw] gtin
  #   @return [::String]
  #     Optional. The Global Trade Item Number.
  # @!attribute [rw] mpn
  #   @return [::String]
  #     Optional. The manufacturer part number.
  # @!attribute [rw] product_title
  #   @return [::String]
  #     Optional. Plain text title of this product.
  # @!attribute [rw] brand
  #   @return [::String]
  #     Optional. Brand of the product.
  # @!attribute [rw] quantity
  #   @return [::Integer]
  #     Required. The quantity of the line item in the order.
  class LineItemDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents how many items are in the shipment for the given shipment_id
  # and line_item_id.
  # @!attribute [rw] shipment_id
  #   @return [::String]
  #     Required. The shipment ID. This field will be hashed in returned
  #     OrderTrackingSignal creation response.
  # @!attribute [rw] line_item_id
  #   @return [::String]
  #     Required. The line item ID.
  # @!attribute [rw] quantity
  #   @return [::Integer]
  #     Required. The line item quantity in the shipment.
  class ShipmentLineItemMapping
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end