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 (=)

ที่พักที่รองรับ

  • adGroupId
  • displayName
  • entityStatus
  • lineItemId
  • adGroupFormat

ตัวอย่าง

  • กลุ่มโฆษณาทั้งหมดในรายการโฆษณา: 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