Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / d059ad881c7ae58c67931c48788d0bd7343ab16c / . / docs / dyn / adexchangebuyer2_v2beta1.accounts.publisherProfiles.html
blob: 49291b88d4792cc275d5b79c3ade2cb2c3854454 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<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">
78 <code><a href="#get">get(accountId, publisherProfileId, x__xgafv=None)</a></code></p>
79<p class="firstline">Gets the requested publisher profile by id.</p>
80<p class="toc_element">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]81 <code><a href="#list">list(accountId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]82<p class="firstline">List all publisher profiles visible to the buyer</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(accountId, publisherProfileId, x__xgafv=None)</code>
89 <pre>Gets the requested publisher profile by id.
90
91Args:
92 accountId: string, Account ID of the buyer. (required)
93 publisherProfileId: string, The id for the publisher profile to get. (required)
94 x__xgafv: string, V1 error format.
95 Allowed values
96 1 - v1 error format
97 2 - v2 error format
98
99Returns:
100 An object of the form:
101
102 { # Note: this resource requires whitelisting for access. Please contact your
103 # account manager for access to Marketplace resources.
104 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]105 # Represents a publisher profile
106 # (https://support.google.com/admanager/answer/6035806?hl=en) in Marketplace.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]107 #
108 # All fields are read only. All string fields are free-form text entered by the
109 # publisher unless noted otherwise.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]110 &quot;programmaticDealsContact&quot;: &quot;A String&quot;, # Contact information for programmatic deals. This is free text entered by
111 # the publisher and may include information like names, phone numbers and
112 # email addresses.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]113 &quot;publisherProfileId&quot;: &quot;A String&quot;, # Unique ID for publisher profile.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]114 &quot;isParent&quot;: True or False, # Indicates if this profile is the parent profile of the seller. A parent
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]115 # profile represents all the inventory from the seller, as opposed to child
116 # profile that is created to brand a portion of inventory. One seller should
117 # have only one parent publisher profile, and can have multiple child
118 # profiles. Publisher profiles for the same seller will have same value of
119 # field google.ads.adexchange.buyer.v2beta1.PublisherProfile.seller.
120 # See https://support.google.com/admanager/answer/6035806?hl=en for details.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]121 &quot;buyerPitchStatement&quot;: &quot;A String&quot;, # Statement explaining what&#x27;s unique about publisher&#x27;s business, and why
122 # buyers should partner with the publisher.
123 &quot;topHeadlines&quot;: [ # Up to three key metrics and rankings. Max 100 characters each.
124 # For example &quot;#1 Mobile News Site for 20 Straight Months&quot;.
125 &quot;A String&quot;,
126 ],
127 &quot;mediaKitUrl&quot;: &quot;A String&quot;, # URL to additional marketing and sales materials.
128 &quot;samplePageUrl&quot;: &quot;A String&quot;, # URL to a sample content page.
129 &quot;displayName&quot;: &quot;A String&quot;, # Name of the publisher profile.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]130 &quot;directDealsContact&quot;: &quot;A String&quot;, # Contact information for direct reservation deals. This is free text entered
131 # by the publisher and may include information like names, phone numbers and
132 # email addresses.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]133 &quot;audienceDescription&quot;: &quot;A String&quot;, # Description on the publisher&#x27;s audience.
134 &quot;overview&quot;: &quot;A String&quot;, # Overview of the publisher.
135 &quot;googlePlusUrl&quot;: &quot;A String&quot;, # URL to publisher&#x27;s Google+ page.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]136 &quot;rateCardInfoUrl&quot;: &quot;A String&quot;, # URL to a publisher rate card.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]137 &quot;domains&quot;: [ # The list of domains represented in this publisher profile. Empty if this is
138 # a parent profile. These are top private domains, meaning that these will
139 # not contain a string like &quot;photos.google.co.uk/123&quot;, but will instead
140 # contain &quot;google.co.uk&quot;.
141 &quot;A String&quot;,
142 ],
143 &quot;logoUrl&quot;: &quot;A String&quot;, # A Google public URL to the logo for this publisher profile. The logo is
144 # stored as a PNG, JPG, or GIF image.
145 &quot;seller&quot;: { # Represents a seller of inventory. Each seller is identified by a unique # Seller of the publisher profile.
146 # Ad Manager account ID.
147 &quot;subAccountId&quot;: &quot;A String&quot;, # Optional sub-account ID for the seller.
148 &quot;accountId&quot;: &quot;A String&quot;, # The unique ID for the seller. The seller fills in this field.
149 # The seller account ID is then available to buyer in the product.
150 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]151 }</pre>
152</div>
153
154<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]155 <code class="details" id="list">list(accountId, pageSize=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]156 <pre>List all publisher profiles visible to the buyer
157
158Args:
159 accountId: string, Account ID of the buyer. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]160 pageSize: integer, Specify the number of results to include per page.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]161 pageToken: string, The page token as return from ListPublisherProfilesResponse.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]162 x__xgafv: string, V1 error format.
163 Allowed values
164 1 - v1 error format
165 2 - v2 error format
166
167Returns:
168 An object of the form:
169
170 { # Response message for profiles visible to the buyer.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]171 &quot;publisherProfiles&quot;: [ # The list of matching publisher profiles.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]172 { # Note: this resource requires whitelisting for access. Please contact your
173 # account manager for access to Marketplace resources.
174 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]175 # Represents a publisher profile
176 # (https://support.google.com/admanager/answer/6035806?hl=en) in Marketplace.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]177 #
178 # All fields are read only. All string fields are free-form text entered by the
179 # publisher unless noted otherwise.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]180 &quot;programmaticDealsContact&quot;: &quot;A String&quot;, # Contact information for programmatic deals. This is free text entered by
181 # the publisher and may include information like names, phone numbers and
182 # email addresses.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]183 &quot;publisherProfileId&quot;: &quot;A String&quot;, # Unique ID for publisher profile.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]184 &quot;isParent&quot;: True or False, # Indicates if this profile is the parent profile of the seller. A parent
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]185 # profile represents all the inventory from the seller, as opposed to child
186 # profile that is created to brand a portion of inventory. One seller should
187 # have only one parent publisher profile, and can have multiple child
188 # profiles. Publisher profiles for the same seller will have same value of
189 # field google.ads.adexchange.buyer.v2beta1.PublisherProfile.seller.
190 # See https://support.google.com/admanager/answer/6035806?hl=en for details.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]191 &quot;buyerPitchStatement&quot;: &quot;A String&quot;, # Statement explaining what&#x27;s unique about publisher&#x27;s business, and why
192 # buyers should partner with the publisher.
193 &quot;topHeadlines&quot;: [ # Up to three key metrics and rankings. Max 100 characters each.
194 # For example &quot;#1 Mobile News Site for 20 Straight Months&quot;.
195 &quot;A String&quot;,
196 ],
197 &quot;mediaKitUrl&quot;: &quot;A String&quot;, # URL to additional marketing and sales materials.
198 &quot;samplePageUrl&quot;: &quot;A String&quot;, # URL to a sample content page.
199 &quot;displayName&quot;: &quot;A String&quot;, # Name of the publisher profile.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]200 &quot;directDealsContact&quot;: &quot;A String&quot;, # Contact information for direct reservation deals. This is free text entered
201 # by the publisher and may include information like names, phone numbers and
202 # email addresses.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]203 &quot;audienceDescription&quot;: &quot;A String&quot;, # Description on the publisher&#x27;s audience.
204 &quot;overview&quot;: &quot;A String&quot;, # Overview of the publisher.
205 &quot;googlePlusUrl&quot;: &quot;A String&quot;, # URL to publisher&#x27;s Google+ page.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]206 &quot;rateCardInfoUrl&quot;: &quot;A String&quot;, # URL to a publisher rate card.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]207 &quot;domains&quot;: [ # The list of domains represented in this publisher profile. Empty if this is
208 # a parent profile. These are top private domains, meaning that these will
209 # not contain a string like &quot;photos.google.co.uk/123&quot;, but will instead
210 # contain &quot;google.co.uk&quot;.
211 &quot;A String&quot;,
212 ],
213 &quot;logoUrl&quot;: &quot;A String&quot;, # A Google public URL to the logo for this publisher profile. The logo is
214 # stored as a PNG, JPG, or GIF image.
215 &quot;seller&quot;: { # Represents a seller of inventory. Each seller is identified by a unique # Seller of the publisher profile.
216 # Ad Manager account ID.
217 &quot;subAccountId&quot;: &quot;A String&quot;, # Optional sub-account ID for the seller.
218 &quot;accountId&quot;: &quot;A String&quot;, # The unique ID for the seller. The seller fills in this field.
219 # The seller account ID is then available to buyer in the product.
220 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]221 },
222 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]223 &quot;nextPageToken&quot;: &quot;A String&quot;, # List pagination support
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]224 }</pre>
225</div>
226
227<div class="method">
228 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
229 <pre>Retrieves the next page of results.
230
231Args:
232 previous_request: The request for the previous page. (required)
233 previous_response: The response from the request for the previous page. (required)
234
235Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]236 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]237 page. Returns None if there are no more items in the collection.
238 </pre>
239</div>
240
241</body></html>