1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="dfareporting_v3_3.html">Campaign Manager 360 API</a> . <a href="dfareporting_v3_3.subaccounts.html">subaccounts</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 subaccount 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 subaccount.</p> 86<p class="toc_element"> 87 <code><a href="#list">list(profileId, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Gets a list of subaccounts, possibly filtered. This method supports paging.</p> 89<p class="toc_element"> 90 <code><a href="#list_next">list_next(previous_request, previous_response)</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 subaccount. 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 subaccount.</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 subaccount by ID. 107 108Args: 109 profileId: string, User profile ID associated with this request. (required) 110 id: string, Subaccount ID. (required) 111 x__xgafv: string, V1 error format. 112 Allowed values 113 1 - v1 error format 114 2 - v2 error format 115 116Returns: 117 An object of the form: 118 119 { # Contains properties of a Campaign Manager subaccount. 120 "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank. 121 "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount. 122 "A String", 123 ], 124 "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field. 125 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount". 126 "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account. 127}</pre> 128</div> 129 130<div class="method"> 131 <code class="details" id="insert">insert(profileId, body=None, x__xgafv=None)</code> 132 <pre>Inserts a new subaccount. 133 134Args: 135 profileId: string, User profile ID associated with this request. (required) 136 body: object, The request body. 137 The object takes the form of: 138 139{ # Contains properties of a Campaign Manager subaccount. 140 "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank. 141 "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount. 142 "A String", 143 ], 144 "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field. 145 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount". 146 "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account. 147} 148 149 x__xgafv: string, V1 error format. 150 Allowed values 151 1 - v1 error format 152 2 - v2 error format 153 154Returns: 155 An object of the form: 156 157 { # Contains properties of a Campaign Manager subaccount. 158 "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank. 159 "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount. 160 "A String", 161 ], 162 "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field. 163 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount". 164 "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account. 165}</pre> 166</div> 167 168<div class="method"> 169 <code class="details" id="list">list(profileId, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, x__xgafv=None)</code> 170 <pre>Gets a list of subaccounts, possibly filtered. This method supports paging. 171 172Args: 173 profileId: string, User profile ID associated with this request. (required) 174 ids: string, Select only subaccounts with these IDs. (repeated) 175 maxResults: integer, Maximum number of results to return. 176 pageToken: string, Value of the nextPageToken from the previous result page. 177 searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "subaccount*2015" will return objects with names like "subaccount June 2015", "subaccount April 2015", or simply "subaccount 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 "subaccount" will match objects with name "my subaccount", "subaccount 2015", or simply "subaccount" . 178 sortField: string, Field by which to sort the list. 179 Allowed values 180 ID - 181 NAME - 182 sortOrder: string, Order of sorted results. 183 Allowed values 184 ASCENDING - 185 DESCENDING - 186 x__xgafv: string, V1 error format. 187 Allowed values 188 1 - v1 error format 189 2 - v2 error format 190 191Returns: 192 An object of the form: 193 194 { # Subaccount List Response 195 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccountsListResponse". 196 "nextPageToken": "A String", # Pagination token to be used for the next list operation. 197 "subaccounts": [ # Subaccount collection. 198 { # Contains properties of a Campaign Manager subaccount. 199 "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank. 200 "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount. 201 "A String", 202 ], 203 "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field. 204 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount". 205 "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account. 206 }, 207 ], 208}</pre> 209</div> 210 211<div class="method"> 212 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 213 <pre>Retrieves the next page of results. 214 215Args: 216 previous_request: The request for the previous page. (required) 217 previous_response: The response from the request for the previous page. (required) 218 219Returns: 220 A request object that you can call 'execute()' on to request the next 221 page. Returns None if there are no more items in the collection. 222 </pre> 223</div> 224 225<div class="method"> 226 <code class="details" id="patch">patch(profileId, id, body=None, x__xgafv=None)</code> 227 <pre>Updates an existing subaccount. This method supports patch semantics. 228 229Args: 230 profileId: string, User profile ID associated with this request. (required) 231 id: string, Subaccount ID. (required) 232 body: object, The request body. 233 The object takes the form of: 234 235{ # Contains properties of a Campaign Manager subaccount. 236 "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank. 237 "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount. 238 "A String", 239 ], 240 "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field. 241 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount". 242 "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account. 243} 244 245 x__xgafv: string, V1 error format. 246 Allowed values 247 1 - v1 error format 248 2 - v2 error format 249 250Returns: 251 An object of the form: 252 253 { # Contains properties of a Campaign Manager subaccount. 254 "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank. 255 "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount. 256 "A String", 257 ], 258 "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field. 259 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount". 260 "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account. 261}</pre> 262</div> 263 264<div class="method"> 265 <code class="details" id="update">update(profileId, body=None, x__xgafv=None)</code> 266 <pre>Updates an existing subaccount. 267 268Args: 269 profileId: string, User profile ID associated with this request. (required) 270 body: object, The request body. 271 The object takes the form of: 272 273{ # Contains properties of a Campaign Manager subaccount. 274 "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank. 275 "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount. 276 "A String", 277 ], 278 "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field. 279 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount". 280 "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account. 281} 282 283 x__xgafv: string, V1 error format. 284 Allowed values 285 1 - v1 error format 286 2 - v2 error format 287 288Returns: 289 An object of the form: 290 291 { # Contains properties of a Campaign Manager subaccount. 292 "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank. 293 "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount. 294 "A String", 295 ], 296 "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field. 297 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount". 298 "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account. 299}</pre> 300</div> 301 302</body></html>