REST Resource: networks.companies

Resource: Company

The Company resource.

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

string

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

string (int64 format)

Output only. 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 ACTIVE if basic settings are enabled and ON_HOLD if advance settings are enabled.
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/{teamId}"
updateTime

string (Timestamp format)

Output only. The instant the Company was last modified.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
thirdPartyCompanyId

string (int64 format)

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

string

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

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.

CompanyCreditStatus

The credit status of a company.

Credit statuses specify the credit-worthiness of a company and affect the ad serving of campaigns belonging to the company.

In basic settings, only the ACTIVE and INACTIVE credit statuses are applicable. In advance settings, all credit statuses are applicable.

Enums
COMPANY_CREDIT_STATUS_UNSPECIFIED No value specified
ACTIVE

The company's credit status is active.

Line items belonging to the company can serve.

This credit status is the default for basic settings and is available in both basic and advance settings.
INACTIVE

The company's credit status is inactive.

Line items belonging to the company cannot be activated. However, line items that were activated before the credit status changed will remain active. New orders or line items belonging to the company cannot be created.

Companies with this credit status will be hidden by default in company search results.

This credit status is available in both basic and advance settings.
ON_HOLD

The company's credit status is on hold.

Line items belonging to the company cannot be activated. However, line items that were activated before the credit status changed will remain active. New orders or line items belonging to the company can be created.

This credit status is the default in advance settings and is only available in advance settings.
STOP

The company's credit status is stopped.

Line items belonging to the company cannot be activated. However, line items that were activated before the credit status changed will remain active. New orders or line items belonging to the company cannot be created.

This credit status is only available in advance settings.
BLOCKED

The company's credit status is blocked.

All active line items belonging to the company will stop serving with immediate effect. Line items belonging to the company cannot be activated, and new orders or line items belonging to the company cannot be created.

This credit status is only available in advance settings.

Methods

get

 API to retrieve a Company object.

list

 API to retrieve a list of Company objects.