REST Resource: networks.companies

  • The Company resource in the API represents a business entity, such as an advertiser or agency, within a network.

  • Companies have various attributes including name, ID, type, contact information, labels, teams, and credit status.

  • The type of a company can be Advertiser, House Advertiser, Agency, House Agency, or Ad Network.

  • The credit status of a company determines if its line items can serve and can be Active, Inactive, On Hold, Stop, or Blocked.

  • Methods are available to retrieve a single Company object or a list of Company objects.

Resource: Company

The Company resource.

JSON representation 
{
  "name": string,
  "appliedLabels": [
    {
      object (AppliedLabel)
    }
  ],
  "appliedTeams": [
    string
  ],
  "companyId": string,
  "displayName": string,
  "type": enum (CompanyType),
  "address": string,
  "email": string,
  "fax": string,
  "phone": string,
  "externalId": string,
  "comment": string,
  "creditStatus": enum (CompanyCreditStatus),
  "primaryContact": string,
  "thirdPartyCompanyId": string,
  "updateTime": string
}
Fields
name

string

Identifier. The resource name of the Company. Format: networks/{networkCode}/companies/{companyId}
appliedLabels[]

object (AppliedLabel)

Optional. The labels that are directly applied to the Company.
appliedTeams[]

string

Optional. The resource names of Teams that are directly associated with the Company. Format: "networks/{networkCode}/teams/{team_id}"
companyId
(deprecated)

string (int64 format)

Output only. Deprecated: Company ID.
displayName

string

Required. The display name of the Company.

This value has a maximum length of 127 characters.
type

enum (CompanyType)

Required. The type of the Company.
address

string

Optional. The address for the Company.

This value has a maximum length of 1024 characters.
email

string

Optional. The email for the Company.

This value has a maximum length of 128 characters.
fax

string

Optional. The fax number for the Company.

This value has a maximum length of 63 characters.
phone

string

Optional. The phone number for the Company.

This value has a maximum length of 63 characters.
externalId

string

Optional. The external ID for the Company.

This value has a maximum length of 255 characters.
comment

string

Optional. Comments about the Company.

This value has a maximum length of 1024 characters.
creditStatus

enum (CompanyCreditStatus)

Optional. The credit status of the Company.

This attribute defaults to [CompanyCreditStatus.ACTIVE][] if basic settings are enabled and [CompanyCreditStatus.ON_HOLD][] if advance settings are enabled.
primaryContact

string

Optional. The resource names of primary Contact of the Company. Format: "networks/{networkCode}/contacts/{contactId}"
thirdPartyCompanyId

string (int64 format)

Optional. The ID of the Google-recognized canonicalized form of the Company.
updateTime

string (Timestamp format)

Output only. The time the Company was last modified.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

CompanyType

The type of a company.

Enums
COMPANY_TYPE_UNSPECIFIED No value specified
ADVERTISER A business entity that purchases ad inventory.
HOUSE_ADVERTISER A company representing the publisher's own advertiser for house ads.
AGENCY An organization that manages ad accounts and offers services, such as ad creation, placement, and management to advertisers.
HOUSE_AGENCY A company representing the publisher's own agency.
AD_NETWORK A company representing multiple advertisers and agencies.

Methods

batchCreate

 Creates Company objects.

batchUpdate

 Batch updates Company objects.

create

 Creates a Company object.

get

 Retrieves a Company object.

list

 Lists Company objects.

patch

 Updates a Company object.