Method: advertisers.adGroups.list

แสดงรายการกลุ่มโฆษณา

คำขอ HTTP

GET https://displayvideo.googleapis.com/v5/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