1 <html><body> 2 <style> 3 4 body, 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 15 body { 16 font-size: 13px; 17 padding: 1em; 18 } 19 20 h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23 } 24 25 h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28 } 29 30 h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34 } 35 36 pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39 } 40 41 pre { 42 margin-top: 0.5em; 43 } 44 45 h1, h2, h3, p { 46 font-family: Arial, sans serif; 47 } 48 49 h1, 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="#get">get(accountId, clientAccountId, userId, x__xgafv=None)</a></code></p> 79 <p class="firstline">Retrieves an existing client user.</p> 80 <p class="toc_element"> 81 <code><a href="#list">list(accountId, clientAccountId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 82 <p class="firstline">Lists all the known client users for a specified</p> 83 <p class="toc_element"> 84 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 85 <p class="firstline">Retrieves the next page of results.</p> 86 <p class="toc_element"> 87 <code><a href="#update">update(accountId, clientAccountId, userId, body, x__xgafv=None)</a></code></p> 88 <p class="firstline">Updates an existing client user.</p> 89 <h3>Method Details</h3> 90 <div class="method"> 91 <code class="details" id="get">get(accountId, clientAccountId, userId, x__xgafv=None)</code> 92 <pre>Retrieves an existing client user. 93 94 Args: 95 accountId: string, Numerical account ID of the client's sponsor buyer. (required) (required) 96 clientAccountId: string, Numerical account ID of the client buyer 97 that the user to be retrieved is associated with. (required) (required) 98 userId: string, Numerical identifier of the user to retrieve. (required) (required) 99 x__xgafv: string, V1 error format. 100 Allowed values 101 1 - v1 error format 102 2 - v2 error format 103 104 Returns: 105 An object of the form: 106 107 { # A client user is created under a client buyer and has restricted access to 108 # the Ad Exchange Marketplace and certain other sections 109 # of the Ad Exchange Buyer UI based on the role 110 # granted to the associated client buyer. 111 # 112 # The only way a new client user can be created is via accepting an 113 # email invitation 114 # (see the 115 # accounts.clients.invitations.create 116 # method). 117 # 118 # All fields are required unless otherwise specified. 119 "status": "A String", # The status of the client user. 120 "clientAccountId": "A String", # Numerical account ID of the client buyer 121 # with which the user is associated; the 122 # buyer must be a client of the current sponsor buyer. 123 # The value of this field is ignored in an update operation. 124 "userId": "A String", # The unique numerical ID of the client user 125 # that has accepted an invitation. 126 # The value of this field is ignored in an update operation. 127 "email": "A String", # User's email address. The value of this field 128 # is ignored in an update operation. 129 }</pre> 130 </div> 131 132 <div class="method"> 133 <code class="details" id="list">list(accountId, clientAccountId, pageSize=None, pageToken=None, x__xgafv=None)</code> 134 <pre>Lists all the known client users for a specified 135 sponsor buyer account ID. 136 137 Args: 138 accountId: string, Numerical account ID of the sponsor buyer of the client to list users for. 139 (required) (required) 140 clientAccountId: string, The account ID of the client buyer to list users for. (required) 141 You must specify either a string representation of a 142 numerical account identifier or the `-` character 143 to list all the client users for all the clients 144 of a given sponsor buyer. (required) 145 pageSize: integer, Requested page size. The server may return fewer clients than requested. 146 If unspecified, the server will pick an appropriate default. 147 pageToken: string, A token identifying a page of results the server should return. 148 Typically, this is the value of 149 ListClientUsersResponse.nextPageToken 150 returned from the previous call to the 151 accounts.clients.users.list method. 152 x__xgafv: string, V1 error format. 153 Allowed values 154 1 - v1 error format 155 2 - v2 error format 156 157 Returns: 158 An object of the form: 159 160 { 161 "nextPageToken": "A String", # A token to retrieve the next page of results. 162 # Pass this value in the 163 # ListClientUsersRequest.pageToken 164 # field in the subsequent call to the 165 # clients.invitations.list 166 # method to retrieve the next 167 # page of results. 168 "users": [ # The returned list of client users. 169 { # A client user is created under a client buyer and has restricted access to 170 # the Ad Exchange Marketplace and certain other sections 171 # of the Ad Exchange Buyer UI based on the role 172 # granted to the associated client buyer. 173 # 174 # The only way a new client user can be created is via accepting an 175 # email invitation 176 # (see the 177 # accounts.clients.invitations.create 178 # method). 179 # 180 # All fields are required unless otherwise specified. 181 "status": "A String", # The status of the client user. 182 "clientAccountId": "A String", # Numerical account ID of the client buyer 183 # with which the user is associated; the 184 # buyer must be a client of the current sponsor buyer. 185 # The value of this field is ignored in an update operation. 186 "userId": "A String", # The unique numerical ID of the client user 187 # that has accepted an invitation. 188 # The value of this field is ignored in an update operation. 189 "email": "A String", # User's email address. The value of this field 190 # is ignored in an update operation. 191 }, 192 ], 193 }</pre> 194 </div> 195 196 <div class="method"> 197 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 198 <pre>Retrieves the next page of results. 199 200 Args: 201 previous_request: The request for the previous page. (required) 202 previous_response: The response from the request for the previous page. (required) 203 204 Returns: 205 A request object that you can call 'execute()' on to request the next 206 page. Returns None if there are no more items in the collection. 207 </pre> 208 </div> 209 210 <div class="method"> 211 <code class="details" id="update">update(accountId, clientAccountId, userId, body, x__xgafv=None)</code> 212 <pre>Updates an existing client user. 213 Only the user status can be changed on update. 214 215 Args: 216 accountId: string, Numerical account ID of the client's sponsor buyer. (required) (required) 217 clientAccountId: string, Numerical account ID of the client buyer that the user to be retrieved 218 is associated with. (required) (required) 219 userId: string, Numerical identifier of the user to retrieve. (required) (required) 220 body: object, The request body. (required) 221 The object takes the form of: 222 223 { # A client user is created under a client buyer and has restricted access to 224 # the Ad Exchange Marketplace and certain other sections 225 # of the Ad Exchange Buyer UI based on the role 226 # granted to the associated client buyer. 227 # 228 # The only way a new client user can be created is via accepting an 229 # email invitation 230 # (see the 231 # accounts.clients.invitations.create 232 # method). 233 # 234 # All fields are required unless otherwise specified. 235 "status": "A String", # The status of the client user. 236 "clientAccountId": "A String", # Numerical account ID of the client buyer 237 # with which the user is associated; the 238 # buyer must be a client of the current sponsor buyer. 239 # The value of this field is ignored in an update operation. 240 "userId": "A String", # The unique numerical ID of the client user 241 # that has accepted an invitation. 242 # The value of this field is ignored in an update operation. 243 "email": "A String", # User's email address. The value of this field 244 # is ignored in an update operation. 245 } 246 247 x__xgafv: string, V1 error format. 248 Allowed values 249 1 - v1 error format 250 2 - v2 error format 251 252 Returns: 253 An object of the form: 254 255 { # A client user is created under a client buyer and has restricted access to 256 # the Ad Exchange Marketplace and certain other sections 257 # of the Ad Exchange Buyer UI based on the role 258 # granted to the associated client buyer. 259 # 260 # The only way a new client user can be created is via accepting an 261 # email invitation 262 # (see the 263 # accounts.clients.invitations.create 264 # method). 265 # 266 # All fields are required unless otherwise specified. 267 "status": "A String", # The status of the client user. 268 "clientAccountId": "A String", # Numerical account ID of the client buyer 269 # with which the user is associated; the 270 # buyer must be a client of the current sponsor buyer. 271 # The value of this field is ignored in an update operation. 272 "userId": "A String", # The unique numerical ID of the client user 273 # that has accepted an invitation. 274 # The value of this field is ignored in an update operation. 275 "email": "A String", # User's email address. The value of this field 276 # is ignored in an update operation. 277 }</pre> 278 </div> 279 280 </body></html>
