Blame - docs/dyn/displayvideo_v1.advertisers.channels.html - platform/external/python/google-api-python-client

blob: d05a97fc1b31959934ccbf0dae714ac1f62feb79 [file] [log] [blame]

Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	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="displayvideo_v1.html">Display & Video 360 API</a> . <a href="displayvideo_v1.advertisers.html">advertisers</a> . <a href="displayvideo_v1.advertisers.channels.html">channels</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	78	<code><a href="displayvideo_v1.advertisers.channels.sites.html">sites()</a></code>
				79	</p>
				80	<p class="firstline">Returns the sites Resource.</p>
				81
				82	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	83	<code><a href="#close">close()</a></code></p>
				84	<p class="firstline">Close httplib2 connections.</p>
				85	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	86	<code><a href="#create">create(advertiserId, body=None, partnerId=None, x__xgafv=None)</a></code></p>
				87	<p class="firstline">Creates a new channel. Returns the newly created channel if successful.</p>
				88	<p class="toc_element">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	89	<code><a href="#get">get(advertiserId, channelId, partnerId=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 Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	92	<code><a href="#list">list(advertiserId, pageSize=None, pageToken=None, orderBy=None, partnerId=None, filter=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	93	<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 Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	97	<p class="toc_element">
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	98	<code><a href="#patch">patch(advertiserId, channelId, body=None, updateMask=None, partnerId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	99	<p class="firstline">Updates a channel. Returns the updated channel if successful.</p>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	100	<h3>Method Details</h3>
				101	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	102	<code class="details" id="close">close()</code>
				103	<pre>Close httplib2 connections.</pre>
				104	</div>
				105
				106	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	107	<code class="details" id="create">create(advertiserId, body=None, partnerId=None, x__xgafv=None)</code>
				108	<pre>Creates a new channel. Returns the newly created channel if successful.
				109
				110	Args:
				111	advertiserId: string, The ID of the advertiser 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 Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	116	"name": "A String", # Output only. The resource name of the channel.
				117	"displayName": "A String", # Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes.
				118	"advertiserId": "A String", # The ID of the advertiser that owns the channel.
				119	"channelId": "A String", # Output only. The unique ID of the channel. Assigned by the system.
				120	"partnerId": "A String", # The ID of the partner that owns the channel.
				121	}
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	122
				123	partnerId: string, The ID of the partner that owns the created channel.
				124	x__xgafv: string, V1 error format.
				125	Allowed values
				126	1 - v1 error format
				127	2 - v2 error format
				128
				129	Returns:
				130	An object of the form:
				131
				132	{ # A single channel. Channels are custom groups of related websites and apps.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	133	"name": "A String", # Output only. The resource name of the channel.
				134	"displayName": "A String", # Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes.
				135	"advertiserId": "A String", # The ID of the advertiser that owns the channel.
				136	"channelId": "A String", # Output only. The unique ID of the channel. Assigned by the system.
				137	"partnerId": "A String", # The ID of the partner that owns the channel.
				138	}</pre>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	139	</div>
				140
				141	<div class="method">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	142	<code class="details" id="get">get(advertiserId, channelId, partnerId=None, x__xgafv=None)</code>
				143	<pre>Gets a channel for a partner or advertiser.
				144
				145	Args:
				146	advertiserId: string, The ID of the advertiser that owns the fetched channel. (required)
				147	channelId: string, Required. The ID of the channel to fetch. (required)
				148	partnerId: string, The ID of the partner that owns the fetched channel.
				149	x__xgafv: string, V1 error format.
				150	Allowed values
				151	1 - v1 error format
				152	2 - v2 error format
				153
				154	Returns:
				155	An object of the form:
				156
				157	{ # A single channel. Channels are custom groups of related websites and apps.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	158	"name": "A String", # Output only. The resource name of the channel.
				159	"displayName": "A String", # Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes.
				160	"advertiserId": "A String", # The ID of the advertiser that owns the channel.
				161	"channelId": "A String", # Output only. The unique ID of the channel. Assigned by the system.
				162	"partnerId": "A String", # The ID of the partner that owns the channel.
				163	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	164	</div>
				165
				166	<div class="method">
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	167	<code class="details" id="list">list(advertiserId, pageSize=None, pageToken=None, orderBy=None, partnerId=None, filter=None, x__xgafv=None)</code>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	168	<pre>Lists channels for a partner or advertiser.
				169
				170	Args:
				171	advertiserId: string, The ID of the advertiser that owns the channels. (required)
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	172	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.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	173	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.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	174	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 " desc" should be added to the field name. Example: `displayName desc`.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	175	partnerId: string, The ID of the partner that owns the channels.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	176	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 "google": `displayName : "google"`. The length of this field should be no more than 500 characters.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	177	x__xgafv: string, V1 error format.
				178	Allowed values
				179	1 - v1 error format
				180	2 - v2 error format
				181
				182	Returns:
				183	An object of the form:
				184
				185	{
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	186	"channels": [ # The list of channels. This list will be absent if empty.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	187	{ # A single channel. Channels are custom groups of related websites and apps.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	188	"name": "A String", # Output only. The resource name of the channel.
				189	"displayName": "A String", # Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes.
				190	"advertiserId": "A String", # The ID of the advertiser that owns the channel.
				191	"channelId": "A String", # Output only. The unique ID of the channel. Assigned by the system.
				192	"partnerId": "A String", # The ID of the partner that owns the channel.
				193	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	194	],
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	195	"nextPageToken": "A String", # 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.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	196	}</pre>
				197	</div>
				198
				199	<div class="method">
				200	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				201	<pre>Retrieves the next page of results.
				202
				203	Args:
				204	previous_request: The request for the previous page. (required)
				205	previous_response: The response from the request for the previous page. (required)
				206
				207	Returns:
				208	A request object that you can call 'execute()' on to request the next
				209	page. Returns None if there are no more items in the collection.
				210	</pre>
				211	</div>
				212
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	213	<div class="method">
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	214	<code class="details" id="patch">patch(advertiserId, channelId, body=None, updateMask=None, partnerId=None, x__xgafv=None)</code>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	215	<pre>Updates a channel. Returns the updated channel if successful.
				216
				217	Args:
				218	advertiserId: string, The ID of the advertiser that owns the created channel. (required)
				219	channelId: string, Output only. The unique ID of the channel. Assigned by the system. (required)
				220	body: object, The request body.
				221	The object takes the form of:
				222
				223	{ # A single channel. Channels are custom groups of related websites and apps.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	224	"name": "A String", # Output only. The resource name of the channel.
				225	"displayName": "A String", # Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes.
				226	"advertiserId": "A String", # The ID of the advertiser that owns the channel.
				227	"channelId": "A String", # Output only. The unique ID of the channel. Assigned by the system.
				228	"partnerId": "A String", # The ID of the partner that owns the channel.
				229	}
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	230
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	231	updateMask: string, Required. The mask to control which fields to update.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	232	partnerId: string, The ID of the partner that owns the created channel.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	233	x__xgafv: string, V1 error format.
				234	Allowed values
				235	1 - v1 error format
				236	2 - v2 error format
				237
				238	Returns:
				239	An object of the form:
				240
				241	{ # A single channel. Channels are custom groups of related websites and apps.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	242	"name": "A String", # Output only. The resource name of the channel.
				243	"displayName": "A String", # Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes.
				244	"advertiserId": "A String", # The ID of the advertiser that owns the channel.
				245	"channelId": "A String", # Output only. The unique ID of the channel. Assigned by the system.
				246	"partnerId": "A String", # The ID of the partner that owns the channel.
				247	}</pre>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	248	</div>
				249
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	250	</body></html>