Represents a ShippingInfo.
Package
@google-shopping/ordertrackingConstructors
(constructor)(properties)
constructor(properties?: google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal.IShippingInfo);Constructs a new ShippingInfo.
| Parameter | |
|---|---|
| Name | Description |
properties |
IShippingInfo
Properties to set |
Properties
actualDeliveryTime
public actualDeliveryTime?: (google.type.IDateTime|null);ShippingInfo actualDeliveryTime.
carrier
public carrier: string;ShippingInfo carrier.
carrierService
public carrierService: string;ShippingInfo carrierService.
earliestDeliveryPromiseTime
public earliestDeliveryPromiseTime?: (google.type.IDateTime|null);ShippingInfo earliestDeliveryPromiseTime.
latestDeliveryPromiseTime
public latestDeliveryPromiseTime?: (google.type.IDateTime|null);ShippingInfo latestDeliveryPromiseTime.
originPostalCode
public originPostalCode: string;ShippingInfo originPostalCode.
originRegionCode
public originRegionCode: string;ShippingInfo originRegionCode.
shipmentId
public shipmentId: string;ShippingInfo shipmentId.
shippedTime
public shippedTime?: (google.type.IDateTime|null);ShippingInfo shippedTime.
shippingStatus
public shippingStatus: (google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal.ShippingInfo.ShippingState|keyof typeof google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal.ShippingInfo.ShippingState);ShippingInfo shippingStatus.
trackingId
public trackingId: string;ShippingInfo trackingId.
Methods
create(properties)
public static create(properties?: google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal.IShippingInfo): google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal.ShippingInfo;Creates a new ShippingInfo instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IShippingInfo
Properties to set |
| Returns | |
|---|---|
| Type | Description |
ShippingInfo |
ShippingInfo instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal.ShippingInfo;Decodes a ShippingInfo message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
ShippingInfo |
ShippingInfo |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal.ShippingInfo;Decodes a ShippingInfo message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
ShippingInfo |
ShippingInfo |
encode(message, writer)
public static encode(message: google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal.IShippingInfo, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified ShippingInfo message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IShippingInfo
ShippingInfo message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal.IShippingInfo, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified ShippingInfo message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IShippingInfo
ShippingInfo message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal.ShippingInfo;Creates a ShippingInfo message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
ShippingInfo |
ShippingInfo |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for ShippingInfo
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this ShippingInfo to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal.ShippingInfo, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a ShippingInfo message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
ShippingInfo
ShippingInfo |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a ShippingInfo message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|