- คำขอ HTTP
- พารามิเตอร์เส้นทาง
- เนื้อความของคำขอ
- เนื้อหาการตอบกลับ
- ขอบเขตการให้สิทธิ์
- MediationReportSpec
- มิติข้อมูล
- เมตริก
- DimensionFilter
- SortCondition
- ตัวอย่าง
- ลองใช้งาน
สร้างรายงานสื่อกลาง AdMob ตามข้อกำหนดของรายงานที่ให้ไว้ แสดงผลลัพธ์ของ RPC สตรีมมิงฝั่งเซิร์ฟเวอร์ ผลลัพธ์จะแสดงตามลำดับคำตอบ
คำขอ HTTP
POST https://admob.googleapis.com/v1beta/{parent=accounts/*}/mediationReport:generate
URL ใช้ไวยากรณ์การแปลง gRPC
พารามิเตอร์เส้นทาง
พารามิเตอร์ | |
---|---|
parent |
ชื่อทรัพยากรของบัญชีที่จะใช้สร้างรายงาน ตัวอย่าง: accounts/pub-9876543210987654 |
เนื้อหาของคำขอ
เนื้อหาของคำขอมีข้อมูลซึ่งมีโครงสร้างต่อไปนี้
การแสดง JSON |
---|
{
"reportSpec": {
object ( |
ช่อง | |
---|---|
reportSpec |
ข้อกำหนดรายงานเครือข่าย |
เนื้อหาการตอบกลับ
การตอบกลับสตรีมมิงสำหรับรายงานสื่อกลาง AdMob โดยที่การตอบกลับในข้อแรกมีส่วนหัวของรายงาน ตามด้วยแถวของการตอบกลับ และสุดท้ายจะมีส่วนท้ายเป็นข้อความการตอบกลับล่าสุด
เช่น
[{
"header": {
"dateRange": {
"startDate": {"year": 2018, "month": 9, "day": 1},
"endDate": {"year": 2018, "month": 9, "day": 1}
},
"localizationSettings": {
"currencyCode": "USD",
"languageCode": "en-US"
}
}
},
{
"row": {
"dimensionValues": {
"DATE": {"value": "20180918"},
"APP": {
"value": "ca-app-pub-8123415297019784~1001342552",
"displayLabel": "My app name!"
}
},
"metricValues": {
"ESTIMATED_EARNINGS": {"decimal_value": "1324746"}
}
}
},
{
"footer": {"matchingRowCount": 1}
}]
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
การแสดง JSON |
---|
{ // Union field |
ช่อง | |
---|---|
ฟิลด์สหภาพ payload ข้อความตอบกลับแต่ละรายการของสตรีมจะมีเพย์โหลด 1 ประเภท payload ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
header |
การตั้งค่าการสร้างรายงานที่อธิบายเนื้อหาของรายงาน เช่น ช่วงวันที่ของรายงานและการตั้งค่าการแปลภาษา |
row |
ข้อมูลรายงานจริง |
footer |
ข้อมูลเพิ่มเติมเกี่ยวกับรายงานที่สร้างขึ้น เช่น คําเตือนเกี่ยวกับข้อมูล |
ขอบเขตการให้สิทธิ์
ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้
https://www.googleapis.com/auth/admob.readonly
https://www.googleapis.com/auth/admob.report
โปรดดูข้อมูลเพิ่มเติมที่ภาพรวมของ OAuth 2.0
MediationReportSpec
ข้อกำหนดในการสร้างรายงานสื่อกลาง AdMob ตัวอย่างเช่น ข้อกำหนดในการรับ eCPM ที่พบโดยแบ่งตามแหล่งที่มาของโฆษณาและแอปสำหรับประเทศ "สหรัฐอเมริกา" และ "CN" อาจมีลักษณะเหมือนตัวอย่างต่อไปนี้
{
"dateRange": {
"startDate": {"year": 2021, "month": 9, "day": 1},
"endDate": {"year": 2021, "month": 9, "day": 30}
},
"dimensions": ["AD_SOURCE", "APP", "COUNTRY"],
"metrics": ["OBSERVED_ECPM"],
"dimensionFilters": [
{
"dimension": "COUNTRY",
"matchesAny": {"values": [{"value": "US", "value": "CN"}]}
}
],
"sortConditions": [
{"dimension":"APP", order: "ASCENDING"}
],
"localizationSettings": {
"currencyCode": "USD",
"languageCode": "en-US"
}
}
เพื่อความเข้าใจที่ดียิ่งขึ้น คุณสามารถใช้ข้อกำหนดก่อนหน้าอย่างเช่น SQL เทียมต่อไปนี้
SELECT AD_SOURCE, APP, COUNTRY, OBSERVED_ECPM
FROM MEDIATION_REPORT
WHERE DATE >= '2021-09-01' AND DATE <= '2021-09-30'
AND COUNTRY IN ('US', 'CN')
GROUP BY AD_SOURCE, APP, COUNTRY
ORDER BY APP ASC;
การแสดง JSON |
---|
{ "dateRange": { object ( |
ช่อง | |
---|---|
dateRange |
ช่วงวันที่ที่สร้างรายงาน |
dimensions[] |
รายการมิติข้อมูลของรายงาน ชุดค่าผสมของมิติข้อมูลเหล่านี้จะเป็นตัวกำหนดแถวของรายงาน หากไม่ได้ระบุมิติข้อมูล รายงานจะแสดงแถวของเมตริกที่ขอสําหรับทั้งบัญชี |
metrics[] |
รายการเมตริกของรายงาน รายงานต้องระบุเมตริกอย่างน้อยหนึ่งรายการ |
dimensionFilters[] |
อธิบายแถวของรายงานที่จะจับคู่ตามค่ามิติข้อมูล |
sortConditions[] |
อธิบายการจัดเรียงแถวของรายงาน ลําดับของเงื่อนไขในรายการจะกําหนดลําดับความสําคัญของเงื่อนไข ยิ่งเงื่อนไขอยู่ก่อนหน้า เงื่อนไขจะมีความสำคัญสูงกว่า หากไม่ได้ระบุเงื่อนไขการจัดเรียงไว้ จะไม่มีการกำหนดลำดับแถว |
localizationSettings |
การตั้งค่าการแปลของรายงาน |
maxReportRows |
จำนวนแถวข้อมูลรายงานสูงสุดที่จะแสดง หากไม่ได้ตั้งค่า API จะแสดงผลแถวมากที่สุดเท่าที่จะเป็นไปได้ สูงสุด 100,000 รายการ ค่าที่ยอมรับคือ 1-100000 ค่าที่มากกว่า 100000 จะแสดงผลข้อผิดพลาด |
timeZone |
เขตเวลาของรายงาน ยอมรับค่าชื่อ IANA TZ เช่น "America/Los_Angeles" หากไม่ได้กำหนดเขตเวลา ค่าเริ่มต้นของบัญชีจะมีผล ตรวจสอบค่าเริ่มต้นตามการดำเนินการรับบัญชี คำเตือน: ค่า "America/Los_Angeles" เป็นค่าเดียวที่รองรับในขณะนี้ |
มิติข้อมูล
มิติข้อมูลของรายงานสื่อกลาง มิติข้อมูลคือแอตทริบิวต์ข้อมูลเพื่อแสดงรายละเอียดหรือปรับแต่งการวัดเชิงปริมาณ (เมตริก) ตามแอตทริบิวต์บางรายการ เช่น รูปแบบโฆษณาหรือแพลตฟอร์มที่ใช้ดูโฆษณา
Enum | |
---|---|
DIMENSION_UNSPECIFIED |
ค่าเริ่มต้นสำหรับช่องที่ยังไม่ได้ตั้งค่า โปรดอย่าใช้ |
DATE |
วันที่ในรูปแบบ ปปปปดดวว (เช่น "20210701") คำขอสามารถระบุมิติข้อมูลได้ไม่เกิน 1 รายการ |
MONTH |
เดือนในรูปแบบ ปปปปดด (เช่น "202107") คำขอสามารถระบุมิติข้อมูลได้ไม่เกิน 1 รายการ |
WEEK |
วันที่ของวันแรกของสัปดาห์ในรูปแบบ ปปปปดดวว (เช่น "20210701") คำขอสามารถระบุมิติข้อมูลได้ไม่เกิน 1 รายการ |
AD_SOURCE |
รหัสที่ไม่ซ้ำกันของแหล่งที่มาของโฆษณา (เช่น "5450213213286189855" และ "เครือข่าย AdMob" เป็นค่าป้ายกำกับ) |
AD_SOURCE_INSTANCE |
รหัสที่ไม่ซ้ำกันของอินสแตนซ์แหล่งที่มาของโฆษณา (เช่น "ca-app-pub-1234:asi:5678" และ "AdMob (ค่าเริ่มต้น)" เป็นค่าป้ายกำกับ) |
AD_UNIT |
รหัสที่ไม่ซ้ำกันของหน่วยโฆษณา (เช่น "ca-app-pub-1234/8790") หากระบุมิติข้อมูล AD_UNIT ไว้ ระบบจะรวม APP โดยอัตโนมัติ |
APP |
รหัสที่ไม่ซ้ำกันของแอปพลิเคชันบนอุปกรณ์เคลื่อนที่ (เช่น "ca-app-pub-1234~1234") |
MEDIATION_GROUP |
รหัสที่ไม่ซ้ำกันของกลุ่มสื่อกลาง (เช่น "ca-app-pub-1234:mg:1234" และ "AdMob (ค่าเริ่มต้น)" เป็นค่าป้ายกํากับ) |
COUNTRY |
รหัสประเทศ CLDR ของสถานที่ที่มีการดู/การคลิกโฆษณาเกิดขึ้น (เช่น "US" หรือ "FR") นี่คือมิติข้อมูลภูมิศาสตร์ |
FORMAT |
รูปแบบของหน่วยโฆษณา (เช่น "แบนเนอร์" "เนทีฟ") ซึ่งเป็นมิติข้อมูลการแสดงโฆษณา |
PLATFORM |
แพลตฟอร์มระบบปฏิบัติการบนอุปกรณ์เคลื่อนที่ของแอป (เช่น "Android" หรือ "iOS") |
MOBILE_OS_VERSION |
เวอร์ชันของระบบปฏิบัติการบนอุปกรณ์เคลื่อนที่ เช่น "iOS 13.5.1" |
GMA_SDK_VERSION |
เวอร์ชัน GMA SDK เช่น "iOS 7.62.0" |
APP_VERSION_NAME |
สำหรับ Android คุณดูชื่อเวอร์ชันของแอปได้ที่ versionName ใน PackageInfo สำหรับ iOS คุณสามารถดูชื่อเวอร์ชันของแอปได้ใน CFBundleShortVersionString |
SERVING_RESTRICTION |
โหมดที่จำกัดสำหรับการแสดงโฆษณา (เช่น "โฆษณาที่ไม่ได้ปรับตามโปรไฟล์ของผู้ใช้") |
เมตริก
เมตริกของรายงานสื่อกลาง เมตริกคือการวัดเชิงปริมาณที่บ่งชี้ถึงประสิทธิภาพของธุรกิจผู้เผยแพร่โฆษณา โดยระบบจะรวบรวมข้อมูลจากเหตุการณ์โฆษณาแต่ละเหตุการณ์และจัดกลุ่มตามมิติข้อมูลของรายงาน ค่าเมตริกเป็นจำนวนเต็มหรือทศนิยม (โดยไม่ปัดเศษ)
Enum | |
---|---|
METRIC_UNSPECIFIED |
ค่าเริ่มต้นสำหรับช่องที่ยังไม่ได้ตั้งค่า โปรดอย่าใช้ |
AD_REQUESTS |
จำนวนคำขอ ค่านี้เป็นจำนวนเต็ม |
CLICKS |
จำนวนครั้งที่ผู้ใช้คลิกโฆษณา ค่านี้เป็นจำนวนเต็ม |
ESTIMATED_EARNINGS |
รายได้โดยประมาณของผู้เผยแพร่โฆษณา AdMob หน่วยสกุลเงิน (USD, EUR หรืออื่นๆ) ของเมตริกรายได้จะกำหนดโดยการตั้งค่าการแปลสำหรับสกุลเงิน จำนวนในหน่วยไมโคร เช่น $6.50 จึงจะแสดงเป็น 6500000 เรารองรับรายได้โดยประมาณต่อกลุ่มสื่อกลางและระดับอินสแตนซ์ของแหล่งที่มาของโฆษณาย้อนหลังไปจนถึงวันที่ 20 ตุลาคม 2019 รายได้โดยประมาณของบุคคลที่สามจะแสดงเป็น 0 สำหรับวันที่ก่อนวันที่ 20 ตุลาคม 2019 |
IMPRESSIONS |
จำนวนโฆษณาทั้งหมดที่แสดงต่อผู้ใช้ ค่านี้เป็นจำนวนเต็ม |
IMPRESSION_CTR |
อัตราส่วนของจำนวนคลิกต่อการแสดงผล ค่านี้คือค่าทศนิยมของความแม่นยําแบบ 2 เท่า (โดยประมาณ) |
MATCHED_REQUESTS |
จำนวนครั้งที่โฆษณาส่งกลับตามคำขอ ค่านี้เป็นจำนวนเต็ม |
MATCH_RATE |
อัตราส่วนของคำขอโฆษณาที่ตรงกันต่อคำขอโฆษณาทั้งหมด ค่านี้คือค่าทศนิยมของความแม่นยําแบบ 2 เท่า (โดยประมาณ) |
OBSERVED_ECPM |
eCPM เฉลี่ยโดยประมาณของเครือข่ายโฆษณาบุคคลที่สาม หน่วยสกุลเงิน (USD, EUR หรืออื่นๆ) ของเมตริกรายได้จะกำหนดโดยการตั้งค่าการแปลสำหรับสกุลเงิน จำนวนในหน่วยไมโคร เช่น $2.30 จะแสดงเป็น 2300000 เรารองรับ eCPM เฉลี่ยโดยประมาณต่อกลุ่มสื่อกลางและระดับอินสแตนซ์ของแหล่งที่มาของโฆษณาย้อนหลังไปจนถึงวันที่ 20 ตุลาคม 2019 eCPM เฉลี่ยโดยประมาณของบุคคลที่สามจะแสดงค่าเป็น 0 สำหรับวันที่ก่อนวันที่ 20 ตุลาคม 2019 |
DimensionFilter
อธิบายแถวของรายงานที่จะจับคู่ตามค่ามิติข้อมูล
การแสดง JSON |
---|
{ "dimension": enum ( |
ช่อง | |
---|---|
dimension |
ใช้เกณฑ์ของตัวกรองกับมิติข้อมูลที่ระบุ |
ฟิลด์สหภาพ operator โอเปอเรเตอร์ตัวกรองที่จะใช้ operator ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
matchesAny |
จับคู่แถวหากค่าของมิติข้อมูลที่ระบุอยู่ในค่าใดค่าหนึ่งที่ระบุในเงื่อนไขนี้ |
SortCondition
ทิศทางการจัดเรียงที่จะใช้กับมิติข้อมูลหรือเมตริก
การแสดง JSON |
---|
{ "order": enum ( |
ช่อง | |
---|---|
order |
ลำดับการจัดเรียงของมิติข้อมูลหรือเมตริก |
ฟิลด์สหภาพ sort_on ระบุค่าที่จะจัดเรียง sort_on ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
dimension |
จัดเรียงตามมิติข้อมูลที่ระบุ |
metric |
จัดเรียงตามเมตริกที่ระบุ |