Represents an OrderTrackingSignal.
Implements
Package
@google-shopping/ordertrackingConstructors
(constructor)(properties)
constructor(properties?: google.shopping.merchant.ordertracking.v1beta.IOrderTrackingSignal);Constructs a new OrderTrackingSignal.
| Parameter | |
|---|---|
| Name | Description |
properties |
IOrderTrackingSignal
Properties to set |
Properties
customerShippingFee
public customerShippingFee?: (google.shopping.type.IPrice|null);OrderTrackingSignal customerShippingFee.
deliveryPostalCode
public deliveryPostalCode: string;OrderTrackingSignal deliveryPostalCode.
deliveryRegionCode
public deliveryRegionCode: string;OrderTrackingSignal deliveryRegionCode.
lineItems
public lineItems: google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal.ILineItemDetails[];OrderTrackingSignal lineItems.
merchantId
public merchantId: (number|Long|string);OrderTrackingSignal merchantId.
orderCreatedTime
public orderCreatedTime?: (google.type.IDateTime|null);OrderTrackingSignal orderCreatedTime.
orderId
public orderId: string;OrderTrackingSignal orderId.
orderTrackingSignalId
public orderTrackingSignalId: (number|Long|string);OrderTrackingSignal orderTrackingSignalId.
shipmentLineItemMapping
public shipmentLineItemMapping: google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal.IShipmentLineItemMapping[];OrderTrackingSignal shipmentLineItemMapping.
shippingInfo
public shippingInfo: google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal.IShippingInfo[];OrderTrackingSignal shippingInfo.
Methods
create(properties)
public static create(properties?: google.shopping.merchant.ordertracking.v1beta.IOrderTrackingSignal): google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal;Creates a new OrderTrackingSignal instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IOrderTrackingSignal
Properties to set |
| Returns | |
|---|---|
| Type | Description |
OrderTrackingSignal |
OrderTrackingSignal instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal;Decodes an OrderTrackingSignal 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 |
OrderTrackingSignal |
OrderTrackingSignal |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal;Decodes an OrderTrackingSignal message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
OrderTrackingSignal |
OrderTrackingSignal |
encode(message, writer)
public static encode(message: google.shopping.merchant.ordertracking.v1beta.IOrderTrackingSignal, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified OrderTrackingSignal message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IOrderTrackingSignal
OrderTrackingSignal 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.IOrderTrackingSignal, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified OrderTrackingSignal message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IOrderTrackingSignal
OrderTrackingSignal 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;Creates an OrderTrackingSignal 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 |
OrderTrackingSignal |
OrderTrackingSignal |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for OrderTrackingSignal
| 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 OrderTrackingSignal to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from an OrderTrackingSignal message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
OrderTrackingSignal
OrderTrackingSignal |
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 an OrderTrackingSignal message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|