Method: googleAudiences.list

แสดงรายการกลุ่มเป้าหมายของ Google

ลำดับจะกำหนดโดยพารามิเตอร์ orderBy

คำขอ HTTP

GET https://displayvideo.googleapis.com/v5/googleAudiences

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

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

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

integer

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

string

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

string

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

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

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

string

อนุญาตให้กรองตามช่องกลุ่มเป้าหมายของ Google

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

  • นิพจน์ตัวกรองสําหรับกลุ่มเป้าหมายของ Google มีข้อจํากัดได้สูงสุด 1 รายการเท่านั้น
  • ข้อจำกัดมีรูปแบบเป็น {field} {operator} {value}
  • ทุกช่องต้องใช้โอเปอเรเตอร์ HAS (:)

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

  • displayName

ตัวอย่าง

  • กลุ่มเป้าหมายทั้งหมดของ Google ที่มีชื่อที่แสดงซึ่งมีคำว่า "Google": displayName:"Google"

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

ดูข้อมูลเพิ่มเติมได้ที่คู่มือกรองคำขอ LIST
ต้องระบุ ระบุเอนทิตี DV360 ที่มีการส่งคำขอ คำขอ LIST จะแสดงเฉพาะเอนทิตีกลุ่มเป้าหมายของ Google ที่เอนทิตี DV360 ซึ่งระบุไว้ใน accessor เข้าถึงได้ ต่อไปนี้คือรายการช่องที่แยกกันโดยสิ้นเชิง ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้
partnerId

string (int64 format)

รหัสของพาร์ทเนอร์ที่มีสิทธิ์เข้าถึงกลุ่มเป้าหมายของ Google ที่ดึงมา
advertiserId

string (int64 format)

รหัสของผู้ลงโฆษณาที่มีสิทธิ์เข้าถึงกลุ่มเป้าหมาย Google ที่ดึงมา
สิ้นสุดฟิลด์ที่แยกกัน

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

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

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

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

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

object (GoogleAudience)

รายการกลุ่มเป้าหมายของ Google

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

string

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

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

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

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

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