Represents a LineItem.
Package
@google-ads/admanagerConstructors
(constructor)(properties)
constructor(properties?: google.ads.admanager.v1.ILineItem);Constructs a new LineItem.
| Parameter | |
|---|---|
| Name | Description |
properties |
ILineItem
Properties to set |
Properties
budget
public budget?: (google.type.IMoney|null);LineItem budget.
customFieldValues
public customFieldValues: google.ads.admanager.v1.ICustomFieldValue[];LineItem customFieldValues.
displayName
public displayName?: (string|null);LineItem displayName.
endTime
public endTime?: (google.protobuf.ITimestamp|null);LineItem endTime.
goal
public goal?: (google.ads.admanager.v1.IGoal|null);LineItem goal.
lineItemType
public lineItemType?: (google.ads.admanager.v1.LineItemTypeEnum.LineItemType|keyof typeof google.ads.admanager.v1.LineItemTypeEnum.LineItemType|null);LineItem lineItemType.
name
public name: string;LineItem name.
order
public order?: (string|null);LineItem order.
rate
public rate?: (google.type.IMoney|null);LineItem rate.
startTime
public startTime?: (google.protobuf.ITimestamp|null);LineItem startTime.
Methods
create(properties)
public static create(properties?: google.ads.admanager.v1.ILineItem): google.ads.admanager.v1.LineItem;Creates a new LineItem instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
ILineItem
Properties to set |
| Returns | |
|---|---|
| Type | Description |
LineItem |
LineItem instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.ads.admanager.v1.LineItem;Decodes a LineItem 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 |
LineItem |
LineItem |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.ads.admanager.v1.LineItem;Decodes a LineItem message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
LineItem |
LineItem |
encode(message, writer)
public static encode(message: google.ads.admanager.v1.ILineItem, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified LineItem message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ILineItem
LineItem 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.ILineItem, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified LineItem message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ILineItem
LineItem 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.LineItem;Creates a LineItem 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 |
LineItem |
LineItem |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for LineItem
| 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 LineItem to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.ads.admanager.v1.LineItem, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a LineItem message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
LineItem
LineItem |
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 LineItem message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|