Debian Codegraph @

docs/dyn/dfareporting_v5.creativeFields.html

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