החל מ-8 בספטמבר 2025, בכל פריט חדש צריך להצהיר אם הוא יציג מודעות פוליטיות באיחוד האירופי (EU) או לא. העלאות של קובצי SDF ושל Display & Video 360 API שלא כוללות הצהרות ייכשלו. מידע נוסף על אופן העדכון של האינטגרציה כדי להוסיף את ההצהרה הזו זמין בדף ההוצאה משימוש.
חובה. המזהה של המפרסם שאליו שייכות קבוצות המודעות.
פרמטרים של שאילתה
פרמטרים
pageSize
integer
גודל הדף המבוקש. חייב להיות בין 1 ל-100. אם לא צויין ערך, ברירת המחדל תהיה 100. הפונקציה מחזירה את קוד השגיאה INVALID_ARGUMENT אם צוין ערך לא חוקי.
pageToken
string
אסימון שמזהה דף תוצאות שהשרת צריך להחזיר. בדרך כלל, זהו הערך של nextPageToken שהוחזר מהקריאה הקודמת ל-method youtubeAdGroupAds.list. אם לא מציינים זאת, המערכת תחזיר את דף התוצאות הראשון.
orderBy
string
השדה שלפיו צריך למיין את הרשימה. הערכים הקבילים הם:
displayName (ברירת מחדל)
entityStatus
ברירת המחדל של סדר המיון היא בסדר עולה. כדי לציין סדר יורד בשדה, הסיומת 'תיאור' יש להוסיף לשם השדה. דוגמה: displayName desc
filter
string
מאפשר סינון לפי שדות מותאמים אישית של מודעות בקבוצת מודעות ב-YouTube.
תחביר נתמך:
ביטויי הסינון מורכבים מהגבלה אחת או יותר.
אפשר לשלב את ההגבלות באמצעות AND ועם OR. רצף של הגבלות משתמש באופן מרומז ב-AND.
הגבלה היא בצורה הבאה: {field} {operator} {value}.
צריך להשתמש באופרטור EQUALS (=) בכל השדות.
שדות נתמכים:
adGroupId
displayName
entityStatus
adGroupAdId
דוגמאות:
כל המודעות בקבוצת המודעות: adGroupId="1234"
כל המודעות בקבוצת המודעות בקבוצת מודעות עם סטטוס ישות ENTITY_STATUS_ACTIVE או ENTITY_STATUS_PAUSED: (entityStatus="ENTITY_STATUS_ACTIVE" OR
entityStatus="ENTITY_STATUS_PAUSED") AND
adGroupId="12345"
[null,null,["עדכון אחרון: 2025-07-25 (שעון UTC)."],[[["\u003cp\u003eDisplay & Video 360 API v2 is sunset and this page documents the youtubeAdGroupAds.list method.\u003c/p\u003e\n"],["\u003cp\u003eThis method allows you to list YouTube ad group ads for a given advertiser, with filtering and sorting options.\u003c/p\u003e\n"],["\u003cp\u003eThe request body should be empty and the response will contain a list of YouTube ad group ads and a token for pagination.\u003c/p\u003e\n"],["\u003cp\u003eYou need the \u003ccode\u003ehttps://www.googleapis.com/auth/display-video\u003c/code\u003e OAuth scope to authorize this request.\u003c/p\u003e\n"]]],["This API lists YouTube ad group ads via a `GET` request to `https://displayvideo.googleapis.com/v2/advertisers/{advertiserId}/youtubeAdGroupAds`. The `advertiserId` path parameter is required. Optional query parameters include `pageSize`, `pageToken`, `orderBy` (e.g., by displayName or entityStatus), and `filter` to refine the list (e.g., by adGroupId). The empty request body returns a response with a list of ad group ads and a `nextPageToken` for pagination, authorized through OAuth scope `https://www.googleapis.com/auth/display-video`.\n"],null,["# Method: advertisers.youtubeAdGroupAds.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.ListYoutubeAdGroupAdsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists YouTube ad group ads.\n\n### HTTP request\n\n`GET https://displayvideo.googleapis.com/v2/advertisers/{advertiserId}/youtubeAdGroupAds`\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 `100`. 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.youtubeAdGroupAds/list#body.ListYoutubeAdGroupAdsResponse.FIELDS.next_page_token) returned from the previous call to `youtubeAdGroupAds.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 ad 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 fields: - `adGroupId` - `displayName` - `entityStatus` - `adGroupAdId` Examples: - All ad group ads under an ad group: `adGroupId=\"1234\"` - All ad group ads under an ad group with an entityStatus of `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED`: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\") AND adGroupId=\"12345\"` 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| ``` { \"youtubeAdGroupAds\": [ { object (/display-video/api/reference/rest/v2/advertisers.youtubeAdGroupAds#YoutubeAdGroupAd) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `youtubeAdGroupAds[]` | `object (`[YoutubeAdGroupAd](/display-video/api/reference/rest/v2/advertisers.youtubeAdGroupAds#YoutubeAdGroupAd)`)` The list of ad group ads. 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.youtubeAdGroupAds/list#body.QUERY_PARAMETERS.page_token) field in the subsequent call to `youtubeAdGroupAds.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)."]]
