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="authorizedbuyersmarketplace_v1.html">Authorized Buyers Marketplace API</a> . <a href="authorizedbuyersmarketplace_v1.buyers.html">buyers</a> . <a href="authorizedbuyersmarketplace_v1.buyers.clients.html">clients</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="authorizedbuyersmarketplace_v1.buyers.clients.users.html">users()</a></code> 79</p> 80<p class="firstline">Returns the users Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="#activate">activate(name, body=None, x__xgafv=None)</a></code></p> 84<p class="firstline">Activates an existing client. The state of the client will be updated to "ACTIVE". This method has no effect if the client is already in "ACTIVE" state.</p> 85<p class="toc_element"> 86 <code><a href="#close">close()</a></code></p> 87<p class="firstline">Close httplib2 connections.</p> 88<p class="toc_element"> 89 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> 90<p class="firstline">Creates a new client.</p> 91<p class="toc_element"> 92 <code><a href="#deactivate">deactivate(name, body=None, x__xgafv=None)</a></code></p> 93<p class="firstline">Deactivates an existing client. The state of the client will be updated to "INACTIVE". This method has no effect if the client is already in "INACTIVE" state.</p> 94<p class="toc_element"> 95 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 96<p class="firstline">Gets a client with a given resource name.</p> 97<p class="toc_element"> 98 <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 99<p class="firstline">Lists all the clients for the current buyer.</p> 100<p class="toc_element"> 101 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 102<p class="firstline">Retrieves the next page of results.</p> 103<p class="toc_element"> 104 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> 105<p class="firstline">Updates an existing client.</p> 106<h3>Method Details</h3> 107<div class="method"> 108 <code class="details" id="activate">activate(name, body=None, x__xgafv=None)</code> 109 <pre>Activates an existing client. The state of the client will be updated to "ACTIVE". This method has no effect if the client is already in "ACTIVE" state. 110 111Args: 112 name: string, Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}` (required) 113 body: object, The request body. 114 The object takes the form of: 115 116{ # Request message for activating a client. 117} 118 119 x__xgafv: string, V1 error format. 120 Allowed values 121 1 - v1 error format 122 2 - v2 error format 123 124Returns: 125 An object of the form: 126 127 { # A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI. 128 "displayName": "A String", # Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed. 129 "name": "A String", # Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}` 130 "partnerClientId": "A String", # Arbitrary unique identifier provided by the buyer. This field can be used to associate a client with an identifier in the namespace of the buyer, lookup clients by that identifier and verify whether an Authorized Buyers account of the client already exists. If present, must be unique across all the clients. 131 "role": "A String", # Required. The role assigned to the client. Each role implies a set of permissions granted to the client. 132 "sellerVisible": True or False, # Whether the client will be visible to sellers. 133 "state": "A String", # Output only. The state of the client. 134}</pre> 135</div> 136 137<div class="method"> 138 <code class="details" id="close">close()</code> 139 <pre>Close httplib2 connections.</pre> 140</div> 141 142<div class="method"> 143 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> 144 <pre>Creates a new client. 145 146Args: 147 parent: string, Required. The name of the buyer. Format: `buyers/{accountId}` (required) 148 body: object, The request body. 149 The object takes the form of: 150 151{ # A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI. 152 "displayName": "A String", # Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed. 153 "name": "A String", # Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}` 154 "partnerClientId": "A String", # Arbitrary unique identifier provided by the buyer. This field can be used to associate a client with an identifier in the namespace of the buyer, lookup clients by that identifier and verify whether an Authorized Buyers account of the client already exists. If present, must be unique across all the clients. 155 "role": "A String", # Required. The role assigned to the client. Each role implies a set of permissions granted to the client. 156 "sellerVisible": True or False, # Whether the client will be visible to sellers. 157 "state": "A String", # Output only. The state of the client. 158} 159 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 represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI. 169 "displayName": "A String", # Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed. 170 "name": "A String", # Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}` 171 "partnerClientId": "A String", # Arbitrary unique identifier provided by the buyer. This field can be used to associate a client with an identifier in the namespace of the buyer, lookup clients by that identifier and verify whether an Authorized Buyers account of the client already exists. If present, must be unique across all the clients. 172 "role": "A String", # Required. The role assigned to the client. Each role implies a set of permissions granted to the client. 173 "sellerVisible": True or False, # Whether the client will be visible to sellers. 174 "state": "A String", # Output only. The state of the client. 175}</pre> 176</div> 177 178<div class="method"> 179 <code class="details" id="deactivate">deactivate(name, body=None, x__xgafv=None)</code> 180 <pre>Deactivates an existing client. The state of the client will be updated to "INACTIVE". This method has no effect if the client is already in "INACTIVE" state. 181 182Args: 183 name: string, Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}` (required) 184 body: object, The request body. 185 The object takes the form of: 186 187{ # Request message for disabling a client. 188} 189 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 { # A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI. 199 "displayName": "A String", # Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed. 200 "name": "A String", # Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}` 201 "partnerClientId": "A String", # Arbitrary unique identifier provided by the buyer. This field can be used to associate a client with an identifier in the namespace of the buyer, lookup clients by that identifier and verify whether an Authorized Buyers account of the client already exists. If present, must be unique across all the clients. 202 "role": "A String", # Required. The role assigned to the client. Each role implies a set of permissions granted to the client. 203 "sellerVisible": True or False, # Whether the client will be visible to sellers. 204 "state": "A String", # Output only. The state of the client. 205}</pre> 206</div> 207 208<div class="method"> 209 <code class="details" id="get">get(name, x__xgafv=None)</code> 210 <pre>Gets a client with a given resource name. 211 212Args: 213 name: string, Required. Format: `buyers/{accountId}/clients/{clientAccountId}` (required) 214 x__xgafv: string, V1 error format. 215 Allowed values 216 1 - v1 error format 217 2 - v2 error format 218 219Returns: 220 An object of the form: 221 222 { # A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI. 223 "displayName": "A String", # Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed. 224 "name": "A String", # Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}` 225 "partnerClientId": "A String", # Arbitrary unique identifier provided by the buyer. This field can be used to associate a client with an identifier in the namespace of the buyer, lookup clients by that identifier and verify whether an Authorized Buyers account of the client already exists. If present, must be unique across all the clients. 226 "role": "A String", # Required. The role assigned to the client. Each role implies a set of permissions granted to the client. 227 "sellerVisible": True or False, # Whether the client will be visible to sellers. 228 "state": "A String", # Output only. The state of the client. 229}</pre> 230</div> 231 232<div class="method"> 233 <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 234 <pre>Lists all the clients for the current buyer. 235 236Args: 237 parent: string, Required. The name of the buyer. Format: `buyers/{accountId}` (required) 238 filter: string, Query string using the [Filtering Syntax](https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters) Supported fields for filtering are: * partnerClientId Use this field to filter the clients by the partnerClientId. For example, if the partnerClientId of the client is "1234", the value of this field should be `partnerClientId = "1234"`, in order to get only the client whose partnerClientId is "1234" in the response. 239 pageSize: integer, Requested page size. If left blank, a default page size of 500 will be applied. 240 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 list method. 241 x__xgafv: string, V1 error format. 242 Allowed values 243 1 - v1 error format 244 2 - v2 error format 245 246Returns: 247 An object of the form: 248 249 { # Response message for the list method. 250 "clients": [ # The returned list of clients. 251 { # A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI. 252 "displayName": "A String", # Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed. 253 "name": "A String", # Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}` 254 "partnerClientId": "A String", # Arbitrary unique identifier provided by the buyer. This field can be used to associate a client with an identifier in the namespace of the buyer, lookup clients by that identifier and verify whether an Authorized Buyers account of the client already exists. If present, must be unique across all the clients. 255 "role": "A String", # Required. The role assigned to the client. Each role implies a set of permissions granted to the client. 256 "sellerVisible": True or False, # Whether the client will be visible to sellers. 257 "state": "A String", # Output only. The state of the client. 258 }, 259 ], 260 "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 list method to retrieve the next page of results. 261}</pre> 262</div> 263 264<div class="method"> 265 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 266 <pre>Retrieves the next page of results. 267 268Args: 269 previous_request: The request for the previous page. (required) 270 previous_response: The response from the request for the previous page. (required) 271 272Returns: 273 A request object that you can call 'execute()' on to request the next 274 page. Returns None if there are no more items in the collection. 275 </pre> 276</div> 277 278<div class="method"> 279 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> 280 <pre>Updates an existing client. 281 282Args: 283 name: string, Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}` (required) 284 body: object, The request body. 285 The object takes the form of: 286 287{ # A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI. 288 "displayName": "A String", # Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed. 289 "name": "A String", # Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}` 290 "partnerClientId": "A String", # Arbitrary unique identifier provided by the buyer. This field can be used to associate a client with an identifier in the namespace of the buyer, lookup clients by that identifier and verify whether an Authorized Buyers account of the client already exists. If present, must be unique across all the clients. 291 "role": "A String", # Required. The role assigned to the client. Each role implies a set of permissions granted to the client. 292 "sellerVisible": True or False, # Whether the client will be visible to sellers. 293 "state": "A String", # Output only. The state of the client. 294} 295 296 updateMask: string, List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, e.g. false for boolean fields, 0 for integer fields. A special field mask consisting of a single path "*" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask. 297 x__xgafv: string, V1 error format. 298 Allowed values 299 1 - v1 error format 300 2 - v2 error format 301 302Returns: 303 An object of the form: 304 305 { # A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI. 306 "displayName": "A String", # Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed. 307 "name": "A String", # Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}` 308 "partnerClientId": "A String", # Arbitrary unique identifier provided by the buyer. This field can be used to associate a client with an identifier in the namespace of the buyer, lookup clients by that identifier and verify whether an Authorized Buyers account of the client already exists. If present, must be unique across all the clients. 309 "role": "A String", # Required. The role assigned to the client. Each role implies a set of permissions granted to the client. 310 "sellerVisible": True or False, # Whether the client will be visible to sellers. 311 "state": "A String", # Output only. The state of the client. 312}</pre> 313</div> 314 315</body></html>