| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 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></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="realtimebidding_v1.bidders.creatives.html">creatives()</a></code> |
| 79 | </p> |
| 80 | <p class="firstline">Returns the creatives Resource.</p> |
| 81 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 82 | <p class="toc_element"> |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 83 | <code><a href="realtimebidding_v1.bidders.endpoints.html">endpoints()</a></code> |
| 84 | </p> |
| 85 | <p class="firstline">Returns the endpoints Resource.</p> |
| 86 | |
| 87 | <p class="toc_element"> |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 88 | <code><a href="realtimebidding_v1.bidders.pretargetingConfigs.html">pretargetingConfigs()</a></code> |
| 89 | </p> |
| 90 | <p class="firstline">Returns the pretargetingConfigs Resource.</p> |
| 91 | |
| 92 | <p class="toc_element"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 93 | <code><a href="#close">close()</a></code></p> |
| 94 | <p class="firstline">Close httplib2 connections.</p> |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 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> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 104 | <h3>Method Details</h3> |
| 105 | <div class="method"> |
| 106 | <code class="details" id="close">close()</code> |
| 107 | <pre>Close httplib2 connections.</pre> |
| 108 | </div> |
| 109 | |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 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 | "bypassNonguaranteedDealsPretargeting": 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 | "cookieMatchingNetworkId": "A String", # Output only. The buyer'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 | "cookieMatchingUrl": "A String", # 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 | "dealsBillingId": "A String", # 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 | "name": "A String", # 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 | "bidders": [ # List of bidders. |
| 150 | { # Bidder settings. |
| 151 | "bypassNonguaranteedDealsPretargeting": 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 | "cookieMatchingNetworkId": "A String", # Output only. The buyer'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 | "cookieMatchingUrl": "A String", # 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 | "dealsBillingId": "A String", # 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 | "name": "A String", # 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 | "nextPageToken": "A String", # 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 'execute()' on to request the next |
| 172 | page. Returns None if there are no more items in the collection. |
| 173 | </pre> |
| 174 | </div> |
| 175 | |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 176 | </body></html> |