Method: advertisers.youtubeAdGroupAds.list

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

คำขอ HTTP

GET https://displayvideo.googleapis.com/v2/advertisers/{advertiserId}/youtubeAdGroupAds

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

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

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

string (int64 format)

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

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

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

integer

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

pageToken

string

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

orderBy

string

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

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

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

filter

string

อนุญาตให้กรองตามช่องโฆษณาของกลุ่มโฆษณา YouTube ที่กำหนดเอง

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

  • นิพจน์ตัวกรองประกอบด้วยข้อจำกัดอย่างน้อย 1 ข้อ
  • คุณรวมข้อจำกัดได้โดยใช้ AND และ OR ลําดับข้อจํากัดใช้ AND โดยปริยาย
  • โดยข้อจำกัดจะอยู่ในรูปแบบ {field} {operator} {value}
  • ทุกช่องต้องใช้โอเปอเรเตอร์ EQUALS (=)

ฟิลด์ที่รองรับ:

  • adGroupId
  • displayName
  • entityStatus
  • adGroupAdId

ตัวอย่าง

  • โฆษณาของกลุ่มโฆษณาทั้งหมดภายใต้กลุ่มโฆษณา: adGroupId="1234"
  • โฆษณาของกลุ่มโฆษณาทั้งหมดภายใต้กลุ่มโฆษณาที่มีสถานะรหัสเอนทิตีเป็น ENTITY_STATUS_ACTIVE หรือ ENTITY_STATUS_PAUSED: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupId="12345"

ช่องนี้ควรมีความยาวไม่เกิน 500 อักขระ

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

เนื้อหาของคำขอ

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

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

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

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

object (YoutubeAdGroupAd)

รายการของโฆษณาระดับกลุ่มโฆษณา

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

nextPageToken

string

โทเค็นเพื่อเรียกผลลัพธ์หน้าถัดไป ส่งต่อค่านี้ในฟิลด์ pageToken ในการเรียกครั้งต่อๆ ไปไปยังเมธอด youtubeAdGroupAds.list เพื่อดึงผลลัพธ์หน้าถัดไป

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

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

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

สำหรับข้อมูลเพิ่มเติม โปรดดูที่ภาพรวมของ OAuth 2.0