type Contact (v202411)

  • A Contact represents a person affiliated with a single Company and can be invited to view company orders, line items, creatives, and reports.

  • The Contact object inherits from BaseContact and has unique fields such as id, name, companyId, status, address, cellPhone, comment, email, faxPhone, title, and workPhone.

  • The ContactService includes methods for creating and updating Contacts and can return a ContactPage.

  • The status of a contact, which is readonly, indicates their invitation and access state, with possible values including UNINVITED, INVITE_PENDING, USER_ACTIVE, and USER_DISABLED among others.
Service
ContactService
Dependencies
ContactPage createContacts() updateContacts()
▼
Contact
Inheritance
BaseContact
▼
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.

Namespace
https://www.google.com/apis/ads/publisher/v202411

Field
BaseContact (inherited)
Contact

id

xsd:long

The unique ID of the Contact. This value is readonly and is assigned by Google.

name

xsd:string

The name of the contact. This attribute is required and has a maximum length of 127 characters.

companyId

xsd:long

The ID of the Company that this contact is associated with. This attribute is required and immutable.

status

Contact.Status

The status of the contact. This attribute is readonly and is assigned by Google.

Enumerations
UNINVITED
The contact has not been invited to see their orders.
INVITE_PENDNG
The contact has been invited to see their orders, but has not yet accepted the invitation.
INVITE_EXPIRED
The contact has been invited to see their orders, but the invitation has already expired.
INVITE_CANCELED
The contact was invited to see their orders, but the invitation was cancelled.
USER_ACTIVE
The contact has access to login and view their orders.
USER_DISABLED
The contact accepted an invitation to see their orders, but their access was later revoked.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.

address

xsd:string

The address of the contact. This attribute is optional and has a maximum length of 1024 characters.

cellPhone

xsd:string

The cell phone number where the contact can be reached. This attribute is optional.

comment

xsd:string

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

email

xsd:string

The e-mail address where the contact can be reached. This attribute is optional.

faxPhone

xsd:string

The fax number where the contact can be reached. This attribute is optional.

title

xsd:string

The job title of the contact. This attribute is optional and has a maximum length of 1024 characters.

workPhone

xsd:string

The work phone number where the contact can be reached. This attribute is optional.