Represents a CustomTargetingKey.
Package
@google-ads/admanagerConstructors
(constructor)(properties)
constructor(properties?: google.ads.admanager.v1.ICustomTargetingKey);Constructs a new CustomTargetingKey.
| Parameter | |
|---|---|
| Name | Description |
properties |
ICustomTargetingKey
Properties to set |
Properties
adTagName
public adTagName: string;CustomTargetingKey adTagName.
customTargetingKeyId
public customTargetingKeyId: (number|Long|string);CustomTargetingKey customTargetingKeyId.
displayName
public displayName: string;CustomTargetingKey displayName.
name
public name: string;CustomTargetingKey name.
reportableType
public reportableType: (google.ads.admanager.v1.CustomTargetingKeyReportableTypeEnum.CustomTargetingKeyReportableType|keyof typeof google.ads.admanager.v1.CustomTargetingKeyReportableTypeEnum.CustomTargetingKeyReportableType);CustomTargetingKey reportableType.
status
public status: (google.ads.admanager.v1.CustomTargetingKeyStatusEnum.CustomTargetingKeyStatus|keyof typeof google.ads.admanager.v1.CustomTargetingKeyStatusEnum.CustomTargetingKeyStatus);CustomTargetingKey status.
type
public type: (google.ads.admanager.v1.CustomTargetingKeyTypeEnum.CustomTargetingKeyType|keyof typeof google.ads.admanager.v1.CustomTargetingKeyTypeEnum.CustomTargetingKeyType);CustomTargetingKey type.
Methods
create(properties)
public static create(properties?: google.ads.admanager.v1.ICustomTargetingKey): google.ads.admanager.v1.CustomTargetingKey;Creates a new CustomTargetingKey instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
ICustomTargetingKey
Properties to set |
| Returns | |
|---|---|
| Type | Description |
CustomTargetingKey |
CustomTargetingKey instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.ads.admanager.v1.CustomTargetingKey;Decodes a CustomTargetingKey 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 |
CustomTargetingKey |
CustomTargetingKey |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.ads.admanager.v1.CustomTargetingKey;Decodes a CustomTargetingKey message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
CustomTargetingKey |
CustomTargetingKey |
encode(message, writer)
public static encode(message: google.ads.admanager.v1.ICustomTargetingKey, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified CustomTargetingKey message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ICustomTargetingKey
CustomTargetingKey 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.ICustomTargetingKey, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified CustomTargetingKey message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ICustomTargetingKey
CustomTargetingKey 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.CustomTargetingKey;Creates a CustomTargetingKey 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 |
CustomTargetingKey |
CustomTargetingKey |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for CustomTargetingKey
| 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 CustomTargetingKey to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.ads.admanager.v1.CustomTargetingKey, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a CustomTargetingKey message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
CustomTargetingKey
CustomTargetingKey |
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 CustomTargetingKey message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|