Debian Codegraph @

docs/dyn/dfareporting_v5.accountUserProfiles.html

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