blob: 400aef84e607bca8f1552a4a4f28434858a13932 [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -07001<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="displayvideo_v1.html">Display & Video 360 API</a> . <a href="displayvideo_v1.partners.html">partners</a> . <a href="displayvideo_v1.partners.channels.html">channels</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070078 <code><a href="displayvideo_v1.partners.channels.sites.html">sites()</a></code>
79</p>
80<p class="firstline">Returns the sites Resource.</p>
81
82<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070083 <code><a href="#close">close()</a></code></p>
84<p class="firstline">Close httplib2 connections.</p>
85<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -080086 <code><a href="#create">create(partnerId, advertiserId=None, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -070087<p class="firstline">Creates a new channel. Returns the newly created channel if successful.</p>
88<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -070089 <code><a href="#get">get(partnerId, channelId, advertiserId=None, x__xgafv=None)</a></code></p>
90<p class="firstline">Gets a channel for a partner or advertiser.</p>
91<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -080092 <code><a href="#list">list(partnerId, advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim65020912020-05-20 12:08:20 -070093<p class="firstline">Lists channels for a partner or advertiser.</p>
94<p class="toc_element">
95 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
96<p class="firstline">Retrieves the next page of results.</p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -070097<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -080098 <code><a href="#patch">patch(partnerId, channelId, advertiserId=None, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -070099<p class="firstline">Updates a channel. Returns the updated channel if successful.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700100<h3>Method Details</h3>
101<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700102 <code class="details" id="close">close()</code>
103 <pre>Close httplib2 connections.</pre>
104</div>
105
106<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800107 <code class="details" id="create">create(partnerId, advertiserId=None, body=None, x__xgafv=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700108 <pre>Creates a new channel. Returns the newly created channel if successful.
109
110Args:
111 partnerId: string, The ID of the partner that owns the created channel. (required)
112 body: object, The request body.
113 The object takes the form of:
114
115{ # A single channel. Channels are custom groups of related websites and apps.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800116 &quot;advertiserId&quot;: &quot;A String&quot;, # The ID of the advertiser that owns the channel.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800117 &quot;channelId&quot;: &quot;A String&quot;, # Output only. The unique ID of the channel. Assigned by the system.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800118 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800119 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the channel.
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700120 &quot;negativelyTargetedLineItemCount&quot;: &quot;A String&quot;, # Output only. Number of line items that are directly targeting this channel negatively.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800121 &quot;partnerId&quot;: &quot;A String&quot;, # The ID of the partner that owns the channel.
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700122 &quot;positivelyTargetedLineItemCount&quot;: &quot;A String&quot;, # Output only. Number of line items that are directly targeting this channel positively.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800123}
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700124
125 advertiserId: string, The ID of the advertiser that owns the created channel.
126 x__xgafv: string, V1 error format.
127 Allowed values
128 1 - v1 error format
129 2 - v2 error format
130
131Returns:
132 An object of the form:
133
134 { # A single channel. Channels are custom groups of related websites and apps.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800135 &quot;advertiserId&quot;: &quot;A String&quot;, # The ID of the advertiser that owns the channel.
136 &quot;channelId&quot;: &quot;A String&quot;, # Output only. The unique ID of the channel. Assigned by the system.
137 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes.
138 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the channel.
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700139 &quot;negativelyTargetedLineItemCount&quot;: &quot;A String&quot;, # Output only. Number of line items that are directly targeting this channel negatively.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800140 &quot;partnerId&quot;: &quot;A String&quot;, # The ID of the partner that owns the channel.
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700141 &quot;positivelyTargetedLineItemCount&quot;: &quot;A String&quot;, # Output only. Number of line items that are directly targeting this channel positively.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800142}</pre>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700143</div>
144
145<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700146 <code class="details" id="get">get(partnerId, channelId, advertiserId=None, x__xgafv=None)</code>
147 <pre>Gets a channel for a partner or advertiser.
148
149Args:
150 partnerId: string, The ID of the partner that owns the fetched channel. (required)
151 channelId: string, Required. The ID of the channel to fetch. (required)
152 advertiserId: string, The ID of the advertiser that owns the fetched channel.
153 x__xgafv: string, V1 error format.
154 Allowed values
155 1 - v1 error format
156 2 - v2 error format
157
158Returns:
159 An object of the form:
160
161 { # A single channel. Channels are custom groups of related websites and apps.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800162 &quot;advertiserId&quot;: &quot;A String&quot;, # The ID of the advertiser that owns the channel.
163 &quot;channelId&quot;: &quot;A String&quot;, # Output only. The unique ID of the channel. Assigned by the system.
164 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes.
165 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the channel.
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700166 &quot;negativelyTargetedLineItemCount&quot;: &quot;A String&quot;, # Output only. Number of line items that are directly targeting this channel negatively.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800167 &quot;partnerId&quot;: &quot;A String&quot;, # The ID of the partner that owns the channel.
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700168 &quot;positivelyTargetedLineItemCount&quot;: &quot;A String&quot;, # Output only. Number of line items that are directly targeting this channel positively.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800169}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700170</div>
171
172<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800173 <code class="details" id="list">list(partnerId, advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700174 <pre>Lists channels for a partner or advertiser.
175
176Args:
177 partnerId: string, The ID of the partner that owns the channels. (required)
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800178 advertiserId: string, The ID of the advertiser that owns the channels.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800179 filter: string, Allows filtering by channel fields. Supported syntax: * Filter expressions for channel currently can only contain at most one * restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `displayName` Examples: * All channels for which the display name contains &quot;google&quot;: `displayName : &quot;google&quot;`. The length of this field should be no more than 500 characters.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800180 orderBy: string, Field by which to sort the list. Acceptable values are: * `displayName` (default) * `channelId` The default sorting order is ascending. To specify descending order for a field, a suffix &quot; desc&quot; should be added to the field name. Example: `displayName desc`.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800181 pageSize: integer, Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
182 pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListChannels` method. If not specified, the first page of results will be returned.
Bu Sun Kim65020912020-05-20 12:08:20 -0700183 x__xgafv: string, V1 error format.
184 Allowed values
185 1 - v1 error format
186 2 - v2 error format
187
188Returns:
189 An object of the form:
190
191 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800192 &quot;channels&quot;: [ # The list of channels. This list will be absent if empty.
193 { # A single channel. Channels are custom groups of related websites and apps.
194 &quot;advertiserId&quot;: &quot;A String&quot;, # The ID of the advertiser that owns the channel.
195 &quot;channelId&quot;: &quot;A String&quot;, # Output only. The unique ID of the channel. Assigned by the system.
196 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes.
197 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the channel.
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700198 &quot;negativelyTargetedLineItemCount&quot;: &quot;A String&quot;, # Output only. Number of line items that are directly targeting this channel negatively.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800199 &quot;partnerId&quot;: &quot;A String&quot;, # The ID of the partner that owns the channel.
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700200 &quot;positivelyTargetedLineItemCount&quot;: &quot;A String&quot;, # Output only. Number of line items that are directly targeting this channel positively.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800201 },
202 ],
203 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListChannels` method to retrieve the next page of results.
204}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700205</div>
206
207<div class="method">
208 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
209 <pre>Retrieves the next page of results.
210
211Args:
212 previous_request: The request for the previous page. (required)
213 previous_response: The response from the request for the previous page. (required)
214
215Returns:
216 A request object that you can call &#x27;execute()&#x27; on to request the next
217 page. Returns None if there are no more items in the collection.
218 </pre>
219</div>
220
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700221<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800222 <code class="details" id="patch">patch(partnerId, channelId, advertiserId=None, body=None, updateMask=None, x__xgafv=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700223 <pre>Updates a channel. Returns the updated channel if successful.
224
225Args:
226 partnerId: string, The ID of the partner that owns the created channel. (required)
227 channelId: string, Output only. The unique ID of the channel. Assigned by the system. (required)
228 body: object, The request body.
229 The object takes the form of:
230
231{ # A single channel. Channels are custom groups of related websites and apps.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800232 &quot;advertiserId&quot;: &quot;A String&quot;, # The ID of the advertiser that owns the channel.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800233 &quot;channelId&quot;: &quot;A String&quot;, # Output only. The unique ID of the channel. Assigned by the system.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800234 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800235 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the channel.
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700236 &quot;negativelyTargetedLineItemCount&quot;: &quot;A String&quot;, # Output only. Number of line items that are directly targeting this channel negatively.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800237 &quot;partnerId&quot;: &quot;A String&quot;, # The ID of the partner that owns the channel.
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700238 &quot;positivelyTargetedLineItemCount&quot;: &quot;A String&quot;, # Output only. Number of line items that are directly targeting this channel positively.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800239}
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700240
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800241 advertiserId: string, The ID of the advertiser that owns the created channel.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800242 updateMask: string, Required. The mask to control which fields to update.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700243 x__xgafv: string, V1 error format.
244 Allowed values
245 1 - v1 error format
246 2 - v2 error format
247
248Returns:
249 An object of the form:
250
251 { # A single channel. Channels are custom groups of related websites and apps.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800252 &quot;advertiserId&quot;: &quot;A String&quot;, # The ID of the advertiser that owns the channel.
253 &quot;channelId&quot;: &quot;A String&quot;, # Output only. The unique ID of the channel. Assigned by the system.
254 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes.
255 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the channel.
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700256 &quot;negativelyTargetedLineItemCount&quot;: &quot;A String&quot;, # Output only. Number of line items that are directly targeting this channel negatively.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800257 &quot;partnerId&quot;: &quot;A String&quot;, # The ID of the partner that owns the channel.
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700258 &quot;positivelyTargetedLineItemCount&quot;: &quot;A String&quot;, # Output only. Number of line items that are directly targeting this channel positively.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800259}</pre>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700260</div>
261
Bu Sun Kim65020912020-05-20 12:08:20 -0700262</body></html>