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_4.html">Campaign Manager 360 API</a> . <a href="dfareporting_v3_4.creativeGroups.html">creativeGroups</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 creative group 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 creative group.</p> 86<p class="toc_element"> 87 <code><a href="#list">list(profileId, advertiserIds=None, groupNumber=None, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Retrieves a list of creative 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=None, x__xgafv=None)</a></code></p> 94<p class="firstline">Updates an existing creative group. 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 creative group.</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 creative group by ID. 107 108Args: 109 profileId: string, User profile ID associated with this request. (required) 110 id: string, Creative group 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 creative group. 120 "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank. 121 "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion. 122 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 123 "dimensionName": "A String", # The name of the dimension. 124 "etag": "A String", # The eTag of this response for caching purposes. 125 "id": "A String", # The ID associated with the value if available. 126 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 127 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 128 "value": "A String", # The value of the dimension. 129 }, 130 "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to a subgroup in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion. Acceptable values are 1 to 2, inclusive. 131 "id": "A String", # ID of this creative group. This is a read-only, auto-generated field. 132 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup". 133 "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser. 134 "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank. 135}</pre> 136</div> 137 138<div class="method"> 139 <code class="details" id="insert">insert(profileId, body=None, x__xgafv=None)</code> 140 <pre>Inserts a new creative group. 141 142Args: 143 profileId: string, User profile ID associated with this request. (required) 144 body: object, The request body. 145 The object takes the form of: 146 147{ # Contains properties of a creative group. 148 "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank. 149 "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion. 150 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 151 "dimensionName": "A String", # The name of the dimension. 152 "etag": "A String", # The eTag of this response for caching purposes. 153 "id": "A String", # The ID associated with the value if available. 154 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 155 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 156 "value": "A String", # The value of the dimension. 157 }, 158 "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to a subgroup in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion. Acceptable values are 1 to 2, inclusive. 159 "id": "A String", # ID of this creative group. This is a read-only, auto-generated field. 160 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup". 161 "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser. 162 "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank. 163} 164 165 x__xgafv: string, V1 error format. 166 Allowed values 167 1 - v1 error format 168 2 - v2 error format 169 170Returns: 171 An object of the form: 172 173 { # Contains properties of a creative group. 174 "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank. 175 "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion. 176 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 177 "dimensionName": "A String", # The name of the dimension. 178 "etag": "A String", # The eTag of this response for caching purposes. 179 "id": "A String", # The ID associated with the value if available. 180 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 181 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 182 "value": "A String", # The value of the dimension. 183 }, 184 "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to a subgroup in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion. Acceptable values are 1 to 2, inclusive. 185 "id": "A String", # ID of this creative group. This is a read-only, auto-generated field. 186 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup". 187 "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser. 188 "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank. 189}</pre> 190</div> 191 192<div class="method"> 193 <code class="details" id="list">list(profileId, advertiserIds=None, groupNumber=None, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, x__xgafv=None)</code> 194 <pre>Retrieves a list of creative groups, possibly filtered. This method supports paging. 195 196Args: 197 profileId: string, User profile ID associated with this request. (required) 198 advertiserIds: string, Select only creative groups that belong to these advertisers. (repeated) 199 groupNumber: integer, Select only creative groups that belong to this subgroup. 200 ids: string, Select only creative groups with these IDs. (repeated) 201 maxResults: integer, Maximum number of results to return. 202 pageToken: string, Value of the nextPageToken from the previous result page. 203 searchString: string, Allows searching for creative groups by name or ID. Wildcards (*) are allowed. For example, "creativegroup*2015" will return creative groups with names like "creativegroup June 2015", "creativegroup April 2015", or simply "creativegroup 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativegroup" will match creative groups with the name "my creativegroup", "creativegroup 2015", or simply "creativegroup". 204 sortField: string, Field by which to sort the list. 205 Allowed values 206 ID - 207 NAME - 208 sortOrder: string, Order of sorted results. 209 Allowed values 210 ASCENDING - 211 DESCENDING - 212 x__xgafv: string, V1 error format. 213 Allowed values 214 1 - v1 error format 215 2 - v2 error format 216 217Returns: 218 An object of the form: 219 220 { # Creative Group List Response 221 "creativeGroups": [ # Creative group collection. 222 { # Contains properties of a creative group. 223 "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank. 224 "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion. 225 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 226 "dimensionName": "A String", # The name of the dimension. 227 "etag": "A String", # The eTag of this response for caching purposes. 228 "id": "A String", # The ID associated with the value if available. 229 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 230 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 231 "value": "A String", # The value of the dimension. 232 }, 233 "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to a subgroup in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion. Acceptable values are 1 to 2, inclusive. 234 "id": "A String", # ID of this creative group. This is a read-only, auto-generated field. 235 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup". 236 "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser. 237 "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank. 238 }, 239 ], 240 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroupsListResponse". 241 "nextPageToken": "A String", # Pagination token to be used for the next list operation. 242}</pre> 243</div> 244 245<div class="method"> 246 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 247 <pre>Retrieves the next page of results. 248 249Args: 250 previous_request: The request for the previous page. (required) 251 previous_response: The response from the request for the previous page. (required) 252 253Returns: 254 A request object that you can call 'execute()' on to request the next 255 page. Returns None if there are no more items in the collection. 256 </pre> 257</div> 258 259<div class="method"> 260 <code class="details" id="patch">patch(profileId, id, body=None, x__xgafv=None)</code> 261 <pre>Updates an existing creative group. This method supports patch semantics. 262 263Args: 264 profileId: string, User profile ID associated with this request. (required) 265 id: string, CreativeGroup ID. (required) 266 body: object, The request body. 267 The object takes the form of: 268 269{ # Contains properties of a creative group. 270 "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank. 271 "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion. 272 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 273 "dimensionName": "A String", # The name of the dimension. 274 "etag": "A String", # The eTag of this response for caching purposes. 275 "id": "A String", # The ID associated with the value if available. 276 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 277 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 278 "value": "A String", # The value of the dimension. 279 }, 280 "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to a subgroup in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion. Acceptable values are 1 to 2, inclusive. 281 "id": "A String", # ID of this creative group. This is a read-only, auto-generated field. 282 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup". 283 "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser. 284 "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank. 285} 286 287 x__xgafv: string, V1 error format. 288 Allowed values 289 1 - v1 error format 290 2 - v2 error format 291 292Returns: 293 An object of the form: 294 295 { # Contains properties of a creative group. 296 "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank. 297 "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion. 298 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 299 "dimensionName": "A String", # The name of the dimension. 300 "etag": "A String", # The eTag of this response for caching purposes. 301 "id": "A String", # The ID associated with the value if available. 302 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 303 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 304 "value": "A String", # The value of the dimension. 305 }, 306 "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to a subgroup in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion. Acceptable values are 1 to 2, inclusive. 307 "id": "A String", # ID of this creative group. This is a read-only, auto-generated field. 308 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup". 309 "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser. 310 "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank. 311}</pre> 312</div> 313 314<div class="method"> 315 <code class="details" id="update">update(profileId, body=None, x__xgafv=None)</code> 316 <pre>Updates an existing creative group. 317 318Args: 319 profileId: string, User profile ID associated with this request. (required) 320 body: object, The request body. 321 The object takes the form of: 322 323{ # Contains properties of a creative group. 324 "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank. 325 "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion. 326 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 327 "dimensionName": "A String", # The name of the dimension. 328 "etag": "A String", # The eTag of this response for caching purposes. 329 "id": "A String", # The ID associated with the value if available. 330 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 331 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 332 "value": "A String", # The value of the dimension. 333 }, 334 "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to a subgroup in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion. Acceptable values are 1 to 2, inclusive. 335 "id": "A String", # ID of this creative group. This is a read-only, auto-generated field. 336 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup". 337 "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser. 338 "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank. 339} 340 341 x__xgafv: string, V1 error format. 342 Allowed values 343 1 - v1 error format 344 2 - v2 error format 345 346Returns: 347 An object of the form: 348 349 { # Contains properties of a creative group. 350 "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank. 351 "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion. 352 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 353 "dimensionName": "A String", # The name of the dimension. 354 "etag": "A String", # The eTag of this response for caching purposes. 355 "id": "A String", # The ID associated with the value if available. 356 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 357 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 358 "value": "A String", # The value of the dimension. 359 }, 360 "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to a subgroup in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion. Acceptable values are 1 to 2, inclusive. 361 "id": "A String", # ID of this creative group. This is a read-only, auto-generated field. 362 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup". 363 "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser. 364 "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank. 365}</pre> 366</div> 367 368</body></html>