- คำขอ HTTP
- พารามิเตอร์เส้นทาง
- เนื้อความของคำขอ
- เนื้อหาการตอบกลับ
- ขอบเขตการให้สิทธิ์
- CampaignReportSpec
- มิติข้อมูล
- เมตริก
- ตัวอย่าง
- ลองใช้งาน
สร้างรายงานแคมเปญตามข้อกำหนดที่ให้ไว้
คำขอ HTTP
POST https://admob.googleapis.com/v1beta/{parent=accounts/*}/campaignReport:generate
URL ใช้ไวยากรณ์การแปลง gRPC
พารามิเตอร์เส้นทาง
พารามิเตอร์ | |
---|---|
parent |
ชื่อทรัพยากรของบัญชีที่จะใช้สร้างรายงาน ตัวอย่าง: accounts/pub-9876543210987654 |
เนื้อหาของคำขอ
เนื้อหาของคำขอมีข้อมูลที่มีโครงสร้างต่อไปนี้
การแสดง JSON |
---|
{
"reportSpec": {
object ( |
ช่อง | |
---|---|
reportSpec |
ข้อกำหนดการรายงานแคมเปญ |
เนื้อหาการตอบกลับ
การตอบสนองจาก Campaign Report API
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
การแสดง JSON |
---|
{
"rows": [
{
object ( |
ช่อง | |
---|---|
rows[] |
ข้อมูลรายงานของแคมเปญจากผู้เผยแพร่โฆษณาที่ระบุ ระบบจะแสดงผลแถวจาก API ไม่เกิน 100,000 แถว |
ขอบเขตการให้สิทธิ์
ต้องมีขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้
https://www.googleapis.com/auth/admob.readonly
https://www.googleapis.com/auth/admob.report
ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมของ OAuth 2.0
CampaignReportSpec
ข้อกำหนดสำหรับการสร้างรายงานแคมเปญ ตัวอย่างเช่น ข้อกำหนดให้รับ IMPRESSIONS และ CLICKS แบ่งตาม CAMPAIGN_ID อาจมีลักษณะเหมือนตัวอย่างต่อไปนี้
{
"dateRange": {
"startDate": {"year": 2021, "month": 12, "day": 1},
"endDate": {"year": 2021, "month": 12, "day": 30}
},
"dimensions": ["CAMPAIGN_ID"],
"metrics": ["IMPRESSIONS", "CLICKS"],
}
การแสดง JSON |
---|
{ "dateRange": { object ( |
ช่อง | |
---|---|
dateRange |
ช่วงวันที่ที่สร้างรายงาน ช่วงสูงสุดคือ 30 วัน |
dimensions[] |
รายการมิติข้อมูลของรายงาน ชุดค่าผสมของมิติข้อมูลเหล่านี้จะเป็นตัวกำหนดแถวของรายงาน หากไม่ได้ระบุมิติข้อมูล รายงานจะแสดงเมตริกที่ขอแถวเดียวสําหรับทั้งบัญชี |
metrics[] |
รายการเมตริกของรายงาน รายงานต้องระบุเมตริกอย่างน้อยหนึ่งรายการ |
languageCode |
ภาษาที่ใช้สำหรับข้อความที่แปลแล้ว เช่น ค่ามิติข้อมูลที่เกี่ยวข้องบางค่า โดยแท็กภาษาจะกำหนดไว้ใน IETF BCP47 ค่าเริ่มต้นจะเป็น "en-US" หากไม่ระบุหรือไม่ถูกต้อง |
มิติข้อมูล
มิติข้อมูลของรายงานแคมเปญ
Enum | |
---|---|
DIMENSION_UNSPECIFIED |
ค่าเริ่มต้นของมิติข้อมูลที่ไม่ได้ระบุ โปรดอย่าใช้ |
DATE |
วันที่ในรูปแบบ ปปปปดดวว (เช่น "20210701") |
CAMPAIGN_ID |
รหัสที่ไม่ซ้ำกันของแคมเปญ เช่น "123456789" ซึ่งสอดคล้องกับรหัสแคมเปญจาก API รายการแคมเปญ |
CAMPAIGN_NAME |
ชื่อแคมเปญ |
AD_ID |
รหัสที่ไม่ซ้ำกันของโฆษณา เช่น "123456789" |
AD_NAME |
ชื่อโฆษณา ซึ่งอาจซ้ำกัน |
PLACEMENT_ID |
รหัสที่ไม่ซ้ำกันเฉพาะผู้ให้บริการของแอปที่แสดงโฆษณา เช่น com.goog.bar สำหรับ Android และ 123456789 สำหรับแอป iOS |
PLACEMENT_NAME |
ชื่อของแอปที่มีการวางโฆษณา |
PLACEMENT_PLATFORM |
แพลตฟอร์มของแอปที่ลงโฆษณา |
COUNTRY |
ชื่อของประเทศเป้าหมาย |
FORMAT |
รูปแบบของหน่วยโฆษณา (เช่น "แบนเนอร์" "เนทีฟ") ซึ่งเป็นมิติข้อมูลการแสดงโฆษณา |
เมตริก
เมตริกของรายงานแคมเปญ
Enum | |
---|---|
METRIC_UNSPECIFIED |
ค่าเริ่มต้นสำหรับช่องที่ไม่มีการตั้งค่า โปรดอย่าใช้ |
IMPRESSIONS |
จำนวนครั้งที่โฆษณาแสดงต่อผู้ใช้ |
CLICKS |
จำนวนครั้งที่ผู้ใช้คลิกโฆษณา |
CLICK_THROUGH_RATE |
จำนวนคลิกที่โฆษณาได้รับหารด้วยจำนวนครั้งที่โฆษณาแสดง |
INSTALLS |
จำนวนครั้งที่มีการดาวน์โหลดแอปไปยังอุปกรณ์ |
ESTIMATED_COST |
ค่าใช้จ่ายโดยประมาณในการแสดงโฆษณาแคมเปญแทนโฆษณาที่สร้างรายได้ สกุลเงินที่ใช้คือสกุลเงินในรายงานของแคมเปญ |
AVERAGE_CPI |
ต้นทุนต่อการติดตั้งแอปหนึ่งครั้งโดยเฉลี่ย หมายถึงจํานวนเงินเฉลี่ยที่ใช้ไปเพื่อให้ได้ผู้ใช้ใหม่ สกุลเงินที่ใช้คือสกุลเงินในรายงานของแคมเปญ |
INTERACTIONS |
จำนวนครั้งที่ผู้ใช้โต้ตอบกับโฆษณาได้ ซึ่งประกอบด้วยการคลิกและการมีส่วนร่วม |