Method: advertisers.adGroupAds.list

แสดงโฆษณาของกลุ่มโฆษณา

คำขอ HTTP

GET https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/adGroupAds

URL ใช้ไวยากรณ์การแปลงรหัส gRPC

พารามิเตอร์เส้นทาง

พารามิเตอร์
advertiserId

string (int64 format)

ต้องระบุ รหัสของผู้ลงโฆษณาที่กลุ่มโฆษณาเป็นของ

พารามิเตอร์การค้นหา

พารามิเตอร์
pageSize

integer

ไม่บังคับ ขนาดหน้าที่ขอ ต้องอยู่ระหว่าง 1 ถึง 100 หากไม่ได้ระบุ ระบบจะใช้ 100 เป็นค่าเริ่มต้น แสดงรหัสข้อผิดพลาด INVALID_ARGUMENT หากระบุค่าที่ไม่ถูกต้อง
pageToken

string

ไม่บังคับ โทเค็นที่ระบุหน้าผลลัพธ์ที่เซิร์ฟเวอร์ควรแสดง โดยปกติแล้ว ค่านี้คือค่าของ nextPageToken ที่ส่งคืนจากการเรียกเมธอด adGroupAds.list ครั้งก่อน หากไม่ได้ระบุ ระบบจะแสดงผลหน้าแรกของผลการค้นหา
orderBy

string

ไม่บังคับ ฟิลด์ที่ใช้จัดเรียงรายการ ค่าที่ยอมรับมีดังนี้

  • displayName (ค่าเริ่มต้น)
  • entityStatus

ลำดับการจัดเรียงเริ่มต้นคือจากน้อยไปมาก หากต้องการระบุลำดับจากมากไปน้อยสำหรับฟิลด์ ให้เพิ่มคำต่อท้าย "desc" ในชื่อฟิลด์ ตัวอย่าง: displayName desc
filter

string

ไม่บังคับ อนุญาตให้กรองตามช่องโฆษณากลุ่มโฆษณาที่กําหนดเอง

ไวยากรณ์ที่รองรับ

  • นิพจน์ตัวกรองประกอบด้วยข้อจํากัดอย่างน้อย 1 รายการ
  • 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"

ฟิลด์นี้ควรมีความยาวไม่เกิน 500 อักขระ

ดูข้อมูลเพิ่มเติมได้ในคำแนะนำเกี่ยวกับคำขอLISTตัวกรอง

เนื้อความของคำขอ

เนื้อหาของคำขอต้องว่างเปล่า

เนื้อหาการตอบกลับ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON 
{
  "adGroupAds": [
    {
      object (AdGroupAd)
    }
  ],
  "nextPageToken": string
}
ช่อง
adGroupAds[]

object (AdGroupAd)

รายการโฆษณาของกลุ่มโฆษณา

รายการนี้จะไม่มีหากว่างเปล่า
nextPageToken

string

โทเค็นเพื่อดึงข้อมูลผลลัพธ์หน้าถัดไป ส่งค่านี้ในช่อง pageToken ในการเรียกใช้เมธอด adGroupAds.list ครั้งถัดไปเพื่อดึงข้อมูลผลลัพธ์หน้าถัดไป

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/display-video

ดูข้อมูลเพิ่มเติมได้ที่OAuth 2.0 Overview