Method: advertisers.reachForecast.retrievePlannableUserLists

ดึงข้อมูลรายการผู้ใช้ของบุคคลที่หนึ่งและบุคคลที่สามที่ใช้ได้สำหรับการคาดการณ์

คำขอ HTTP

GET https://displayvideo.googleapis.com/v5/advertisers/{advertiserId}/reachForecast:retrievePlannableUserLists

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

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

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

string (int64 format)

ต้องระบุ รหัสของผู้ลงโฆษณาที่จะดึงข้อมูลรายชื่อผู้ใช้ที่วางแผนได้

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

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

integer

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

string

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

string

ไม่บังคับ อนุญาตให้กรองตามพร็อพเพอร์ตี้รายการผู้ใช้ที่วางแผนได้

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

  • นิพจน์ตัวกรองประกอบด้วยข้อจำกัดอย่างน้อย 1 รายการ
  • ข้อจำกัดสามารถรวมกันได้โดยใช้โอเปอเรเตอร์เชิงตรรกะ AND หรือ OR
  • ข้อจำกัดมีรูปแบบเป็น {field} {operator} {value}
  • ฟิลด์ displayName ต้องใช้โอเปอเรเตอร์ HAS (:)
  • ส่วนช่องอื่นๆ ทั้งหมดต้องใช้โอเปอเรเตอร์ EQUALS (=)

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

  • plannableStatus
  • displayName
  • userListType
  • name

ตัวอย่าง

  • รายการผู้ใช้ทั้งหมดที่วางแผนได้: plannableStatus="PLANNABLE"
  • รายการผู้ใช้ที่วางแผนได้ซึ่งมีชื่อที่แสดงที่มีคำว่า "Shopping": plannableStatus="PLANNABLE" AND displayName:"Shopping"
  • รายชื่อผู้ใช้บุคคลที่หนึ่ง: userListType="FIRST_PARTY"

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

ดูข้อมูลเพิ่มเติมได้ที่คู่มือกรองคำขอ LIST

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

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

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

การตอบกลับสำหรับ reachForecast.retrievePlannableUserLists

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

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

object (PlannableUserList)

เอาต์พุตเท่านั้น รายการรายชื่อผู้ใช้ที่วางแผนได้
nextPageToken

string

เอาต์พุตเท่านั้น โทเค็นสำหรับดึงข้อมูลผลลัพธ์หน้าถัดไป

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

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

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

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

PlannableUserList

รายชื่อผู้ใช้ที่วางแผนได้ซึ่งใช้สำหรับการคาดการณ์การเข้าถึง

การแสดง JSON 
{
  "displayName": string,
  "userListType": enum (UserListType),
  "name": string,
  "plannableStatus": enum (PlannableStatus)
}
ช่อง
displayName

string

เอาต์พุตเท่านั้น ชื่อที่แสดงของรายชื่อผู้ใช้
userListType

enum (UserListType)

เอาต์พุตเท่านั้น ประเภทของรายชื่อผู้ใช้
name

string

เอาต์พุตเท่านั้น ชื่อทรัพยากรที่ระบุรายชื่อผู้ใช้

รูปแบบ: advertisers/{advertiserId}/userLists/{user_list_id}
plannableStatus

enum (PlannableStatus)

เอาต์พุตเท่านั้น สถานะความสามารถในการวางแผนของรายชื่อผู้ใช้

UserListType

ประเภทของรายชื่อผู้ใช้

Enum
USER_LIST_TYPE_UNSPECIFIED ประเภทรายการผู้ใช้ที่ไม่ได้ระบุ
FIRST_PARTY รายชื่อผู้ใช้จากบุคคลที่หนึ่ง
THIRD_PARTY รายชื่อผู้ใช้ของบุคคลที่สาม

PlannableStatus

สถานะที่ระบุว่าวางแผนรายการได้หรือไม่

Enum
PLANNABLE_STATUS_UNSPECIFIED สถานะความสามารถในการวางแผนที่ไม่ได้ระบุ
PLANNABLE รายการผู้ใช้สามารถวางแผนได้
UNPLANNABLE วางแผนรายการผู้ใช้ไม่ได้