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_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v3_1.subaccounts.html">subaccounts</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 subaccount 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 subaccount.</p> 83<p class="toc_element"> 84 <code><a href="#list">list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)</a></code></p> 85<p class="firstline">Gets a list of subaccounts, 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 subaccount. 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 subaccount.</p> 95<h3>Method Details</h3> 96<div class="method"> 97 <code class="details" id="get">get(profileId, id)</code> 98 <pre>Gets one subaccount by ID. 99 100Args: 101 profileId: string, User profile ID associated with this request. (required) 102 id: string, Subaccount ID. (required) 103 104Returns: 105 An object of the form: 106 107 { # Contains properties of a Campaign Manager subaccount. 108 "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount". 109 "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount. 110 "A String", 111 ], 112 "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field. 113 "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. 114 "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank. 115 }</pre> 116</div> 117 118<div class="method"> 119 <code class="details" id="insert">insert(profileId, body)</code> 120 <pre>Inserts a new subaccount. 121 122Args: 123 profileId: string, User profile ID associated with this request. (required) 124 body: object, The request body. (required) 125 The object takes the form of: 126 127{ # Contains properties of a Campaign Manager subaccount. 128 "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount". 129 "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount. 130 "A String", 131 ], 132 "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field. 133 "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. 134 "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank. 135 } 136 137 138Returns: 139 An object of the form: 140 141 { # Contains properties of a Campaign Manager subaccount. 142 "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount". 143 "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount. 144 "A String", 145 ], 146 "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field. 147 "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. 148 "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank. 149 }</pre> 150</div> 151 152<div class="method"> 153 <code class="details" id="list">list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)</code> 154 <pre>Gets a list of subaccounts, possibly filtered. This method supports paging. 155 156Args: 157 profileId: string, User profile ID associated with this request. (required) 158 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". 159 pageToken: string, Value of the nextPageToken from the previous result page. 160 sortField: string, Field by which to sort the list. 161 Allowed values 162 ID - 163 NAME - 164 ids: string, Select only subaccounts with these IDs. (repeated) 165 maxResults: integer, Maximum number of results to return. 166 sortOrder: string, Order of sorted results. 167 Allowed values 168 ASCENDING - 169 DESCENDING - 170 171Returns: 172 An object of the form: 173 174 { # Subaccount List Response 175 "nextPageToken": "A String", # Pagination token to be used for the next list operation. 176 "kind": "dfareporting#subaccountsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccountsListResponse". 177 "subaccounts": [ # Subaccount collection. 178 { # Contains properties of a Campaign Manager subaccount. 179 "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount". 180 "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount. 181 "A String", 182 ], 183 "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field. 184 "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. 185 "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank. 186 }, 187 ], 188 }</pre> 189</div> 190 191<div class="method"> 192 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 193 <pre>Retrieves the next page of results. 194 195Args: 196 previous_request: The request for the previous page. (required) 197 previous_response: The response from the request for the previous page. (required) 198 199Returns: 200 A request object that you can call 'execute()' on to request the next 201 page. Returns None if there are no more items in the collection. 202 </pre> 203</div> 204 205<div class="method"> 206 <code class="details" id="patch">patch(profileId, id, body)</code> 207 <pre>Updates an existing subaccount. This method supports patch semantics. 208 209Args: 210 profileId: string, User profile ID associated with this request. (required) 211 id: string, Subaccount ID. (required) 212 body: object, The request body. (required) 213 The object takes the form of: 214 215{ # Contains properties of a Campaign Manager subaccount. 216 "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount". 217 "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount. 218 "A String", 219 ], 220 "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field. 221 "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. 222 "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank. 223 } 224 225 226Returns: 227 An object of the form: 228 229 { # Contains properties of a Campaign Manager subaccount. 230 "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount". 231 "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount. 232 "A String", 233 ], 234 "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field. 235 "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. 236 "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank. 237 }</pre> 238</div> 239 240<div class="method"> 241 <code class="details" id="update">update(profileId, body)</code> 242 <pre>Updates an existing subaccount. 243 244Args: 245 profileId: string, User profile ID associated with this request. (required) 246 body: object, The request body. (required) 247 The object takes the form of: 248 249{ # Contains properties of a Campaign Manager subaccount. 250 "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount". 251 "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount. 252 "A String", 253 ], 254 "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field. 255 "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. 256 "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank. 257 } 258 259 260Returns: 261 An object of the form: 262 263 { # Contains properties of a Campaign Manager subaccount. 264 "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount". 265 "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount. 266 "A String", 267 ], 268 "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field. 269 "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. 270 "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank. 271 }</pre> 272</div> 273 274</body></html>