Represents an Order.
Package
@google-ads/admanagerConstructors
(constructor)(properties)
constructor(properties?: google.ads.admanager.v1.IOrder);Constructs a new Order.
| Parameter | |
|---|---|
| Name | Description |
properties |
IOrder
Properties to set |
Properties
advertiser
public advertiser: string;Order advertiser.
advertiserContacts
public advertiserContacts: string[];Order advertiserContacts.
agency
public agency: string;Order agency.
agencyContacts
public agencyContacts: string[];Order agencyContacts.
appliedLabels
public appliedLabels: google.ads.admanager.v1.IAppliedLabel[];Order appliedLabels.
appliedTeams
public appliedTeams: string[];Order appliedTeams.
archived
public archived: boolean;Order archived.
creator
public creator: string;Order creator.
currencyCode
public currencyCode: string;Order currencyCode.
customFieldValues
public customFieldValues: google.ads.admanager.v1.ICustomFieldValue[];Order customFieldValues.
displayName
public displayName: string;Order displayName.
effectiveAppliedLabels
public effectiveAppliedLabels: google.ads.admanager.v1.IAppliedLabel[];Order effectiveAppliedLabels.
effectiveTeams
public effectiveTeams: string[];Order effectiveTeams.
endTime
public endTime?: (google.protobuf.ITimestamp|null);Order endTime.
externalOrderId
public externalOrderId: (number|Long|string);Order externalOrderId.
lastModifiedByApp
public lastModifiedByApp: string;Order lastModifiedByApp.
name
public name: string;Order name.
notes
public notes: string;Order notes.
orderId
public orderId: (number|Long|string);Order orderId.
poNumber
public poNumber: string;Order poNumber.
programmatic
public programmatic: boolean;Order programmatic.
salesperson
public salesperson: string;Order salesperson.
secondarySalespeople
public secondarySalespeople: string[];Order secondarySalespeople.
secondaryTraffickers
public secondaryTraffickers: string[];Order secondaryTraffickers.
startTime
public startTime?: (google.protobuf.ITimestamp|null);Order startTime.
status
public status: (google.ads.admanager.v1.OrderStatusEnum.OrderStatus|keyof typeof google.ads.admanager.v1.OrderStatusEnum.OrderStatus);Order status.
trafficker
public trafficker: string;Order trafficker.
unlimitedEndTime
public unlimitedEndTime: boolean;Order unlimitedEndTime.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);Order updateTime.
Methods
create(properties)
public static create(properties?: google.ads.admanager.v1.IOrder): google.ads.admanager.v1.Order;Creates a new Order instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IOrder
Properties to set |
| Returns | |
|---|---|
| Type | Description |
Order |
Order instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.ads.admanager.v1.Order;Decodes an Order 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 |
Order |
Order |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.ads.admanager.v1.Order;Decodes an Order message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Order |
Order |
encode(message, writer)
public static encode(message: google.ads.admanager.v1.IOrder, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Order message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IOrder
Order 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.ads.admanager.v1.IOrder, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Order message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IOrder
Order 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.ads.admanager.v1.Order;Creates an Order 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 |
Order |
Order |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Order
| 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 Order to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.ads.admanager.v1.Order, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from an Order message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
Order
Order |
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 Order message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|