اعتبارًا من
8 سبتمبر 2025، يجب أن يحدّد كل عنصر جديد في الحملة ما إذا كان سيعرض إعلانات سياسية في الاتحاد الأوروبي أم لا. ستتعذّر عمليات تحميل واجهة برمجة التطبيقات "مساحة العرض والفيديو 360" وملفات SDF التي لا تقدّم بيانات الإفصاح. يمكنك الاطّلاع على
صفحة الإيقاف النهائي لمزيد من التفاصيل حول كيفية تعديل عملية الدمج لإجراء هذا البيان.
Method: advertisers.adGroups.list
تنظيم صفحاتك في مجموعات
يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
يُدرج المجموعات الإعلانية.
طلب HTTP
GET https://displayvideo.googleapis.com/v4/advertisers/{advertiserId}/adGroups
يستخدِم عنوان URL بنية تحويل ترميز gRPC.
مَعلمات المسار
| المعلمات |
advertiserId |
string (int64 format)
مطلوب. رقم تعريف المعلِن الذي تنتمي إليه المجموعات الإعلانية.
|
مَعلمات طلب البحث
| المعلمات |
pageSize |
integer
اختياريّ. حجم الصفحة المطلوب يجب أن تتراوح بين 1 و200. إذا لم يتم تحديد قيمة، سيتم ضبطها تلقائيًا على 100. تُعرِض رمز الخطأ INVALID_ARGUMENT في حال تحديد قيمة غير صالحة.
|
pageToken |
string
اختياريّ. رمز مميّز يحدّد صفحة النتائج التي يجب أن يعرضها الخادم. وعادةً ما تكون هذه هي قيمة nextPageToken التي تم إرجاعها من الطلب السابق لاستخدام طريقة adGroups.list. إذا لم يتم تحديدها، سيتم عرض الصفحة الأولى من النتائج.
|
orderBy |
string
اختياريّ. الحقل الذي يتم ترتيب القائمة حسبه القيم المقبولة هي:
displayName (تلقائي)entityStatus يكون ترتيب الفرز التلقائي تصاعديًا. لتحديد الترتيب التنازلي لحقل معيّن، يجب إضافة اللاحقة "desc" إلى اسم الحقل. مثال: displayName desc
|
filter |
string
اختياريّ. تتيح الفلترة حسب حقول المجموعات الإعلانية المخصّصة. بنية الجملة المتوافقة:
- تتألّف عبارات الفلاتر من قيد واحد أو أكثر.
- يمكن الجمع بين القيود باستخدام
AND وOR. تستخدم تسلسلاً من القيود AND بشكل ضمني.
- يكون قيد المحتوى على شكل
{field} {operator} {value}.
- يجب أن تستخدم جميع الحقول عامل التشغيل
EQUALS (=).
السمات المتوافقة:
adGroupIddisplayNameentityStatuslineItemIdadGroupFormat أمثلة:
- جميع المجموعات الإعلانية ضمن عنصر:
lineItemId="1234"
- جميع المجموعات الإعلانية
ENTITY_STATUS_ACTIVE أو ENTITY_STATUS_PAUSED AD_GROUP_FORMAT_IN_STREAM ضمن حساب معلِن: (entityStatus="ENTITY_STATUS_ACTIVE" OR
entityStatus="ENTITY_STATUS_PAUSED") AND
adGroupFormat="AD_GROUP_FORMAT_IN_STREAM"
يجب ألا يزيد طول هذا الحقل عن 500 حرف. يُرجى الرجوع إلى دليل طلبات فلترة LIST للحصول على مزيد من المعلومات.
|
نص الطلب
يجب أن يكون نص الطلب فارغًا.
نص الاستجابة
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
| تمثيل JSON |
{
"adGroups": [
{
object (AdGroup)
}
],
"nextPageToken": string
} |
| الحقول |
adGroups[] |
object (AdGroup)
قائمة المجموعات الإعلانية لن تظهر هذه القائمة إذا كانت فارغة.
|
nextPageToken |
string
رمز مميّز لاسترداد الصفحة التالية من النتائج نقْل هذه القيمة في حقل pageToken في الطلب اللاحق لطريقة adGroups.list لاسترداد الصفحة التالية من النتائج.
|
نطاقات التفويض
يجب توفير نطاق OAuth التالي:
https://www.googleapis.com/auth/display-video
لمزيد من المعلومات، يُرجى الاطّلاع على OAuth 2.0 Overview.
إنّ محتوى هذه الصفحة مرخّص بموجب ترخيص Creative Commons Attribution 4.0 ما لم يُنصّ على خلاف ذلك، ونماذج الرموز مرخّصة بموجب ترخيص Apache 2.0. للاطّلاع على التفاصيل، يُرجى مراجعة سياسات موقع Google Developers. إنّ Java هي علامة تجارية مسجَّلة لشركة Oracle و/أو شركائها التابعين.
تاريخ التعديل الأخير: 2025-07-25 (حسب التوقيت العالمي المتفَّق عليه)
[null,null,["تاريخ التعديل الأخير: 2025-07-25 (حسب التوقيت العالمي المتفَّق عليه)"],[],["This document outlines the `adGroups.list` method in the Display & Video 360 API v4. It details how to retrieve a list of ad groups associated with a specific advertiser. Key actions include sending a GET request to a specified URL, using the `advertiserId` as a path parameter. Optional query parameters like `pageSize`, `pageToken`, `orderBy`, and `filter` enable result customization. The response returns a list of `adGroups` and a `nextPageToken` for pagination. The request body should be empty, and specific OAuth scopes are needed for authorization.\n"],null,["# Method: advertisers.adGroups.list\n\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.ListAdGroupsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists ad groups.\n\n### HTTP request\n\n`GET https://displayvideo.googleapis.com/v4/advertisers/{advertiserId}/adGroups`\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` Optional. 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` Optional. A token identifying a page of results the server should return. Typically, this is the value of [nextPageToken](/display-video/api/reference/rest/v4/advertisers.adGroups/list#body.ListAdGroupsResponse.FIELDS.next_page_token) returned from the previous call to `adGroups.list` method. If not specified, the first page of results will be returned. |\n| `orderBy` | `string` Optional. 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` Optional. Allows filtering by custom 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` `AD_GROUP_FORMAT_IN_STREAM` ad groups under an advertiser: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\") AND adGroupFormat=\"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| ``` { \"adGroups\": [ { object (/display-video/api/reference/rest/v4/advertisers.adGroups#AdGroup) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `adGroups[]` | `object (`[AdGroup](/display-video/api/reference/rest/v4/advertisers.adGroups#AdGroup)`)` 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/v4/advertisers.adGroups/list#body.QUERY_PARAMETERS.page_token) field in the subsequent call to `adGroups.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](/identity/protocols/OAuth2)."]]
