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

blob: 1a70495827ce259213d37ff89402d24ac1b5e8c7 [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">
				78	<code><a href="#get">get(partnerId, channelId, advertiserId=None, x__xgafv=None)</a></code></p>
				79	<p class="firstline">Gets a channel for a partner or advertiser.</p>
				80	<p class="toc_element">
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	81	<code><a href="#list">list(partnerId, filter=None, pageToken=None, pageSize=None, advertiserId=None, orderBy=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	82	<p class="firstline">Lists channels for a partner or advertiser.</p>
				83	<p class="toc_element">
				84	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				85	<p class="firstline">Retrieves the next page of results.</p>
				86	<h3>Method Details</h3>
				87	<div class="method">
				88	<code class="details" id="get">get(partnerId, channelId, advertiserId=None, x__xgafv=None)</code>
				89	<pre>Gets a channel for a partner or advertiser.
				90
				91	Args:
				92	partnerId: string, The ID of the partner that owns the fetched channel. (required)
				93	channelId: string, Required. The ID of the channel to fetch. (required)
				94	advertiserId: string, The ID of the advertiser that owns the fetched channel.
				95	x__xgafv: string, V1 error format.
				96	Allowed values
				97	1 - v1 error format
				98	2 - v2 error format
				99
				100	Returns:
				101	An object of the form:
				102
				103	{ # A single channel. Channels are custom groups of related websites and apps.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	104	"name": "A String", # Output only. The resource name of the channel.
				105	"displayName": "A String", # Required. The display name of the channel.
				106	# Must be UTF-8 encoded with a maximum length of 240 bytes.
				107	"partnerId": "A String", # The ID of the partner that owns the channel.
				108	"channelId": "A String", # Output only. The unique ID of the channel. Assigned by the system.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	109	"advertiserId": "A String", # The ID of the advertiser that owns the channel.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	110	}</pre>
				111	</div>
				112
				113	<div class="method">
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	114	<code class="details" id="list">list(partnerId, filter=None, pageToken=None, pageSize=None, advertiserId=None, orderBy=None, x__xgafv=None)</code>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	115	<pre>Lists channels for a partner or advertiser.
				116
				117	Args:
				118	partnerId: string, The ID of the partner that owns the channels. (required)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	119	filter: string, Allows filtering by channel fields.
				120
				121	Supported syntax:
				122
				123	* Filter expressions for channel currently can only contain at most one
				124	* restriction.
				125	* A restriction has the form of `{field} {operator} {value}`.
				126	* The operator must be `CONTAINS (:)`.
				127	* Supported fields:
				128	- `displayName`
				129
				130	Examples:
				131
				132	* All channels for which the display name contains "google":
				133	`displayName : "google"`.
				134
				135	The length of this field should be no more than 500 characters.
				136	pageToken: string, A token identifying a page of results the server should return.
				137	Typically, this is the value of
				138	next_page_token returned from the
				139	previous call to `ListChannels` method. If not specified, the first page
				140	of results will be returned.
				141	pageSize: integer, Requested page size. Must be between `1` and `100`. If unspecified will
				142	default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
				143	is specified.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	144	advertiserId: string, The ID of the advertiser that owns the channels.
				145	orderBy: string, Field by which to sort the list.
				146	Acceptable values are:
				147
				148	* `displayName` (default)
				149	* `channelId`
				150
				151	The default sorting order is ascending. To specify descending order for a
				152	field, a suffix " desc" should be added to the field name. Example:
				153	`displayName desc`.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	154	x__xgafv: string, V1 error format.
				155	Allowed values
				156	1 - v1 error format
				157	2 - v2 error format
				158
				159	Returns:
				160	An object of the form:
				161
				162	{
				163	"nextPageToken": "A String", # A token to retrieve the next page of results.
				164	# Pass this value in the page_token field
				165	# in the subsequent call to `ListChannels` method to retrieve the next page
				166	# of results.
				167	"channels": [ # The list of channels.
				168	#
				169	# This list will be absent if empty.
				170	{ # A single channel. Channels are custom groups of related websites and apps.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	171	"name": "A String", # Output only. The resource name of the channel.
				172	"displayName": "A String", # Required. The display name of the channel.
				173	# Must be UTF-8 encoded with a maximum length of 240 bytes.
				174	"partnerId": "A String", # The ID of the partner that owns the channel.
				175	"channelId": "A String", # Output only. The unique ID of the channel. Assigned by the system.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	176	"advertiserId": "A String", # The ID of the advertiser that owns the channel.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	177	},
				178	],
				179	}</pre>
				180	</div>
				181
				182	<div class="method">
				183	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				184	<pre>Retrieves the next page of results.
				185
				186	Args:
				187	previous_request: The request for the previous page. (required)
				188	previous_response: The response from the request for the previous page. (required)
				189
				190	Returns:
				191	A request object that you can call 'execute()' on to request the next
				192	page. Returns None if there are no more items in the collection.
				193	</pre>
				194	</div>
				195
				196	</body></html>