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

blob: 749a2b7faf93749ac56d0f0877ae78a7fc86d753 [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.firstAndThirdPartyAudiences.html">firstAndThirdPartyAudiences</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="#get">get(firstAndThirdPartyAudienceId, partnerId=None, advertiserId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	79	<p class="firstline">Gets a first and third party audience.</p>
				80	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	81	<code><a href="#list">list(advertiserId=None, partnerId=None, orderBy=None, pageSize=None, pageToken=None, filter=None, x__xgafv=None)</a></code></p>
				82	<p class="firstline">Lists first and third party audiences. The order is defined by the order_by parameter.</p>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	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">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	88	<code class="details" id="get">get(firstAndThirdPartyAudienceId, partnerId=None, advertiserId=None, x__xgafv=None)</code>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	89	<pre>Gets a first and third party audience.
				90
				91	Args:
				92	firstAndThirdPartyAudienceId: string, Required. The ID of the first and third party audience to fetch. (required)
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	93	partnerId: string, The ID of the partner that has access to the fetched first and third party audience.
				94	advertiserId: string, The ID of the advertiser that has access to the fetched first and third party audience.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	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
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	103	{ # Describes a first or third party audience list used for targeting. First party audiences are created via usage of client data. Third party audiences are provided by Third Party data providers and can only be licensed to customers.
				104	"description": "A String", # The user-provided description of the audience. Only applicable to first party audiences.
				105	"firstAndThirdPartyAudienceId": "A String", # Output only. The unique ID of the first and third party audience. Assigned by the system.
				106	"gmailAudienceSize": "A String", # Output only. The estimated audience size for Gmail network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	107	"firstAndThirdPartyAudienceType": "A String", # Output only. Whether the audience is a first or third party audience.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	108	"displayName": "A String", # The display name of the first and third party audience.
				109	"displayMobileAppAudienceSize": "A String", # Output only. The estimated mobile app audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
				110	"displayMobileWebAudienceSize": "A String", # Output only. The estimated mobile web audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
				111	"membershipDurationDays": "A String", # The duration in days that an entry remains in the audience after the qualifying event. Only applicable to first party audiences.
				112	"audienceType": "A String", # Output only. The type of the audience.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	113	"name": "A String", # Output only. The resource name of the first and third party audience.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	114	"displayAudienceSize": "A String", # Output only. The estimated audience size for the Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request.
				115	"youtubeAudienceSize": "A String", # Output only. The estimated audience size for YouTube network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
				116	"activeDisplayAudienceSize": "A String", # Output only. The estimated audience size for the Display network in the past month. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request.
				117	"audienceSource": "A String", # Output only. The source of the audience.
				118	"displayDesktopAudienceSize": "A String", # Output only. The estimated desktop audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	119	}</pre>
				120	</div>
				121
				122	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	123	<code class="details" id="list">list(advertiserId=None, partnerId=None, orderBy=None, pageSize=None, pageToken=None, filter=None, x__xgafv=None)</code>
				124	<pre>Lists first and third party audiences. The order is defined by the order_by parameter.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	125
				126	Args:
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	127	advertiserId: string, The ID of the advertiser that has access to the fetched first and third party audiences.
				128	partnerId: string, The ID of the partner that has access to the fetched first and third party audiences.
				129	orderBy: string, Field by which to sort the list. Acceptable values are: * `firstAndThirdPartyAudienceId` (default) * `displayName` 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`.
				130	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.
				131	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 `ListFirstAndThirdPartyAudiences` method. If not specified, the first page of results will be returned.
				132	filter: string, Allows filtering by first and third party audience fields. Supported syntax: * Filter expressions for first and third party audiences 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 first and third party audiences 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]	133	x__xgafv: string, V1 error format.
				134	Allowed values
				135	1 - v1 error format
				136	2 - v2 error format
				137
				138	Returns:
				139	An object of the form:
				140
				141	{
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	142	"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 `ListFirstAndThirdPartyAudiences` method to retrieve the next page of results.
				143	"firstAndThirdPartyAudiences": [ # The list of first and third party audiences. Audience size properties will not be included. This list will be absent if empty.
				144	{ # Describes a first or third party audience list used for targeting. First party audiences are created via usage of client data. Third party audiences are provided by Third Party data providers and can only be licensed to customers.
				145	"description": "A String", # The user-provided description of the audience. Only applicable to first party audiences.
				146	"firstAndThirdPartyAudienceId": "A String", # Output only. The unique ID of the first and third party audience. Assigned by the system.
				147	"gmailAudienceSize": "A String", # Output only. The estimated audience size for Gmail network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	148	"firstAndThirdPartyAudienceType": "A String", # Output only. Whether the audience is a first or third party audience.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	149	"displayName": "A String", # The display name of the first and third party audience.
				150	"displayMobileAppAudienceSize": "A String", # Output only. The estimated mobile app audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
				151	"displayMobileWebAudienceSize": "A String", # Output only. The estimated mobile web audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
				152	"membershipDurationDays": "A String", # The duration in days that an entry remains in the audience after the qualifying event. Only applicable to first party audiences.
				153	"audienceType": "A String", # Output only. The type of the audience.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	154	"name": "A String", # Output only. The resource name of the first and third party audience.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	155	"displayAudienceSize": "A String", # Output only. The estimated audience size for the Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request.
				156	"youtubeAudienceSize": "A String", # Output only. The estimated audience size for YouTube network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
				157	"activeDisplayAudienceSize": "A String", # Output only. The estimated audience size for the Display network in the past month. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request.
				158	"audienceSource": "A String", # Output only. The source of the audience.
				159	"displayDesktopAudienceSize": "A String", # Output only. The estimated desktop audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	160	},
				161	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	162	}</pre>
				163	</div>
				164
				165	<div class="method">
				166	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				167	<pre>Retrieves the next page of results.
				168
				169	Args:
				170	previous_request: The request for the previous page. (required)
				171	previous_response: The response from the request for the previous page. (required)
				172
				173	Returns:
				174	A request object that you can call 'execute()' on to request the next
				175	page. Returns None if there are no more items in the collection.
				176	</pre>
				177	</div>
				178
				179	</body></html>