Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3bf2781e29cb828409f3a8a21939323286524569 / . / docs / dyn / adexchangebuyer2_v2beta1.accounts.publisherProfiles.html
blob: 940ce5dd9100f66b0f7dee17808d4797e59bb483 [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 #
105 # Represents a publisher profile in Marketplace.
106 #
107 # All fields are read only. All string fields are free-form text entered by the
108 # publisher unless noted otherwise.
109 "rateCardInfoUrl": "A String", # URL to a publisher rate card.
110 "audienceDescription": "A String", # Description on the publisher's audience.
111 "displayName": "A String", # Name of the publisher profile.
112 "programmaticDealsContact": "A String", # Contact information for programmatic deals. This is free text entered by
113 # the publisher and may include information like names, phone numbers and
114 # email addresses.
115 "directDealsContact": "A String", # Contact information for direct reservation deals. This is free text entered
116 # by the publisher and may include information like names, phone numbers and
117 # email addresses.
118 "mediaKitUrl": "A String", # URL to additional marketing and sales materials.
119 "overview": "A String", # Overview of the publisher.
120 "buyerPitchStatement": "A String", # Statement explaining what's unique about publisher's business, and why
121 # buyers should partner with the publisher.
122 "seller": { # Represents a seller of inventory. Each seller is identified by a unique # Seller of the publisher profile.
123 # Ad Manager account ID.
124 "subAccountId": "A String", # Optional sub-account ID for the seller.
125 "accountId": "A String", # The unique ID for the seller. The seller fills in this field.
126 # The seller account ID is then available to buyer in the product.
127 },
128 "googlePlusUrl": "A String", # URL to publisher's Google+ page.
129 "samplePageUrl": "A String", # URL to a sample content page.
130 "topHeadlines": [ # Up to three key metrics and rankings. Max 100 characters each.
131 # For example "#1 Mobile News Site for 20 Straight Months".
132 "A String",
133 ],
134 "logoUrl": "A String", # A Google public URL to the logo for this publisher profile. The logo is
135 # stored as a PNG, JPG, or GIF image.
136 "domains": [ # The list of domains represented in this publisher profile. Empty if this is
137 # a parent profile. These are top private domains, meaning that these will
138 # not contain a string like "photos.google.co.uk/123", but will instead
139 # contain "google.co.uk".
140 "A String",
141 ],
142 "publisherProfileId": "A String", # Unique ID for publisher profile.
143 }</pre>
144</div>
145
146<div class="method">
147 <code class="details" id="list">list(accountId, pageSize=None, pageToken=None, x__xgafv=None)</code>
148 <pre>List all publisher profiles visible to the buyer
149
150Args:
151 accountId: string, Account ID of the buyer. (required)
152 pageSize: integer, Specify the number of results to include per page.
153 pageToken: string, The page token as return from ListPublisherProfilesResponse.
154 x__xgafv: string, V1 error format.
155 Allowed values
156 1 - v1 error format
157 2 - v2 error format
158
159Returns:
160 An object of the form:
161
162 { # Response message for profiles visible to the buyer.
163 "nextPageToken": "A String", # List pagination support
164 "publisherProfiles": [ # The list of matching publisher profiles.
165 { # Note: this resource requires whitelisting for access. Please contact your
166 # account manager for access to Marketplace resources.
167 #
168 # Represents a publisher profile in Marketplace.
169 #
170 # All fields are read only. All string fields are free-form text entered by the
171 # publisher unless noted otherwise.
172 "rateCardInfoUrl": "A String", # URL to a publisher rate card.
173 "audienceDescription": "A String", # Description on the publisher's audience.
174 "displayName": "A String", # Name of the publisher profile.
175 "programmaticDealsContact": "A String", # Contact information for programmatic deals. This is free text entered by
176 # the publisher and may include information like names, phone numbers and
177 # email addresses.
178 "directDealsContact": "A String", # Contact information for direct reservation deals. This is free text entered
179 # by the publisher and may include information like names, phone numbers and
180 # email addresses.
181 "mediaKitUrl": "A String", # URL to additional marketing and sales materials.
182 "overview": "A String", # Overview of the publisher.
183 "buyerPitchStatement": "A String", # Statement explaining what's unique about publisher's business, and why
184 # buyers should partner with the publisher.
185 "seller": { # Represents a seller of inventory. Each seller is identified by a unique # Seller of the publisher profile.
186 # Ad Manager account ID.
187 "subAccountId": "A String", # Optional sub-account ID for the seller.
188 "accountId": "A String", # The unique ID for the seller. The seller fills in this field.
189 # The seller account ID is then available to buyer in the product.
190 },
191 "googlePlusUrl": "A String", # URL to publisher's Google+ page.
192 "samplePageUrl": "A String", # URL to a sample content page.
193 "topHeadlines": [ # Up to three key metrics and rankings. Max 100 characters each.
194 # For example "#1 Mobile News Site for 20 Straight Months".
195 "A String",
196 ],
197 "logoUrl": "A String", # A Google public URL to the logo for this publisher profile. The logo is
198 # stored as a PNG, JPG, or GIF image.
199 "domains": [ # The list of domains represented in this publisher profile. Empty if this is
200 # a parent profile. These are top private domains, meaning that these will
201 # not contain a string like "photos.google.co.uk/123", but will instead
202 # contain "google.co.uk".
203 "A String",
204 ],
205 "publisherProfileId": "A String", # Unique ID for publisher profile.
206 },
207 ],
208 }</pre>
209</div>
210
211<div class="method">
212 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
213 <pre>Retrieves the next page of results.
214
215Args:
216 previous_request: The request for the previous page. (required)
217 previous_response: The response from the request for the previous page. (required)
218
219Returns:
220 A request object that you can call 'execute()' on to request the next
221 page. Returns None if there are no more items in the collection.
222 </pre>
223</div>
224
225</body></html>