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 \ V1Methods
__construct
Constructor.
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}
string
setName
Identifier. The resource name of the CustomField
.
Format: networks/{network_code}/customFields/{custom_field_id}
var
string
$this
getCustomFieldId
Output only. Unique ID of the CustomField. This value is readonly and is assigned by Google.
int|string
setCustomFieldId
Output only. Unique ID of the CustomField. This value is readonly and is assigned by Google.
var
int|string
$this
getDisplayName
Required. Name of the CustomField. The max length is 127 characters.
string
setDisplayName
Required. Name of the CustomField. The max length is 127 characters.
var
string
$this
getDescription
Optional. A description of the custom field. The maximum length is 511 characters.
string
setDescription
Optional. A description of the custom field. The maximum length is 511 characters.
var
string
$this
getStatus
Output only. The status of the CustomField
.
int
setStatus
Output only. The status of the CustomField
.
var
int
$this
getEntityType
Required. The type of entity the CustomField
can be applied to.
int
setEntityType
Required. The type of entity the CustomField
can be applied to.
var
int
$this
getDataType
Required. The data type of the CustomField
.
int
setDataType
Required. The data type of the CustomField
.
var
int
$this
getVisibility
Required. The visibility of the CustomField
.
int
setVisibility
Required. The visibility of the CustomField
.
var
int
$this
getOptions
Optional. The drop-down options for the CustomField
.
Only applicable for CustomField
with the drop-down data type.
setOptions
Optional. The drop-down options for the CustomField
.
Only applicable for CustomField
with the drop-down data type.
$this
