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