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

blob: 400aef84e607bca8f1552a4a4f28434858a13932 [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">
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">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	86	<code><a href="#create">create(partnerId, advertiserId=None, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	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(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 Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	92	<code><a href="#list">list(partnerId, advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=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	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	98	<code><a href="#patch">patch(partnerId, channelId, advertiserId=None, body=None, updateMask=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">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	107	<code class="details" id="create">create(partnerId, advertiserId=None, body=None, x__xgafv=None)</code>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	108	<pre>Creates a new channel. Returns the newly created channel if successful.
				109
				110	Args:
				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 Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	116	"advertiserId": "A String", # The ID of the advertiser that owns the channel.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	117	"channelId": "A String", # Output only. The unique ID of the channel. Assigned by the system.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	118	"displayName": "A String", # Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	119	"name": "A String", # Output only. The resource name of the channel.
yoshi-code-bot	f0c2fa6	2021-04-23 08:24:04 -0700	[diff] [blame]	120	"negativelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel negatively.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	121	"partnerId": "A String", # The ID of the partner that owns the channel.
yoshi-code-bot	f0c2fa6	2021-04-23 08:24:04 -0700	[diff] [blame]	122	"positivelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel positively.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	123	}
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	124
				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
				131	Returns:
				132	An object of the form:
				133
				134	{ # A single channel. Channels are custom groups of related websites and apps.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	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	"displayName": "A String", # Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes.
				138	"name": "A String", # Output only. The resource name of the channel.
yoshi-code-bot	f0c2fa6	2021-04-23 08:24:04 -0700	[diff] [blame]	139	"negativelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel negatively.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	140	"partnerId": "A String", # The ID of the partner that owns the channel.
yoshi-code-bot	f0c2fa6	2021-04-23 08:24:04 -0700	[diff] [blame]	141	"positivelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel positively.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	142	}</pre>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	143	</div>
				144
				145	<div class="method">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	146	<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
				149	Args:
				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
				158	Returns:
				159	An object of the form:
				160
				161	{ # A single channel. Channels are custom groups of related websites and apps.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	162	"advertiserId": "A String", # The ID of the advertiser that owns the channel.
				163	"channelId": "A String", # Output only. The unique ID of the channel. Assigned by the system.
				164	"displayName": "A String", # Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes.
				165	"name": "A String", # Output only. The resource name of the channel.
yoshi-code-bot	f0c2fa6	2021-04-23 08:24:04 -0700	[diff] [blame]	166	"negativelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel negatively.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	167	"partnerId": "A String", # The ID of the partner that owns the channel.
yoshi-code-bot	f0c2fa6	2021-04-23 08:24:04 -0700	[diff] [blame]	168	"positivelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel positively.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	169	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	170	</div>
				171
				172	<div class="method">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	173	<code class="details" id="list">list(partnerId, advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	174	<pre>Lists channels for a partner or advertiser.
				175
				176	Args:
				177	partnerId: string, The ID of the partner that owns the channels. (required)
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	178	advertiserId: string, The ID of the advertiser that owns the channels.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	179	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.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	180	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`.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	181	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 Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	183	x__xgafv: string, V1 error format.
				184	Allowed values
				185	1 - v1 error format
				186	2 - v2 error format
				187
				188	Returns:
				189	An object of the form:
				190
				191	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	192	"channels": [ # 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	"advertiserId": "A String", # The ID of the advertiser that owns the channel.
				195	"channelId": "A String", # Output only. The unique ID of the channel. Assigned by the system.
				196	"displayName": "A String", # Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes.
				197	"name": "A String", # Output only. The resource name of the channel.
yoshi-code-bot	f0c2fa6	2021-04-23 08:24:04 -0700	[diff] [blame]	198	"negativelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel negatively.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	199	"partnerId": "A String", # The ID of the partner that owns the channel.
yoshi-code-bot	f0c2fa6	2021-04-23 08:24:04 -0700	[diff] [blame]	200	"positivelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel positively.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	201	},
				202	],
				203	"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.
				204	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	205	</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
				211	Args:
				212	previous_request: The request for the previous page. (required)
				213	previous_response: The response from the request for the previous page. (required)
				214
				215	Returns:
				216	A request object that you can call 'execute()' 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 Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	221	<div class="method">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	222	<code class="details" id="patch">patch(partnerId, channelId, advertiserId=None, body=None, updateMask=None, x__xgafv=None)</code>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	223	<pre>Updates a channel. Returns the updated channel if successful.
				224
				225	Args:
				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 Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	232	"advertiserId": "A String", # The ID of the advertiser that owns the channel.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	233	"channelId": "A String", # Output only. The unique ID of the channel. Assigned by the system.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	234	"displayName": "A String", # Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	235	"name": "A String", # Output only. The resource name of the channel.
yoshi-code-bot	f0c2fa6	2021-04-23 08:24:04 -0700	[diff] [blame]	236	"negativelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel negatively.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	237	"partnerId": "A String", # The ID of the partner that owns the channel.
yoshi-code-bot	f0c2fa6	2021-04-23 08:24:04 -0700	[diff] [blame]	238	"positivelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel positively.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	239	}
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	240
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	241	advertiserId: string, The ID of the advertiser that owns the created channel.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	242	updateMask: string, Required. The mask to control which fields to update.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	243	x__xgafv: string, V1 error format.
				244	Allowed values
				245	1 - v1 error format
				246	2 - v2 error format
				247
				248	Returns:
				249	An object of the form:
				250
				251	{ # A single channel. Channels are custom groups of related websites and apps.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	252	"advertiserId": "A String", # The ID of the advertiser that owns the channel.
				253	"channelId": "A String", # Output only. The unique ID of the channel. Assigned by the system.
				254	"displayName": "A String", # Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes.
				255	"name": "A String", # Output only. The resource name of the channel.
yoshi-code-bot	f0c2fa6	2021-04-23 08:24:04 -0700	[diff] [blame]	256	"negativelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel negatively.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	257	"partnerId": "A String", # The ID of the partner that owns the channel.
yoshi-code-bot	f0c2fa6	2021-04-23 08:24:04 -0700	[diff] [blame]	258	"positivelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel positively.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	259	}</pre>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	260	</div>
				261
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	262	</body></html>