Method: advertisers.lineItems.list

แสดงรายการโฆษณาในผู้ลงโฆษณา

ลำดับจะกำหนดโดยพารามิเตอร์ orderBy หากไม่ได้ระบุ filter ของ entityStatus รายการโฆษณาที่มี ENTITY_STATUS_ARCHIVED จะไม่รวมอยู่ในผลลัพธ์

คำขอ HTTP

GET https://displayvideo.googleapis.com/v1beta2/advertisers/{advertiserId}/lineItems

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

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

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

string (int64 format)

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

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

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

integer

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

string

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

string

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

  • displayName (ค่าเริ่มต้น)
  • entityStatus
  • flight.dateRange.endDate
  • updateTime

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

string

อนุญาตให้กรองตามคุณสมบัติของรายการโฆษณา

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

  • นิพจน์ตัวกรองประกอบด้วยข้อจำกัดอย่างน้อย 1 ข้อ
  • สามารถรวมข้อจำกัดด้วยโอเปอเรเตอร์ทางตรรกะ AND หรือ OR ลำดับข้อจำกัดใช้ AND โดยนัย
  • ข้อจำกัดอยู่ในรูปแบบ {field} {operator} {value}
  • โอเปอเรเตอร์ที่ใช้ใน flight.dateRange.endDate ต้องน้อยกว่า (<)
  • โอเปอเรเตอร์ที่ใช้ใน updateTime ต้องเป็น GREATER THAN OR EQUAL TO (>=) หรือ LESS THAN OR EQUAL TO (<=)
  • โอเปอเรเตอร์ที่ใช้ใน warningMessages ต้องเป็น HAS (:)
  • โอเปอเรเตอร์ที่ใช้ในช่องอื่นๆ ทั้งหมดต้องเป็น EQUALS (=)
  • พร็อพเพอร์ตี้ที่รองรับ
    • campaignId
    • displayName
    • insertionOrderId
    • entityStatus
    • lineItemId
    • lineItemType
    • flight.dateRange.endDate (อินพุตอยู่ในรูปแบบ ปปปป-ดด-วว)
    • warningMessages
    • flight.triggerId
    • updateTime (อินพุตในรูปแบบ ISO 8601 หรือ YYYY-MM-DDTHH:MM:SSZ)
    • targetedChannelId
    • targetedNegativeKeywordListId

ตัวอย่าง

  • รายการโฆษณาทั้งหมดภายใต้ใบสั่งซื้อการใส่โฆษณา: insertionOrderId="1234"
  • รายการโฆษณา ENTITY_STATUS_ACTIVE หรือ ENTITY_STATUS_PAUSED และ LINE_ITEM_TYPE_DISPLAY_DEFAULT ทั้งหมดภายใต้ผู้ลงโฆษณารายหนึ่ง: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"
  • รายการโฆษณาทั้งหมดที่มีวันที่แสดงโฆษณาสิ้นสุดก่อนวันที่ 28 มีนาคม 2019: flight.dateRange.endDate<"2019-03-28"
  • รายการโฆษณาทั้งหมดที่มี NO_VALID_CREATIVE ใน warningMessages: warningMessages:"NO_VALID_CREATIVE"
  • รายการโฆษณาทั้งหมดที่มีเวลาอัปเดตน้อยกว่าหรือเท่ากับ 2020-11-04T18:54:47Z (format of ISO 8601): updateTime<="2020-11-04T18:54:47Z"
  • รายการโฆษณาทั้งหมดที่มีเวลาอัปเดตมากกว่าหรือเท่ากับ 2020-11-04T18:54:47Z (format of ISO 8601): updateTime>="2020-11-04T18:54:47Z"
  • รายการโฆษณาทั้งหมดที่ใช้ทั้งแชแนลที่ระบุและรายการคีย์เวิร์ดเชิงลบที่ระบุในการกำหนดเป้าหมาย: targetedNegativeKeywordListId=789 AND targetedChannelId=12345

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

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

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

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

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

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

object (LineItem)

รายชื่อรายการโฆษณา

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

string

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

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

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

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

ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมของ OAuth 2.0