1<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="displayvideo_v1.html">Display & Video 360 API</a> . <a href="displayvideo_v1.customBiddingAlgorithms.html">customBiddingAlgorithms</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="displayvideo_v1.customBiddingAlgorithms.scripts.html">scripts()</a></code> 79</p> 80<p class="firstline">Returns the scripts Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="#close">close()</a></code></p> 84<p class="firstline">Close httplib2 connections.</p> 85<p class="toc_element"> 86 <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p> 87<p class="firstline">Creates a new custom bidding algorithm. Returns the newly created custom bidding algorithm if successful.</p> 88<p class="toc_element"> 89 <code><a href="#get">get(customBiddingAlgorithmId, advertiserId=None, partnerId=None, x__xgafv=None)</a></code></p> 90<p class="firstline">Gets a custom bidding algorithm.</p> 91<p class="toc_element"> 92 <code><a href="#list">list(advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None)</a></code></p> 93<p class="firstline">Lists custom bidding algorithms that are accessible to the current user and can be used in bidding stratgies. The order is defined by the order_by parameter.</p> 94<p class="toc_element"> 95 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 96<p class="firstline">Retrieves the next page of results.</p> 97<p class="toc_element"> 98 <code><a href="#patch">patch(customBiddingAlgorithmId, body=None, updateMask=None, x__xgafv=None)</a></code></p> 99<p class="firstline">Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful.</p> 100<p class="toc_element"> 101 <code><a href="#uploadScript">uploadScript(customBiddingAlgorithmId, advertiserId=None, partnerId=None, x__xgafv=None)</a></code></p> 102<p class="firstline">Creates a custom bidding script reference object for a script file. The resulting reference object provides a resource path to which the script file should be uploaded. This reference object should be included in when creating a new custom bidding script object.</p> 103<h3>Method Details</h3> 104<div class="method"> 105 <code class="details" id="close">close()</code> 106 <pre>Close httplib2 connections.</pre> 107</div> 108 109<div class="method"> 110 <code class="details" id="create">create(body=None, x__xgafv=None)</code> 111 <pre>Creates a new custom bidding algorithm. Returns the newly created custom bidding algorithm if successful. 112 113Args: 114 body: object, The request body. 115 The object takes the form of: 116 117{ # A single custom bidding algorithm. 118 "advertiserId": "A String", # Immutable. The unique ID of the advertiser that owns the custom bidding algorithm. 119 "customBiddingAlgorithmId": "A String", # Output only. The unique ID of the custom bidding algorithm. Assigned by the system. 120 "customBiddingAlgorithmState": "A String", # Output only. The status of custom bidding algorithm. 121 "customBiddingAlgorithmType": "A String", # Required. Immutable. The type of custom bidding algorithm. 122 "displayName": "A String", # Required. The display name of the custom bidding algorithm. Must be UTF-8 encoded with a maximum size of 240 bytes. 123 "entityStatus": "A String", # Controls whether or not the custom bidding algorithm can be used as a bidding strategy. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED` 124 "name": "A String", # Output only. The resource name of the custom bidding algorithm. 125 "partnerId": "A String", # Immutable. The unique ID of the partner that owns the custom bidding algorithm. 126 "sharedAdvertiserIds": [ # The IDs of the advertisers who have access to this algorithm. If advertiser_id is set, this field will only consist of that value. This field will not be set if the algorithm [`owner`](/display-video/api/reference/rest/v1/customBiddingAlgorithms#CustomBiddingAlgorithm.FIELDS.oneof_owner) is a partner and is being retrieved using an advertiser [`accessor`](/display-video/api/reference/rest/v1/customBiddingAlgorithms/list#body.QUERY_PARAMETERS.oneof_accessor). 127 "A String", 128 ], 129} 130 131 x__xgafv: string, V1 error format. 132 Allowed values 133 1 - v1 error format 134 2 - v2 error format 135 136Returns: 137 An object of the form: 138 139 { # A single custom bidding algorithm. 140 "advertiserId": "A String", # Immutable. The unique ID of the advertiser that owns the custom bidding algorithm. 141 "customBiddingAlgorithmId": "A String", # Output only. The unique ID of the custom bidding algorithm. Assigned by the system. 142 "customBiddingAlgorithmState": "A String", # Output only. The status of custom bidding algorithm. 143 "customBiddingAlgorithmType": "A String", # Required. Immutable. The type of custom bidding algorithm. 144 "displayName": "A String", # Required. The display name of the custom bidding algorithm. Must be UTF-8 encoded with a maximum size of 240 bytes. 145 "entityStatus": "A String", # Controls whether or not the custom bidding algorithm can be used as a bidding strategy. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED` 146 "name": "A String", # Output only. The resource name of the custom bidding algorithm. 147 "partnerId": "A String", # Immutable. The unique ID of the partner that owns the custom bidding algorithm. 148 "sharedAdvertiserIds": [ # The IDs of the advertisers who have access to this algorithm. If advertiser_id is set, this field will only consist of that value. This field will not be set if the algorithm [`owner`](/display-video/api/reference/rest/v1/customBiddingAlgorithms#CustomBiddingAlgorithm.FIELDS.oneof_owner) is a partner and is being retrieved using an advertiser [`accessor`](/display-video/api/reference/rest/v1/customBiddingAlgorithms/list#body.QUERY_PARAMETERS.oneof_accessor). 149 "A String", 150 ], 151}</pre> 152</div> 153 154<div class="method"> 155 <code class="details" id="get">get(customBiddingAlgorithmId, advertiserId=None, partnerId=None, x__xgafv=None)</code> 156 <pre>Gets a custom bidding algorithm. 157 158Args: 159 customBiddingAlgorithmId: string, Required. The ID of the custom bidding algorithm to fetch. (required) 160 advertiserId: string, The ID of the DV360 partner that has access to the custom bidding algorithm. 161 partnerId: string, The ID of the DV360 partner that has access to the custom bidding algorithm. 162 x__xgafv: string, V1 error format. 163 Allowed values 164 1 - v1 error format 165 2 - v2 error format 166 167Returns: 168 An object of the form: 169 170 { # A single custom bidding algorithm. 171 "advertiserId": "A String", # Immutable. The unique ID of the advertiser that owns the custom bidding algorithm. 172 "customBiddingAlgorithmId": "A String", # Output only. The unique ID of the custom bidding algorithm. Assigned by the system. 173 "customBiddingAlgorithmState": "A String", # Output only. The status of custom bidding algorithm. 174 "customBiddingAlgorithmType": "A String", # Required. Immutable. The type of custom bidding algorithm. 175 "displayName": "A String", # Required. The display name of the custom bidding algorithm. Must be UTF-8 encoded with a maximum size of 240 bytes. 176 "entityStatus": "A String", # Controls whether or not the custom bidding algorithm can be used as a bidding strategy. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED` 177 "name": "A String", # Output only. The resource name of the custom bidding algorithm. 178 "partnerId": "A String", # Immutable. The unique ID of the partner that owns the custom bidding algorithm. 179 "sharedAdvertiserIds": [ # The IDs of the advertisers who have access to this algorithm. If advertiser_id is set, this field will only consist of that value. This field will not be set if the algorithm [`owner`](/display-video/api/reference/rest/v1/customBiddingAlgorithms#CustomBiddingAlgorithm.FIELDS.oneof_owner) is a partner and is being retrieved using an advertiser [`accessor`](/display-video/api/reference/rest/v1/customBiddingAlgorithms/list#body.QUERY_PARAMETERS.oneof_accessor). 180 "A String", 181 ], 182}</pre> 183</div> 184 185<div class="method"> 186 <code class="details" id="list">list(advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None)</code> 187 <pre>Lists custom bidding algorithms that are accessible to the current user and can be used in bidding stratgies. The order is defined by the order_by parameter. 188 189Args: 190 advertiserId: string, The ID of the DV360 advertiser that has access to the custom bidding algorithm. 191 filter: string, Allows filtering by custom bidding algorithm fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND`. A sequence of restrictions * implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)` or `EQUALS (=)`. * The operator must be `CONTAINS (:)` for the following field: - `displayName` * The operator must be `EQUALS (=)` for the following field: - `customBiddingAlgorithmType` - `customBiddingAlgorithmState` * For `displayName`, the value is a string. We return all custom bidding algorithms whose display_name contains such string. * For `customBiddingAlgorithmType`, the value is a string. We return all algorithms whose custom_bidding_algorithm_type is equal to the given type. * For `customBiddingAlgorithmState`, the value is a string. We return all algorithms whose custom_bidding_algorithm_state is equal to the given type. Examples: * All custom bidding algorithms for which the display name contains "politics": `displayName:politics`. * All custom bidding algorithms for which the type is "SCRIPT_BASED": `customBiddingAlgorithmType=SCRIPT_BASED` * All custom bidding algorithms for which the state is "ENABLED": `customBiddingAlgorithmState=ENABLED` The length of this field should be no more than 500 characters. 192 orderBy: string, Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. 193 pageSize: integer, Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. 194 pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCustomBiddingAlgorithms` method. If not specified, the first page of results will be returned. 195 partnerId: string, The ID of the DV360 partner that has access to the custom bidding algorithm. 196 x__xgafv: string, V1 error format. 197 Allowed values 198 1 - v1 error format 199 2 - v2 error format 200 201Returns: 202 An object of the form: 203 204 { 205 "customBiddingAlgorithms": [ # The list of custom bidding algorithms. This list will be absent if empty. 206 { # A single custom bidding algorithm. 207 "advertiserId": "A String", # Immutable. The unique ID of the advertiser that owns the custom bidding algorithm. 208 "customBiddingAlgorithmId": "A String", # Output only. The unique ID of the custom bidding algorithm. Assigned by the system. 209 "customBiddingAlgorithmState": "A String", # Output only. The status of custom bidding algorithm. 210 "customBiddingAlgorithmType": "A String", # Required. Immutable. The type of custom bidding algorithm. 211 "displayName": "A String", # Required. The display name of the custom bidding algorithm. Must be UTF-8 encoded with a maximum size of 240 bytes. 212 "entityStatus": "A String", # Controls whether or not the custom bidding algorithm can be used as a bidding strategy. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED` 213 "name": "A String", # Output only. The resource name of the custom bidding algorithm. 214 "partnerId": "A String", # Immutable. The unique ID of the partner that owns the custom bidding algorithm. 215 "sharedAdvertiserIds": [ # The IDs of the advertisers who have access to this algorithm. If advertiser_id is set, this field will only consist of that value. This field will not be set if the algorithm [`owner`](/display-video/api/reference/rest/v1/customBiddingAlgorithms#CustomBiddingAlgorithm.FIELDS.oneof_owner) is a partner and is being retrieved using an advertiser [`accessor`](/display-video/api/reference/rest/v1/customBiddingAlgorithms/list#body.QUERY_PARAMETERS.oneof_accessor). 216 "A String", 217 ], 218 }, 219 ], 220 "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListCustomBiddingAlgorithmsRequest` method to retrieve the next page of results. If this field is null, it means this is the last page. 221}</pre> 222</div> 223 224<div class="method"> 225 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 226 <pre>Retrieves the next page of results. 227 228Args: 229 previous_request: The request for the previous page. (required) 230 previous_response: The response from the request for the previous page. (required) 231 232Returns: 233 A request object that you can call 'execute()' on to request the next 234 page. Returns None if there are no more items in the collection. 235 </pre> 236</div> 237 238<div class="method"> 239 <code class="details" id="patch">patch(customBiddingAlgorithmId, body=None, updateMask=None, x__xgafv=None)</code> 240 <pre>Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful. 241 242Args: 243 customBiddingAlgorithmId: string, Output only. The unique ID of the custom bidding algorithm. Assigned by the system. (required) 244 body: object, The request body. 245 The object takes the form of: 246 247{ # A single custom bidding algorithm. 248 "advertiserId": "A String", # Immutable. The unique ID of the advertiser that owns the custom bidding algorithm. 249 "customBiddingAlgorithmId": "A String", # Output only. The unique ID of the custom bidding algorithm. Assigned by the system. 250 "customBiddingAlgorithmState": "A String", # Output only. The status of custom bidding algorithm. 251 "customBiddingAlgorithmType": "A String", # Required. Immutable. The type of custom bidding algorithm. 252 "displayName": "A String", # Required. The display name of the custom bidding algorithm. Must be UTF-8 encoded with a maximum size of 240 bytes. 253 "entityStatus": "A String", # Controls whether or not the custom bidding algorithm can be used as a bidding strategy. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED` 254 "name": "A String", # Output only. The resource name of the custom bidding algorithm. 255 "partnerId": "A String", # Immutable. The unique ID of the partner that owns the custom bidding algorithm. 256 "sharedAdvertiserIds": [ # The IDs of the advertisers who have access to this algorithm. If advertiser_id is set, this field will only consist of that value. This field will not be set if the algorithm [`owner`](/display-video/api/reference/rest/v1/customBiddingAlgorithms#CustomBiddingAlgorithm.FIELDS.oneof_owner) is a partner and is being retrieved using an advertiser [`accessor`](/display-video/api/reference/rest/v1/customBiddingAlgorithms/list#body.QUERY_PARAMETERS.oneof_accessor). 257 "A String", 258 ], 259} 260 261 updateMask: string, Required. The mask to control which fields to update. 262 x__xgafv: string, V1 error format. 263 Allowed values 264 1 - v1 error format 265 2 - v2 error format 266 267Returns: 268 An object of the form: 269 270 { # A single custom bidding algorithm. 271 "advertiserId": "A String", # Immutable. The unique ID of the advertiser that owns the custom bidding algorithm. 272 "customBiddingAlgorithmId": "A String", # Output only. The unique ID of the custom bidding algorithm. Assigned by the system. 273 "customBiddingAlgorithmState": "A String", # Output only. The status of custom bidding algorithm. 274 "customBiddingAlgorithmType": "A String", # Required. Immutable. The type of custom bidding algorithm. 275 "displayName": "A String", # Required. The display name of the custom bidding algorithm. Must be UTF-8 encoded with a maximum size of 240 bytes. 276 "entityStatus": "A String", # Controls whether or not the custom bidding algorithm can be used as a bidding strategy. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED` 277 "name": "A String", # Output only. The resource name of the custom bidding algorithm. 278 "partnerId": "A String", # Immutable. The unique ID of the partner that owns the custom bidding algorithm. 279 "sharedAdvertiserIds": [ # The IDs of the advertisers who have access to this algorithm. If advertiser_id is set, this field will only consist of that value. This field will not be set if the algorithm [`owner`](/display-video/api/reference/rest/v1/customBiddingAlgorithms#CustomBiddingAlgorithm.FIELDS.oneof_owner) is a partner and is being retrieved using an advertiser [`accessor`](/display-video/api/reference/rest/v1/customBiddingAlgorithms/list#body.QUERY_PARAMETERS.oneof_accessor). 280 "A String", 281 ], 282}</pre> 283</div> 284 285<div class="method"> 286 <code class="details" id="uploadScript">uploadScript(customBiddingAlgorithmId, advertiserId=None, partnerId=None, x__xgafv=None)</code> 287 <pre>Creates a custom bidding script reference object for a script file. The resulting reference object provides a resource path to which the script file should be uploaded. This reference object should be included in when creating a new custom bidding script object. 288 289Args: 290 customBiddingAlgorithmId: string, Required. The ID of the custom bidding algorithm owns the script. (required) 291 advertiserId: string, The ID of the advertiser that owns the parent custom bidding algorithm. 292 partnerId: string, The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script. 293 x__xgafv: string, V1 error format. 294 Allowed values 295 1 - v1 error format 296 2 - v2 error format 297 298Returns: 299 An object of the form: 300 301 { # The reference to the uploaded custom bidding script file. 302 "resourceName": "A String", # A resource name to be used in media.download to Download the script files. Or media.upload to Upload the script files. Resource names have the format `customBiddingAlgorithms/{custom_bidding_algorithm_id}/scriptRef/{ref_id}`. 303}</pre> 304</div> 305 306</body></html>