ตั้งแต่วันที่
8 กันยายน 2025 เป็นต้นไป รายการโฆษณาใหม่ทุกรายการจะต้องประกาศว่าจะแสดงโฆษณาทางการเมืองในสหภาพยุโรป (EU) หรือไม่ การอัปโหลด API ของ Display & Video 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
ไม่บังคับ อนุญาตให้กรองตามช่องกลุ่มโฆษณาที่กำหนดเอง ไวยากรณ์ที่รองรับ
- นิพจน์ตัวกรองประกอบด้วยข้อจํากัดอย่างน้อย 1 ข้อ
- คุณสามารถใช้ข้อจำกัดร่วมกันได้โดยใช้
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
เนื้อหาของหน้าเว็บนี้ได้รับอนุญาตภายใต้ใบอนุญาตที่ต้องระบุที่มาของครีเอทีฟคอมมอนส์ 4.0 และตัวอย่างโค้ดได้รับอนุญาตภายใต้ใบอนุญาต Apache 2.0 เว้นแต่จะระบุไว้เป็นอย่างอื่น โปรดดูรายละเอียดที่นโยบายเว็บไซต์ Google Developers Java เป็นเครื่องหมายการค้าจดทะเบียนของ Oracle และ/หรือบริษัทในเครือ
อัปเดตล่าสุด 2025-07-25 UTC
[null,null,["อัปเดตล่าสุด 2025-07-25 UTC"],[],["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)."]]
