| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="displayvideo_v4.html">Display & Video 360 API</a> . <a href="displayvideo_v4.customBiddingAlgorithms.html">customBiddingAlgorithms</a> . <a href="displayvideo_v4.customBiddingAlgorithms.rules.html">rules</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#create">create(customBiddingAlgorithmId, advertiserId=None, body=None, partnerId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates a new rules resource. Returns the newly created rules resource if successful. *Warning*: Starting **April 1, 2025**, requests updating custom bidding algorithms that are assigned to line items will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(customBiddingAlgorithmId, customBiddingAlgorithmRulesId, advertiserId=None, partnerId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Retrieves a rules resource.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(customBiddingAlgorithmId, advertiserId=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists rules resources that belong to the given algorithm. The order is defined by the order_by parameter.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next()</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="create">create(customBiddingAlgorithmId, advertiserId=None, body=None, partnerId=None, x__xgafv=None)</code> |
| <pre>Creates a new rules resource. Returns the newly created rules resource if successful. *Warning*: Starting **April 1, 2025**, requests updating custom bidding algorithms that are assigned to line items will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). |
| |
| Args: |
| customBiddingAlgorithmId: string, Required. The ID of the custom bidding algorithm that owns the rules resource. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A single custom bidding algorithm rules. |
| "active": True or False, # Output only. Whether the rules resource is currently being used for scoring by the parent algorithm. |
| "createTime": "A String", # Output only. The time when the rules resource was created. |
| "customBiddingAlgorithmId": "A String", # Output only. The unique ID of the custom bidding algorithm that the rules resource belongs to. |
| "customBiddingAlgorithmRulesId": "A String", # Output only. The unique ID of the rules resource. |
| "error": { # An error message for a CustomBiddingAlgorithmRules resource. # Output only. Error code of the rejected rules resource. This field will only be populated when the state is `REJECTED`. |
| "errorCode": "A String", # The type of error. |
| }, |
| "name": "A String", # Output only. The resource name of the rules resource. |
| "rules": { # The reference to the uploaded AlgorithmRules file. Retrieve the location to upload new AlgorithmRules file to using customBiddingAlgorithms.uploadRules. # Required. Immutable. The reference to the uploaded AlgorithmRules file. |
| "resourceName": "A String", # A resource name to be used in media.download to download the rules files. Or media.upload to upload the rules files. Resource names have the format `customBiddingAlgorithms/{custom_bidding_algorithm_id}/rulesRef/{ref_id}`. |
| }, |
| "state": "A String", # Output only. The state of the rules resource. |
| } |
| |
| advertiserId: string, The ID of the advertiser that owns the parent custom bidding algorithm. |
| partnerId: string, The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this rules resource. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A single custom bidding algorithm rules. |
| "active": True or False, # Output only. Whether the rules resource is currently being used for scoring by the parent algorithm. |
| "createTime": "A String", # Output only. The time when the rules resource was created. |
| "customBiddingAlgorithmId": "A String", # Output only. The unique ID of the custom bidding algorithm that the rules resource belongs to. |
| "customBiddingAlgorithmRulesId": "A String", # Output only. The unique ID of the rules resource. |
| "error": { # An error message for a CustomBiddingAlgorithmRules resource. # Output only. Error code of the rejected rules resource. This field will only be populated when the state is `REJECTED`. |
| "errorCode": "A String", # The type of error. |
| }, |
| "name": "A String", # Output only. The resource name of the rules resource. |
| "rules": { # The reference to the uploaded AlgorithmRules file. Retrieve the location to upload new AlgorithmRules file to using customBiddingAlgorithms.uploadRules. # Required. Immutable. The reference to the uploaded AlgorithmRules file. |
| "resourceName": "A String", # A resource name to be used in media.download to download the rules files. Or media.upload to upload the rules files. Resource names have the format `customBiddingAlgorithms/{custom_bidding_algorithm_id}/rulesRef/{ref_id}`. |
| }, |
| "state": "A String", # Output only. The state of the rules resource. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(customBiddingAlgorithmId, customBiddingAlgorithmRulesId, advertiserId=None, partnerId=None, x__xgafv=None)</code> |
| <pre>Retrieves a rules resource. |
| |
| Args: |
| customBiddingAlgorithmId: string, Required. The ID of the custom bidding algorithm that owns the rules resource. (required) |
| customBiddingAlgorithmRulesId: string, Required. The ID of the rules resource to fetch. (required) |
| advertiserId: string, The ID of the advertiser that owns the parent custom bidding algorithm. |
| partnerId: string, The ID of the partner that owns the parent custom bidding algorithm. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A single custom bidding algorithm rules. |
| "active": True or False, # Output only. Whether the rules resource is currently being used for scoring by the parent algorithm. |
| "createTime": "A String", # Output only. The time when the rules resource was created. |
| "customBiddingAlgorithmId": "A String", # Output only. The unique ID of the custom bidding algorithm that the rules resource belongs to. |
| "customBiddingAlgorithmRulesId": "A String", # Output only. The unique ID of the rules resource. |
| "error": { # An error message for a CustomBiddingAlgorithmRules resource. # Output only. Error code of the rejected rules resource. This field will only be populated when the state is `REJECTED`. |
| "errorCode": "A String", # The type of error. |
| }, |
| "name": "A String", # Output only. The resource name of the rules resource. |
| "rules": { # The reference to the uploaded AlgorithmRules file. Retrieve the location to upload new AlgorithmRules file to using customBiddingAlgorithms.uploadRules. # Required. Immutable. The reference to the uploaded AlgorithmRules file. |
| "resourceName": "A String", # A resource name to be used in media.download to download the rules files. Or media.upload to upload the rules files. Resource names have the format `customBiddingAlgorithms/{custom_bidding_algorithm_id}/rulesRef/{ref_id}`. |
| }, |
| "state": "A String", # Output only. The state of the rules resource. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(customBiddingAlgorithmId, advertiserId=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None)</code> |
| <pre>Lists rules resources that belong to the given algorithm. The order is defined by the order_by parameter. |
| |
| Args: |
| customBiddingAlgorithmId: string, Required. The ID of the custom bidding algorithm that owns the rules resource. (required) |
| advertiserId: string, The ID of the advertiser that owns the parent custom bidding algorithm. |
| orderBy: string, Field by which to sort the list. Acceptable values are: * `createTime desc` (default) The default sorting order is descending. To specify ascending order for a field, the suffix "desc" should be removed. Example: `createTime`. |
| pageSize: integer, Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. |
| 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 `ListCustomBiddingAlgorithmRules` method. If not specified, the first page of results will be returned. |
| partnerId: string, The ID of the partner that owns the parent custom bidding algorithm. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "customBiddingRules": [ # The list of CustomBiddingAlgorithmRules resources. This list will be absent if empty. |
| { # A single custom bidding algorithm rules. |
| "active": True or False, # Output only. Whether the rules resource is currently being used for scoring by the parent algorithm. |
| "createTime": "A String", # Output only. The time when the rules resource was created. |
| "customBiddingAlgorithmId": "A String", # Output only. The unique ID of the custom bidding algorithm that the rules resource belongs to. |
| "customBiddingAlgorithmRulesId": "A String", # Output only. The unique ID of the rules resource. |
| "error": { # An error message for a CustomBiddingAlgorithmRules resource. # Output only. Error code of the rejected rules resource. This field will only be populated when the state is `REJECTED`. |
| "errorCode": "A String", # The type of error. |
| }, |
| "name": "A String", # Output only. The resource name of the rules resource. |
| "rules": { # The reference to the uploaded AlgorithmRules file. Retrieve the location to upload new AlgorithmRules file to using customBiddingAlgorithms.uploadRules. # Required. Immutable. The reference to the uploaded AlgorithmRules file. |
| "resourceName": "A String", # A resource name to be used in media.download to download the rules files. Or media.upload to upload the rules files. Resource names have the format `customBiddingAlgorithms/{custom_bidding_algorithm_id}/rulesRef/{ref_id}`. |
| }, |
| "state": "A String", # Output only. The state of the rules resource. |
| }, |
| ], |
| "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 `ListCustomBiddingAlgorithmRulesRequest` method to retrieve the next page of results. If this field is null, it means this is the last page. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next()</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| </body></html> |
