Home | History | Annotate | Download | only in dyn 
      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_v2_7.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_7.accountUserProfiles.html">accountUserProfiles</a></h1>
     76 <h2>Instance Methods</h2>
     77 <p class="toc_element">
     78   <code><a href="#get">get(profileId, id)</a></code></p>
     79 <p class="firstline">Gets one account user profile by ID.</p>
     80 <p class="toc_element">
     81   <code><a href="#insert">insert(profileId, body)</a></code></p>
     82 <p class="firstline">Inserts a new account user profile.</p>
     83 <p class="toc_element">
     84   <code><a href="#list">list(profileId, searchString=None, subaccountId=None, sortField=None, ids=None, maxResults=None, pageToken=None, sortOrder=None, userRoleId=None, active=None)</a></code></p>
     85 <p class="firstline">Retrieves a list of account user profiles, possibly filtered. This method supports paging.</p>
     86 <p class="toc_element">
     87   <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
     88 <p class="firstline">Retrieves the next page of results.</p>
     89 <p class="toc_element">
     90   <code><a href="#patch">patch(profileId, id, body)</a></code></p>
     91 <p class="firstline">Updates an existing account user profile. This method supports patch semantics.</p>
     92 <p class="toc_element">
     93   <code><a href="#update">update(profileId, body)</a></code></p>
     94 <p class="firstline">Updates an existing account user profile.</p>
     95 <h3>Method Details</h3>
     96 <div class="method">
     97     <code class="details" id="get">get(profileId, id)</code>
     98   <pre>Gets one account user profile by ID.
     99 
    100 Args:
    101   profileId: string, User profile ID associated with this request. (required)
    102   id: string, User profile ID. (required)
    103 
    104 Returns:
    105   An object of the form:
    106 
    107     { # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
    108       "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
    109       "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
    110       "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: "&;"#%,".
    111       "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
    112         "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
    113           "A String",
    114         ],
    115         "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.
    116         "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    117       },
    118       "locale": "A String", # Locale of the user profile. This is a required field.
    119           # Acceptable values are:
    120           # - "cs" (Czech)
    121           # - "de" (German)
    122           # - "en" (English)
    123           # - "en-GB" (English United Kingdom)
    124           # - "es" (Spanish)
    125           # - "fr" (French)
    126           # - "it" (Italian)
    127           # - "ja" (Japanese)
    128           # - "ko" (Korean)
    129           # - "pl" (Polish)
    130           # - "pt-BR" (Portuguese Brazil)
    131           # - "ru" (Russian)
    132           # - "sv" (Swedish)
    133           # - "tr" (Turkish)
    134           # - "zh-CN" (Chinese Simplified)
    135           # - "zh-TW" (Chinese Traditional)
    136       "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
    137         "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
    138           "A String",
    139         ],
    140         "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.
    141         "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    142       },
    143       "comments": "A String", # Comments for this user profile.
    144       "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
    145       "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
    146         "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
    147           "A String",
    148         ],
    149         "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.
    150         "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    151       },
    152       "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
    153         "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
    154           "A String",
    155         ],
    156         "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.
    157         "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    158       },
    159       "userRoleId": "A String", # User role ID of the user profile. This is a required field.
    160       "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
    161       "traffickerType": "A String", # Trafficker type of this user profile.
    162       "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.
    163       "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.
    164       "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
    165     }</pre>
    166 </div>
    167 
    168 <div class="method">
    169     <code class="details" id="insert">insert(profileId, body)</code>
    170   <pre>Inserts a new account user profile.
    171 
    172 Args:
    173   profileId: string, User profile ID associated with this request. (required)
    174   body: object, The request body. (required)
    175     The object takes the form of:
    176 
    177 { # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
    178     "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
    179     "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
    180     "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: "&;"#%,".
    181     "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
    182       "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
    183         "A String",
    184       ],
    185       "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.
    186       "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    187     },
    188     "locale": "A String", # Locale of the user profile. This is a required field.
    189         # Acceptable values are:
    190         # - "cs" (Czech)
    191         # - "de" (German)
    192         # - "en" (English)
    193         # - "en-GB" (English United Kingdom)
    194         # - "es" (Spanish)
    195         # - "fr" (French)
    196         # - "it" (Italian)
    197         # - "ja" (Japanese)
    198         # - "ko" (Korean)
    199         # - "pl" (Polish)
    200         # - "pt-BR" (Portuguese Brazil)
    201         # - "ru" (Russian)
    202         # - "sv" (Swedish)
    203         # - "tr" (Turkish)
    204         # - "zh-CN" (Chinese Simplified)
    205         # - "zh-TW" (Chinese Traditional)
    206     "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
    207       "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
    208         "A String",
    209       ],
    210       "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.
    211       "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    212     },
    213     "comments": "A String", # Comments for this user profile.
    214     "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
    215     "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
    216       "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
    217         "A String",
    218       ],
    219       "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.
    220       "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    221     },
    222     "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
    223       "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
    224         "A String",
    225       ],
    226       "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.
    227       "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    228     },
    229     "userRoleId": "A String", # User role ID of the user profile. This is a required field.
    230     "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
    231     "traffickerType": "A String", # Trafficker type of this user profile.
    232     "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.
    233     "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.
    234     "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
    235   }
    236 
    237 
    238 Returns:
    239   An object of the form:
    240 
    241     { # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
    242       "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
    243       "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
    244       "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: "&;"#%,".
    245       "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
    246         "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
    247           "A String",
    248         ],
    249         "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.
    250         "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    251       },
    252       "locale": "A String", # Locale of the user profile. This is a required field.
    253           # Acceptable values are:
    254           # - "cs" (Czech)
    255           # - "de" (German)
    256           # - "en" (English)
    257           # - "en-GB" (English United Kingdom)
    258           # - "es" (Spanish)
    259           # - "fr" (French)
    260           # - "it" (Italian)
    261           # - "ja" (Japanese)
    262           # - "ko" (Korean)
    263           # - "pl" (Polish)
    264           # - "pt-BR" (Portuguese Brazil)
    265           # - "ru" (Russian)
    266           # - "sv" (Swedish)
    267           # - "tr" (Turkish)
    268           # - "zh-CN" (Chinese Simplified)
    269           # - "zh-TW" (Chinese Traditional)
    270       "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
    271         "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
    272           "A String",
    273         ],
    274         "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.
    275         "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    276       },
    277       "comments": "A String", # Comments for this user profile.
    278       "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
    279       "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
    280         "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
    281           "A String",
    282         ],
    283         "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.
    284         "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    285       },
    286       "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
    287         "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
    288           "A String",
    289         ],
    290         "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.
    291         "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    292       },
    293       "userRoleId": "A String", # User role ID of the user profile. This is a required field.
    294       "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
    295       "traffickerType": "A String", # Trafficker type of this user profile.
    296       "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.
    297       "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.
    298       "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
    299     }</pre>
    300 </div>
    301 
    302 <div class="method">
    303     <code class="details" id="list">list(profileId, searchString=None, subaccountId=None, sortField=None, ids=None, maxResults=None, pageToken=None, sortOrder=None, userRoleId=None, active=None)</code>
    304   <pre>Retrieves a list of account user profiles, possibly filtered. This method supports paging.
    305 
    306 Args:
    307   profileId: string, User profile ID associated with this request. (required)
    308   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".
    309   subaccountId: string, Select only user profiles with the specified subaccount ID.
    310   sortField: string, Field by which to sort the list.
    311     Allowed values
    312       ID - 
    313       NAME - 
    314   ids: string, Select only user profiles with these IDs. (repeated)
    315   maxResults: integer, Maximum number of results to return.
    316   pageToken: string, Value of the nextPageToken from the previous result page.
    317   sortOrder: string, Order of sorted results.
    318     Allowed values
    319       ASCENDING - 
    320       DESCENDING - 
    321   userRoleId: string, Select only user profiles with the specified user role ID.
    322   active: boolean, Select only active user profiles.
    323 
    324 Returns:
    325   An object of the form:
    326 
    327     { # Account User Profile List Response
    328     "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    329     "accountUserProfiles": [ # Account user profile collection.
    330       { # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
    331           "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
    332           "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
    333           "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: "&;"#%,".
    334           "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
    335             "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
    336               "A String",
    337             ],
    338             "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.
    339             "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    340           },
    341           "locale": "A String", # Locale of the user profile. This is a required field.
    342               # Acceptable values are:
    343               # - "cs" (Czech)
    344               # - "de" (German)
    345               # - "en" (English)
    346               # - "en-GB" (English United Kingdom)
    347               # - "es" (Spanish)
    348               # - "fr" (French)
    349               # - "it" (Italian)
    350               # - "ja" (Japanese)
    351               # - "ko" (Korean)
    352               # - "pl" (Polish)
    353               # - "pt-BR" (Portuguese Brazil)
    354               # - "ru" (Russian)
    355               # - "sv" (Swedish)
    356               # - "tr" (Turkish)
    357               # - "zh-CN" (Chinese Simplified)
    358               # - "zh-TW" (Chinese Traditional)
    359           "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
    360             "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
    361               "A String",
    362             ],
    363             "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.
    364             "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    365           },
    366           "comments": "A String", # Comments for this user profile.
    367           "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
    368           "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
    369             "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
    370               "A String",
    371             ],
    372             "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.
    373             "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    374           },
    375           "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
    376             "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
    377               "A String",
    378             ],
    379             "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.
    380             "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    381           },
    382           "userRoleId": "A String", # User role ID of the user profile. This is a required field.
    383           "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
    384           "traffickerType": "A String", # Trafficker type of this user profile.
    385           "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.
    386           "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.
    387           "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
    388         },
    389     ],
    390     "kind": "dfareporting#accountUserProfilesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfilesListResponse".
    391   }</pre>
    392 </div>
    393 
    394 <div class="method">
    395     <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
    396   <pre>Retrieves the next page of results.
    397 
    398 Args:
    399   previous_request: The request for the previous page. (required)
    400   previous_response: The response from the request for the previous page. (required)
    401 
    402 Returns:
    403   A request object that you can call 'execute()' on to request the next
    404   page. Returns None if there are no more items in the collection.
    405     </pre>
    406 </div>
    407 
    408 <div class="method">
    409     <code class="details" id="patch">patch(profileId, id, body)</code>
    410   <pre>Updates an existing account user profile. This method supports patch semantics.
    411 
    412 Args:
    413   profileId: string, User profile ID associated with this request. (required)
    414   id: string, User profile ID. (required)
    415   body: object, The request body. (required)
    416     The object takes the form of:
    417 
    418 { # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
    419     "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
    420     "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
    421     "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: "&;"#%,".
    422     "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
    423       "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
    424         "A String",
    425       ],
    426       "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.
    427       "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    428     },
    429     "locale": "A String", # Locale of the user profile. This is a required field.
    430         # Acceptable values are:
    431         # - "cs" (Czech)
    432         # - "de" (German)
    433         # - "en" (English)
    434         # - "en-GB" (English United Kingdom)
    435         # - "es" (Spanish)
    436         # - "fr" (French)
    437         # - "it" (Italian)
    438         # - "ja" (Japanese)
    439         # - "ko" (Korean)
    440         # - "pl" (Polish)
    441         # - "pt-BR" (Portuguese Brazil)
    442         # - "ru" (Russian)
    443         # - "sv" (Swedish)
    444         # - "tr" (Turkish)
    445         # - "zh-CN" (Chinese Simplified)
    446         # - "zh-TW" (Chinese Traditional)
    447     "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
    448       "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
    449         "A String",
    450       ],
    451       "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.
    452       "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    453     },
    454     "comments": "A String", # Comments for this user profile.
    455     "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
    456     "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
    457       "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
    458         "A String",
    459       ],
    460       "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.
    461       "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    462     },
    463     "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
    464       "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
    465         "A String",
    466       ],
    467       "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.
    468       "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    469     },
    470     "userRoleId": "A String", # User role ID of the user profile. This is a required field.
    471     "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
    472     "traffickerType": "A String", # Trafficker type of this user profile.
    473     "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.
    474     "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.
    475     "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
    476   }
    477 
    478 
    479 Returns:
    480   An object of the form:
    481 
    482     { # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
    483       "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
    484       "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
    485       "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: "&;"#%,".
    486       "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
    487         "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
    488           "A String",
    489         ],
    490         "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.
    491         "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    492       },
    493       "locale": "A String", # Locale of the user profile. This is a required field.
    494           # Acceptable values are:
    495           # - "cs" (Czech)
    496           # - "de" (German)
    497           # - "en" (English)
    498           # - "en-GB" (English United Kingdom)
    499           # - "es" (Spanish)
    500           # - "fr" (French)
    501           # - "it" (Italian)
    502           # - "ja" (Japanese)
    503           # - "ko" (Korean)
    504           # - "pl" (Polish)
    505           # - "pt-BR" (Portuguese Brazil)
    506           # - "ru" (Russian)
    507           # - "sv" (Swedish)
    508           # - "tr" (Turkish)
    509           # - "zh-CN" (Chinese Simplified)
    510           # - "zh-TW" (Chinese Traditional)
    511       "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
    512         "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
    513           "A String",
    514         ],
    515         "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.
    516         "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    517       },
    518       "comments": "A String", # Comments for this user profile.
    519       "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
    520       "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
    521         "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
    522           "A String",
    523         ],
    524         "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.
    525         "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    526       },
    527       "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
    528         "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
    529           "A String",
    530         ],
    531         "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.
    532         "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    533       },
    534       "userRoleId": "A String", # User role ID of the user profile. This is a required field.
    535       "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
    536       "traffickerType": "A String", # Trafficker type of this user profile.
    537       "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.
    538       "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.
    539       "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
    540     }</pre>
    541 </div>
    542 
    543 <div class="method">
    544     <code class="details" id="update">update(profileId, body)</code>
    545   <pre>Updates an existing account user profile.
    546 
    547 Args:
    548   profileId: string, User profile ID associated with this request. (required)
    549   body: object, The request body. (required)
    550     The object takes the form of:
    551 
    552 { # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
    553     "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
    554     "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
    555     "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: "&;"#%,".
    556     "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
    557       "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
    558         "A String",
    559       ],
    560       "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.
    561       "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    562     },
    563     "locale": "A String", # Locale of the user profile. This is a required field.
    564         # Acceptable values are:
    565         # - "cs" (Czech)
    566         # - "de" (German)
    567         # - "en" (English)
    568         # - "en-GB" (English United Kingdom)
    569         # - "es" (Spanish)
    570         # - "fr" (French)
    571         # - "it" (Italian)
    572         # - "ja" (Japanese)
    573         # - "ko" (Korean)
    574         # - "pl" (Polish)
    575         # - "pt-BR" (Portuguese Brazil)
    576         # - "ru" (Russian)
    577         # - "sv" (Swedish)
    578         # - "tr" (Turkish)
    579         # - "zh-CN" (Chinese Simplified)
    580         # - "zh-TW" (Chinese Traditional)
    581     "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
    582       "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
    583         "A String",
    584       ],
    585       "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.
    586       "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    587     },
    588     "comments": "A String", # Comments for this user profile.
    589     "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
    590     "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
    591       "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
    592         "A String",
    593       ],
    594       "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.
    595       "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    596     },
    597     "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
    598       "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
    599         "A String",
    600       ],
    601       "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.
    602       "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    603     },
    604     "userRoleId": "A String", # User role ID of the user profile. This is a required field.
    605     "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
    606     "traffickerType": "A String", # Trafficker type of this user profile.
    607     "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.
    608     "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.
    609     "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
    610   }
    611 
    612 
    613 Returns:
    614   An object of the form:
    615 
    616     { # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
    617       "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
    618       "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
    619       "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: "&;"#%,".
    620       "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
    621         "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
    622           "A String",
    623         ],
    624         "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.
    625         "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    626       },
    627       "locale": "A String", # Locale of the user profile. This is a required field.
    628           # Acceptable values are:
    629           # - "cs" (Czech)
    630           # - "de" (German)
    631           # - "en" (English)
    632           # - "en-GB" (English United Kingdom)
    633           # - "es" (Spanish)
    634           # - "fr" (French)
    635           # - "it" (Italian)
    636           # - "ja" (Japanese)
    637           # - "ko" (Korean)
    638           # - "pl" (Polish)
    639           # - "pt-BR" (Portuguese Brazil)
    640           # - "ru" (Russian)
    641           # - "sv" (Swedish)
    642           # - "tr" (Turkish)
    643           # - "zh-CN" (Chinese Simplified)
    644           # - "zh-TW" (Chinese Traditional)
    645       "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
    646         "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
    647           "A String",
    648         ],
    649         "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.
    650         "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    651       },
    652       "comments": "A String", # Comments for this user profile.
    653       "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
    654       "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
    655         "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
    656           "A String",
    657         ],
    658         "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.
    659         "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    660       },
    661       "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
    662         "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
    663           "A String",
    664         ],
    665         "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.
    666         "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    667       },
    668       "userRoleId": "A String", # User role ID of the user profile. This is a required field.
    669       "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
    670       "traffickerType": "A String", # Trafficker type of this user profile.
    671       "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.
    672       "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.
    673       "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
    674     }</pre>
    675 </div>
    676 
    677 </body></html>