Method: advertisers.youtubeAdGroups.list

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

คำขอ HTTP

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

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

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

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

string (int64 format)

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

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

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

integer

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

string

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

string

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

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

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

string

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

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

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

พร็อพเพอร์ตี้ที่รองรับ

  • adGroupId
  • displayName
  • entityStatus
  • lineItemId
  • adGroupFormat

ตัวอย่าง

  • กลุ่มโฆษณาทั้งหมดที่อยู่ภายใต้รายการโฆษณา: lineItemId="1234"
  • กลุ่มโฆษณา ENTITY_STATUS_ACTIVE หรือ ENTITY_STATUS_PAUSED YOUTUBE_AND_PARTNERS_AD_GROUP_FORMAT_IN_STREAM ทั้งหมดภายใต้ผู้ลงโฆษณา: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupFormat="YOUTUBE_AND_PARTNERS_AD_GROUP_FORMAT_IN_STREAM"

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

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

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

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

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

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

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

object (YoutubeAdGroup)

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

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

string

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

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

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

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

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