Represents a CustomField.
Package
@google-ads/admanagerConstructors
(constructor)(properties)
constructor(properties?: google.ads.admanager.v1.ICustomField);Constructs a new CustomField.
| Parameter | |
|---|---|
| Name | Description |
properties |
ICustomField
Properties to set |
Properties
customFieldId
public customFieldId: (number|Long|string);CustomField customFieldId.
dataType
public dataType: (google.ads.admanager.v1.CustomFieldDataTypeEnum.CustomFieldDataType|keyof typeof google.ads.admanager.v1.CustomFieldDataTypeEnum.CustomFieldDataType);CustomField dataType.
description
public description: string;CustomField description.
displayName
public displayName: string;CustomField displayName.
entityType
public entityType: (google.ads.admanager.v1.CustomFieldEntityTypeEnum.CustomFieldEntityType|keyof typeof google.ads.admanager.v1.CustomFieldEntityTypeEnum.CustomFieldEntityType);CustomField entityType.
name
public name: string;CustomField name.
options
public options: google.ads.admanager.v1.ICustomFieldOption[];CustomField options.
status
public status: (google.ads.admanager.v1.CustomFieldStatusEnum.CustomFieldStatus|keyof typeof google.ads.admanager.v1.CustomFieldStatusEnum.CustomFieldStatus);CustomField status.
visibility
public visibility: (google.ads.admanager.v1.CustomFieldVisibilityEnum.CustomFieldVisibility|keyof typeof google.ads.admanager.v1.CustomFieldVisibilityEnum.CustomFieldVisibility);CustomField visibility.
Methods
create(properties)
public static create(properties?: google.ads.admanager.v1.ICustomField): google.ads.admanager.v1.CustomField;Creates a new CustomField instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
ICustomField
Properties to set |
| Returns | |
|---|---|
| Type | Description |
CustomField |
CustomField instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.ads.admanager.v1.CustomField;Decodes a CustomField 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 |
CustomField |
CustomField |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.ads.admanager.v1.CustomField;Decodes a CustomField message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
CustomField |
CustomField |
encode(message, writer)
public static encode(message: google.ads.admanager.v1.ICustomField, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified CustomField message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ICustomField
CustomField 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.ICustomField, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified CustomField message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ICustomField
CustomField 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.CustomField;Creates a CustomField 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 |
CustomField |
CustomField |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for CustomField
| 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 CustomField to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.ads.admanager.v1.CustomField, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a CustomField message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
CustomField
CustomField |
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 CustomField message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|