You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
496 lines
24 KiB
496 lines
24 KiB
<html><body>
|
|
<style>
|
|
|
|
body, h1, h2, h3, div, span, p, pre, a {
|
|
margin: 0;
|
|
padding: 0;
|
|
border: 0;
|
|
font-weight: inherit;
|
|
font-style: inherit;
|
|
font-size: 100%;
|
|
font-family: inherit;
|
|
vertical-align: baseline;
|
|
}
|
|
|
|
body {
|
|
font-size: 13px;
|
|
padding: 1em;
|
|
}
|
|
|
|
h1 {
|
|
font-size: 26px;
|
|
margin-bottom: 1em;
|
|
}
|
|
|
|
h2 {
|
|
font-size: 24px;
|
|
margin-bottom: 1em;
|
|
}
|
|
|
|
h3 {
|
|
font-size: 20px;
|
|
margin-bottom: 1em;
|
|
margin-top: 1em;
|
|
}
|
|
|
|
pre, code {
|
|
line-height: 1.5;
|
|
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
|
|
}
|
|
|
|
pre {
|
|
margin-top: 0.5em;
|
|
}
|
|
|
|
h1, h2, h3, p {
|
|
font-family: Arial, sans serif;
|
|
}
|
|
|
|
h1, h2, h3 {
|
|
border-bottom: solid #CCC 1px;
|
|
}
|
|
|
|
.toc_element {
|
|
margin-top: 0.5em;
|
|
}
|
|
|
|
.firstline {
|
|
margin-left: 2 em;
|
|
}
|
|
|
|
.method {
|
|
margin-top: 1em;
|
|
border: solid 1px #CCC;
|
|
padding: 1em;
|
|
background: #EEE;
|
|
}
|
|
|
|
.details {
|
|
font-weight: bold;
|
|
font-size: 14px;
|
|
}
|
|
|
|
</style>
|
|
|
|
<h1><a href="adexchangebuyer2_v2beta1.html">Ad Exchange Buyer API II</a> . <a href="adexchangebuyer2_v2beta1.accounts.html">accounts</a> . <a href="adexchangebuyer2_v2beta1.accounts.clients.html">clients</a></h1>
|
|
<h2>Instance Methods</h2>
|
|
<p class="toc_element">
|
|
<code><a href="adexchangebuyer2_v2beta1.accounts.clients.invitations.html">invitations()</a></code>
|
|
</p>
|
|
<p class="firstline">Returns the invitations Resource.</p>
|
|
|
|
<p class="toc_element">
|
|
<code><a href="adexchangebuyer2_v2beta1.accounts.clients.users.html">users()</a></code>
|
|
</p>
|
|
<p class="firstline">Returns the users Resource.</p>
|
|
|
|
<p class="toc_element">
|
|
<code><a href="#create">create(accountId, body, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Creates a new client buyer.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#get">get(accountId, clientAccountId, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Gets a client buyer with a given client account ID.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#list">list(accountId, pageSize=None, partnerClientId=None, pageToken=None, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Lists all the clients for the current sponsor buyer.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
|
<p class="firstline">Retrieves the next page of results.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#update">update(accountId, clientAccountId, body, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Updates an existing client buyer.</p>
|
|
<h3>Method Details</h3>
|
|
<div class="method">
|
|
<code class="details" id="create">create(accountId, body, x__xgafv=None)</code>
|
|
<pre>Creates a new client buyer.
|
|
|
|
Args:
|
|
accountId: string, Unique numerical account ID for the buyer of which the client buyer
|
|
is a customer; the sponsor buyer to create a client for. (required) (required)
|
|
body: object, The request body. (required)
|
|
The object takes the form of:
|
|
|
|
{ # A client resource represents a client buyer—an agency, a brand, or an
|
|
# advertiser customer of the sponsor buyer. Users associated with the client
|
|
# buyer have restricted access to the Marketplace and certain other sections of
|
|
# the Authorized Buyers UI based on the role granted to the client buyer. All
|
|
# fields are required unless otherwise specified.
|
|
"status": "A String", # The status of the client buyer.
|
|
"clientAccountId": "A String", # The globally-unique numerical ID of the client.
|
|
# The value of this field is ignored in create and update operations.
|
|
"entityType": "A String", # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
|
|
"entityName": "A String", # 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.
|
|
"partnerClientId": "A String", # 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": "A String", # 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`.
|
|
"visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.
|
|
"entityId": "A String", # 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.
|
|
#
|
|
# A list of all known advertisers with their identifiers is available in the
|
|
# [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)
|
|
# file.
|
|
#
|
|
# A list of all known brands with their identifiers is available in the
|
|
# [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)
|
|
# file.
|
|
#
|
|
# A list of all known agencies with their identifiers is available in the
|
|
# [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)
|
|
# file.
|
|
"clientName": "A String", # 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.
|
|
}
|
|
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # A client resource represents a client buyer—an agency, a brand, or an
|
|
# advertiser customer of the sponsor buyer. Users associated with the client
|
|
# buyer have restricted access to the Marketplace and certain other sections of
|
|
# the Authorized Buyers UI based on the role granted to the client buyer. All
|
|
# fields are required unless otherwise specified.
|
|
"status": "A String", # The status of the client buyer.
|
|
"clientAccountId": "A String", # The globally-unique numerical ID of the client.
|
|
# The value of this field is ignored in create and update operations.
|
|
"entityType": "A String", # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
|
|
"entityName": "A String", # 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.
|
|
"partnerClientId": "A String", # 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": "A String", # 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`.
|
|
"visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.
|
|
"entityId": "A String", # 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.
|
|
#
|
|
# A list of all known advertisers with their identifiers is available in the
|
|
# [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)
|
|
# file.
|
|
#
|
|
# A list of all known brands with their identifiers is available in the
|
|
# [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)
|
|
# file.
|
|
#
|
|
# A list of all known agencies with their identifiers is available in the
|
|
# [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)
|
|
# file.
|
|
"clientName": "A String", # 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.
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="get">get(accountId, clientAccountId, x__xgafv=None)</code>
|
|
<pre>Gets a client buyer with a given client account ID.
|
|
|
|
Args:
|
|
accountId: string, Numerical account ID of the client's sponsor buyer. (required) (required)
|
|
clientAccountId: string, Numerical account ID of the client buyer to retrieve. (required) (required)
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # A client resource represents a client buyer—an agency, a brand, or an
|
|
# advertiser customer of the sponsor buyer. Users associated with the client
|
|
# buyer have restricted access to the Marketplace and certain other sections of
|
|
# the Authorized Buyers UI based on the role granted to the client buyer. All
|
|
# fields are required unless otherwise specified.
|
|
"status": "A String", # The status of the client buyer.
|
|
"clientAccountId": "A String", # The globally-unique numerical ID of the client.
|
|
# The value of this field is ignored in create and update operations.
|
|
"entityType": "A String", # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
|
|
"entityName": "A String", # 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.
|
|
"partnerClientId": "A String", # 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": "A String", # 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`.
|
|
"visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.
|
|
"entityId": "A String", # 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.
|
|
#
|
|
# A list of all known advertisers with their identifiers is available in the
|
|
# [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)
|
|
# file.
|
|
#
|
|
# A list of all known brands with their identifiers is available in the
|
|
# [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)
|
|
# file.
|
|
#
|
|
# A list of all known agencies with their identifiers is available in the
|
|
# [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)
|
|
# file.
|
|
"clientName": "A String", # 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.
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="list">list(accountId, pageSize=None, partnerClientId=None, pageToken=None, x__xgafv=None)</code>
|
|
<pre>Lists all the clients for the current sponsor buyer.
|
|
|
|
Args:
|
|
accountId: string, Unique numerical account ID of the sponsor buyer to list the clients for. (required)
|
|
pageSize: integer, Requested page size. The server may return fewer clients than requested.
|
|
If unspecified, the server will pick an appropriate default.
|
|
partnerClientId: string, Optional unique identifier (from the standpoint of an Ad Exchange sponsor
|
|
buyer partner) of the client to return.
|
|
If specified, at most one client will be returned in the response.
|
|
pageToken: string, A token identifying a page of results the server should return.
|
|
Typically, this is the value of
|
|
ListClientsResponse.nextPageToken
|
|
returned from the previous call to the
|
|
accounts.clients.list
|
|
method.
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{
|
|
"nextPageToken": "A String", # A token to retrieve the next page of results.
|
|
# Pass this value in the
|
|
# ListClientsRequest.pageToken
|
|
# field in the subsequent call to the
|
|
# accounts.clients.list
|
|
# method to retrieve the next page of results.
|
|
"clients": [ # The returned list of clients.
|
|
{ # A client resource represents a client buyer—an agency, a brand, or an
|
|
# advertiser customer of the sponsor buyer. Users associated with the client
|
|
# buyer have restricted access to the Marketplace and certain other sections of
|
|
# the Authorized Buyers UI based on the role granted to the client buyer. All
|
|
# fields are required unless otherwise specified.
|
|
"status": "A String", # The status of the client buyer.
|
|
"clientAccountId": "A String", # The globally-unique numerical ID of the client.
|
|
# The value of this field is ignored in create and update operations.
|
|
"entityType": "A String", # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
|
|
"entityName": "A String", # 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.
|
|
"partnerClientId": "A String", # 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": "A String", # 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`.
|
|
"visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.
|
|
"entityId": "A String", # 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.
|
|
#
|
|
# A list of all known advertisers with their identifiers is available in the
|
|
# [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)
|
|
# file.
|
|
#
|
|
# A list of all known brands with their identifiers is available in the
|
|
# [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)
|
|
# file.
|
|
#
|
|
# A list of all known agencies with their identifiers is available in the
|
|
# [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)
|
|
# file.
|
|
"clientName": "A String", # 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.
|
|
},
|
|
],
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
|
|
<pre>Retrieves the next page of results.
|
|
|
|
Args:
|
|
previous_request: The request for the previous page. (required)
|
|
previous_response: The response from the request for the previous page. (required)
|
|
|
|
Returns:
|
|
A request object that you can call 'execute()' on to request the next
|
|
page. Returns None if there are no more items in the collection.
|
|
</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="update">update(accountId, clientAccountId, body, x__xgafv=None)</code>
|
|
<pre>Updates an existing client buyer.
|
|
|
|
Args:
|
|
accountId: string, Unique numerical account ID for the buyer of which the client buyer
|
|
is a customer; the sponsor buyer to update a client for. (required) (required)
|
|
clientAccountId: string, Unique numerical account ID of the client to update. (required) (required)
|
|
body: object, The request body. (required)
|
|
The object takes the form of:
|
|
|
|
{ # A client resource represents a client buyer—an agency, a brand, or an
|
|
# advertiser customer of the sponsor buyer. Users associated with the client
|
|
# buyer have restricted access to the Marketplace and certain other sections of
|
|
# the Authorized Buyers UI based on the role granted to the client buyer. All
|
|
# fields are required unless otherwise specified.
|
|
"status": "A String", # The status of the client buyer.
|
|
"clientAccountId": "A String", # The globally-unique numerical ID of the client.
|
|
# The value of this field is ignored in create and update operations.
|
|
"entityType": "A String", # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
|
|
"entityName": "A String", # 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.
|
|
"partnerClientId": "A String", # 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": "A String", # 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`.
|
|
"visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.
|
|
"entityId": "A String", # 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.
|
|
#
|
|
# A list of all known advertisers with their identifiers is available in the
|
|
# [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)
|
|
# file.
|
|
#
|
|
# A list of all known brands with their identifiers is available in the
|
|
# [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)
|
|
# file.
|
|
#
|
|
# A list of all known agencies with their identifiers is available in the
|
|
# [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)
|
|
# file.
|
|
"clientName": "A String", # 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.
|
|
}
|
|
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # A client resource represents a client buyer—an agency, a brand, or an
|
|
# advertiser customer of the sponsor buyer. Users associated with the client
|
|
# buyer have restricted access to the Marketplace and certain other sections of
|
|
# the Authorized Buyers UI based on the role granted to the client buyer. All
|
|
# fields are required unless otherwise specified.
|
|
"status": "A String", # The status of the client buyer.
|
|
"clientAccountId": "A String", # The globally-unique numerical ID of the client.
|
|
# The value of this field is ignored in create and update operations.
|
|
"entityType": "A String", # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
|
|
"entityName": "A String", # 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.
|
|
"partnerClientId": "A String", # 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": "A String", # 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`.
|
|
"visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.
|
|
"entityId": "A String", # 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.
|
|
#
|
|
# A list of all known advertisers with their identifiers is available in the
|
|
# [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)
|
|
# file.
|
|
#
|
|
# A list of all known brands with their identifiers is available in the
|
|
# [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)
|
|
# file.
|
|
#
|
|
# A list of all known agencies with their identifiers is available in the
|
|
# [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)
|
|
# file.
|
|
"clientName": "A String", # 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.
|
|
}</pre>
|
|
</div>
|
|
|
|
</body></html> |