REST Resource: networks.contacts

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

  • Contacts have associated information including name, display name, company, status, address, and various contact methods like phone and email.

  • The ContactStatus enum describes the various states a contact can be in, such as invited, active, or disabled.

  • Methods are available to create, retrieve, update, and list Contact objects individually or in batches.

Resource: 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.

JSON representation 
{
  "name": string,
  "displayName": string,
  "company": string,
  "status": enum (ContactStatus),
  "address": string,
  "cellPhone": string,
  "comment": string,
  "email": string,
  "fax": string,
  "title": string,
  "workPhone": string
}
Fields
name

string

Identifier. The resource name of the Contact. Format: networks/{networkCode}/contacts/{contactId}
displayName

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/{networkCode}/companies/{companyId}"
status

enum (ContactStatus)

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.
cellPhone

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.
workPhone

string

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

ContactStatus

Describes the contact statuses.

Enums
CONTACT_STATUS_UNSPECIFIED Default value. This value is unused.
INVITE_CANCELED The contact was invited to see their orders, but the invitation was cancelled.
INVITE_EXPIRED The contact has been invited to see their orders, but the invitation has already expired.
INVITE_PENDING The contact has been invited to see their orders, but has not yet accepted the invitation.
UNINVITED The contact has not been invited to see their orders.
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.

Methods

batchCreate

 Creates Contact objects.

batchUpdate

 Batch updates Contact objects.

create

 Creates a Contact object.

get

 Retrieves a Contact object.

list

 Lists Contact objects.

patch

 Updates a Contact object.