اعتبارًا من 8 سبتمبر 2025، يجب أن يحدّد كل عنصر جديد في الحملة ما إذا كان سيعرض إعلانات سياسية في الاتحاد الأوروبي أم لا. ستتعذّر عمليات تحميل واجهة برمجة التطبيقات "مساحة العرض والفيديو 360" وملفات 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-25 (حسب التوقيت العالمي المتفَّق عليه)
[null,null,["تاريخ التعديل الأخير: 2025-07-25 (حسب التوقيت العالمي المتفَّق عليه)"],[[["\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)."]]