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.creativeGroups.html">creativeGroups</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 creative group 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 creative group.</p> 83 <p class="toc_element"> 84 <code><a href="#list">list(profileId, searchString=None, pageToken=None, sortField=None, advertiserIds=None, groupNumber=None, maxResults=None, ids=None, sortOrder=None)</a></code></p> 85 <p class="firstline">Retrieves a list of creative groups, 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 creative group. 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 creative group.</p> 95 <h3>Method Details</h3> 96 <div class="method"> 97 <code class="details" id="get">get(profileId, id)</code> 98 <pre>Gets one creative group by ID. 99 100 Args: 101 profileId: string, User profile ID associated with this request. (required) 102 id: string, Creative group ID. (required) 103 104 Returns: 105 An object of the form: 106 107 { # Contains properties of a creative group. 108 "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup". 109 "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank. 110 "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. 111 "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. 112 "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion. 113 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 114 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 115 "value": "A String", # The value of the dimension. 116 "dimensionName": "A String", # The name of the dimension. 117 "etag": "A String", # The eTag of this response for caching purposes. 118 "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. 119 "id": "A String", # The ID associated with the value if available. 120 }, 121 "id": "A String", # ID of this creative group. This is a read-only, auto-generated field. 122 "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank. 123 }</pre> 124 </div> 125 126 <div class="method"> 127 <code class="details" id="insert">insert(profileId, body)</code> 128 <pre>Inserts a new creative group. 129 130 Args: 131 profileId: string, User profile ID associated with this request. (required) 132 body: object, The request body. (required) 133 The object takes the form of: 134 135 { # Contains properties of a creative group. 136 "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup". 137 "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank. 138 "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. 139 "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. 140 "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion. 141 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 142 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 143 "value": "A String", # The value of the dimension. 144 "dimensionName": "A String", # The name of the dimension. 145 "etag": "A String", # The eTag of this response for caching purposes. 146 "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. 147 "id": "A String", # The ID associated with the value if available. 148 }, 149 "id": "A String", # ID of this creative group. This is a read-only, auto-generated field. 150 "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank. 151 } 152 153 154 Returns: 155 An object of the form: 156 157 { # Contains properties of a creative group. 158 "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup". 159 "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank. 160 "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. 161 "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. 162 "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion. 163 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 164 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 165 "value": "A String", # The value of the dimension. 166 "dimensionName": "A String", # The name of the dimension. 167 "etag": "A String", # The eTag of this response for caching purposes. 168 "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. 169 "id": "A String", # The ID associated with the value if available. 170 }, 171 "id": "A String", # ID of this creative group. This is a read-only, auto-generated field. 172 "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank. 173 }</pre> 174 </div> 175 176 <div class="method"> 177 <code class="details" id="list">list(profileId, searchString=None, pageToken=None, sortField=None, advertiserIds=None, groupNumber=None, maxResults=None, ids=None, sortOrder=None)</code> 178 <pre>Retrieves a list of creative groups, possibly filtered. This method supports paging. 179 180 Args: 181 profileId: string, User profile ID associated with this request. (required) 182 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". 183 pageToken: string, Value of the nextPageToken from the previous result page. 184 sortField: string, Field by which to sort the list. 185 Allowed values 186 ID - 187 NAME - 188 advertiserIds: string, Select only creative groups that belong to these advertisers. (repeated) 189 groupNumber: integer, Select only creative groups that belong to this subgroup. 190 maxResults: integer, Maximum number of results to return. 191 ids: string, Select only creative groups with these IDs. (repeated) 192 sortOrder: string, Order of sorted results. 193 Allowed values 194 ASCENDING - 195 DESCENDING - 196 197 Returns: 198 An object of the form: 199 200 { # Creative Group List Response 201 "nextPageToken": "A String", # Pagination token to be used for the next list operation. 202 "creativeGroups": [ # Creative group collection. 203 { # Contains properties of a creative group. 204 "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup". 205 "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank. 206 "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. 207 "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. 208 "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion. 209 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 210 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 211 "value": "A String", # The value of the dimension. 212 "dimensionName": "A String", # The name of the dimension. 213 "etag": "A String", # The eTag of this response for caching purposes. 214 "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. 215 "id": "A String", # The ID associated with the value if available. 216 }, 217 "id": "A String", # ID of this creative group. This is a read-only, auto-generated field. 218 "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank. 219 }, 220 ], 221 "kind": "dfareporting#creativeGroupsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroupsListResponse". 222 }</pre> 223 </div> 224 225 <div class="method"> 226 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 227 <pre>Retrieves the next page of results. 228 229 Args: 230 previous_request: The request for the previous page. (required) 231 previous_response: The response from the request for the previous page. (required) 232 233 Returns: 234 A request object that you can call 'execute()' on to request the next 235 page. Returns None if there are no more items in the collection. 236 </pre> 237 </div> 238 239 <div class="method"> 240 <code class="details" id="patch">patch(profileId, id, body)</code> 241 <pre>Updates an existing creative group. This method supports patch semantics. 242 243 Args: 244 profileId: string, User profile ID associated with this request. (required) 245 id: string, Creative group ID. (required) 246 body: object, The request body. (required) 247 The object takes the form of: 248 249 { # Contains properties of a creative group. 250 "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup". 251 "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank. 252 "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. 253 "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. 254 "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion. 255 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 256 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 257 "value": "A String", # The value of the dimension. 258 "dimensionName": "A String", # The name of the dimension. 259 "etag": "A String", # The eTag of this response for caching purposes. 260 "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. 261 "id": "A String", # The ID associated with the value if available. 262 }, 263 "id": "A String", # ID of this creative group. This is a read-only, auto-generated field. 264 "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank. 265 } 266 267 268 Returns: 269 An object of the form: 270 271 { # Contains properties of a creative group. 272 "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup". 273 "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank. 274 "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. 275 "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. 276 "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion. 277 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 278 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 279 "value": "A String", # The value of the dimension. 280 "dimensionName": "A String", # The name of the dimension. 281 "etag": "A String", # The eTag of this response for caching purposes. 282 "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. 283 "id": "A String", # The ID associated with the value if available. 284 }, 285 "id": "A String", # ID of this creative group. This is a read-only, auto-generated field. 286 "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank. 287 }</pre> 288 </div> 289 290 <div class="method"> 291 <code class="details" id="update">update(profileId, body)</code> 292 <pre>Updates an existing creative group. 293 294 Args: 295 profileId: string, User profile ID associated with this request. (required) 296 body: object, The request body. (required) 297 The object takes the form of: 298 299 { # Contains properties of a creative group. 300 "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup". 301 "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank. 302 "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. 303 "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. 304 "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion. 305 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 306 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 307 "value": "A String", # The value of the dimension. 308 "dimensionName": "A String", # The name of the dimension. 309 "etag": "A String", # The eTag of this response for caching purposes. 310 "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. 311 "id": "A String", # The ID associated with the value if available. 312 }, 313 "id": "A String", # ID of this creative group. This is a read-only, auto-generated field. 314 "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank. 315 } 316 317 318 Returns: 319 An object of the form: 320 321 { # Contains properties of a creative group. 322 "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup". 323 "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank. 324 "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. 325 "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. 326 "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion. 327 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 328 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 329 "value": "A String", # The value of the dimension. 330 "dimensionName": "A String", # The name of the dimension. 331 "etag": "A String", # The eTag of this response for caching purposes. 332 "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. 333 "id": "A String", # The ID associated with the value if available. 334 }, 335 "id": "A String", # ID of this creative group. This is a read-only, auto-generated field. 336 "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank. 337 }</pre> 338 </div> 339 340 </body></html>
