Debian Codegraph @

docs/dyn/dfareporting_v4.contentCategories.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_v4.html">Campaign Manager 360 API</a> . <a href="dfareporting_v4.contentCategories.html">contentCategories</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 content category.</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 content category 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 content category.</p>
89 <p class="toc_element">
90 <code><a href="#list">list(profileId, 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 content categories, 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 content category. 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 content category.</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 content category.
110
111 Args:
112 profileId: string, User profile ID associated with this request. (required)
113 id: string, Content category 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 content category by ID.
124
125 Args:
126 profileId: string, User profile ID associated with this request. (required)
127 id: string, Content category 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 {
137 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this content category. This is a read-only field that can be left blank.
138 &quot;id&quot;: &quot;A String&quot;, # ID of this content category. This is a read-only, auto-generated field.
139 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#contentCategory&quot;.
140 &quot;name&quot;: &quot;A String&quot;, # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
141 }</pre>
142 </div>
143
144 <div class="method">
145 <code class="details" id="insert">insert(profileId, body=None, x__xgafv=None)</code>
146 <pre>Inserts a new content category.
147
148 Args:
149 profileId: string, User profile ID associated with this request. (required)
150 body: object, The request body.
151 The object takes the form of:
152
153 {
154 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this content category. This is a read-only field that can be left blank.
155 &quot;id&quot;: &quot;A String&quot;, # ID of this content category. This is a read-only, auto-generated field.
156 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#contentCategory&quot;.
157 &quot;name&quot;: &quot;A String&quot;, # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
158 }
159
160 x__xgafv: string, V1 error format.
161 Allowed values
162 1 - v1 error format
163 2 - v2 error format
164
165 Returns:
166 An object of the form:
167
168 {
169 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this content category. This is a read-only field that can be left blank.
170 &quot;id&quot;: &quot;A String&quot;, # ID of this content category. This is a read-only, auto-generated field.
171 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#contentCategory&quot;.
172 &quot;name&quot;: &quot;A String&quot;, # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
173 }</pre>
174 </div>
175
176 <div class="method">
177 <code class="details" id="list">list(profileId, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, x__xgafv=None)</code>
178 <pre>Retrieves a list of content categories, possibly filtered. This method supports paging.
179
180 Args:
181 profileId: string, User profile ID associated with this request. (required)
182 ids: string, Select only content categories with these IDs. (repeated)
183 maxResults: integer, Maximum number of results to return.
184 pageToken: string, Value of the nextPageToken from the previous result page.
185 searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, &quot;contentcategory*2015&quot; will return objects with names like &quot;contentcategory June 2015&quot;, &quot;contentcategory April 2015&quot;, or simply &quot;contentcategory 2015&quot;. Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of &quot;contentcategory&quot; will match objects with name &quot;my contentcategory&quot;, &quot;contentcategory 2015&quot;, or simply &quot;contentcategory&quot;.
186 sortField: string, Field by which to sort the list.
187 Allowed values
188 ID -
189 NAME -
190 sortOrder: string, Order of sorted results.
191 Allowed values
192 ASCENDING - Ascending order.
193 DESCENDING - Descending order.
194 x__xgafv: string, V1 error format.
195 Allowed values
196 1 - v1 error format
197 2 - v2 error format
198
199 Returns:
200 An object of the form:
201
202 { # Content Category List Response
203 &quot;contentCategories&quot;: [ # Content category collection.
204 {
205 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this content category. This is a read-only field that can be left blank.
206 &quot;id&quot;: &quot;A String&quot;, # ID of this content category. This is a read-only, auto-generated field.
207 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#contentCategory&quot;.
208 &quot;name&quot;: &quot;A String&quot;, # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
209 },
210 ],
211 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#contentCategoriesListResponse&quot;.
212 &quot;nextPageToken&quot;: &quot;A String&quot;, # Pagination token to be used for the next list operation.
213 }</pre>
214 </div>
215
216 <div class="method">
217 <code class="details" id="list_next">list_next()</code>
218 <pre>Retrieves the next page of results.
219
220 Args:
221 previous_request: The request for the previous page. (required)
222 previous_response: The response from the request for the previous page. (required)
223
224 Returns:
225 A request object that you can call &#x27;execute()&#x27; on to request the next
226 page. Returns None if there are no more items in the collection.
227 </pre>
228 </div>
229
230 <div class="method">
231 <code class="details" id="patch">patch(profileId, id, body=None, x__xgafv=None)</code>
232 <pre>Updates an existing content category. This method supports patch semantics.
233
234 Args:
235 profileId: string, User profile ID associated with this request. (required)
236 id: string, Required. ContentCategory ID. (required)
237 body: object, The request body.
238 The object takes the form of:
239
240 {
241 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this content category. This is a read-only field that can be left blank.
242 &quot;id&quot;: &quot;A String&quot;, # ID of this content category. This is a read-only, auto-generated field.
243 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#contentCategory&quot;.
244 &quot;name&quot;: &quot;A String&quot;, # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
245 }
246
247 x__xgafv: string, V1 error format.
248 Allowed values
249 1 - v1 error format
250 2 - v2 error format
251
252 Returns:
253 An object of the form:
254
255 {
256 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this content category. This is a read-only field that can be left blank.
257 &quot;id&quot;: &quot;A String&quot;, # ID of this content category. This is a read-only, auto-generated field.
258 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#contentCategory&quot;.
259 &quot;name&quot;: &quot;A String&quot;, # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
260 }</pre>
261 </div>
262
263 <div class="method">
264 <code class="details" id="update">update(profileId, body=None, x__xgafv=None)</code>
265 <pre>Updates an existing content category.
266
267 Args:
268 profileId: string, User profile ID associated with this request. (required)
269 body: object, The request body.
270 The object takes the form of:
271
272 {
273 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this content category. This is a read-only field that can be left blank.
274 &quot;id&quot;: &quot;A String&quot;, # ID of this content category. This is a read-only, auto-generated field.
275 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#contentCategory&quot;.
276 &quot;name&quot;: &quot;A String&quot;, # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
277 }
278
279 x__xgafv: string, V1 error format.
280 Allowed values
281 1 - v1 error format
282 2 - v2 error format
283
284 Returns:
285 An object of the form:
286
287 {
288 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this content category. This is a read-only field that can be left blank.
289 &quot;id&quot;: &quot;A String&quot;, # ID of this content category. This is a read-only, auto-generated field.
290 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#contentCategory&quot;.
291 &quot;name&quot;: &quot;A String&quot;, # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
292 }</pre>
293 </div>
294
295 </body></html>