ดิสเพลย์และ Video 360 API v2 จะหยุดให้บริการในวันที่
3 กันยายน 2024 โปรด
ย้ายข้อมูลไปยังเวอร์ชัน 3 ก่อนวันที่ดังกล่าวเพื่อไม่ให้บริการหยุดชะงัก
Method: advertisers.campaigns.list
จัดทุกอย่างให้เป็นระเบียบอยู่เสมอด้วยคอลเล็กชัน
บันทึกและจัดหมวดหมู่เนื้อหาตามค่ากำหนดของคุณ
แสดงรายการแคมเปญในผู้ลงโฆษณา
ลำดับจะกำหนดโดยพารามิเตอร์ orderBy
หากไม่ได้ระบุ filter
ของ entityStatus
แคมเปญที่มี ENTITY_STATUS_ARCHIVED
จะไม่รวมอยู่ในผลลัพธ์
คำขอ HTTP
GET https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/campaigns
URL ใช้ไวยากรณ์การแปลง gRPC
พารามิเตอร์เส้นทาง
พารามิเตอร์ |
advertiserId |
string (int64 format)
รหัสของผู้ลงโฆษณาที่จะแสดงรายการแคมเปญ
|
พารามิเตอร์การค้นหา
พารามิเตอร์ |
pageSize |
integer
ขนาดหน้าที่ขอ ต้องอยู่ระหว่าง 1 ถึง 200 หากไม่ระบุ จะมีค่าเริ่มต้นเป็น 100
|
pageToken |
string
โทเค็นที่ระบุหน้าผลลัพธ์ที่เซิร์ฟเวอร์ควรจะแสดงผล โดยปกติแล้วจะเป็นค่าของ nextPageToken ที่แสดงผลจากการเรียกใช้ก่อนหน้านี้ไปยังเมธอด campaigns.list หากไม่ได้ระบุ ระบบจะแสดงผลการค้นหาหน้าแรก
|
orderBy |
string
ช่องที่จะใช้จัดเรียงรายการ ค่าที่ยอมรับมีดังนี้
displayName (ค่าเริ่มต้น)
entityStatus
updateTime
ลำดับการจัดเรียงเริ่มต้นจะเป็นจากน้อยไปมาก หากต้องการระบุลำดับจากมากไปน้อยสำหรับช่อง ควรเพิ่มส่วนต่อท้าย "desc" ลงในชื่อช่อง ตัวอย่าง: displayName desc
|
filter |
string
อนุญาตให้กรองตามช่องแคมเปญ ไวยากรณ์ที่รองรับ:
- นิพจน์ตัวกรองประกอบด้วยข้อจำกัดอย่างน้อย 1 ข้อ
- สามารถรวมข้อจำกัดด้วยโอเปอเรเตอร์ทางตรรกะ
AND หรือ OR ลำดับข้อจำกัดใช้ AND โดยนัย
- ข้อจำกัดอยู่ในรูปแบบ
{field} {operator} {value}
- ฟิลด์
updateTime ต้องใช้โอเปอเรเตอร์ GREATER THAN OR EQUAL TO (>=) หรือ LESS THAN OR EQUAL TO (<=)
- ช่องอื่นๆ ทั้งหมดต้องใช้โอเปอเรเตอร์
EQUALS (=)
ช่องที่รองรับ
campaignId
displayName
entityStatus
updateTime (อินพุตในรูปแบบ ISO 8601 หรือ YYYY-MM-DDTHH:MM:SSZ )
ตัวอย่าง
- แคมเปญทั้งหมด
ENTITY_STATUS_ACTIVE หรือ ENTITY_STATUS_PAUSED ภายใต้ผู้ลงโฆษณา: (entityStatus="ENTITY_STATUS_ACTIVE" OR
entityStatus="ENTITY_STATUS_PAUSED")
- แคมเปญทั้งหมดที่มีเวลาอัปเดตน้อยกว่าหรือเท่ากับ 2020-11-04T18:54:47Z (รูปแบบ ISO 8601):
updateTime<="2020-11-04T18:54:47Z"
- แคมเปญทั้งหมดที่มีเวลาอัปเดตมากกว่าหรือเท่ากับ 2020-11-04T18:54:47Z (รูปแบบ ISO 8601):
updateTime>="2020-11-04T18:54:47Z"
ช่องนี้ควรมีความยาวไม่เกิน 500 อักขระ โปรดดูข้อมูลเพิ่มเติมในคำแนะนำเกี่ยวกับตัวกรองคำขอ LIST
|
เนื้อหาของคำขอ
เนื้อหาของคำขอต้องว่างเปล่า
เนื้อหาการตอบกลับ
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
การแสดง JSON |
{
"campaigns": [
{
object (Campaign )
}
],
"nextPageToken": string
} |
ช่อง |
campaigns[] |
object (Campaign )
รายการแคมเปญ รายการนี้จะไม่แสดงหากว่างเปล่า
|
nextPageToken |
string
โทเค็นสำหรับเรียกผลการค้นหาหน้าถัดไป ส่งค่านี้ในช่อง pageToken ในการเรียกเมธอด campaigns.list ที่ตามมาเพื่อดึงผลการค้นหาหน้าถัดไป
|
ขอบเขตการให้สิทธิ์
ต้องมีขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้
https://www.googleapis.com/auth/display-video
https://www.googleapis.com/auth/display-video-mediaplanning
ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมของ 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":"อื่นๆ"
}]
{
"last_modified": "อัปเดตล่าสุด 2024-06-11 UTC",
"state": ""
}