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.advertiserGroups.html">advertiserGroups</a></h1> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="#delete">delete(profileId, id)</a></code></p> 79 <p class="firstline">Deletes an existing advertiser group.</p> 80 <p class="toc_element"> 81 <code><a href="#get">get(profileId, id)</a></code></p> 82 <p class="firstline">Gets one advertiser group by ID.</p> 83 <p class="toc_element"> 84 <code><a href="#insert">insert(profileId, body)</a></code></p> 85 <p class="firstline">Inserts a new advertiser group.</p> 86 <p class="toc_element"> 87 <code><a href="#list">list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)</a></code></p> 88 <p class="firstline">Retrieves a list of advertiser groups, 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)</a></code></p> 94 <p class="firstline">Updates an existing advertiser group. This method supports patch semantics.</p> 95 <p class="toc_element"> 96 <code><a href="#update">update(profileId, body)</a></code></p> 97 <p class="firstline">Updates an existing advertiser group.</p> 98 <h3>Method Details</h3> 99 <div class="method"> 100 <code class="details" id="delete">delete(profileId, id)</code> 101 <pre>Deletes an existing advertiser group. 102 103 Args: 104 profileId: string, User profile ID associated with this request. (required) 105 id: string, Advertiser group ID. (required) 106 </pre> 107 </div> 108 109 <div class="method"> 110 <code class="details" id="get">get(profileId, id)</code> 111 <pre>Gets one advertiser group by ID. 112 113 Args: 114 profileId: string, User profile ID associated with this request. (required) 115 id: string, Advertiser group ID. (required) 116 117 Returns: 118 An object of the form: 119 120 { # Groups advertisers together so that reports can be generated for the entire group at once. 121 "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup". 122 "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field. 123 "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account. 124 "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank. 125 }</pre> 126 </div> 127 128 <div class="method"> 129 <code class="details" id="insert">insert(profileId, body)</code> 130 <pre>Inserts a new advertiser group. 131 132 Args: 133 profileId: string, User profile ID associated with this request. (required) 134 body: object, The request body. (required) 135 The object takes the form of: 136 137 { # Groups advertisers together so that reports can be generated for the entire group at once. 138 "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup". 139 "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field. 140 "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account. 141 "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank. 142 } 143 144 145 Returns: 146 An object of the form: 147 148 { # Groups advertisers together so that reports can be generated for the entire group at once. 149 "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup". 150 "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field. 151 "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account. 152 "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank. 153 }</pre> 154 </div> 155 156 <div class="method"> 157 <code class="details" id="list">list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)</code> 158 <pre>Retrieves a list of advertiser groups, possibly filtered. This method supports paging. 159 160 Args: 161 profileId: string, User profile ID associated with this request. (required) 162 searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser group June 2015", "advertiser group April 2015", or simply "advertiser group 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 "advertisergroup" will match objects with name "my advertisergroup", "advertisergroup 2015", or simply "advertisergroup". 163 pageToken: string, Value of the nextPageToken from the previous result page. 164 sortField: string, Field by which to sort the list. 165 Allowed values 166 ID - 167 NAME - 168 ids: string, Select only advertiser groups with these IDs. (repeated) 169 maxResults: integer, Maximum number of results to return. 170 sortOrder: string, Order of sorted results. 171 Allowed values 172 ASCENDING - 173 DESCENDING - 174 175 Returns: 176 An object of the form: 177 178 { # Advertiser Group List Response 179 "nextPageToken": "A String", # Pagination token to be used for the next list operation. 180 "kind": "dfareporting#advertiserGroupsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroupsListResponse". 181 "advertiserGroups": [ # Advertiser group collection. 182 { # Groups advertisers together so that reports can be generated for the entire group at once. 183 "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup". 184 "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field. 185 "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account. 186 "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank. 187 }, 188 ], 189 }</pre> 190 </div> 191 192 <div class="method"> 193 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 194 <pre>Retrieves the next page of results. 195 196 Args: 197 previous_request: The request for the previous page. (required) 198 previous_response: The response from the request for the previous page. (required) 199 200 Returns: 201 A request object that you can call 'execute()' on to request the next 202 page. Returns None if there are no more items in the collection. 203 </pre> 204 </div> 205 206 <div class="method"> 207 <code class="details" id="patch">patch(profileId, id, body)</code> 208 <pre>Updates an existing advertiser group. This method supports patch semantics. 209 210 Args: 211 profileId: string, User profile ID associated with this request. (required) 212 id: string, Advertiser group ID. (required) 213 body: object, The request body. (required) 214 The object takes the form of: 215 216 { # Groups advertisers together so that reports can be generated for the entire group at once. 217 "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup". 218 "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field. 219 "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account. 220 "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank. 221 } 222 223 224 Returns: 225 An object of the form: 226 227 { # Groups advertisers together so that reports can be generated for the entire group at once. 228 "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup". 229 "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field. 230 "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account. 231 "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank. 232 }</pre> 233 </div> 234 235 <div class="method"> 236 <code class="details" id="update">update(profileId, body)</code> 237 <pre>Updates an existing advertiser group. 238 239 Args: 240 profileId: string, User profile ID associated with this request. (required) 241 body: object, The request body. (required) 242 The object takes the form of: 243 244 { # Groups advertisers together so that reports can be generated for the entire group at once. 245 "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup". 246 "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field. 247 "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account. 248 "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank. 249 } 250 251 252 Returns: 253 An object of the form: 254 255 { # Groups advertisers together so that reports can be generated for the entire group at once. 256 "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup". 257 "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field. 258 "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account. 259 "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank. 260 }</pre> 261 </div> 262 263 </body></html>
