1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<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>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the requested publisher profile by name.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists publisher profiles. The returned publisher profiles aren't in any defined order. The order of the results might change. A new publisher profile can appear in any place in the list of returned results.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets the requested publisher profile by name.
Args:
name: string, Required. Name of the publisher profile. Format: `buyers/{buyerId}/publisherProfiles/{publisherProfileId}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The values in the publisher profile are supplied by the publisher. All fields are not filterable unless stated otherwise.
"audienceDescription": "A String", # Description on the publisher's audience.
"directDealsContact": "A String", # 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.
"displayName": "A String", # Display name of the publisher profile. Can be used to filter the response of the publisherProfiles.list method.
"domains": [ # 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 "photos.google.co.uk/123", but will instead contain "google.co.uk". Can be used to filter the response of the publisherProfiles.list method.
"A String",
],
"isParent": 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 "is_parent: true".
"logoUrl": "A String", # A Google public URL to the logo for this publisher profile. The logo is stored as a PNG, JPG, or GIF image.
"mediaKitUrl": "A String", # URL to additional marketing and sales materials.
"mobileApps": [ # The list of apps represented in this publisher profile. Empty if this is a parent profile.
{ # A mobile application that contains a external app ID, name, and app store.
"appStore": "A String", # The app store the app belongs to. Can be used to filter the response of the publisherProfiles.list method.
"externalAppId": "A String", # The external ID for the app from its app store. Can be used to filter the response of the publisherProfiles.list method.
"name": "A String", # The name of the app.
},
],
"name": "A String", # Name of the publisher profile. Format: `buyers/{buyer}/publisherProfiles/{publisher_profile}`
"overview": "A String", # Overview of the publisher.
"pitchStatement": "A String", # Statement explaining what's unique about publisher's business, and why buyers should partner with the publisher.
"programmaticDealsContact": "A String", # Contact information for programmatic deals. This is free text entered by the publisher and may include information like names, phone numbers and email addresses.
"publisherCode": "A String", # A unique identifying code for the seller. This value is the same for all of the seller's parent and child publisher profiles. Can be used to filter the response of the publisherProfiles.list method.
"samplePageUrl": "A String", # URL to a sample content page.
"topHeadlines": [ # Up to three key metrics and rankings. For example, "#1 Mobile News Site for 20 Straight Months".
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists publisher profiles. The returned publisher profiles aren't in any defined order. The order of the results might change. A new publisher profile can appear in any place in the list of returned results.
Args:
parent: string, Required. Parent that owns the collection of publisher profiles Format: `buyers/{buyerId}` (required)
filter: string, Optional query string using the [Cloud API list filtering] (https://developers.google.com/authorized-buyers/apis/guides/list-filters) syntax.
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.
pageToken: string, The page token as returned from a previous ListPublisherProfilesResponse.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for profiles visible to the buyer.
"nextPageToken": "A String", # Token to fetch the next page of results.
"publisherProfiles": [ # The list of matching publisher profiles.
{ # The values in the publisher profile are supplied by the publisher. All fields are not filterable unless stated otherwise.
"audienceDescription": "A String", # Description on the publisher's audience.
"directDealsContact": "A String", # 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.
"displayName": "A String", # Display name of the publisher profile. Can be used to filter the response of the publisherProfiles.list method.
"domains": [ # 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 "photos.google.co.uk/123", but will instead contain "google.co.uk". Can be used to filter the response of the publisherProfiles.list method.
"A String",
],
"isParent": 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 "is_parent: true".
"logoUrl": "A String", # A Google public URL to the logo for this publisher profile. The logo is stored as a PNG, JPG, or GIF image.
"mediaKitUrl": "A String", # URL to additional marketing and sales materials.
"mobileApps": [ # The list of apps represented in this publisher profile. Empty if this is a parent profile.
{ # A mobile application that contains a external app ID, name, and app store.
"appStore": "A String", # The app store the app belongs to. Can be used to filter the response of the publisherProfiles.list method.
"externalAppId": "A String", # The external ID for the app from its app store. Can be used to filter the response of the publisherProfiles.list method.
"name": "A String", # The name of the app.
},
],
"name": "A String", # Name of the publisher profile. Format: `buyers/{buyer}/publisherProfiles/{publisher_profile}`
"overview": "A String", # Overview of the publisher.
"pitchStatement": "A String", # Statement explaining what's unique about publisher's business, and why buyers should partner with the publisher.
"programmaticDealsContact": "A String", # Contact information for programmatic deals. This is free text entered by the publisher and may include information like names, phone numbers and email addresses.
"publisherCode": "A String", # A unique identifying code for the seller. This value is the same for all of the seller's parent and child publisher profiles. Can be used to filter the response of the publisherProfiles.list method.
"samplePageUrl": "A String", # URL to a sample content page.
"topHeadlines": [ # Up to three key metrics and rankings. For example, "#1 Mobile News Site for 20 Straight Months".
"A String",
],
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|
