| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -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_v1alpha.html">Real-time Bidding API</a> . <a href="realtimebidding_v1alpha.bidders.html">bidders</a> . <a href="realtimebidding_v1alpha.bidders.biddingFunctions.html">biddingFunctions</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame^] | 78 | <code><a href="#activate">activate(name, body=None, x__xgafv=None)</a></code></p> |
| 79 | <p class="firstline">Activates an existing bidding function. An activated function is available for invocation for the server-side TURTLEDOVE simulations.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#archive">archive(name, body=None, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Archives an existing bidding function. An archived function will not be available for function invocation for the server-side TURTLEDOVE simulations unless it is activated.</p> |
| 83 | <p class="toc_element"> |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 84 | <code><a href="#close">close()</a></code></p> |
| 85 | <p class="firstline">Close httplib2 connections.</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> |
| 88 | <p class="firstline">Creates a new bidding function.</p> |
| 89 | <p class="toc_element"> |
| 90 | <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| 91 | <p class="firstline">Lists the bidding functions that a bidder currently has registered.</p> |
| 92 | <p class="toc_element"> |
| 93 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 94 | <p class="firstline">Retrieves the next page of results.</p> |
| 95 | <h3>Method Details</h3> |
| 96 | <div class="method"> |
| yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame^] | 97 | <code class="details" id="activate">activate(name, body=None, x__xgafv=None)</code> |
| 98 | <pre>Activates an existing bidding function. An activated function is available for invocation for the server-side TURTLEDOVE simulations. |
| 99 | |
| 100 | Args: |
| 101 | name: string, Required. The name of the bidding function to activate. Format: `bidders/{bidder_account_id}/biddingFunction/{bidding_function_name}` (required) |
| 102 | body: object, The request body. |
| 103 | The object takes the form of: |
| 104 | |
| 105 | { # The request to activate a bidding function. |
| 106 | } |
| 107 | |
| 108 | x__xgafv: string, V1 error format. |
| 109 | Allowed values |
| 110 | 1 - v1 error format |
| 111 | 2 - v2 error format |
| 112 | |
| 113 | Returns: |
| 114 | An object of the form: |
| 115 | |
| 116 | { # The bidding function to be executed as part of the TURTLEDOVE simulation experiment bidding flow. |
| 117 | "biddingFunction": "A String", # The raw Javascript source code of the bidding function. |
| 118 | "name": "A String", # The name of the bidding function that must follow the pattern: `bidders/{bidder_account_id}/biddingFunctions/{bidding_function_name}`. |
| 119 | "state": "A String", # Output only. The state of the bidding function. |
| 120 | "type": "A String", # The type of the bidding function to be created. |
| 121 | }</pre> |
| 122 | </div> |
| 123 | |
| 124 | <div class="method"> |
| 125 | <code class="details" id="archive">archive(name, body=None, x__xgafv=None)</code> |
| 126 | <pre>Archives an existing bidding function. An archived function will not be available for function invocation for the server-side TURTLEDOVE simulations unless it is activated. |
| 127 | |
| 128 | Args: |
| 129 | name: string, Required. The name of the bidding function to archive. Format: `bidders/{bidder_account_id}/biddingFunction/{bidding_function_name}` (required) |
| 130 | body: object, The request body. |
| 131 | The object takes the form of: |
| 132 | |
| 133 | { # A request to archive a bidding function. |
| 134 | } |
| 135 | |
| 136 | x__xgafv: string, V1 error format. |
| 137 | Allowed values |
| 138 | 1 - v1 error format |
| 139 | 2 - v2 error format |
| 140 | |
| 141 | Returns: |
| 142 | An object of the form: |
| 143 | |
| 144 | { # The bidding function to be executed as part of the TURTLEDOVE simulation experiment bidding flow. |
| 145 | "biddingFunction": "A String", # The raw Javascript source code of the bidding function. |
| 146 | "name": "A String", # The name of the bidding function that must follow the pattern: `bidders/{bidder_account_id}/biddingFunctions/{bidding_function_name}`. |
| 147 | "state": "A String", # Output only. The state of the bidding function. |
| 148 | "type": "A String", # The type of the bidding function to be created. |
| 149 | }</pre> |
| 150 | </div> |
| 151 | |
| 152 | <div class="method"> |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 153 | <code class="details" id="close">close()</code> |
| 154 | <pre>Close httplib2 connections.</pre> |
| 155 | </div> |
| 156 | |
| 157 | <div class="method"> |
| 158 | <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> |
| 159 | <pre>Creates a new bidding function. |
| 160 | |
| 161 | Args: |
| 162 | parent: string, Required. The name of the bidder for which to create the bidding function. Format: `bidders/{bidderAccountId}` (required) |
| 163 | body: object, The request body. |
| 164 | The object takes the form of: |
| 165 | |
| 166 | { # The bidding function to be executed as part of the TURTLEDOVE simulation experiment bidding flow. |
| Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 167 | "biddingFunction": "A String", # The raw Javascript source code of the bidding function. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 168 | "name": "A String", # The name of the bidding function that must follow the pattern: `bidders/{bidder_account_id}/biddingFunctions/{bidding_function_name}`. |
| yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame^] | 169 | "state": "A String", # Output only. The state of the bidding function. |
| yoshi-code-bot | 64143a0 | 2021-04-27 05:08:04 -0700 | [diff] [blame] | 170 | "type": "A String", # The type of the bidding function to be created. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 171 | } |
| 172 | |
| 173 | x__xgafv: string, V1 error format. |
| 174 | Allowed values |
| 175 | 1 - v1 error format |
| 176 | 2 - v2 error format |
| 177 | |
| 178 | Returns: |
| 179 | An object of the form: |
| 180 | |
| 181 | { # The bidding function to be executed as part of the TURTLEDOVE simulation experiment bidding flow. |
| Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 182 | "biddingFunction": "A String", # The raw Javascript source code of the bidding function. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 183 | "name": "A String", # The name of the bidding function that must follow the pattern: `bidders/{bidder_account_id}/biddingFunctions/{bidding_function_name}`. |
| yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame^] | 184 | "state": "A String", # Output only. The state of the bidding function. |
| yoshi-code-bot | 64143a0 | 2021-04-27 05:08:04 -0700 | [diff] [blame] | 185 | "type": "A String", # The type of the bidding function to be created. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 186 | }</pre> |
| 187 | </div> |
| 188 | |
| 189 | <div class="method"> |
| 190 | <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| 191 | <pre>Lists the bidding functions that a bidder currently has registered. |
| 192 | |
| 193 | Args: |
| 194 | parent: string, Required. Name of the bidder whose bidding functions will be listed. Format: `bidders/{bidder_account_id}` (required) |
| 195 | pageSize: integer, The maximum number of bidding functions to return. |
| 196 | pageToken: string, A token identifying a page of results the server should return. This value is received from a previous `ListBiddingFunctions` call in ListBiddingFunctionsResponse.nextPageToken. |
| 197 | x__xgafv: string, V1 error format. |
| 198 | Allowed values |
| 199 | 1 - v1 error format |
| 200 | 2 - v2 error format |
| 201 | |
| 202 | Returns: |
| 203 | An object of the form: |
| 204 | |
| 205 | { # A response containing a list of a bidder's bidding functions. |
| 206 | "biddingFunctions": [ # A list of a bidder's bidding functions. |
| 207 | { # The bidding function to be executed as part of the TURTLEDOVE simulation experiment bidding flow. |
| Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 208 | "biddingFunction": "A String", # The raw Javascript source code of the bidding function. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 209 | "name": "A String", # The name of the bidding function that must follow the pattern: `bidders/{bidder_account_id}/biddingFunctions/{bidding_function_name}`. |
| yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame^] | 210 | "state": "A String", # Output only. The state of the bidding function. |
| yoshi-code-bot | 64143a0 | 2021-04-27 05:08:04 -0700 | [diff] [blame] | 211 | "type": "A String", # The type of the bidding function to be created. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 212 | }, |
| 213 | ], |
| 214 | "nextPageToken": "A String", # A token which can be passed to a subsequent call to the `ListBiddingFunctions` method to retrieve the next page of results in ListBiddingFunctionsRequest.pageToken. |
| 215 | }</pre> |
| 216 | </div> |
| 217 | |
| 218 | <div class="method"> |
| 219 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 220 | <pre>Retrieves the next page of results. |
| 221 | |
| 222 | Args: |
| 223 | previous_request: The request for the previous page. (required) |
| 224 | previous_response: The response from the request for the previous page. (required) |
| 225 | |
| 226 | Returns: |
| 227 | A request object that you can call 'execute()' on to request the next |
| 228 | page. Returns None if there are no more items in the collection. |
| 229 | </pre> |
| 230 | </div> |
| 231 | |
| 232 | </body></html> |