Google Ads Ad Manager V1 Client - Class CustomField (0.1.1)

Reference documentation and code samples for the Google Ads Ad Manager V1 Client class CustomField.

An additional, user-created field on an entity.

Generated from protobuf message google.ads.admanager.v1.CustomField

Namespace

Google \ Ads \ AdManager \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Identifier. The resource name of the CustomField. Format: networks/{network_code}/customFields/{custom_field_id}

↳ custom_field_id int|string

Output only. Unique ID of the CustomField. This value is readonly and is assigned by Google.

↳ display_name string

Required. Name of the CustomField. The max length is 127 characters.

↳ description string

Optional. A description of the custom field. The maximum length is 511 characters.

↳ status int

Output only. The status of the CustomField.

↳ entity_type int

Required. The type of entity the CustomField can be applied to.

↳ data_type int

Required. The data type of the CustomField.

↳ visibility int

Required. The visibility of the CustomField.

↳ options array<Google\Ads\AdManager\V1\CustomFieldOption>

Optional. The drop-down options for the CustomField. Only applicable for CustomField with the drop-down data type.

getName

Identifier. The resource name of the CustomField.

Format: networks/{network_code}/customFields/{custom_field_id}

Returns
Type Description
string

setName

Identifier. The resource name of the CustomField.

Format: networks/{network_code}/customFields/{custom_field_id}

Parameter
Name Description
var string
Returns
Type Description
$this

getCustomFieldId

Output only. Unique ID of the CustomField. This value is readonly and is assigned by Google.

Returns
Type Description
int|string

setCustomFieldId

Output only. Unique ID of the CustomField. This value is readonly and is assigned by Google.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getDisplayName

Required. Name of the CustomField. The max length is 127 characters.

Returns
Type Description
string

setDisplayName

Required. Name of the CustomField. The max length is 127 characters.

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

Optional. A description of the custom field. The maximum length is 511 characters.

Returns
Type Description
string

setDescription

Optional. A description of the custom field. The maximum length is 511 characters.

Parameter
Name Description
var string
Returns
Type Description
$this

getStatus

Output only. The status of the CustomField.

Returns
Type Description
int

setStatus

Output only. The status of the CustomField.

Parameter
Name Description
var int
Returns
Type Description
$this

getEntityType

Required. The type of entity the CustomField can be applied to.

Returns
Type Description
int

setEntityType

Required. The type of entity the CustomField can be applied to.

Parameter
Name Description
var int
Returns
Type Description
$this

getDataType

Required. The data type of the CustomField.

Returns
Type Description
int

setDataType

Required. The data type of the CustomField.

Parameter
Name Description
var int
Returns
Type Description
$this

getVisibility

Required. The visibility of the CustomField.

Returns
Type Description
int

setVisibility

Required. The visibility of the CustomField.

Parameter
Name Description
var int
Returns
Type Description
$this

getOptions

Optional. The drop-down options for the CustomField.

Only applicable for CustomField with the drop-down data type.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setOptions

Optional. The drop-down options for the CustomField.

Only applicable for CustomField with the drop-down data type.

Parameter
Name Description
var array<Google\Ads\AdManager\V1\CustomFieldOption>
Returns
Type Description
$this