از 8 سپتامبر 2025 ، هر مورد خط جدید باید اعلام کند که آیا تبلیغات سیاسی اتحادیه اروپا (EU) را ارائه می دهد یا خیر. Display & Video 360 API و بارگذاری‌های SDF که اعلان‌ها را ارائه نمی‌کنند با شکست مواجه می‌شوند. برای جزئیات بیشتر در مورد نحوه به روز رسانی یکپارچه سازی خود برای ایجاد این اعلامیه، به صفحه لغو اعتبار ما مراجعه کنید.
اندازه صفحه درخواستی باید بین 1 تا 200 باشد. اگر نامشخص باشد به طور پیش فرض 100 خواهد بود. اگر مقدار نامعتبری مشخص شده باشد، کد خطا INVALID_ARGUMENT را برمی‌گرداند.
pageToken
string
نشانه ای که صفحه ای از نتایجی را که سرور باید برگرداند، شناسایی کند. به طور معمول، این مقدار nextPageToken است که از فراخوانی قبلی به متد customLists.list برگردانده شده است. اگر مشخص نشده باشد، صفحه اول نتایج برگردانده خواهد شد.
orderBy
string
فیلدی که بر اساس آن لیست مرتب می شود. مقادیر قابل قبول عبارتند از:
customListId (پیش فرض)
displayName
ترتیب مرتب سازی پیش فرض صعودی است. برای تعیین ترتیب نزولی برای یک فیلد، پسوند "desc" باید به نام فیلد اضافه شود. مثال: displayName desc .
filter
string
فیلتر کردن بر اساس فیلدهای فهرست سفارشی را می دهد.
نحو پشتیبانی شده:
عبارات فیلتر برای لیست های سفارشی فقط می توانند حداکثر یک محدودیت داشته باشند.
یک محدودیت به شکل {field} {operator} {value} است.
همه فیلدها باید از عملگر HAS (:) استفاده کنند.
زمینه های پشتیبانی شده:
displayName
مثال ها:
همه فهرست‌های سفارشی که نام نمایشی آنها حاوی "Google" است: displayName:"Google" .
نشانه ای برای بازیابی صفحه بعدی نتایج. این مقدار را در قسمت pageToken در فراخوانی بعدی به روش customLists.list ارسال کنید تا صفحه بعدی نتایج را بازیابی کنید.
تاریخ آخرین بهروزرسانی 2025-07-24 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-07-24 بهوقت ساعت هماهنگ جهانی."],[[["\u003cp\u003eDisplay & Video 360 API v1 is sunset and this page documents the custom lists endpoint.\u003c/p\u003e\n"],["\u003cp\u003eThis endpoint allows you to retrieve a list of custom lists, with options to filter, sort, and paginate the results.\u003c/p\u003e\n"],["\u003cp\u003eThe request body should be empty, and the response includes an array of custom lists and a token for pagination.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires the \u003ccode\u003ehttps://www.googleapis.com/auth/display-video\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],["This document outlines the process for listing custom lists using the Display & Video 360 API. It utilizes a `GET` request to the `/v1/customLists` endpoint. Users can specify `pageSize`, `pageToken`, `orderBy`, `filter`, and `advertiserId` as query parameters. The response includes an array of `customLists` and a `nextPageToken` for pagination. It requires the `https://www.googleapis.com/auth/display-video` authorization scope. The request body is empty.\n"],null,["# Method: customLists.list\n\n| Display \\& Video 360 API v1 has been sunset.\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListCustomListsResponse.SCHEMA_REPRESENTATION)\n- [Authorization Scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists custom lists.\n\nThe order is defined by the [orderBy](/display-video/api/reference/rest/v1/customLists/list#body.QUERY_PARAMETERS.order_by) parameter.\n\n### HTTP request\n\n`GET https://displayvideo.googleapis.com/v1/customLists`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `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. |\n| `pageToken` | `string` A token identifying a page of results the server should return. Typically, this is the value of [nextPageToken](/display-video/api/reference/rest/v1/customLists/list#body.ListCustomListsResponse.FIELDS.next_page_token) returned from the previous call to `customLists.list` method. If not specified, the first page of results will be returned. |\n| `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`. |\n| `filter` | `string` Allows filtering by custom list fields. Supported syntax: - Filter expressions for custom lists can only contain at most one restriction. - A restriction has the form of `{field} {operator} {value}`. - All fields must use the `HAS (:)` operator. 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. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. |\n| `advertiserId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The ID of the DV360 advertiser that has access to the fetched custom lists. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"customLists\": [ { object (/display-video/api/reference/rest/v1/customLists#CustomList) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `customLists[]` | `object (`[CustomList](/display-video/api/reference/rest/v1/customLists#CustomList)`)` The list of custom lists. This list will be absent if empty. |\n| `nextPageToken` | `string` A token to retrieve the next page of results. Pass this value in the [pageToken](/display-video/api/reference/rest/v1/customLists/list#body.QUERY_PARAMETERS.page_token) field in the subsequent call to `customLists.list` method to retrieve the next page of results. |\n\n### Authorization Scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/display-video`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2)."]]
