Google Ads Ad Manager V1 Client - Class Contact (0.6.0)

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

A contact represents a person who is affiliated with a single company. A contact can have a variety of contact information associated to it, and can be invited to view their company's orders, line items, creatives, and reports.

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

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 Contact. Format: networks/{network_code}/contacts/{contact_id}

↳ display_name string

Required. The name of the contact. This attribute has a maximum length of 127 characters.

↳ company string

Required. Immutable. The resource name of the Company. Format: "networks/{network_code}/companies/{company_id}"

↳ status int

Output only. The status of the contact. This attribute is assigned by Google.

↳ address string

Optional. The address of the contact. This attribute has a maximum length of 1024 characters.

↳ cell_phone string

Optional. The cell phone number where the contact can be reached.

↳ comment string

Optional. A free-form text comment for the contact. This attribute has a maximum length of 1024 characters.

↳ email string

Optional. The e-mail address where the contact can be reached. This attribute has a maximum length of 128 characters.

↳ fax string

Optional. The fax number where the contact can be reached. This attribute has a maximum length of 1024 characters.

↳ title string

Optional. The job title of the contact. This attribute has a maximum length of 1024 characters.

↳ work_phone string

Optional. The work phone number where the contact can be reached. This attribute has a maximum length of 1024 characters.

getName

Identifier. The resource name of the Contact.

Format: networks/{network_code}/contacts/{contact_id}

Returns
Type Description
string

setName

Identifier. The resource name of the Contact.

Format: networks/{network_code}/contacts/{contact_id}

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

Required. The name of the contact. This attribute has a maximum length of 127 characters.

Returns
Type Description
string

hasDisplayName

clearDisplayName

setDisplayName

Required. The name of the contact. This attribute has a maximum length of 127 characters.

Parameter
Name Description
var string
Returns
Type Description
$this

getCompany

Required. Immutable. The resource name of the Company.

Format: "networks/{network_code}/companies/{company_id}"

Returns
Type Description
string

hasCompany

clearCompany

setCompany

Required. Immutable. The resource name of the Company.

Format: "networks/{network_code}/companies/{company_id}"

Parameter
Name Description
var string
Returns
Type Description
$this

getStatus

Output only. The status of the contact. This attribute is assigned by Google.

Returns
Type Description
int

hasStatus

clearStatus

setStatus

Output only. The status of the contact. This attribute is assigned by Google.

Parameter
Name Description
var int
Returns
Type Description
$this

getAddress

Optional. The address of the contact. This attribute has a maximum length of 1024 characters.

Returns
Type Description
string

hasAddress

clearAddress

setAddress

Optional. The address of the contact. This attribute has a maximum length of 1024 characters.

Parameter
Name Description
var string
Returns
Type Description
$this

getCellPhone

Optional. The cell phone number where the contact can be reached.

Returns
Type Description
string

hasCellPhone

clearCellPhone

setCellPhone

Optional. The cell phone number where the contact can be reached.

Parameter
Name Description
var string
Returns
Type Description
$this

getComment

Optional. A free-form text comment for the contact. This attribute has a maximum length of 1024 characters.

Returns
Type Description
string

hasComment

clearComment

setComment

Optional. A free-form text comment for the contact. This attribute has a maximum length of 1024 characters.

Parameter
Name Description
var string
Returns
Type Description
$this

getEmail

Optional. The e-mail address where the contact can be reached. This attribute has a maximum length of 128 characters.

Returns
Type Description
string

hasEmail

clearEmail

setEmail

Optional. The e-mail address where the contact can be reached. This attribute has a maximum length of 128 characters.

Parameter
Name Description
var string
Returns
Type Description
$this

getFax

Optional. The fax number where the contact can be reached. This attribute has a maximum length of 1024 characters.

Returns
Type Description
string

hasFax

clearFax

setFax

Optional. The fax number where the contact can be reached. This attribute has a maximum length of 1024 characters.

Parameter
Name Description
var string
Returns
Type Description
$this

getTitle

Optional. The job title of the contact. This attribute has a maximum length of 1024 characters.

Returns
Type Description
string

hasTitle

clearTitle

setTitle

Optional. The job title of the contact. This attribute has a maximum length of 1024 characters.

Parameter
Name Description
var string
Returns
Type Description
$this

getWorkPhone

Optional. The work phone number where the contact can be reached. This attribute has a maximum length of 1024 characters.

Returns
Type Description
string

hasWorkPhone

clearWorkPhone

setWorkPhone

Optional. The work phone number where the contact can be reached. This attribute has a maximum length of 1024 characters.

Parameter
Name Description
var string
Returns
Type Description
$this