اعتبارًا من 8 سبتمبر 2025، يجب أن يحدّد كل عنصر جديد في الحملة ما إذا كان سيعرض إعلانات سياسية في الاتحاد الأوروبي أم لا. ستتعذّر عمليات تحميل واجهة برمجة التطبيقات "مساحة العرض والفيديو 360" وملفات SDF التي لا تقدّم بيانات الإفصاح. يمكنك الاطّلاع على صفحة الإيقاف النهائي لمزيد من التفاصيل حول كيفية تعديل عملية الدمج لإجراء هذا البيان.
مطلوب. رقم تعريف المعلن الذي تنتمي إليه المجموعات الإعلانية.
معامِلات طلب البحث
المعلمات
pageSize
integer
حجم الصفحة المطلوب. يجب أن تتراوح القيمة بين 1 و200. وفي حال عدم تحديد قيمة، سيتم ضبط القيمة تلقائيًا على "100". تعرض رمز الخطأ INVALID_ARGUMENT إذا تم تحديد قيمة غير صالحة.
pageToken
string
هو رمز مميز يحدد صفحة من النتائج التي يجب أن يعرضها الخادم. وعادةً ما تكون هذه هي قيمة nextPageToken التي يتم عرضها من الاستدعاء السابق لطريقة youtubeAdGroups.list. وفي حال عدم تحديده، سيتم عرض الصفحة الأولى من النتائج.
orderBy
string
الحقل الذي سيتم ترتيب القائمة وفقًا له. القيم المقبولة هي:
displayName (تلقائي)
entityStatus
يكون ترتيب الترتيب التلقائي تصاعديًا. لتحديد ترتيب تنازلي للحقل، يجب استخدام اللاحقة "desc" يجب إضافته إلى اسم الحقل. مثال: displayName desc
filter
string
تسمح بالفلترة حسب حقول المجموعات الإعلانية المخصّصة على YouTube.
بنية متوافقة:
تتكون تعبيرات الفلاتر من قيد واحد أو أكثر.
يمكن دمج القيود من خلال AND وOR. سلسلة من القيود تستخدم ضمنيًا AND.
يكون للقيد {field} {operator} {value}.
يجب أن تستخدم جميع الحقول عامل التشغيل EQUALS (=).
السمات المتوافقة:
adGroupId
displayName
entityStatus
lineItemId
adGroupFormat
أمثلة:
كل المجموعات الإعلانية ضمن عنصر: lineItemId="1234"
كل المجموعات الإعلانية البالغ عددها ENTITY_STATUS_ACTIVE أو ENTITY_STATUS_PAUSEDYOUTUBE_AND_PARTNERS_AD_GROUP_FORMAT_IN_STREAM ضمن معلن: (entityStatus="ENTITY_STATUS_ACTIVE" OR
entityStatus="ENTITY_STATUS_PAUSED") AND
adGroupFormat="YOUTUBE_AND_PARTNERS_AD_GROUP_FORMAT_IN_STREAM"
رمز مميز لاسترداد الصفحة التالية من النتائج. مرِّر هذه القيمة في الحقل pageToken في طريقة الاستدعاء التالية إلى youtubeAdGroups.list لاسترداد الصفحة التالية من النتائج.
تاريخ التعديل الأخير: 2025-07-25 (حسب التوقيت العالمي المتفَّق عليه)
[null,null,["تاريخ التعديل الأخير: 2025-07-25 (حسب التوقيت العالمي المتفَّق عليه)"],[[["\u003cp\u003eLists YouTube ad groups for a specified advertiser using the Display & Video 360 API.\u003c/p\u003e\n"],["\u003cp\u003eSupports filtering and sorting options for retrieving specific ad group data.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/display-video\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eThe API uses pagination to return large result sets; retrieve subsequent pages using the \u003ccode\u003enextPageToken\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eProvides details like ad group ID, display name, entity status, and associated line item ID.\u003c/p\u003e\n"]]],["This document details the API for listing YouTube ad groups within Display & Video 360. It uses a `GET` request to `https://displayvideo.googleapis.com/v2/advertisers/{advertiserId}/youtubeAdGroups`, requiring an `advertiserId` path parameter. Query parameters allow for pagination (`pageSize`, `pageToken`), sorting (`orderBy`), and filtering (`filter`). The request body is empty, and the successful response includes a list of `youtubeAdGroups` and a `nextPageToken` for pagination. The API requires the `https://www.googleapis.com/auth/display-video` authorization scope.\n"],null,["# Method: advertisers.youtubeAdGroups.list\n\n| Display \\& Video 360 API v2 has sunset.\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListYoutubeAdGroupsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists YouTube ad groups.\n\n### HTTP request\n\n`GET https://displayvideo.googleapis.com/v2/advertisers/{advertiserId}/youtubeAdGroups`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------|\n| `advertiserId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Required. The ID of the advertiser the ad groups belongs to. |\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/v2/advertisers.youtubeAdGroups/list#body.ListYoutubeAdGroupsResponse.FIELDS.next_page_token) returned from the previous call to `youtubeAdGroups.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: - `displayName` (default) - `entityStatus` 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 YouTube ad group fields. Supported syntax: - Filter expressions are made up of one or more restrictions. - Restrictions can be combined by `AND` and `OR`. A sequence of restrictions implicitly uses `AND`. - A restriction has the form of `{field} {operator} {value}`. - All fields must use the `EQUALS (=)` operator. Supported properties: - `adGroupId` - `displayName` - `entityStatus` - `lineItemId` - `adGroupFormat` Examples: - All ad groups under an line item: `lineItemId=\"1234\"` - All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` `YOUTUBE_AND_PARTNERS_AD_GROUP_FORMAT_IN_STREAM` ad groups under an advertiser: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\") AND adGroupFormat=\"YOUTUBE_AND_PARTNERS_AD_GROUP_FORMAT_IN_STREAM\"` 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\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| ``` { \"youtubeAdGroups\": [ { object (/display-video/api/reference/rest/v2/advertisers.youtubeAdGroups#YoutubeAdGroup) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `youtubeAdGroups[]` | `object (`[YoutubeAdGroup](/display-video/api/reference/rest/v2/advertisers.youtubeAdGroups#YoutubeAdGroup)`)` The list of ad groups. 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/v2/advertisers.youtubeAdGroups/list#body.QUERY_PARAMETERS.page_token) field in the subsequent call to `youtubeAdGroups.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)."]]
