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.customLists.html">customLists</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(customListId, advertiserId=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Gets a custom list.</p> 83<p class="toc_element"> 84 <code><a href="#list">list(advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Lists custom lists. The order is defined by the order_by parameter.</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(customListId, advertiserId=None, x__xgafv=None)</code> 97 <pre>Gets a custom list. 98 99Args: 100 customListId: string, Required. The ID of the custom list to fetch. (required) 101 advertiserId: string, The ID of the DV360 advertiser that has access to the fetched custom lists. 102 x__xgafv: string, V1 error format. 103 Allowed values 104 1 - v1 error format 105 2 - v2 error format 106 107Returns: 108 An object of the form: 109 110 { # Describes a custom list entity, such as a custom affinity or custom intent audience list. 111 "customListId": "A String", # Output only. The unique ID of the custom list. Assigned by the system. 112 "displayName": "A String", # Output only. The display name of the custom list. . 113 "name": "A String", # Output only. The resource name of the custom list. 114}</pre> 115</div> 116 117<div class="method"> 118 <code class="details" id="list">list(advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 119 <pre>Lists custom lists. The order is defined by the order_by parameter. 120 121Args: 122 advertiserId: string, The ID of the DV360 advertiser that has access to the fetched custom lists. 123 filter: string, Allows filtering by custom list fields. Supported syntax: * Filter expressions for custom lists currently can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `displayName` Examples: * All custom lists for which the display name contains "Google": `displayName : "Google"`. The length of this field should be no more than 500 characters. 124 orderBy: string, Field by which to sort the list. Acceptable values are: * `customListId` (default) * `displayName` 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`. 125 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. 126 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 `ListCustomLists` method. If not specified, the first page of results will be returned. 127 x__xgafv: string, V1 error format. 128 Allowed values 129 1 - v1 error format 130 2 - v2 error format 131 132Returns: 133 An object of the form: 134 135 { 136 "customLists": [ # The list of custom lists. This list will be absent if empty. 137 { # Describes a custom list entity, such as a custom affinity or custom intent audience list. 138 "customListId": "A String", # Output only. The unique ID of the custom list. Assigned by the system. 139 "displayName": "A String", # Output only. The display name of the custom list. . 140 "name": "A String", # Output only. The resource name of the custom list. 141 }, 142 ], 143 "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 `ListCustomLists` method to retrieve the next page of results. 144}</pre> 145</div> 146 147<div class="method"> 148 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 149 <pre>Retrieves the next page of results. 150 151Args: 152 previous_request: The request for the previous page. (required) 153 previous_response: The response from the request for the previous page. (required) 154 155Returns: 156 A request object that you can call 'execute()' on to request the next 157 page. Returns None if there are no more items in the collection. 158 </pre> 159</div> 160 161</body></html>