| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="content_v2_1.html">Content API for Shopping</a> . <a href="content_v2_1.ordertrackingsignals.html">ordertrackingsignals</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#create">create(merchantId, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates new order tracking signal.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="create">create(merchantId, body=None, x__xgafv=None)</code> |
| <pre>Creates new order tracking signal. |
| |
| Args: |
| merchantId: string, The ID of the merchant for which the order signal is created. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Represents a merchant trade from which signals are extracted, e.g. shipping. |
| "customerShippingFee": { # The price represented as a number and currency. # The shipping fee of the order; this value should be set to zero in the case of free shipping. |
| "currency": "A String", # The currency of the price. |
| "value": "A String", # The price represented as a number. |
| }, |
| "deliveryPostalCode": "A 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. |
| "deliveryRegionCode": "A String", # Required. The [CLDR territory code] (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) for the shipping destination. |
| "lineItems": [ # Information about line items in the order. |
| { # The line items of the order. |
| "brand": "A String", # Brand of the product. |
| "gtin": "A String", # The Global Trade Item Number. |
| "lineItemId": "A String", # Required. The ID for this line item. |
| "mpn": "A String", # The manufacturer part number. |
| "productDescription": "A String", # Plain text description of this product (deprecated: Please use product_title instead). |
| "productId": "A String", # Required. The Content API REST ID of the product, in the form channel:contentLanguage:targetCountry:offerId. |
| "productTitle": "A String", # Plain text title of this product. |
| "quantity": "A String", # The quantity of the line item in the order. |
| "sku": "A String", # Merchant SKU for this item (deprecated). |
| "upc": "A String", # Universal product code for this item (deprecated: Please use GTIN instead). |
| }, |
| ], |
| "merchantId": "A String", # 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). |
| "orderCreatedTime": { # 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. # Required. The time when the order was created on the merchant side. Include the year and timezone string, if available. |
| "day": 42, # Required. Day of month. Must be from 1 to 31 and valid for the year and month. |
| "hours": 42, # Required. Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| "minutes": 42, # Required. Minutes of hour of day. Must be from 0 to 59. |
| "month": 42, # Required. Month of year. Must be from 1 to 12. |
| "nanos": 42, # Required. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| "seconds": 42, # Required. Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Time zone. |
| "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York". |
| "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a". |
| }, |
| "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }. |
| "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. |
| }, |
| "orderId": "A String", # Required. The ID of the order on the merchant side. This field will be hashed in returned OrderTrackingSignal creation response. |
| "orderTrackingSignalId": "A String", # Output only. The ID that uniquely identifies this order tracking signal. |
| "shipmentLineItemMapping": [ # The mapping of the line items to the shipment information. |
| { # Represents how many items are in the shipment for the given shipment_id and line_item_id. |
| "lineItemId": "A String", # Required. The line item ID. |
| "quantity": "A String", # The line item quantity in the shipment. |
| "shipmentId": "A String", # Required. The shipment ID. This field will be hashed in returned OrderTrackingSignal creation response. |
| }, |
| ], |
| "shippingInfo": [ # The shipping information for the order. |
| { # The shipping information for the order. |
| "actualDeliveryTime": { # 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. # 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. |
| "day": 42, # Required. Day of month. Must be from 1 to 31 and valid for the year and month. |
| "hours": 42, # Required. Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| "minutes": 42, # Required. Minutes of hour of day. Must be from 0 to 59. |
| "month": 42, # Required. Month of year. Must be from 1 to 12. |
| "nanos": 42, # Required. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| "seconds": 42, # Required. Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Time zone. |
| "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York". |
| "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a". |
| }, |
| "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }. |
| "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. |
| }, |
| "carrierName": "A 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. |
| "carrierServiceName": "A String", # The service type for fulfillment, e.g., GROUND, FIRST_CLASS, etc. |
| "earliestDeliveryPromiseTime": { # 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. # 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. |
| "day": 42, # Required. Day of month. Must be from 1 to 31 and valid for the year and month. |
| "hours": 42, # Required. Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| "minutes": 42, # Required. Minutes of hour of day. Must be from 0 to 59. |
| "month": 42, # Required. Month of year. Must be from 1 to 12. |
| "nanos": 42, # Required. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| "seconds": 42, # Required. Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Time zone. |
| "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York". |
| "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a". |
| }, |
| "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }. |
| "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. |
| }, |
| "latestDeliveryPromiseTime": { # 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. # 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. |
| "day": 42, # Required. Day of month. Must be from 1 to 31 and valid for the year and month. |
| "hours": 42, # Required. Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| "minutes": 42, # Required. Minutes of hour of day. Must be from 0 to 59. |
| "month": 42, # Required. Month of year. Must be from 1 to 12. |
| "nanos": 42, # Required. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| "seconds": 42, # Required. Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Time zone. |
| "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York". |
| "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a". |
| }, |
| "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }. |
| "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. |
| }, |
| "originPostalCode": "A 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. |
| "originRegionCode": "A String", # The [CLDR territory code] (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) for the shipping origin. |
| "shipmentId": "A String", # Required. The shipment ID. This field will be hashed in returned OrderTrackingSignal creation response. |
| "shippedTime": { # 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. # The time when the shipment was shipped. Include the year and timezone string, if available. |
| "day": 42, # Required. Day of month. Must be from 1 to 31 and valid for the year and month. |
| "hours": 42, # Required. Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| "minutes": 42, # Required. Minutes of hour of day. Must be from 0 to 59. |
| "month": 42, # Required. Month of year. Must be from 1 to 12. |
| "nanos": 42, # Required. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| "seconds": 42, # Required. Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Time zone. |
| "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York". |
| "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a". |
| }, |
| "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }. |
| "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. |
| }, |
| "shippingStatus": "A String", # The status of the shipment. |
| "trackingId": "A 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. |
| }, |
| ], |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents a merchant trade from which signals are extracted, e.g. shipping. |
| "customerShippingFee": { # The price represented as a number and currency. # The shipping fee of the order; this value should be set to zero in the case of free shipping. |
| "currency": "A String", # The currency of the price. |
| "value": "A String", # The price represented as a number. |
| }, |
| "deliveryPostalCode": "A 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. |
| "deliveryRegionCode": "A String", # Required. The [CLDR territory code] (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) for the shipping destination. |
| "lineItems": [ # Information about line items in the order. |
| { # The line items of the order. |
| "brand": "A String", # Brand of the product. |
| "gtin": "A String", # The Global Trade Item Number. |
| "lineItemId": "A String", # Required. The ID for this line item. |
| "mpn": "A String", # The manufacturer part number. |
| "productDescription": "A String", # Plain text description of this product (deprecated: Please use product_title instead). |
| "productId": "A String", # Required. The Content API REST ID of the product, in the form channel:contentLanguage:targetCountry:offerId. |
| "productTitle": "A String", # Plain text title of this product. |
| "quantity": "A String", # The quantity of the line item in the order. |
| "sku": "A String", # Merchant SKU for this item (deprecated). |
| "upc": "A String", # Universal product code for this item (deprecated: Please use GTIN instead). |
| }, |
| ], |
| "merchantId": "A String", # 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). |
| "orderCreatedTime": { # 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. # Required. The time when the order was created on the merchant side. Include the year and timezone string, if available. |
| "day": 42, # Required. Day of month. Must be from 1 to 31 and valid for the year and month. |
| "hours": 42, # Required. Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| "minutes": 42, # Required. Minutes of hour of day. Must be from 0 to 59. |
| "month": 42, # Required. Month of year. Must be from 1 to 12. |
| "nanos": 42, # Required. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| "seconds": 42, # Required. Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Time zone. |
| "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York". |
| "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a". |
| }, |
| "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }. |
| "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. |
| }, |
| "orderId": "A String", # Required. The ID of the order on the merchant side. This field will be hashed in returned OrderTrackingSignal creation response. |
| "orderTrackingSignalId": "A String", # Output only. The ID that uniquely identifies this order tracking signal. |
| "shipmentLineItemMapping": [ # The mapping of the line items to the shipment information. |
| { # Represents how many items are in the shipment for the given shipment_id and line_item_id. |
| "lineItemId": "A String", # Required. The line item ID. |
| "quantity": "A String", # The line item quantity in the shipment. |
| "shipmentId": "A String", # Required. The shipment ID. This field will be hashed in returned OrderTrackingSignal creation response. |
| }, |
| ], |
| "shippingInfo": [ # The shipping information for the order. |
| { # The shipping information for the order. |
| "actualDeliveryTime": { # 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. # 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. |
| "day": 42, # Required. Day of month. Must be from 1 to 31 and valid for the year and month. |
| "hours": 42, # Required. Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| "minutes": 42, # Required. Minutes of hour of day. Must be from 0 to 59. |
| "month": 42, # Required. Month of year. Must be from 1 to 12. |
| "nanos": 42, # Required. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| "seconds": 42, # Required. Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Time zone. |
| "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York". |
| "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a". |
| }, |
| "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }. |
| "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. |
| }, |
| "carrierName": "A 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. |
| "carrierServiceName": "A String", # The service type for fulfillment, e.g., GROUND, FIRST_CLASS, etc. |
| "earliestDeliveryPromiseTime": { # 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. # 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. |
| "day": 42, # Required. Day of month. Must be from 1 to 31 and valid for the year and month. |
| "hours": 42, # Required. Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| "minutes": 42, # Required. Minutes of hour of day. Must be from 0 to 59. |
| "month": 42, # Required. Month of year. Must be from 1 to 12. |
| "nanos": 42, # Required. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| "seconds": 42, # Required. Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Time zone. |
| "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York". |
| "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a". |
| }, |
| "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }. |
| "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. |
| }, |
| "latestDeliveryPromiseTime": { # 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. # 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. |
| "day": 42, # Required. Day of month. Must be from 1 to 31 and valid for the year and month. |
| "hours": 42, # Required. Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| "minutes": 42, # Required. Minutes of hour of day. Must be from 0 to 59. |
| "month": 42, # Required. Month of year. Must be from 1 to 12. |
| "nanos": 42, # Required. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| "seconds": 42, # Required. Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Time zone. |
| "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York". |
| "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a". |
| }, |
| "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }. |
| "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. |
| }, |
| "originPostalCode": "A 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. |
| "originRegionCode": "A String", # The [CLDR territory code] (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) for the shipping origin. |
| "shipmentId": "A String", # Required. The shipment ID. This field will be hashed in returned OrderTrackingSignal creation response. |
| "shippedTime": { # 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. # The time when the shipment was shipped. Include the year and timezone string, if available. |
| "day": 42, # Required. Day of month. Must be from 1 to 31 and valid for the year and month. |
| "hours": 42, # Required. Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| "minutes": 42, # Required. Minutes of hour of day. Must be from 0 to 59. |
| "month": 42, # Required. Month of year. Must be from 1 to 12. |
| "nanos": 42, # Required. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| "seconds": 42, # Required. Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Time zone. |
| "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York". |
| "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a". |
| }, |
| "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }. |
| "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. |
| }, |
| "shippingStatus": "A String", # The status of the shipment. |
| "trackingId": "A 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. |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| </body></html> |
