blob: bf576a137f3437b169e547d8b42e9fe43cd8aee1 [file] [log] [blame]
yoshi-code-bota8b35b92021-03-31 13:33:30 -07001<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="realtimebidding_v1.html">Real-time Bidding API</a> . <a href="realtimebidding_v1.bidders.html">bidders</a> . <a href="realtimebidding_v1.bidders.endpoints.html">endpoints</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 a bidder endpoint by its name.</p>
83<p class="toc_element">
84 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Lists all the bidder's endpoints.</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 a bidder endpoint by its name.
98
99Args:
100 name: string, Required. Name of the bidder endpoint to get. Format: `bidders/{bidderAccountId}/endpoints/{endpointId}` (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 { # Bidder endpoint that receives bid requests.
110 &quot;bidProtocol&quot;: &quot;A String&quot;, # The protocol that the bidder endpoint is using.
111 &quot;maximumQps&quot;: &quot;A String&quot;, # The maximum number of queries per second allowed to be sent to this server.
112 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the endpoint resource that must follow the pattern `bidders/{bidderAccountId}/endpoints/{endpointId}`, where {bidderAccountId} is the account ID of the bidder who operates this endpoint, and {endpointId} is a unique ID assigned by the server.
113 &quot;tradingLocation&quot;: &quot;A String&quot;, # The trading location that bid requests should be sent from. See https://developers.google.com/authorized-buyers/rtb/peer-guide#trading-locations for further information.
114 &quot;url&quot;: &quot;A String&quot;, # Output only. The URL that bid requests should be sent to.
115}</pre>
116</div>
117
118<div class="method">
119 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
120 <pre>Lists all the bidder&#x27;s endpoints.
121
122Args:
123 parent: string, Required. Name of the bidder whose endpoints will be listed. Format: `bidders/{bidderAccountId}` (required)
124 pageSize: integer, The maximum number of endpoints to return. If unspecified, at most 100 endpoints will be returned. The maximum value is 500; values above 500 will be coerced to 500.
125 pageToken: string, A token identifying a page of results the server should return. This value is received from a previous `ListEndpoints` call in ListEndpointsResponse.nextPageToken.
126 x__xgafv: string, V1 error format.
127 Allowed values
128 1 - v1 error format
129 2 - v2 error format
130
131Returns:
132 An object of the form:
133
134 { # A response containing bidder endpoints.
135 &quot;endpoints&quot;: [ # List of bidder endpoints.
136 { # Bidder endpoint that receives bid requests.
137 &quot;bidProtocol&quot;: &quot;A String&quot;, # The protocol that the bidder endpoint is using.
138 &quot;maximumQps&quot;: &quot;A String&quot;, # The maximum number of queries per second allowed to be sent to this server.
139 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the endpoint resource that must follow the pattern `bidders/{bidderAccountId}/endpoints/{endpointId}`, where {bidderAccountId} is the account ID of the bidder who operates this endpoint, and {endpointId} is a unique ID assigned by the server.
140 &quot;tradingLocation&quot;: &quot;A String&quot;, # The trading location that bid requests should be sent from. See https://developers.google.com/authorized-buyers/rtb/peer-guide#trading-locations for further information.
141 &quot;url&quot;: &quot;A String&quot;, # Output only. The URL that bid requests should be sent to.
142 },
143 ],
144 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token which can be passed to a subsequent call to the `ListEndpoints` method to retrieve the next page of results in ListEndpointsRequest.pageToken.
145}</pre>
146</div>
147
148<div class="method">
149 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
150 <pre>Retrieves the next page of results.
151
152Args:
153 previous_request: The request for the previous page. (required)
154 previous_response: The response from the request for the previous page. (required)
155
156Returns:
157 A request object that you can call &#x27;execute()&#x27; on to request the next
158 page. Returns None if there are no more items in the collection.
159 </pre>
160</div>
161
162</body></html>