Method: advertisers.creatives.list

แสดงครีเอทีฟโฆษณาในผู้ลงโฆษณา

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

คำขอ HTTP

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

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

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

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

string (int64 format)

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

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

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

integer

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

string

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

string

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

  • creativeId (ค่าเริ่มต้น)
  • createTime
  • mediaDuration
  • dimensions (จัดเรียงตามความกว้างก่อน ตามด้วยความสูง)

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

string

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

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

  • นิพจน์ตัวกรองประกอบด้วยข้อจำกัดอย่างน้อย 1 ข้อ
  • ต้องรวมข้อจำกัดสำหรับช่องเดียวกันด้วย OR
  • ต้องรวมข้อจำกัดสำหรับฟิลด์ต่างๆ ด้วย AND
  • ระหว่าง ( ถึง ) จะมีได้เฉพาะข้อจำกัดที่รวมกันได้ด้วย OR สำหรับช่องเดียวกัน
  • โดยข้อจำกัดจะอยู่ในรูปแบบ {field} {operator} {value}
  • โอเปอเรเตอร์ต้องเป็น EQUALS (=) สําหรับช่องต่อไปนี้
    • entityStatus
    • creativeType
    • dimensions
    • minDuration
    • maxDuration
    • approvalStatus
    • exchangeReviewStatus
    • dynamic
    • creativeId
  • โอเปอเรเตอร์ต้องเป็น HAS (:) สําหรับช่องต่อไปนี้
    • lineItemIds
  • โอเปอเรเตอร์ต้องเป็น GREATER THAN OR EQUAL TO (>=) หรือ LESS THAN OR EQUAL TO (<=) สำหรับช่องต่อไปนี้
    • updateTime (ป้อนในรูปแบบ ISO 8601 หรือ YYYY-MM-DDTHH:MM:SSZ)
  • สำหรับ entityStatus, minDuration, maxDuration, updateTime และ dynamic อาจมีข้อจำกัดไม่เกิน 1 ข้อ
  • สำหรับ dimensions ค่าจะอยู่ในรูปแบบ "{width}x{height}"
  • สำหรับ exchangeReviewStatus ค่าจะอยู่ในรูปแบบ {exchange}-{reviewStatus}
  • สำหรับ minDuration และ maxDuration ค่าจะอยู่ในรูปแบบ "{duration}s" รองรับรายละเอียดในหน่วยมิลลิวินาทีเท่านั้น
  • สำหรับ updateTime ค่าในช่องของแหล่งข้อมูลครีเอทีฟโฆษณาแสดงถึงเวลาล่าสุดที่มีการอัปเดตครีเอทีฟโฆษณา ซึ่งรวมถึงการอัปเดตที่เกิดจากระบบ (เช่น การอัปเดตการตรวจสอบครีเอทีฟโฆษณา)
  • อาจมีข้อจำกัดของ lineItemIds หลายข้อเพื่อค้นหารหัสรายการโฆษณาที่เป็นไปได้หลายรหัส
  • อาจมีข้อจำกัดของ creativeId หลายข้อในการค้นหาด้วยรหัสครีเอทีฟโฆษณาที่เป็นไปได้หลายรหัส

ตัวอย่าง

  • ครีเอทีฟโฆษณาเนทีฟทั้งหมด: creativeType="CREATIVE_TYPE_NATIVE"
  • ครีเอทีฟโฆษณาที่ใช้งานอยู่ทั้งหมดที่มีขนาด 300x400 หรือ 50x100: entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400" OR dimensions="50x100")
  • โฆษณาแบบไดนามิกทั้งหมดที่ได้รับการอนุมัติจาก AdX หรือ AppNexus ซึ่งมีระยะเวลาขั้นต่ำ 5 วินาทีและ 200 มิลลิวินาที dynamic="true" AND minDuration="5.2s" AND (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")
  • ครีเอทีฟโฆษณาวิดีโอทั้งหมดที่เชื่อมโยงกับรหัสรายการโฆษณา 1 หรือ 2: creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2)
  • ค้นหาครีเอทีฟโฆษณาตามรหัสครีเอทีฟโฆษณาหลายรหัส: creativeId=1 OR creativeId=2

  • ครีเอทีฟโฆษณาทั้งหมดที่มีเวลาอัปเดตมากกว่าหรือเท่ากับ 2020-11-04T18:54:47Z (format of ISO 8601): updateTime>="2020-11-04T18:54:47Z" ช่องนี้ควรมีความยาวไม่เกิน 500 อักขระ

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

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

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

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

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

object (Creative)

รายการครีเอทีฟโฆษณา

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

string

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

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

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

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

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