1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
|
<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="dfareporting_v3_5.html">Campaign Manager 360 API</a> . <a href="dfareporting_v3_5.accountUserProfiles.html">accountUserProfiles</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#get">get(profileId, id, x__xgafv=None)</a></code></p>
<p class="firstline">Gets one account user profile by ID.</p>
<p class="toc_element">
<code><a href="#insert">insert(profileId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Inserts a new account user profile.</p>
<p class="toc_element">
<code><a href="#list">list(profileId, active=None, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, subaccountId=None, userRoleId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a list of account user profiles, possibly filtered. This method supports paging.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(profileId, id, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing account user profile. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#update">update(profileId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing account user profile.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(profileId, id, x__xgafv=None)</code>
<pre>Gets one account user profile by ID.
Args:
profileId: string, User profile ID associated with this request. (required)
id: string, User profile ID. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # AccountUserProfiles contains properties of a Campaign Manager user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
"accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
"active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
"advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
"objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
"A String",
],
"status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
},
"campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
"objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
"A String",
],
"status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
},
"comments": "A String", # Comments for this user profile.
"email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
"id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
"locale": "A String", # Locale of the user profile. This is a required field. Acceptable values are: - "cs" (Czech) - "de" (German) - "en" (English) - "en-GB" (English United Kingdom) - "es" (Spanish) - "fr" (French) - "it" (Italian) - "ja" (Japanese) - "ko" (Korean) - "pl" (Polish) - "pt-BR" (Portuguese Brazil) - "ru" (Russian) - "sv" (Swedish) - "tr" (Turkish) - "zh-CN" (Chinese Simplified) - "zh-TW" (Chinese Traditional)
"name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;<>"#%,".
"siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
"objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
"A String",
],
"status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
},
"subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
"traffickerType": "A String", # Trafficker type of this user profile. This is a read-only field.
"userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
"userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
"objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
"A String",
],
"status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
},
"userRoleId": "A String", # User role ID of the user profile. This is a required field.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(profileId, body=None, x__xgafv=None)</code>
<pre>Inserts a new account user profile.
Args:
profileId: string, User profile ID associated with this request. (required)
body: object, The request body.
The object takes the form of:
{ # AccountUserProfiles contains properties of a Campaign Manager user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
"accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
"active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
"advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
"objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
"A String",
],
"status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
},
"campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
"objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
"A String",
],
"status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
},
"comments": "A String", # Comments for this user profile.
"email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
"id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
"locale": "A String", # Locale of the user profile. This is a required field. Acceptable values are: - "cs" (Czech) - "de" (German) - "en" (English) - "en-GB" (English United Kingdom) - "es" (Spanish) - "fr" (French) - "it" (Italian) - "ja" (Japanese) - "ko" (Korean) - "pl" (Polish) - "pt-BR" (Portuguese Brazil) - "ru" (Russian) - "sv" (Swedish) - "tr" (Turkish) - "zh-CN" (Chinese Simplified) - "zh-TW" (Chinese Traditional)
"name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;<>"#%,".
"siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
"objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
"A String",
],
"status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
},
"subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
"traffickerType": "A String", # Trafficker type of this user profile. This is a read-only field.
"userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
"userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
"objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
"A String",
],
"status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
},
"userRoleId": "A String", # User role ID of the user profile. This is a required field.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # AccountUserProfiles contains properties of a Campaign Manager user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
"accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
"active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
"advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
"objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
"A String",
],
"status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
},
"campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
"objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
"A String",
],
"status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
},
"comments": "A String", # Comments for this user profile.
"email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
"id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
"locale": "A String", # Locale of the user profile. This is a required field. Acceptable values are: - "cs" (Czech) - "de" (German) - "en" (English) - "en-GB" (English United Kingdom) - "es" (Spanish) - "fr" (French) - "it" (Italian) - "ja" (Japanese) - "ko" (Korean) - "pl" (Polish) - "pt-BR" (Portuguese Brazil) - "ru" (Russian) - "sv" (Swedish) - "tr" (Turkish) - "zh-CN" (Chinese Simplified) - "zh-TW" (Chinese Traditional)
"name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;<>"#%,".
"siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
"objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
"A String",
],
"status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
},
"subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
"traffickerType": "A String", # Trafficker type of this user profile. This is a read-only field.
"userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
"userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
"objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
"A String",
],
"status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
},
"userRoleId": "A String", # User role ID of the user profile. This is a required field.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(profileId, active=None, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, subaccountId=None, userRoleId=None, x__xgafv=None)</code>
<pre>Retrieves a list of account user profiles, possibly filtered. This method supports paging.
Args:
profileId: string, User profile ID associated with this request. (required)
active: boolean, Select only active user profiles.
ids: string, Select only user profiles with these IDs. (repeated)
maxResults: integer, Maximum number of results to return.
pageToken: string, Value of the nextPageToken from the previous result page.
searchString: string, Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, "user profile*2015" will return objects with names like "user profile June 2015", "user profile April 2015", or simply "user profile 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "user profile" will match objects with name "my user profile", "user profile 2015", or simply "user profile".
sortField: string, Field by which to sort the list.
Allowed values
ID -
NAME -
sortOrder: string, Order of sorted results.
Allowed values
ASCENDING -
DESCENDING -
subaccountId: string, Select only user profiles with the specified subaccount ID.
userRoleId: string, Select only user profiles with the specified user role ID.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Account User Profile List Response
"accountUserProfiles": [ # Account user profile collection.
{ # AccountUserProfiles contains properties of a Campaign Manager user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
"accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
"active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
"advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
"objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
"A String",
],
"status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
},
"campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
"objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
"A String",
],
"status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
},
"comments": "A String", # Comments for this user profile.
"email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
"id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
"locale": "A String", # Locale of the user profile. This is a required field. Acceptable values are: - "cs" (Czech) - "de" (German) - "en" (English) - "en-GB" (English United Kingdom) - "es" (Spanish) - "fr" (French) - "it" (Italian) - "ja" (Japanese) - "ko" (Korean) - "pl" (Polish) - "pt-BR" (Portuguese Brazil) - "ru" (Russian) - "sv" (Swedish) - "tr" (Turkish) - "zh-CN" (Chinese Simplified) - "zh-TW" (Chinese Traditional)
"name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;<>"#%,".
"siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
"objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
"A String",
],
"status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
},
"subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
"traffickerType": "A String", # Trafficker type of this user profile. This is a read-only field.
"userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
"userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
"objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
"A String",
],
"status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
},
"userRoleId": "A String", # User role ID of the user profile. This is a required field.
},
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfilesListResponse".
"nextPageToken": "A String", # Pagination token to be used for the next list operation.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</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="patch">patch(profileId, id, body=None, x__xgafv=None)</code>
<pre>Updates an existing account user profile. This method supports patch semantics.
Args:
profileId: string, User profile ID associated with this request. (required)
id: string, AccountUserProfile ID. (required)
body: object, The request body.
The object takes the form of:
{ # AccountUserProfiles contains properties of a Campaign Manager user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
"accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
"active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
"advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
"objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
"A String",
],
"status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
},
"campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
"objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
"A String",
],
"status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
},
"comments": "A String", # Comments for this user profile.
"email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
"id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
"locale": "A String", # Locale of the user profile. This is a required field. Acceptable values are: - "cs" (Czech) - "de" (German) - "en" (English) - "en-GB" (English United Kingdom) - "es" (Spanish) - "fr" (French) - "it" (Italian) - "ja" (Japanese) - "ko" (Korean) - "pl" (Polish) - "pt-BR" (Portuguese Brazil) - "ru" (Russian) - "sv" (Swedish) - "tr" (Turkish) - "zh-CN" (Chinese Simplified) - "zh-TW" (Chinese Traditional)
"name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;<>"#%,".
"siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
"objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
"A String",
],
"status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
},
"subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
"traffickerType": "A String", # Trafficker type of this user profile. This is a read-only field.
"userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
"userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
"objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
"A String",
],
"status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
},
"userRoleId": "A String", # User role ID of the user profile. This is a required field.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # AccountUserProfiles contains properties of a Campaign Manager user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
"accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
"active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
"advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
"objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
"A String",
],
"status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
},
"campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
"objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
"A String",
],
"status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
},
"comments": "A String", # Comments for this user profile.
"email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
"id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
"locale": "A String", # Locale of the user profile. This is a required field. Acceptable values are: - "cs" (Czech) - "de" (German) - "en" (English) - "en-GB" (English United Kingdom) - "es" (Spanish) - "fr" (French) - "it" (Italian) - "ja" (Japanese) - "ko" (Korean) - "pl" (Polish) - "pt-BR" (Portuguese Brazil) - "ru" (Russian) - "sv" (Swedish) - "tr" (Turkish) - "zh-CN" (Chinese Simplified) - "zh-TW" (Chinese Traditional)
"name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;<>"#%,".
"siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
"objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
"A String",
],
"status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
},
"subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
"traffickerType": "A String", # Trafficker type of this user profile. This is a read-only field.
"userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
"userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
"objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
"A String",
],
"status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
},
"userRoleId": "A String", # User role ID of the user profile. This is a required field.
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(profileId, body=None, x__xgafv=None)</code>
<pre>Updates an existing account user profile.
Args:
profileId: string, User profile ID associated with this request. (required)
body: object, The request body.
The object takes the form of:
{ # AccountUserProfiles contains properties of a Campaign Manager user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
"accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
"active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
"advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
"objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
"A String",
],
"status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
},
"campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
"objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
"A String",
],
"status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
},
"comments": "A String", # Comments for this user profile.
"email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
"id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
"locale": "A String", # Locale of the user profile. This is a required field. Acceptable values are: - "cs" (Czech) - "de" (German) - "en" (English) - "en-GB" (English United Kingdom) - "es" (Spanish) - "fr" (French) - "it" (Italian) - "ja" (Japanese) - "ko" (Korean) - "pl" (Polish) - "pt-BR" (Portuguese Brazil) - "ru" (Russian) - "sv" (Swedish) - "tr" (Turkish) - "zh-CN" (Chinese Simplified) - "zh-TW" (Chinese Traditional)
"name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;<>"#%,".
"siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
"objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
"A String",
],
"status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
},
"subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
"traffickerType": "A String", # Trafficker type of this user profile. This is a read-only field.
"userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
"userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
"objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
"A String",
],
"status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
},
"userRoleId": "A String", # User role ID of the user profile. This is a required field.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # AccountUserProfiles contains properties of a Campaign Manager user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
"accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
"active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
"advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
"objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
"A String",
],
"status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
},
"campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
"objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
"A String",
],
"status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
},
"comments": "A String", # Comments for this user profile.
"email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
"id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
"locale": "A String", # Locale of the user profile. This is a required field. Acceptable values are: - "cs" (Czech) - "de" (German) - "en" (English) - "en-GB" (English United Kingdom) - "es" (Spanish) - "fr" (French) - "it" (Italian) - "ja" (Japanese) - "ko" (Korean) - "pl" (Polish) - "pt-BR" (Portuguese Brazil) - "ru" (Russian) - "sv" (Swedish) - "tr" (Turkish) - "zh-CN" (Chinese Simplified) - "zh-TW" (Chinese Traditional)
"name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;<>"#%,".
"siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
"objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
"A String",
],
"status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
},
"subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
"traffickerType": "A String", # Trafficker type of this user profile. This is a read-only field.
"userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
"userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
"objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
"A String",
],
"status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
},
"userRoleId": "A String", # User role ID of the user profile. This is a required field.
}</pre>
</div>
</body></html>
|
