GOgoogle
accounts

POST /v2beta1/accounts/{accountId}/clients

Changed on

Creates a new client buyer.

Request

  • Base URL
    https://adexchangebuyer.googleapis.com
  • Auth
    OAuth 2 and OAuth 2
    Implicithttps://accounts.google.com/o/oauth2/auth
    Scopeshttps://www.googleapis.com/auth/adexchange.buyer
    Authorization codehttps://accounts.google.com/o/oauth2/auth
    Token URLhttps://accounts.google.com/o/oauth2/token
    Scopeshttps://www.googleapis.com/auth/adexchange.buyer

Path parameters

accountIdstring int64 required

Unique numerical account ID for the buyer of which the client buyer is a customer; the sponsor buyer to create a client for. (required)

Request body

clientAccountIdstring int64

The globally-unique numerical ID of the client. The value of this field is ignored in create and update operations.

clientNamestring

Name used to represent this client to publishers. You may have multiple clients that map to the same entity, but for each client the combination of clientName and entity must be unique. You can specify this field as empty. Maximum length of 255 characters is allowed.

entityIdstring int64

Numerical identifier of the client entity. The entity can be an advertiser, a brand, or an agency. This identifier is unique among all the entities with the same type. The value of this field is ignored if the entity type is not provided. A list of all known advertisers with their identifiers is available in the advertisers.txt file. A list of all known brands with their identifiers is available in the brands.txt file. A list of all known agencies with their identifiers is available in the agencies.txt file.

entityNamestring

The name of the entity. This field is automatically fetched based on the type and ID. The value of this field is ignored in create and update operations.

entityType'ENTITY_TYPE_UNSPECIFIED' | 'ADVERTISER' | 'BRAND' | 'AGENCY' | 'ENTITY_TYPE_UNCLASSIFIED'

An optional field for specifying the type of the client entity: ADVERTISER, BRAND, or AGENCY.

partnerClientIdstring

Optional arbitrary unique identifier of this client buyer from the standpoint of its Ad Exchange sponsor buyer. This field can be used to associate a client buyer with the identifier in the namespace of its sponsor buyer, lookup client buyers by that identifier and verify whether an Ad Exchange counterpart of a given client buyer already exists. If present, must be unique among all the client buyers for its Ad Exchange sponsor buyer.

role'CLIENT_ROLE_UNSPECIFIED' | 'CLIENT_DEAL_VIEWER' | 'CLIENT_DEAL_NEGOTIATOR' | 'CLIENT_DEAL_APPROVER'

The role which is assigned to the client buyer. Each role implies a set of permissions granted to the client. Must be one of CLIENT_DEAL_VIEWER, CLIENT_DEAL_NEGOTIATOR or CLIENT_DEAL_APPROVER.

status'CLIENT_STATUS_UNSPECIFIED' | 'DISABLED' | 'ACTIVE'

The status of the client buyer.

visibleToSellerboolean

Whether the client buyer will be visible to sellers.

Response

Successful response

clientAccountIdstring int64

The globally-unique numerical ID of the client. The value of this field is ignored in create and update operations.

clientNamestring

Name used to represent this client to publishers. You may have multiple clients that map to the same entity, but for each client the combination of clientName and entity must be unique. You can specify this field as empty. Maximum length of 255 characters is allowed.

entityIdstring int64

Numerical identifier of the client entity. The entity can be an advertiser, a brand, or an agency. This identifier is unique among all the entities with the same type. The value of this field is ignored if the entity type is not provided. A list of all known advertisers with their identifiers is available in the advertisers.txt file. A list of all known brands with their identifiers is available in the brands.txt file. A list of all known agencies with their identifiers is available in the agencies.txt file.

entityNamestring

The name of the entity. This field is automatically fetched based on the type and ID. The value of this field is ignored in create and update operations.

entityType'ENTITY_TYPE_UNSPECIFIED' | 'ADVERTISER' | 'BRAND' | 'AGENCY' | 'ENTITY_TYPE_UNCLASSIFIED'

An optional field for specifying the type of the client entity: ADVERTISER, BRAND, or AGENCY.

partnerClientIdstring

Optional arbitrary unique identifier of this client buyer from the standpoint of its Ad Exchange sponsor buyer. This field can be used to associate a client buyer with the identifier in the namespace of its sponsor buyer, lookup client buyers by that identifier and verify whether an Ad Exchange counterpart of a given client buyer already exists. If present, must be unique among all the client buyers for its Ad Exchange sponsor buyer.

role'CLIENT_ROLE_UNSPECIFIED' | 'CLIENT_DEAL_VIEWER' | 'CLIENT_DEAL_NEGOTIATOR' | 'CLIENT_DEAL_APPROVER'

The role which is assigned to the client buyer. Each role implies a set of permissions granted to the client. Must be one of CLIENT_DEAL_VIEWER, CLIENT_DEAL_NEGOTIATOR or CLIENT_DEAL_APPROVER.

status'CLIENT_STATUS_UNSPECIFIED' | 'DISABLED' | 'ACTIVE'

The status of the client buyer.

visibleToSellerboolean

Whether the client buyer will be visible to sellers.

Changes

  • af1a744df07bRevision changes
    • breaking

      removed the request body

    • breaking

      removed the media type */* for the response with the status