Skip to content

Commit 7b1555a

Browse files
feat(realtimebidding): update the api
#### realtimebidding:v1 The following keys were added: - resources.bidders.methods.get (Total Keys: 11) - resources.bidders.methods.list (Total Keys: 12) - resources.bidders.resources.endpoints.methods.get (Total Keys: 11) - resources.bidders.resources.endpoints.methods.list (Total Keys: 16) - resources.buyers.methods.get (Total Keys: 11) - resources.buyers.methods.list (Total Keys: 12) - schemas.AdTechnologyProviders (Total Keys: 10) - schemas.Bidder (Total Keys: 10) - schemas.Buyer (Total Keys: 17) - schemas.CreativeServingDecision.properties.adTechnologyProviders (Total Keys: 1) - schemas.Endpoint (Total Keys: 8) - schemas.ListBiddersResponse (Total Keys: 5) - schemas.ListBuyersResponse (Total Keys: 5) - schemas.ListEndpointsResponse (Total Keys: 5)
1 parent 21efe10 commit 7b1555a

10 files changed

+3941
-2554
lines changed

docs/dyn/realtimebidding_v1.bidders.creatives.html

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,17 @@ <h3>Method Details</h3>
125125
&quot;creativeFormat&quot;: &quot;A String&quot;, # Output only. The format of this creative. Can be used to filter the response of the creatives.list method.
126126
&quot;creativeId&quot;: &quot;A String&quot;, # Buyer-specific creative ID that references this creative in bid responses. This field is Ignored in update operations. Can be used to filter the response of the creatives.list method. The maximum length of the creative ID is 128 bytes.
127127
&quot;creativeServingDecision&quot;: { # Top level status and detected attributes of a creative. # Output only. Top level status and detected attributes of a creative (for example domain, language, advertiser, product category, etc.) that affect whether (status) and where (context) a creative will be allowed to serve.
128+
&quot;adTechnologyProviders&quot;: { # The list of detected Ad Technology Providers for this creative. Bids placed for inventory that will serve to EEA or UK users are expected to comply with GDPR requirements. You must ensure that the creatives used in such bids should contain only user consented ad technology providers as indicated in the bid request. Google reserves the right to filter non-compliant bids. User consented ad technology providers can be found in the [Google Protocol](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) with the `BidRequest.adslot.consented_providers_settings` field, and can be found as an [OpenRTB extension](https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto) with the `BidRequest.user.ext.consented_providers_settings` and `BidRequest.user.ext.consent` fields. See https://support.google.com/authorizedbuyers/answer/9789378 for additional information about the Google TCF v2 integration. # The detected ad technology providers.
129+
&quot;detectedGvlIds&quot;: [ # The detected IAB Global Vendor List (GVL) IDs for this creative. See the IAB Global Vendor List at https://vendorlist.consensu.org/v2/vendor-list.json for details about the vendors.
130+
&quot;A String&quot;,
131+
],
132+
&quot;detectedProviderIds&quot;: [ # The detected [Google Ad Tech Providers (ATP)](https://support.google.com/admanager/answer/9012903) for this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/providers.csv for mapping of provider ID to provided name, a privacy policy URL, and a list of domains which can be attributed to the provider.
133+
&quot;A String&quot;,
134+
],
135+
&quot;unidentifiedProviderDomains&quot;: [ # Domains of detected unidentified ad technology providers (if any). You must ensure that the creatives used in bids placed for inventory that will serve to EEA or UK users does not contain unidentified ad technology providers. Google reserves the right to filter non-compliant bids.
136+
&quot;A String&quot;,
137+
],
138+
},
128139
&quot;chinaPolicyCompliance&quot;: { # Policy compliance of the creative for a transaction type or a region. # The policy compliance of this creative in China. When approved or disapproved, this applies to both deals and open auction in China. When pending review, this creative is allowed to serve for deals but not for open auction.
129140
&quot;status&quot;: &quot;A String&quot;, # Serving status for the given transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Can be used to filter the response of the creatives.list method.
130141
&quot;topics&quot;: [ # Topics related to the policy compliance for this transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Topics may be present only if status is DISAPPROVED.
Lines changed: 162 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,162 @@
1+
<html><body>
2+
<style>
3+
4+
body, 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+
15+
body {
16+
font-size: 13px;
17+
padding: 1em;
18+
}
19+
20+
h1 {
21+
font-size: 26px;
22+
margin-bottom: 1em;
23+
}
24+
25+
h2 {
26+
font-size: 24px;
27+
margin-bottom: 1em;
28+
}
29+
30+
h3 {
31+
font-size: 20px;
32+
margin-bottom: 1em;
33+
margin-top: 1em;
34+
}
35+
36+
pre, code {
37+
line-height: 1.5;
38+
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39+
}
40+
41+
pre {
42+
margin-top: 0.5em;
43+
}
44+
45+
h1, h2, h3, p {
46+
font-family: Arial, sans serif;
47+
}
48+
49+
h1, 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+
99+
Args:
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+
106+
Returns:
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+
122+
Args:
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+
131+
Returns:
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+
152+
Args:
153+
previous_request: The request for the previous page. (required)
154+
previous_response: The response from the request for the previous page. (required)
155+
156+
Returns:
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>

docs/dyn/realtimebidding_v1.bidders.html

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,11 @@ <h2>Instance Methods</h2>
7979
</p>
8080
<p class="firstline">Returns the creatives Resource.</p>
8181

82+
<p class="toc_element">
83+
<code><a href="realtimebidding_v1.bidders.endpoints.html">endpoints()</a></code>
84+
</p>
85+
<p class="firstline">Returns the endpoints Resource.</p>
86+
8287
<p class="toc_element">
8388
<code><a href="realtimebidding_v1.bidders.pretargetingConfigs.html">pretargetingConfigs()</a></code>
8489
</p>
@@ -87,10 +92,85 @@ <h2>Instance Methods</h2>
8792
<p class="toc_element">
8893
<code><a href="#close">close()</a></code></p>
8994
<p class="firstline">Close httplib2 connections.</p>
95+
<p class="toc_element">
96+
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
97+
<p class="firstline">Gets a bidder account by its name.</p>
98+
<p class="toc_element">
99+
<code><a href="#list">list(pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
100+
<p class="firstline">Lists all the bidder accounts that belong to the caller.</p>
101+
<p class="toc_element">
102+
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
103+
<p class="firstline">Retrieves the next page of results.</p>
90104
<h3>Method Details</h3>
91105
<div class="method">
92106
<code class="details" id="close">close()</code>
93107
<pre>Close httplib2 connections.</pre>
94108
</div>
95109

110+
<div class="method">
111+
<code class="details" id="get">get(name, x__xgafv=None)</code>
112+
<pre>Gets a bidder account by its name.
113+
114+
Args:
115+
name: string, Required. Name of the bidder to get. Format: `bidders/{bidderAccountId}` (required)
116+
x__xgafv: string, V1 error format.
117+
Allowed values
118+
1 - v1 error format
119+
2 - v2 error format
120+
121+
Returns:
122+
An object of the form:
123+
124+
{ # Bidder settings.
125+
&quot;bypassNonguaranteedDealsPretargeting&quot;: True or False, # Output only. A flag to bypass pretargeting for private auctions and preferred deals. When true, bid requests from these nonguaranteed deals will always be sent. When false, bid requests will be subject to regular pretargeting configurations. Programmatic Guaranteed deals will always be sent to the bidder, regardless of the value for this flag. Auction packages are not impacted by this value and are subject to the regular pretargeting configurations.
126+
&quot;cookieMatchingNetworkId&quot;: &quot;A String&quot;, # Output only. The buyer&#x27;s network ID used for cookie matching. This ID corresponds to the `google_nid` parameter in the URL used in cookie match requests. Refer to https://developers.google.com/authorized-buyers/rtb/cookie-guide for further information.
127+
&quot;cookieMatchingUrl&quot;: &quot;A String&quot;, # Output only. The base URL used in cookie match requests. Refer to https://developers.google.com/authorized-buyers/rtb/cookie-guide for further information.
128+
&quot;dealsBillingId&quot;: &quot;A String&quot;, # Output only. The billing ID for the deals pretargeting config. This billing ID is sent on the bid request for guaranteed and nonguaranteed deals matched in pretargeting.
129+
&quot;name&quot;: &quot;A String&quot;, # Output only. Name of the bidder resource that must follow the pattern `bidders/{bidderAccountId}`, where `{bidderAccountId}` is the account ID of the bidder whose information is to be received. One can get their account ID on the Authorized Buyers or Open Bidding UI, or by contacting their Google account manager.
130+
}</pre>
131+
</div>
132+
133+
<div class="method">
134+
<code class="details" id="list">list(pageSize=None, pageToken=None, x__xgafv=None)</code>
135+
<pre>Lists all the bidder accounts that belong to the caller.
136+
137+
Args:
138+
pageSize: integer, The maximum number of bidders to return. If unspecified, at most 100 bidders will be returned. The maximum value is 500; values above 500 will be coerced to 500.
139+
pageToken: string, A token identifying a page of results the server should return. This value is received from a previous `ListBidders` call in ListBiddersResponse.nextPageToken.
140+
x__xgafv: string, V1 error format.
141+
Allowed values
142+
1 - v1 error format
143+
2 - v2 error format
144+
145+
Returns:
146+
An object of the form:
147+
148+
{ # A response containing bidders.
149+
&quot;bidders&quot;: [ # List of bidders.
150+
{ # Bidder settings.
151+
&quot;bypassNonguaranteedDealsPretargeting&quot;: True or False, # Output only. A flag to bypass pretargeting for private auctions and preferred deals. When true, bid requests from these nonguaranteed deals will always be sent. When false, bid requests will be subject to regular pretargeting configurations. Programmatic Guaranteed deals will always be sent to the bidder, regardless of the value for this flag. Auction packages are not impacted by this value and are subject to the regular pretargeting configurations.
152+
&quot;cookieMatchingNetworkId&quot;: &quot;A String&quot;, # Output only. The buyer&#x27;s network ID used for cookie matching. This ID corresponds to the `google_nid` parameter in the URL used in cookie match requests. Refer to https://developers.google.com/authorized-buyers/rtb/cookie-guide for further information.
153+
&quot;cookieMatchingUrl&quot;: &quot;A String&quot;, # Output only. The base URL used in cookie match requests. Refer to https://developers.google.com/authorized-buyers/rtb/cookie-guide for further information.
154+
&quot;dealsBillingId&quot;: &quot;A String&quot;, # Output only. The billing ID for the deals pretargeting config. This billing ID is sent on the bid request for guaranteed and nonguaranteed deals matched in pretargeting.
155+
&quot;name&quot;: &quot;A String&quot;, # Output only. Name of the bidder resource that must follow the pattern `bidders/{bidderAccountId}`, where `{bidderAccountId}` is the account ID of the bidder whose information is to be received. One can get their account ID on the Authorized Buyers or Open Bidding UI, or by contacting their Google account manager.
156+
},
157+
],
158+
&quot;nextPageToken&quot;: &quot;A String&quot;, # A token which can be passed to a subsequent call to the `ListBidders` method to retrieve the next page of results in ListBiddersRequest.pageToken.
159+
}</pre>
160+
</div>
161+
162+
<div class="method">
163+
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
164+
<pre>Retrieves the next page of results.
165+
166+
Args:
167+
previous_request: The request for the previous page. (required)
168+
previous_response: The response from the request for the previous page. (required)
169+
170+
Returns:
171+
A request object that you can call &#x27;execute()&#x27; on to request the next
172+
page. Returns None if there are no more items in the collection.
173+
</pre>
174+
</div>
175+
96176
</body></html>

0 commit comments

Comments
 (0)