החל מ-8 בספטמבר 2025, בכל פריט חדש צריך להצהיר אם הוא יציג מודעות פוליטיות באיחוד האירופי (EU) או לא. העלאות של קובצי SDF ושל Display & Video 360 API שלא כוללות הצהרות ייכשלו. מידע נוסף על אופן העדכון של האינטגרציה כדי להוסיף את ההצהרה הזו זמין בדף ההוצאה משימוש.
חובה. המזהה של המפרסם שאליו שייכות קבוצות המודעות.
פרמטרים של שאילתה
פרמטרים
pageSize
integer
אופציונלי. גודל הדף המבוקש. חייב להיות בין 1 לבין 100. אם לא צוין ערך, ברירת המחדל היא 100. הפונקציה מחזירה את קוד השגיאה INVALID_ARGUMENT אם צוין ערך לא חוקי.
pageToken
string
אופציונלי. אסימון שמזהה דף תוצאות שהשרת אמור להציג. בדרך כלל, זהו הערך של nextPageToken שהוחזר מהקריאה הקודמת לשיטה adGroupAds.list. אם לא יצוין, יוצג דף התוצאות הראשון.
orderBy
string
אופציונלי. השדה שלפיו רוצים למיין את הרשימה. הערכים הקבילים הם:
displayName (ברירת מחדל)
entityStatus
סדר המיון שמוגדר כברירת מחדל הוא עולה. כדי לציין סדר יורד בשדה, צריך להוסיף את הסיומת 'desc' לשם השדה. דוגמה: displayName desc
filter
string
אופציונלי. מאפשר סינון לפי שדות מותאמים אישית של מודעות בקבוצות של מודעות.
תחביר נתמך:
ביטויי מסננים מורכבים מהגבלה אחת או יותר.
אפשר לשלב הגבלות באמצעות AND ו-OR. ברצף של הגבלות נעשה שימוש ב-AND באופן משתמע.
הפורמט של הגבלה הוא {field} {operator} {value}.
בכל השדות צריך להשתמש באופרטור EQUALS (=).
שדות נתמכים:
adGroupId
displayName
entityStatus
adGroupAdId
דוגמאות:
כל המודעות בקבוצת מודעות מסוימת: adGroupId="1234"
כל המודעות בקבוצת מודעות עם סטטוס entityStatus של 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\u003eLists ad group ads associated with a specific advertiser ID using the \u003ccode\u003eGET\u003c/code\u003e method.\u003c/p\u003e\n"],["\u003cp\u003eAllows for filtering and sorting of results based on various criteria like \u003ccode\u003edisplayName\u003c/code\u003e, \u003ccode\u003eentityStatus\u003c/code\u003e, etc., using query parameters.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes a list of ad group ads and a token for pagination to retrieve further results.\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"]]],["This document outlines the process of listing ad group ads via the `adGroupAds.list` method. It requires a `GET` request to a specific URL, using the advertiser's ID as a path parameter. Optional query parameters like `pageSize`, `pageToken`, `orderBy`, and `filter` enable pagination, sorting, and filtering. The request body must be empty. The response body will include a list of ad group ads and a `nextPageToken` for pagination. The process requires OAuth authorization with the `https://www.googleapis.com/auth/display-video` scope.\n"],null,["# Method: advertisers.adGroupAds.list\n\n| Display \\& Video 360 API is deprecated and will sunset on **October 7, 2025** . Migrate to [Display \\& Video 360 API v4](/display-video/api/reference/rest/v4) before sunset to avoid an interruption in service.\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.ListAdGroupAdsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists ad group ads.\n\n### HTTP request\n\n`GET https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/adGroupAds`\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 `100`. 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/v3/advertisers.adGroupAds/list#body.ListAdGroupAdsResponse.FIELDS.next_page_token) returned from the previous call to `adGroupAds.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 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| ``` { \"adGroupAds\": [ { object (/display-video/api/reference/rest/v3/advertisers.adGroupAds#AdGroupAd) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `adGroupAds[]` | `object (`[AdGroupAd](/display-video/api/reference/rest/v3/advertisers.adGroupAds#AdGroupAd)`)` 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/v3/advertisers.adGroupAds/list#body.QUERY_PARAMETERS.page_token) field in the subsequent call to `adGroupAds.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)."]]
