از 8 سپتامبر 2025 ، هر مورد خط جدید باید اعلام کند که آیا تبلیغات سیاسی اتحادیه اروپا (EU) را ارائه می دهد یا خیر. Display & Video 360 API و بارگذاری‌های 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-24 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-07-24 بهوقت ساعت هماهنگ جهانی."],[[["\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)."]]
