ดิสเพลย์และ Video 360 API v2 จะหยุดให้บริการในวันที่
3 กันยายน 2024 โปรด
ย้ายข้อมูลไปยังเวอร์ชัน 3 ก่อนวันที่ดังกล่าวเพื่อไม่ให้บริการหยุดชะงัก
Method: advertisers.creatives.list
จัดทุกอย่างให้เป็นระเบียบอยู่เสมอด้วยคอลเล็กชัน
บันทึกและจัดหมวดหมู่เนื้อหาตามค่ากำหนดของคุณ
แสดงรายการครีเอทีฟโฆษณาในส่วนของผู้ลงโฆษณา
ลำดับจะกำหนดโดยพารามิเตอร์ orderBy
หากไม่ได้ระบุ filter
ของ entityStatus
ครีเอทีฟโฆษณาที่มี ENTITY_STATUS_ARCHIVED
จะไม่รวมอยู่ในผลลัพธ์
คำขอ HTTP
GET https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/creatives
URL ใช้ไวยากรณ์การแปลง gRPC
พารามิเตอร์เส้นทาง
พารามิเตอร์ |
advertiserId |
string (int64 format)
ต้องระบุ รหัสของผู้ลงโฆษณาที่จะแสดงรายการครีเอทีฟโฆษณา
|
พารามิเตอร์การค้นหา
พารามิเตอร์ |
pageSize |
integer
ขนาดหน้าที่ขอ ต้องอยู่ระหว่าง 1 ถึง 200 หากไม่ระบุ จะมีค่าเริ่มต้นเป็น 100 แสดงผลรหัสข้อผิดพลาด INVALID_ARGUMENT หากระบุค่าไม่ถูกต้อง
|
pageToken |
string
โทเค็นที่ระบุหน้าผลลัพธ์ที่เซิร์ฟเวอร์ควรจะแสดงผล โดยปกติแล้วจะเป็นค่าของ nextPageToken ที่แสดงผลจากการเรียกใช้ก่อนหน้านี้ไปยังเมธอด creatives.list หากไม่ได้ระบุ ระบบจะแสดงผลการค้นหาหน้าแรก
|
orderBy |
string
ช่องที่จะใช้จัดเรียงรายการ ค่าที่ยอมรับมีดังนี้
creativeId (ค่าเริ่มต้น)
createTime
mediaDuration
dimensions (จัดเรียงตามความกว้างก่อนแล้วตามด้วยความสูง)
ลำดับการจัดเรียงเริ่มต้นจะเป็นจากน้อยไปมาก หากต้องการระบุลำดับจากมากไปน้อยสำหรับช่อง ควรเพิ่มส่วนต่อท้าย "desc" ลงในชื่อช่อง ตัวอย่าง: createTime desc
|
filter |
string
อนุญาตให้กรองตามช่องครีเอทีฟโฆษณา ไวยากรณ์ที่รองรับ:
- นิพจน์ตัวกรองประกอบด้วยข้อจำกัดอย่างน้อย 1 ข้อ
- สามารถรวมข้อจำกัดด้วยโอเปอเรเตอร์ทางตรรกะ
AND หรือ OR ลำดับข้อจำกัดใช้ AND โดยนัย
- ข้อจำกัดอยู่ในรูปแบบ
{field} {operator} {value}
- ฟิลด์
lineItemIds ต้องใช้โอเปอเรเตอร์ HAS (:)
- ฟิลด์
updateTime ต้องใช้โอเปอเรเตอร์ GREATER THAN OR EQUAL TO (>=) หรือ LESS THAN OR EQUAL TO (<=)
- ช่องอื่นๆ ทั้งหมดต้องใช้โอเปอเรเตอร์
EQUALS (=)
- สำหรับช่อง
entityStatus , minDuration , maxDuration , updateTime และ dynamic อาจมีข้อจำกัดสูงสุด 1 รายการ
ช่องที่รองรับ
approvalStatus
creativeId
creativeType
dimensions (ข้อมูลในรูปแบบ {width}x{height} )
dynamic
entityStatus
exchangeReviewStatus (ข้อมูลในรูปแบบ {exchange}-{reviewStatus} )
lineItemIds
maxDuration (ป้อนข้อมูลในรูปแบบ {duration}s สนับสนุนวินาทีเท่านั้น)
minDuration (ป้อนข้อมูลในรูปแบบ {duration}s สนับสนุนวินาทีเท่านั้น)
updateTime (อินพุตในรูปแบบ ISO 8601 หรือ YYYY-MM-DDTHH:MM:SSZ )
หมายเหตุ
- สำหรับ
updateTime ค่าในช่องของทรัพยากรครีเอทีฟโฆษณาจะแสดงเวลาล่าสุดที่มีการอัปเดตครีเอทีฟโฆษณา ซึ่งรวมถึงการอัปเดตที่ระบบทำ (เช่น อัปเดตการตรวจสอบครีเอทีฟโฆษณา)
ตัวอย่าง
- ครีเอทีฟโฆษณาเนทีฟทั้งหมด:
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 (รูปแบบของ ISO 8601):
updateTime>="2020-11-04T18:54:47Z"
ช่องนี้ควรมีความยาวไม่เกิน 500 อักขระ โปรดดูข้อมูลเพิ่มเติมในคำแนะนำเกี่ยวกับตัวกรองคำขอ LIST
|
เนื้อหาของคำขอ
เนื้อหาของคำขอต้องว่างเปล่า
เนื้อหาการตอบกลับ
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
การแสดง 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
เนื้อหาของหน้าเว็บนี้ได้รับอนุญาตภายใต้ใบอนุญาตที่ต้องระบุที่มาของครีเอทีฟคอมมอนส์ 4.0 และตัวอย่างโค้ดได้รับอนุญาตภายใต้ใบอนุญาต Apache 2.0 เว้นแต่จะระบุไว้เป็นอย่างอื่น โปรดดูรายละเอียดที่นโยบายเว็บไซต์ Google Developers Java เป็นเครื่องหมายการค้าจดทะเบียนของ Oracle และ/หรือบริษัทในเครือ
อัปเดตล่าสุด 2024-06-11 UTC
[{
"type": "thumb-down",
"id": "missingTheInformationINeed",
"label":"ไม่มีข้อมูลที่ฉันต้องการ"
},{
"type": "thumb-down",
"id": "tooComplicatedTooManySteps",
"label":"ซับซ้อนเกินไป/มีหลายขั้นตอนมากเกินไป"
},{
"type": "thumb-down",
"id": "outOfDate",
"label":"ล้าสมัย"
},{
"type": "thumb-down",
"id": "translationIssue",
"label":"ปัญหาเกี่ยวกับการแปล"
},{
"type": "thumb-down",
"id": "samplesCodeIssue",
"label":"ตัวอย่าง/ปัญหาเกี่ยวกับโค้ด"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"อื่นๆ"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"เข้าใจง่าย"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"แก้ปัญหาของฉันได้"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"อื่นๆ"
}]