Blame - docs/dyn/adexchangebuyer2_v2beta1.accounts.publisherProfiles.html - platform/external/python/google-api-python-client

blob: 47f20d514197f436c0186e525a2d17448c67741e [file] [log] [blame]

Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -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="adexchangebuyer2_v2beta1.html">Ad Exchange Buyer API II</a> . <a href="adexchangebuyer2_v2beta1.accounts.html">accounts</a> . <a href="adexchangebuyer2_v2beta1.accounts.publisherProfiles.html">publisherProfiles</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	78	<code><a href="#close">close()</a></code></p>
				79	<p class="firstline">Close httplib2 connections.</p>
				80	<p class="toc_element">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	81	<code><a href="#get">get(accountId, publisherProfileId, x__xgafv=None)</a></code></p>
				82	<p class="firstline">Gets the requested publisher profile by id.</p>
				83	<p class="toc_element">
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame^]	84	<code><a href="#list">list(accountId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	85	<p class="firstline">List all publisher profiles visible to the buyer</p>
				86	<p class="toc_element">
				87	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				88	<p class="firstline">Retrieves the next page of results.</p>
				89	<h3>Method Details</h3>
				90	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	91	<code class="details" id="close">close()</code>
				92	<pre>Close httplib2 connections.</pre>
				93	</div>
				94
				95	<div class="method">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	96	<code class="details" id="get">get(accountId, publisherProfileId, x__xgafv=None)</code>
				97	<pre>Gets the requested publisher profile by id.
				98
				99	Args:
				100	accountId: string, Account ID of the buyer. (required)
				101	publisherProfileId: string, The id for the publisher profile to get. (required)
				102	x__xgafv: string, V1 error format.
				103	Allowed values
				104	1 - v1 error format
				105	2 - v2 error format
				106
				107	Returns:
				108	An object of the form:
				109
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	110	{ # Note: this resource requires whitelisting for access. Please contact your account manager for access to Marketplace resources. Represents a publisher profile (https://support.google.com/admanager/answer/6035806) in Marketplace. All fields are read only. All string fields are free-form text entered by the publisher unless noted otherwise.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame^]	111	"googlePlusUrl": "A String", # URL to publisher's Google+ page.
				112	"logoUrl": "A String", # A Google public URL to the logo for this publisher profile. The logo is stored as a PNG, JPG, or GIF image.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	113	"rateCardInfoUrl": "A String", # URL to a publisher rate card.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame^]	114	"programmaticDealsContact": "A String", # Contact information for programmatic deals. This is free text entered by the publisher and may include information like names, phone numbers and email addresses.
				115	"samplePageUrl": "A String", # URL to a sample content page.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	116	"domains": [ # The list of domains represented in this publisher profile. Empty if this is a parent profile. These are top private domains, meaning that these will not contain a string like "photos.google.co.uk/123", but will instead contain "google.co.uk".
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	117	"A String",
				118	],
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame^]	119	"isParent": True or False, # Indicates if this profile is the parent profile of the seller. A parent profile represents all the inventory from the seller, as opposed to child profile that is created to brand a portion of inventory. One seller should have only one parent publisher profile, and can have multiple child profiles. Publisher profiles for the same seller will have same value of field google.ads.adexchange.buyer.v2beta1.PublisherProfile.seller. See https://support.google.com/admanager/answer/6035806 for details.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	120	"topHeadlines": [ # Up to three key metrics and rankings. Max 100 characters each. For example "#1 Mobile News Site for 20 Straight Months".
				121	"A String",
				122	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	123	"buyerPitchStatement": "A String", # Statement explaining what's unique about publisher's business, and why buyers should partner with the publisher.
				124	"directDealsContact": "A String", # Contact information for direct reservation deals. This is free text entered by the publisher and may include information like names, phone numbers and email addresses.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	125	"seller": { # Represents a seller of inventory. Each seller is identified by a unique Ad Manager account ID. # Seller of the publisher profile.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	126	"subAccountId": "A String", # Optional sub-account ID for the seller.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	127	"accountId": "A String", # The unique ID for the seller. The seller fills in this field. The seller account ID is then available to buyer in the product.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	128	},
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame^]	129	"mobileApps": [ # The list of apps represented in this publisher profile. Empty if this is a parent profile.
				130	{ # A mobile application that contains a external app ID, name, and app store.
				131	"appStore": "A String", # The app store the app belongs to.
				132	"name": "A String", # The name of the app.
				133	"externalAppId": "A String", # The external ID for the app from its app store.
				134	},
				135	],
				136	"displayName": "A String", # Name of the publisher profile.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	137	"mediaKitUrl": "A String", # URL to additional marketing and sales materials.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame^]	138	"publisherProfileId": "A String", # Unique ID for publisher profile.
				139	"overview": "A String", # Overview of the publisher.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	140	"audienceDescription": "A String", # Description on the publisher's audience.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	141	}</pre>
				142	</div>
				143
				144	<div class="method">
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame^]	145	<code class="details" id="list">list(accountId, pageSize=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	146	<pre>List all publisher profiles visible to the buyer
				147
				148	Args:
				149	accountId: string, Account ID of the buyer. (required)
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	150	pageSize: integer, Specify the number of results to include per page.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame^]	151	pageToken: string, The page token as return from ListPublisherProfilesResponse.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	152	x__xgafv: string, V1 error format.
				153	Allowed values
				154	1 - v1 error format
				155	2 - v2 error format
				156
				157	Returns:
				158	An object of the form:
				159
				160	{ # Response message for profiles visible to the buyer.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame^]	161	"nextPageToken": "A String", # List pagination support
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	162	"publisherProfiles": [ # The list of matching publisher profiles.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	163	{ # Note: this resource requires whitelisting for access. Please contact your account manager for access to Marketplace resources. Represents a publisher profile (https://support.google.com/admanager/answer/6035806) in Marketplace. All fields are read only. All string fields are free-form text entered by the publisher unless noted otherwise.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame^]	164	"googlePlusUrl": "A String", # URL to publisher's Google+ page.
				165	"logoUrl": "A String", # A Google public URL to the logo for this publisher profile. The logo is stored as a PNG, JPG, or GIF image.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	166	"rateCardInfoUrl": "A String", # URL to a publisher rate card.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame^]	167	"programmaticDealsContact": "A String", # Contact information for programmatic deals. This is free text entered by the publisher and may include information like names, phone numbers and email addresses.
				168	"samplePageUrl": "A String", # URL to a sample content page.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	169	"domains": [ # The list of domains represented in this publisher profile. Empty if this is a parent profile. These are top private domains, meaning that these will not contain a string like "photos.google.co.uk/123", but will instead contain "google.co.uk".
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	170	"A String",
				171	],
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame^]	172	"isParent": True or False, # Indicates if this profile is the parent profile of the seller. A parent profile represents all the inventory from the seller, as opposed to child profile that is created to brand a portion of inventory. One seller should have only one parent publisher profile, and can have multiple child profiles. Publisher profiles for the same seller will have same value of field google.ads.adexchange.buyer.v2beta1.PublisherProfile.seller. See https://support.google.com/admanager/answer/6035806 for details.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	173	"topHeadlines": [ # Up to three key metrics and rankings. Max 100 characters each. For example "#1 Mobile News Site for 20 Straight Months".
				174	"A String",
				175	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	176	"buyerPitchStatement": "A String", # Statement explaining what's unique about publisher's business, and why buyers should partner with the publisher.
				177	"directDealsContact": "A String", # Contact information for direct reservation deals. This is free text entered by the publisher and may include information like names, phone numbers and email addresses.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	178	"seller": { # Represents a seller of inventory. Each seller is identified by a unique Ad Manager account ID. # Seller of the publisher profile.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	179	"subAccountId": "A String", # Optional sub-account ID for the seller.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	180	"accountId": "A String", # The unique ID for the seller. The seller fills in this field. The seller account ID is then available to buyer in the product.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	181	},
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame^]	182	"mobileApps": [ # The list of apps represented in this publisher profile. Empty if this is a parent profile.
				183	{ # A mobile application that contains a external app ID, name, and app store.
				184	"appStore": "A String", # The app store the app belongs to.
				185	"name": "A String", # The name of the app.
				186	"externalAppId": "A String", # The external ID for the app from its app store.
				187	},
				188	],
				189	"displayName": "A String", # Name of the publisher profile.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	190	"mediaKitUrl": "A String", # URL to additional marketing and sales materials.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame^]	191	"publisherProfileId": "A String", # Unique ID for publisher profile.
				192	"overview": "A String", # Overview of the publisher.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	193	"audienceDescription": "A String", # Description on the publisher's audience.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	194	},
				195	],
				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:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	208	A request object that you can call 'execute()' on to request the next
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	209	page. Returns None if there are no more items in the collection.
				210	</pre>
				211	</div>
				212
				213	</body></html>