• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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_v2_7.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_7.creativeFieldValues.html">creativeFieldValues</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#delete">delete(profileId, creativeFieldId, id)</a></code></p>
79<p class="firstline">Deletes an existing creative field value.</p>
80<p class="toc_element">
81  <code><a href="#get">get(profileId, creativeFieldId, id)</a></code></p>
82<p class="firstline">Gets one creative field value by ID.</p>
83<p class="toc_element">
84  <code><a href="#insert">insert(profileId, creativeFieldId, body)</a></code></p>
85<p class="firstline">Inserts a new creative field value.</p>
86<p class="toc_element">
87  <code><a href="#list">list(profileId, creativeFieldId, searchString=None, sortField=None, ids=None, maxResults=None, pageToken=None, sortOrder=None)</a></code></p>
88<p class="firstline">Retrieves a list of creative field values, 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, creativeFieldId, id, body)</a></code></p>
94<p class="firstline">Updates an existing creative field value. This method supports patch semantics.</p>
95<p class="toc_element">
96  <code><a href="#update">update(profileId, creativeFieldId, body)</a></code></p>
97<p class="firstline">Updates an existing creative field value.</p>
98<h3>Method Details</h3>
99<div class="method">
100    <code class="details" id="delete">delete(profileId, creativeFieldId, id)</code>
101  <pre>Deletes an existing creative field value.
102
103Args:
104  profileId: string, User profile ID associated with this request. (required)
105  creativeFieldId: string, Creative field ID for this creative field value. (required)
106  id: string, Creative Field Value ID (required)
107</pre>
108</div>
109
110<div class="method">
111    <code class="details" id="get">get(profileId, creativeFieldId, id)</code>
112  <pre>Gets one creative field value by ID.
113
114Args:
115  profileId: string, User profile ID associated with this request. (required)
116  creativeFieldId: string, Creative field ID for this creative field value. (required)
117  id: string, Creative Field Value ID (required)
118
119Returns:
120  An object of the form:
121
122    { # Contains properties of a creative field value.
123      "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
124      "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
125      "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
126    }</pre>
127</div>
128
129<div class="method">
130    <code class="details" id="insert">insert(profileId, creativeFieldId, body)</code>
131  <pre>Inserts a new creative field value.
132
133Args:
134  profileId: string, User profile ID associated with this request. (required)
135  creativeFieldId: string, Creative field ID for this creative field value. (required)
136  body: object, The request body. (required)
137    The object takes the form of:
138
139{ # Contains properties of a creative field value.
140    "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
141    "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
142    "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
143  }
144
145
146Returns:
147  An object of the form:
148
149    { # Contains properties of a creative field value.
150      "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
151      "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
152      "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
153    }</pre>
154</div>
155
156<div class="method">
157    <code class="details" id="list">list(profileId, creativeFieldId, searchString=None, sortField=None, ids=None, maxResults=None, pageToken=None, sortOrder=None)</code>
158  <pre>Retrieves a list of creative field values, possibly filtered. This method supports paging.
159
160Args:
161  profileId: string, User profile ID associated with this request. (required)
162  creativeFieldId: string, Creative field ID for this creative field value. (required)
163  searchString: string, Allows searching for creative field values by their values. Wildcards (e.g. *) are not allowed.
164  sortField: string, Field by which to sort the list.
165    Allowed values
166      ID -
167      VALUE -
168  ids: string, Select only creative field values with these IDs. (repeated)
169  maxResults: integer, Maximum number of results to return.
170  pageToken: string, Value of the nextPageToken from the previous result page.
171  sortOrder: string, Order of sorted results.
172    Allowed values
173      ASCENDING -
174      DESCENDING -
175
176Returns:
177  An object of the form:
178
179    { # Creative Field Value List Response
180    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
181    "kind": "dfareporting#creativeFieldValuesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValuesListResponse".
182    "creativeFieldValues": [ # Creative field value collection.
183      { # Contains properties of a creative field value.
184          "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
185          "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
186          "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
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
196Args:
197  previous_request: The request for the previous page. (required)
198  previous_response: The response from the request for the previous page. (required)
199
200Returns:
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, creativeFieldId, id, body)</code>
208  <pre>Updates an existing creative field value. This method supports patch semantics.
209
210Args:
211  profileId: string, User profile ID associated with this request. (required)
212  creativeFieldId: string, Creative field ID for this creative field value. (required)
213  id: string, Creative Field Value ID (required)
214  body: object, The request body. (required)
215    The object takes the form of:
216
217{ # Contains properties of a creative field value.
218    "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
219    "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
220    "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
221  }
222
223
224Returns:
225  An object of the form:
226
227    { # Contains properties of a creative field value.
228      "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
229      "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
230      "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
231    }</pre>
232</div>
233
234<div class="method">
235    <code class="details" id="update">update(profileId, creativeFieldId, body)</code>
236  <pre>Updates an existing creative field value.
237
238Args:
239  profileId: string, User profile ID associated with this request. (required)
240  creativeFieldId: string, Creative field ID for this creative field value. (required)
241  body: object, The request body. (required)
242    The object takes the form of:
243
244{ # Contains properties of a creative field value.
245    "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
246    "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
247    "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
248  }
249
250
251Returns:
252  An object of the form:
253
254    { # Contains properties of a creative field value.
255      "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
256      "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
257      "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
258    }</pre>
259</div>
260
261</body></html>