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> . <a href="adexchangebuyer2_v2beta1.accounts.clients.users.html">users</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#get">get(accountId, clientAccountId, userId, x__xgafv=None)</a></code></p> 82<p class="firstline">Retrieves an existing client user.</p> 83<p class="toc_element"> 84 <code><a href="#list">list(accountId, clientAccountId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Lists all the known client users for a specified sponsor buyer account ID.</p> 86<p class="toc_element"> 87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 88<p class="firstline">Retrieves the next page of results.</p> 89<p class="toc_element"> 90 <code><a href="#update">update(accountId, clientAccountId, userId, body=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Updates an existing client user. Only the user status can be changed on update.</p> 92<h3>Method Details</h3> 93<div class="method"> 94 <code class="details" id="close">close()</code> 95 <pre>Close httplib2 connections.</pre> 96</div> 97 98<div class="method"> 99 <code class="details" id="get">get(accountId, clientAccountId, userId, x__xgafv=None)</code> 100 <pre>Retrieves an existing client user. 101 102Args: 103 accountId: string, Numerical account ID of the client's sponsor buyer. (required) (required) 104 clientAccountId: string, Numerical account ID of the client buyer that the user to be retrieved is associated with. (required) (required) 105 userId: string, Numerical identifier of the user to retrieve. (required) (required) 106 x__xgafv: string, V1 error format. 107 Allowed values 108 1 - v1 error format 109 2 - v2 error format 110 111Returns: 112 An object of the form: 113 114 { # A client user is created under a client buyer and has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client buyer. The only way a new client user can be created is via accepting an email invitation (see the accounts.clients.invitations.create method). All fields are required unless otherwise specified. 115 "clientAccountId": "A String", # Numerical account ID of the client buyer with which the user is associated; the buyer must be a client of the current sponsor buyer. The value of this field is ignored in an update operation. 116 "email": "A String", # User's email address. The value of this field is ignored in an update operation. 117 "status": "A String", # The status of the client user. 118 "userId": "A String", # The unique numerical ID of the client user that has accepted an invitation. The value of this field is ignored in an update operation. 119}</pre> 120</div> 121 122<div class="method"> 123 <code class="details" id="list">list(accountId, clientAccountId, pageSize=None, pageToken=None, x__xgafv=None)</code> 124 <pre>Lists all the known client users for a specified sponsor buyer account ID. 125 126Args: 127 accountId: string, Numerical account ID of the sponsor buyer of the client to list users for. (required) (required) 128 clientAccountId: string, The account ID of the client buyer to list users for. (required) You must specify either a string representation of a numerical account identifier or the `-` character to list all the client users for all the clients of a given sponsor buyer. (required) 129 pageSize: integer, Requested page size. The server may return fewer clients than requested. If unspecified, the server will pick an appropriate default. 130 pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of ListClientUsersResponse.nextPageToken returned from the previous call to the accounts.clients.users.list method. 131 x__xgafv: string, V1 error format. 132 Allowed values 133 1 - v1 error format 134 2 - v2 error format 135 136Returns: 137 An object of the form: 138 139 { 140 "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the ListClientUsersRequest.pageToken field in the subsequent call to the clients.invitations.list method to retrieve the next page of results. 141 "users": [ # The returned list of client users. 142 { # A client user is created under a client buyer and has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client buyer. The only way a new client user can be created is via accepting an email invitation (see the accounts.clients.invitations.create method). All fields are required unless otherwise specified. 143 "clientAccountId": "A String", # Numerical account ID of the client buyer with which the user is associated; the buyer must be a client of the current sponsor buyer. The value of this field is ignored in an update operation. 144 "email": "A String", # User's email address. The value of this field is ignored in an update operation. 145 "status": "A String", # The status of the client user. 146 "userId": "A String", # The unique numerical ID of the client user that has accepted an invitation. The value of this field is ignored in an update operation. 147 }, 148 ], 149}</pre> 150</div> 151 152<div class="method"> 153 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 154 <pre>Retrieves the next page of results. 155 156Args: 157 previous_request: The request for the previous page. (required) 158 previous_response: The response from the request for the previous page. (required) 159 160Returns: 161 A request object that you can call 'execute()' on to request the next 162 page. Returns None if there are no more items in the collection. 163 </pre> 164</div> 165 166<div class="method"> 167 <code class="details" id="update">update(accountId, clientAccountId, userId, body=None, x__xgafv=None)</code> 168 <pre>Updates an existing client user. Only the user status can be changed on update. 169 170Args: 171 accountId: string, Numerical account ID of the client's sponsor buyer. (required) (required) 172 clientAccountId: string, Numerical account ID of the client buyer that the user to be retrieved is associated with. (required) (required) 173 userId: string, Numerical identifier of the user to retrieve. (required) (required) 174 body: object, The request body. 175 The object takes the form of: 176 177{ # A client user is created under a client buyer and has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client buyer. The only way a new client user can be created is via accepting an email invitation (see the accounts.clients.invitations.create method). All fields are required unless otherwise specified. 178 "clientAccountId": "A String", # Numerical account ID of the client buyer with which the user is associated; the buyer must be a client of the current sponsor buyer. The value of this field is ignored in an update operation. 179 "email": "A String", # User's email address. The value of this field is ignored in an update operation. 180 "status": "A String", # The status of the client user. 181 "userId": "A String", # The unique numerical ID of the client user that has accepted an invitation. The value of this field is ignored in an update operation. 182} 183 184 x__xgafv: string, V1 error format. 185 Allowed values 186 1 - v1 error format 187 2 - v2 error format 188 189Returns: 190 An object of the form: 191 192 { # A client user is created under a client buyer and has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client buyer. The only way a new client user can be created is via accepting an email invitation (see the accounts.clients.invitations.create method). All fields are required unless otherwise specified. 193 "clientAccountId": "A String", # Numerical account ID of the client buyer with which the user is associated; the buyer must be a client of the current sponsor buyer. The value of this field is ignored in an update operation. 194 "email": "A String", # User's email address. The value of this field is ignored in an update operation. 195 "status": "A String", # The status of the client user. 196 "userId": "A String", # The unique numerical ID of the client user that has accepted an invitation. The value of this field is ignored in an update operation. 197}</pre> 198</div> 199 200</body></html>