Represents a CreativeTemplateVariable.
Package
@google-ads/admanagerConstructors
(constructor)(properties)
constructor(properties?: google.ads.admanager.v1.ICreativeTemplateVariable);Constructs a new CreativeTemplateVariable.
| Parameter | |
|---|---|
| Name | Description |
properties |
ICreativeTemplateVariable
Properties to set |
Properties
assetVariable
public assetVariable?: (google.ads.admanager.v1.CreativeTemplateVariable.IAssetCreativeTemplateVariable|null);CreativeTemplateVariable assetVariable.
description
public description?: (string|null);CreativeTemplateVariable description.
label
public label?: (string|null);CreativeTemplateVariable label.
listStringVariable
public listStringVariable?: (google.ads.admanager.v1.CreativeTemplateVariable.IListStringCreativeTemplateVariable|null);CreativeTemplateVariable listStringVariable.
longVariable
public longVariable?: (google.ads.admanager.v1.CreativeTemplateVariable.ILongCreativeTemplateVariable|null);CreativeTemplateVariable longVariable.
required
public required?: (boolean|null);CreativeTemplateVariable required.
stringVariable
public stringVariable?: (google.ads.admanager.v1.CreativeTemplateVariable.IStringCreativeTemplateVariable|null);CreativeTemplateVariable stringVariable.
SubType
public SubType?: ("assetVariable"|"listStringVariable"|"longVariable"|"stringVariable"|"urlVariable");CreativeTemplateVariable SubType.
uniqueDisplayName
public uniqueDisplayName?: (string|null);CreativeTemplateVariable uniqueDisplayName.
urlVariable
public urlVariable?: (google.ads.admanager.v1.CreativeTemplateVariable.IUrlCreativeTemplateVariable|null);CreativeTemplateVariable urlVariable.
Methods
create(properties)
public static create(properties?: google.ads.admanager.v1.ICreativeTemplateVariable): google.ads.admanager.v1.CreativeTemplateVariable;Creates a new CreativeTemplateVariable instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
ICreativeTemplateVariable
Properties to set |
| Returns | |
|---|---|
| Type | Description |
CreativeTemplateVariable |
CreativeTemplateVariable instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.ads.admanager.v1.CreativeTemplateVariable;Decodes a CreativeTemplateVariable 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 |
CreativeTemplateVariable |
CreativeTemplateVariable |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.ads.admanager.v1.CreativeTemplateVariable;Decodes a CreativeTemplateVariable message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
CreativeTemplateVariable |
CreativeTemplateVariable |
encode(message, writer)
public static encode(message: google.ads.admanager.v1.ICreativeTemplateVariable, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified CreativeTemplateVariable message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ICreativeTemplateVariable
CreativeTemplateVariable 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.ICreativeTemplateVariable, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified CreativeTemplateVariable message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ICreativeTemplateVariable
CreativeTemplateVariable 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.CreativeTemplateVariable;Creates a CreativeTemplateVariable 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 |
CreativeTemplateVariable |
CreativeTemplateVariable |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for CreativeTemplateVariable
| 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 CreativeTemplateVariable to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.ads.admanager.v1.CreativeTemplateVariable, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a CreativeTemplateVariable message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
CreativeTemplateVariable
CreativeTemplateVariable |
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 CreativeTemplateVariable message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|