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

blob: 68af64f742e1d57a2c0a00bfc8cf4442cffee9cb [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.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 Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame^]	78	<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">
				83	<code><a href="#create">create(partnerId, body=None, advertiserId=None, x__xgafv=None)</a></code></p>
				84	<p class="firstline">Creates a new channel. Returns the newly created channel if successful.</p>
				85	<p class="toc_element">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	86	<code><a href="#get">get(partnerId, channelId, advertiserId=None, x__xgafv=None)</a></code></p>
				87	<p class="firstline">Gets a channel for a partner or advertiser.</p>
				88	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame^]	89	<code><a href="#list">list(partnerId, orderBy=None, pageToken=None, filter=None, advertiserId=None, pageSize=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	90	<p class="firstline">Lists channels for a partner or advertiser.</p>
				91	<p class="toc_element">
				92	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				93	<p class="firstline">Retrieves the next page of results.</p>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame^]	94	<p class="toc_element">
				95	<code><a href="#patch">patch(partnerId, channelId, body=None, updateMask=None, advertiserId=None, x__xgafv=None)</a></code></p>
				96	<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]	97	<h3>Method Details</h3>
				98	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame^]	99	<code class="details" id="create">create(partnerId, body=None, advertiserId=None, x__xgafv=None)</code>
				100	<pre>Creates a new channel. Returns the newly created channel if successful.
				101
				102	Args:
				103	partnerId: string, The ID of the partner that owns the created channel. (required)
				104	body: object, The request body.
				105	The object takes the form of:
				106
				107	{ # A single channel. Channels are custom groups of related websites and apps.
				108	"advertiserId": "A String", # The ID of the advertiser that owns the channel.
				109	"channelId": "A String", # Output only. The unique ID of the channel. Assigned by the system.
				110	"displayName": "A String", # Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes.
				111	"partnerId": "A String", # The ID of the partner that owns the channel.
				112	"name": "A String", # Output only. The resource name of the channel.
				113	}
				114
				115	advertiserId: string, The ID of the advertiser that owns the created channel.
				116	x__xgafv: string, V1 error format.
				117	Allowed values
				118	1 - v1 error format
				119	2 - v2 error format
				120
				121	Returns:
				122	An object of the form:
				123
				124	{ # A single channel. Channels are custom groups of related websites and apps.
				125	"advertiserId": "A String", # The ID of the advertiser that owns the channel.
				126	"channelId": "A String", # Output only. The unique ID of the channel. Assigned by the system.
				127	"displayName": "A String", # Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes.
				128	"partnerId": "A String", # The ID of the partner that owns the channel.
				129	"name": "A String", # Output only. The resource name of the channel.
				130	}</pre>
				131	</div>
				132
				133	<div class="method">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	134	<code class="details" id="get">get(partnerId, channelId, advertiserId=None, x__xgafv=None)</code>
				135	<pre>Gets a channel for a partner or advertiser.
				136
				137	Args:
				138	partnerId: string, The ID of the partner that owns the fetched channel. (required)
				139	channelId: string, Required. The ID of the channel to fetch. (required)
				140	advertiserId: string, The ID of the advertiser that owns the fetched channel.
				141	x__xgafv: string, V1 error format.
				142	Allowed values
				143	1 - v1 error format
				144	2 - v2 error format
				145
				146	Returns:
				147	An object of the form:
				148
				149	{ # A single channel. Channels are custom groups of related websites and apps.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	150	"advertiserId": "A String", # The ID of the advertiser that owns the channel.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame^]	151	"channelId": "A String", # Output only. The unique ID of the channel. Assigned by the system.
				152	"displayName": "A String", # Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes.
				153	"partnerId": "A String", # The ID of the partner that owns the channel.
				154	"name": "A String", # Output only. The resource name of the channel.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	155	}</pre>
				156	</div>
				157
				158	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame^]	159	<code class="details" id="list">list(partnerId, orderBy=None, pageToken=None, filter=None, advertiserId=None, pageSize=None, x__xgafv=None)</code>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	160	<pre>Lists channels for a partner or advertiser.
				161
				162	Args:
				163	partnerId: string, The ID of the partner that owns the channels. (required)
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame^]	164	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`.
				165	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.
				166	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	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	167	advertiserId: string, The ID of the advertiser that owns the channels.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame^]	168	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	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	169	x__xgafv: string, V1 error format.
				170	Allowed values
				171	1 - v1 error format
				172	2 - v2 error format
				173
				174	Returns:
				175	An object of the form:
				176
				177	{
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame^]	178	"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.
				179	"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]	180	{ # A single channel. Channels are custom groups of related websites and apps.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	181	"advertiserId": "A String", # The ID of the advertiser that owns the channel.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame^]	182	"channelId": "A String", # Output only. The unique ID of the channel. Assigned by the system.
				183	"displayName": "A String", # Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes.
				184	"partnerId": "A String", # The ID of the partner that owns the channel.
				185	"name": "A String", # Output only. The resource name of the channel.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	186	},
				187	],
				188	}</pre>
				189	</div>
				190
				191	<div class="method">
				192	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				193	<pre>Retrieves the next page of results.
				194
				195	Args:
				196	previous_request: The request for the previous page. (required)
				197	previous_response: The response from the request for the previous page. (required)
				198
				199	Returns:
				200	A request object that you can call 'execute()' on to request the next
				201	page. Returns None if there are no more items in the collection.
				202	</pre>
				203	</div>
				204
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame^]	205	<div class="method">
				206	<code class="details" id="patch">patch(partnerId, channelId, body=None, updateMask=None, advertiserId=None, x__xgafv=None)</code>
				207	<pre>Updates a channel. Returns the updated channel if successful.
				208
				209	Args:
				210	partnerId: string, The ID of the partner that owns the created channel. (required)
				211	channelId: string, Output only. The unique ID of the channel. Assigned by the system. (required)
				212	body: object, The request body.
				213	The object takes the form of:
				214
				215	{ # A single channel. Channels are custom groups of related websites and apps.
				216	"advertiserId": "A String", # The ID of the advertiser that owns the channel.
				217	"channelId": "A String", # Output only. The unique ID of the channel. Assigned by the system.
				218	"displayName": "A String", # Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes.
				219	"partnerId": "A String", # The ID of the partner that owns the channel.
				220	"name": "A String", # Output only. The resource name of the channel.
				221	}
				222
				223	updateMask: string, Required. The mask to control which fields to update.
				224	advertiserId: string, The ID of the advertiser that owns the created channel.
				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	{ # A single channel. Channels are custom groups of related websites and apps.
				234	"advertiserId": "A String", # The ID of the advertiser that owns the channel.
				235	"channelId": "A String", # Output only. The unique ID of the channel. Assigned by the system.
				236	"displayName": "A String", # Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes.
				237	"partnerId": "A String", # The ID of the partner that owns the channel.
				238	"name": "A String", # Output only. The resource name of the channel.
				239	}</pre>
				240	</div>
				241
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	242	</body></html>