• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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="authorizedbuyersmarketplace_v1.html">Authorized Buyers Marketplace API</a> . <a href="authorizedbuyersmarketplace_v1.buyers.html">buyers</a> . <a href="authorizedbuyersmarketplace_v1.buyers.publisherProfiles.html">publisherProfiles</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
81  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
82<p class="firstline">Gets the requested publisher profile by name.</p>
83<p class="toc_element">
84  <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Lists publisher profiles</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">
91    <code class="details" id="close">close()</code>
92  <pre>Close httplib2 connections.</pre>
93</div>
94
95<div class="method">
96    <code class="details" id="get">get(name, x__xgafv=None)</code>
97  <pre>Gets the requested publisher profile by name.
98
99Args:
100  name: string, Required. Name of the publisher profile. Format: `buyers/{buyerId}/publisherProfiles/{publisherProfileId}` (required)
101  x__xgafv: string, V1 error format.
102    Allowed values
103      1 - v1 error format
104      2 - v2 error format
105
106Returns:
107  An object of the form:
108
109    { # The values in the publisher profile are supplied by the publisher. All fields are not filterable unless stated otherwise.
110  &quot;audienceDescription&quot;: &quot;A String&quot;, # Description on the publisher&#x27;s audience.
111  &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.
112  &quot;displayName&quot;: &quot;A String&quot;, # Display name of the publisher profile. Can be used to filter the response of the publisherProfiles.list method.
113  &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;. Can be used to filter the response of the publisherProfiles.list method.
114    &quot;A String&quot;,
115  ],
116  &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 has only one parent publisher profile, and can have multiple child profiles. See https://support.google.com/admanager/answer/6035806 for details. Can be used to filter the response of the publisherProfiles.list method by setting the filter to &quot;is_parent: true&quot;.
117  &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.
118  &quot;mediaKitUrl&quot;: &quot;A String&quot;, # URL to additional marketing and sales materials.
119  &quot;mobileApps&quot;: [ # The list of apps represented in this publisher profile. Empty if this is a parent profile.
120    { # A mobile application that contains a external app ID, name, and app store.
121      &quot;appStore&quot;: &quot;A String&quot;, # The app store the app belongs to. Can be used to filter the response of the publisherProfiles.list method.
122      &quot;externalAppId&quot;: &quot;A String&quot;, # The external ID for the app from its app store. Can be used to filter the response of the publisherProfiles.list method.
123      &quot;name&quot;: &quot;A String&quot;, # The name of the app.
124    },
125  ],
126  &quot;name&quot;: &quot;A String&quot;, # Name of the publisher profile. Format: `buyers/{buyer}/publisherProfiles/{publisher_profile}`
127  &quot;overview&quot;: &quot;A String&quot;, # Overview of the publisher.
128  &quot;pitchStatement&quot;: &quot;A String&quot;, # Statement explaining what&#x27;s unique about publisher&#x27;s business, and why buyers should partner with the publisher.
129  &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.
130  &quot;publisherCode&quot;: &quot;A String&quot;, # A unique identifying code for the seller. This value is the same for all of the seller&#x27;s parent and child publisher profiles. Can be used to filter the response of the publisherProfiles.list method.
131  &quot;samplePageUrl&quot;: &quot;A String&quot;, # URL to a sample content page.
132  &quot;topHeadlines&quot;: [ # Up to three key metrics and rankings. For example &quot;#1 Mobile News Site for 20 Straight Months&quot;.
133    &quot;A String&quot;,
134  ],
135}</pre>
136</div>
137
138<div class="method">
139    <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
140  <pre>Lists publisher profiles
141
142Args:
143  parent: string, Required. Parent that owns the collection of publisher profiles Format: `buyers/{buyerId}` (required)
144  filter: string, Optional query string using the [Cloud API list filtering] (https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters) syntax.
145  pageSize: integer, Requested page size. The server may return fewer results than requested. If requested more than 500, the server will return 500 results per page. If unspecified, the server will pick a default page size of 100.
146  pageToken: string, The page token as returned from a previous ListPublisherProfilesResponse.
147  x__xgafv: string, V1 error format.
148    Allowed values
149      1 - v1 error format
150      2 - v2 error format
151
152Returns:
153  An object of the form:
154
155    { # Response message for profiles visible to the buyer.
156  &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to fetch the next page of results.
157  &quot;publisherProfiles&quot;: [ # The list of matching publisher profiles.
158    { # The values in the publisher profile are supplied by the publisher. All fields are not filterable unless stated otherwise.
159      &quot;audienceDescription&quot;: &quot;A String&quot;, # Description on the publisher&#x27;s audience.
160      &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.
161      &quot;displayName&quot;: &quot;A String&quot;, # Display name of the publisher profile. Can be used to filter the response of the publisherProfiles.list method.
162      &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;. Can be used to filter the response of the publisherProfiles.list method.
163        &quot;A String&quot;,
164      ],
165      &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 has only one parent publisher profile, and can have multiple child profiles. See https://support.google.com/admanager/answer/6035806 for details. Can be used to filter the response of the publisherProfiles.list method by setting the filter to &quot;is_parent: true&quot;.
166      &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.
167      &quot;mediaKitUrl&quot;: &quot;A String&quot;, # URL to additional marketing and sales materials.
168      &quot;mobileApps&quot;: [ # The list of apps represented in this publisher profile. Empty if this is a parent profile.
169        { # A mobile application that contains a external app ID, name, and app store.
170          &quot;appStore&quot;: &quot;A String&quot;, # The app store the app belongs to. Can be used to filter the response of the publisherProfiles.list method.
171          &quot;externalAppId&quot;: &quot;A String&quot;, # The external ID for the app from its app store. Can be used to filter the response of the publisherProfiles.list method.
172          &quot;name&quot;: &quot;A String&quot;, # The name of the app.
173        },
174      ],
175      &quot;name&quot;: &quot;A String&quot;, # Name of the publisher profile. Format: `buyers/{buyer}/publisherProfiles/{publisher_profile}`
176      &quot;overview&quot;: &quot;A String&quot;, # Overview of the publisher.
177      &quot;pitchStatement&quot;: &quot;A String&quot;, # Statement explaining what&#x27;s unique about publisher&#x27;s business, and why buyers should partner with the publisher.
178      &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.
179      &quot;publisherCode&quot;: &quot;A String&quot;, # A unique identifying code for the seller. This value is the same for all of the seller&#x27;s parent and child publisher profiles. Can be used to filter the response of the publisherProfiles.list method.
180      &quot;samplePageUrl&quot;: &quot;A String&quot;, # URL to a sample content page.
181      &quot;topHeadlines&quot;: [ # Up to three key metrics and rankings. For example &quot;#1 Mobile News Site for 20 Straight Months&quot;.
182        &quot;A String&quot;,
183      ],
184    },
185  ],
186}</pre>
187</div>
188
189<div class="method">
190    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
191  <pre>Retrieves the next page of results.
192
193Args:
194  previous_request: The request for the previous page. (required)
195  previous_response: The response from the request for the previous page. (required)
196
197Returns:
198  A request object that you can call &#x27;execute()&#x27; on to request the next
199  page. Returns None if there are no more items in the collection.
200    </pre>
201</div>
202
203</body></html>