blob: 653764cdae90f88060eb59209d2facbf08aa17c2 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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 Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070081 <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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070084 <code><a href="#list">list(accountId, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070085<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 Frenkel3e17f892020-10-06 16:46:05 -070091 <code class="details" id="close">close()</code>
92 <pre>Close httplib2 connections.</pre>
93</div>
94
95<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070096 <code class="details" id="get">get(accountId, publisherProfileId, x__xgafv=None)</code>
97 <pre>Gets the requested publisher profile by id.
98
99Args:
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
107Returns:
108 An object of the form:
109
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700110 { # 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700111 &quot;audienceDescription&quot;: &quot;A String&quot;, # Description on the publisher&#x27;s audience.
112 &quot;overview&quot;: &quot;A String&quot;, # Overview of the publisher.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700113 &quot;programmaticDealsContact&quot;: &quot;A String&quot;, # Contact information for programmatic deals. This is free text entered by the publisher and may include information like names, phone numbers and email addresses.
114 &quot;isParent&quot;: 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.
115 &quot;mediaKitUrl&quot;: &quot;A String&quot;, # URL to additional marketing and sales materials.
116 &quot;seller&quot;: { # Represents a seller of inventory. Each seller is identified by a unique Ad Manager account ID. # Seller of the publisher profile.
117 &quot;accountId&quot;: &quot;A String&quot;, # The unique ID for the seller. The seller fills in this field. The seller account ID is then available to buyer in the product.
118 &quot;subAccountId&quot;: &quot;A String&quot;, # Optional sub-account ID for the seller.
119 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700120 &quot;rateCardInfoUrl&quot;: &quot;A String&quot;, # URL to a publisher rate card.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700121 &quot;buyerPitchStatement&quot;: &quot;A String&quot;, # Statement explaining what&#x27;s unique about publisher&#x27;s business, and why buyers should partner with the publisher.
122 &quot;domains&quot;: [ # 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 &quot;photos.google.co.uk/123&quot;, but will instead contain &quot;google.co.uk&quot;.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700123 &quot;A String&quot;,
124 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700125 &quot;directDealsContact&quot;: &quot;A String&quot;, # 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.
126 &quot;logoUrl&quot;: &quot;A String&quot;, # A Google public URL to the logo for this publisher profile. The logo is stored as a PNG, JPG, or GIF image.
127 &quot;googlePlusUrl&quot;: &quot;A String&quot;, # URL to publisher&#x27;s Google+ page.
128 &quot;publisherProfileId&quot;: &quot;A String&quot;, # Unique ID for publisher profile.
129 &quot;displayName&quot;: &quot;A String&quot;, # Name of the publisher profile.
130 &quot;samplePageUrl&quot;: &quot;A String&quot;, # URL to a sample content page.
131 &quot;topHeadlines&quot;: [ # Up to three key metrics and rankings. Max 100 characters each. For example &quot;#1 Mobile News Site for 20 Straight Months&quot;.
132 &quot;A String&quot;,
133 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700134 }</pre>
135</div>
136
137<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700138 <code class="details" id="list">list(accountId, pageToken=None, pageSize=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700139 <pre>List all publisher profiles visible to the buyer
140
141Args:
142 accountId: string, Account ID of the buyer. (required)
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700143 pageToken: string, The page token as return from ListPublisherProfilesResponse.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700144 pageSize: integer, Specify the number of results to include per page.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700145 x__xgafv: string, V1 error format.
146 Allowed values
147 1 - v1 error format
148 2 - v2 error format
149
150Returns:
151 An object of the form:
152
153 { # Response message for profiles visible to the buyer.
Bu Sun Kim65020912020-05-20 12:08:20 -0700154 &quot;publisherProfiles&quot;: [ # The list of matching publisher profiles.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700155 { # 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700156 &quot;audienceDescription&quot;: &quot;A String&quot;, # Description on the publisher&#x27;s audience.
157 &quot;overview&quot;: &quot;A String&quot;, # Overview of the publisher.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700158 &quot;programmaticDealsContact&quot;: &quot;A String&quot;, # Contact information for programmatic deals. This is free text entered by the publisher and may include information like names, phone numbers and email addresses.
159 &quot;isParent&quot;: 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.
160 &quot;mediaKitUrl&quot;: &quot;A String&quot;, # URL to additional marketing and sales materials.
161 &quot;seller&quot;: { # Represents a seller of inventory. Each seller is identified by a unique Ad Manager account ID. # Seller of the publisher profile.
162 &quot;accountId&quot;: &quot;A String&quot;, # The unique ID for the seller. The seller fills in this field. The seller account ID is then available to buyer in the product.
163 &quot;subAccountId&quot;: &quot;A String&quot;, # Optional sub-account ID for the seller.
164 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700165 &quot;rateCardInfoUrl&quot;: &quot;A String&quot;, # URL to a publisher rate card.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700166 &quot;buyerPitchStatement&quot;: &quot;A String&quot;, # Statement explaining what&#x27;s unique about publisher&#x27;s business, and why buyers should partner with the publisher.
167 &quot;domains&quot;: [ # 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 &quot;photos.google.co.uk/123&quot;, but will instead contain &quot;google.co.uk&quot;.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700168 &quot;A String&quot;,
169 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700170 &quot;directDealsContact&quot;: &quot;A String&quot;, # 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.
171 &quot;logoUrl&quot;: &quot;A String&quot;, # A Google public URL to the logo for this publisher profile. The logo is stored as a PNG, JPG, or GIF image.
172 &quot;googlePlusUrl&quot;: &quot;A String&quot;, # URL to publisher&#x27;s Google+ page.
173 &quot;publisherProfileId&quot;: &quot;A String&quot;, # Unique ID for publisher profile.
174 &quot;displayName&quot;: &quot;A String&quot;, # Name of the publisher profile.
175 &quot;samplePageUrl&quot;: &quot;A String&quot;, # URL to a sample content page.
176 &quot;topHeadlines&quot;: [ # Up to three key metrics and rankings. Max 100 characters each. For example &quot;#1 Mobile News Site for 20 Straight Months&quot;.
177 &quot;A String&quot;,
178 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700179 },
180 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700181 &quot;nextPageToken&quot;: &quot;A String&quot;, # List pagination support
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700182 }</pre>
183</div>
184
185<div class="method">
186 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
187 <pre>Retrieves the next page of results.
188
189Args:
190 previous_request: The request for the previous page. (required)
191 previous_response: The response from the request for the previous page. (required)
192
193Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700194 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700195 page. Returns None if there are no more items in the collection.
196 </pre>
197</div>
198
199</body></html>