1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<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> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="adexchangebuyer2_v2beta1.accounts.clients.invitations.html">invitations()</a></code> 79</p> 80<p class="firstline">Returns the invitations Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="adexchangebuyer2_v2beta1.accounts.clients.users.html">users()</a></code> 84</p> 85<p class="firstline">Returns the users Resource.</p> 86 87<p class="toc_element"> 88 <code><a href="#close">close()</a></code></p> 89<p class="firstline">Close httplib2 connections.</p> 90<p class="toc_element"> 91 <code><a href="#create">create(accountId, body=None, x__xgafv=None)</a></code></p> 92<p class="firstline">Creates a new client buyer.</p> 93<p class="toc_element"> 94 <code><a href="#get">get(accountId, clientAccountId, x__xgafv=None)</a></code></p> 95<p class="firstline">Gets a client buyer with a given client account ID.</p> 96<p class="toc_element"> 97 <code><a href="#list">list(accountId, pageSize=None, pageToken=None, partnerClientId=None, x__xgafv=None)</a></code></p> 98<p class="firstline">Lists all the clients for the current sponsor buyer.</p> 99<p class="toc_element"> 100 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 101<p class="firstline">Retrieves the next page of results.</p> 102<p class="toc_element"> 103 <code><a href="#update">update(accountId, clientAccountId, body=None, x__xgafv=None)</a></code></p> 104<p class="firstline">Updates an existing client buyer.</p> 105<h3>Method Details</h3> 106<div class="method"> 107 <code class="details" id="close">close()</code> 108 <pre>Close httplib2 connections.</pre> 109</div> 110 111<div class="method"> 112 <code class="details" id="create">create(accountId, body=None, x__xgafv=None)</code> 113 <pre>Creates a new client buyer. 114 115Args: 116 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) 117 body: object, The request body. 118 The object takes the form of: 119 120{ # 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. 121 "clientAccountId": "A String", # The globally-unique numerical ID of the client. The value of this field is ignored in create and update operations. 122 "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. Maximum length of 255 characters is allowed. 123 "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. 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](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. 124 "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. 125 "entityType": "A String", # An optional field for specifying the type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`. 126 "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. 127 "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`. 128 "status": "A String", # The status of the client buyer. 129 "visibleToSeller": True or False, # Whether the client buyer will be visible to sellers. 130} 131 132 x__xgafv: string, V1 error format. 133 Allowed values 134 1 - v1 error format 135 2 - v2 error format 136 137Returns: 138 An object of the form: 139 140 { # 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. 141 "clientAccountId": "A String", # The globally-unique numerical ID of the client. The value of this field is ignored in create and update operations. 142 "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. Maximum length of 255 characters is allowed. 143 "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. 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](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. 144 "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. 145 "entityType": "A String", # An optional field for specifying the type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`. 146 "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. 147 "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`. 148 "status": "A String", # The status of the client buyer. 149 "visibleToSeller": True or False, # Whether the client buyer will be visible to sellers. 150}</pre> 151</div> 152 153<div class="method"> 154 <code class="details" id="get">get(accountId, clientAccountId, x__xgafv=None)</code> 155 <pre>Gets a client buyer with a given client account ID. 156 157Args: 158 accountId: string, Numerical account ID of the client's sponsor buyer. (required) (required) 159 clientAccountId: string, Numerical account ID of the client buyer to retrieve. (required) (required) 160 x__xgafv: string, V1 error format. 161 Allowed values 162 1 - v1 error format 163 2 - v2 error format 164 165Returns: 166 An object of the form: 167 168 { # 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. 169 "clientAccountId": "A String", # The globally-unique numerical ID of the client. The value of this field is ignored in create and update operations. 170 "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. Maximum length of 255 characters is allowed. 171 "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. 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](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. 172 "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. 173 "entityType": "A String", # An optional field for specifying the type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`. 174 "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. 175 "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`. 176 "status": "A String", # The status of the client buyer. 177 "visibleToSeller": True or False, # Whether the client buyer will be visible to sellers. 178}</pre> 179</div> 180 181<div class="method"> 182 <code class="details" id="list">list(accountId, pageSize=None, pageToken=None, partnerClientId=None, x__xgafv=None)</code> 183 <pre>Lists all the clients for the current sponsor buyer. 184 185Args: 186 accountId: string, Unique numerical account ID of the sponsor buyer to list the clients for. (required) 187 pageSize: integer, Requested page size. The server may return fewer clients than requested. If unspecified, the server will pick an appropriate default. 188 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. 189 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. 190 x__xgafv: string, V1 error format. 191 Allowed values 192 1 - v1 error format 193 2 - v2 error format 194 195Returns: 196 An object of the form: 197 198 { 199 "clients": [ # The returned list of clients. 200 { # 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. 201 "clientAccountId": "A String", # The globally-unique numerical ID of the client. The value of this field is ignored in create and update operations. 202 "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. Maximum length of 255 characters is allowed. 203 "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. 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](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. 204 "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. 205 "entityType": "A String", # An optional field for specifying the type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`. 206 "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. 207 "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`. 208 "status": "A String", # The status of the client buyer. 209 "visibleToSeller": True or False, # Whether the client buyer will be visible to sellers. 210 }, 211 ], 212 "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. 213}</pre> 214</div> 215 216<div class="method"> 217 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 218 <pre>Retrieves the next page of results. 219 220Args: 221 previous_request: The request for the previous page. (required) 222 previous_response: The response from the request for the previous page. (required) 223 224Returns: 225 A request object that you can call 'execute()' on to request the next 226 page. Returns None if there are no more items in the collection. 227 </pre> 228</div> 229 230<div class="method"> 231 <code class="details" id="update">update(accountId, clientAccountId, body=None, x__xgafv=None)</code> 232 <pre>Updates an existing client buyer. 233 234Args: 235 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) 236 clientAccountId: string, Unique numerical account ID of the client to update. (required) (required) 237 body: object, The request body. 238 The object takes the form of: 239 240{ # 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. 241 "clientAccountId": "A String", # The globally-unique numerical ID of the client. The value of this field is ignored in create and update operations. 242 "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. Maximum length of 255 characters is allowed. 243 "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. 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](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. 244 "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. 245 "entityType": "A String", # An optional field for specifying the type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`. 246 "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. 247 "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`. 248 "status": "A String", # The status of the client buyer. 249 "visibleToSeller": True or False, # Whether the client buyer will be visible to sellers. 250} 251 252 x__xgafv: string, V1 error format. 253 Allowed values 254 1 - v1 error format 255 2 - v2 error format 256 257Returns: 258 An object of the form: 259 260 { # 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. 261 "clientAccountId": "A String", # The globally-unique numerical ID of the client. The value of this field is ignored in create and update operations. 262 "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. Maximum length of 255 characters is allowed. 263 "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. 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](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. 264 "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. 265 "entityType": "A String", # An optional field for specifying the type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`. 266 "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. 267 "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`. 268 "status": "A String", # The status of the client buyer. 269 "visibleToSeller": True or False, # Whether the client buyer will be visible to sellers. 270}</pre> 271</div> 272 273</body></html>