Method: advertisers.locationLists.list

แสดงรายการสถานที่ตั้งตามรหัสผู้ลงโฆษณาที่กำหนด

คำขอ HTTP

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

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

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

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

string (int64 format)

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

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

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

integer

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

pageToken

string

โทเค็นที่ระบุหน้าผลลัพธ์ที่เซิร์ฟเวอร์ควรแสดงผล

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

orderBy

string

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

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

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

filter

string

อนุญาตให้กรองตามฟิลด์รายการสถานที่ตั้ง

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

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

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

  • locationType

ตัวอย่าง

  • รายการสถานที่ตั้งระดับภูมิภาคทั้งหมด: locationType="TARGETING_LOCATION_TYPE_REGIONAL"
  • รายการสถานที่ใกล้เคียงทั้งหมด: locationType="TARGETING_LOCATION_TYPE_PROXIMITY"

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

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

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

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

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

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

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

object (LocationList)

รายการสถานที่

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

nextPageToken

string

โทเค็นเพื่อเรียกผลลัพธ์หน้าถัดไป

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

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

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

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

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