1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="dfareporting_v3_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v3_1.creativeGroups.html">creativeGroups</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(profileId, id)</a></code></p>
<p class="firstline">Gets one creative group by ID.</p>
<p class="toc_element">
<code><a href="#insert">insert(profileId, body)</a></code></p>
<p class="firstline">Inserts a new creative group.</p>
<p class="toc_element">
<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>
<p class="firstline">Retrieves a list of creative groups, possibly filtered. This method supports paging.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(profileId, id, body)</a></code></p>
<p class="firstline">Updates an existing creative group. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#update">update(profileId, body)</a></code></p>
<p class="firstline">Updates an existing creative group.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(profileId, id)</code>
<pre>Gets one creative group by ID.
Args:
profileId: string, User profile ID associated with this request. (required)
id: string, Creative group ID. (required)
Returns:
An object of the form:
{ # Contains properties of a creative group.
"kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
"subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
"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.
"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.
"advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"id": "A String", # ID of this creative group. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(profileId, body)</code>
<pre>Inserts a new creative group.
Args:
profileId: string, User profile ID associated with this request. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Contains properties of a creative group.
"kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
"subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
"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.
"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.
"advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"id": "A String", # ID of this creative group. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
}
Returns:
An object of the form:
{ # Contains properties of a creative group.
"kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
"subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
"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.
"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.
"advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"id": "A String", # ID of this creative group. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(profileId, searchString=None, pageToken=None, sortField=None, advertiserIds=None, groupNumber=None, maxResults=None, ids=None, sortOrder=None)</code>
<pre>Retrieves a list of creative groups, possibly filtered. This method supports paging.
Args:
profileId: string, User profile ID associated with this request. (required)
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".
pageToken: string, Value of the nextPageToken from the previous result page.
sortField: string, Field by which to sort the list.
Allowed values
ID -
NAME -
advertiserIds: string, Select only creative groups that belong to these advertisers. (repeated)
groupNumber: integer, Select only creative groups that belong to this subgroup.
maxResults: integer, Maximum number of results to return.
ids: string, Select only creative groups with these IDs. (repeated)
sortOrder: string, Order of sorted results.
Allowed values
ASCENDING -
DESCENDING -
Returns:
An object of the form:
{ # Creative Group List Response
"nextPageToken": "A String", # Pagination token to be used for the next list operation.
"creativeGroups": [ # Creative group collection.
{ # Contains properties of a creative group.
"kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
"subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
"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.
"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.
"advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"id": "A String", # ID of this creative group. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
},
],
"kind": "dfareporting#creativeGroupsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroupsListResponse".
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(profileId, id, body)</code>
<pre>Updates an existing creative group. This method supports patch semantics.
Args:
profileId: string, User profile ID associated with this request. (required)
id: string, Creative group ID. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Contains properties of a creative group.
"kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
"subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
"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.
"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.
"advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"id": "A String", # ID of this creative group. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
}
Returns:
An object of the form:
{ # Contains properties of a creative group.
"kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
"subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
"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.
"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.
"advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"id": "A String", # ID of this creative group. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(profileId, body)</code>
<pre>Updates an existing creative group.
Args:
profileId: string, User profile ID associated with this request. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Contains properties of a creative group.
"kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
"subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
"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.
"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.
"advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"id": "A String", # ID of this creative group. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
}
Returns:
An object of the form:
{ # Contains properties of a creative group.
"kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
"subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
"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.
"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.
"advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"id": "A String", # ID of this creative group. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
}</pre>
</div>
</body></html>
|
