- एचटीटीपी अनुरोध
- पाथ पैरामीटर
- अनुरोध का मुख्य हिस्सा
- जवाब का मुख्य हिस्सा
- अनुमति के दायरे
- MediationReportSpec
- डाइमेंशन
- मेट्रिक
- DimensionFilter
- SortCondition
- उदाहरण
- इसे आज़माएं!
दी गई रिपोर्ट स्पेसिफ़िकेशन के आधार पर, AdMob मीडिएशन (अलग-अलग नेटवर्क से विज्ञापन दिखाना) रिपोर्ट जनरेट करता है. सर्वर-साइड स्ट्रीमिंग RPC का नतीजा दिखाता है. इसका नतीजा, रिस्पॉन्स के हिसाब से दिखाया जाता है.
एचटीटीपी अनुरोध
POST https://admob.googleapis.com/v1/{parent=accounts/*}/mediationReport:generate
यह यूआरएल 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 . स्ट्रीम के जवाब वाले हर मैसेज में एक तरह का पेलोड होता है. payload इनमें से सिर्फ़ एक हो सकता है: |
|
header |
रिपोर्ट जनरेट करने की सेटिंग, जिनसे रिपोर्ट के कॉन्टेंट के बारे में जानकारी मिलती है. जैसे, रिपोर्ट की तारीख की सीमा और स्थानीय भाषा के मुताबिक बनाने की सेटिंग. |
row |
रिपोर्ट का असल डेटा. |
footer |
जनरेट की गई रिपोर्ट के बारे में अतिरिक्त जानकारी, जैसे कि डेटा के बारे में चेतावनियां. |
अनुमति के दायरे
इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:
https://www.googleapis.com/auth/admob.readonly
https://www.googleapis.com/auth/admob.report
ज़्यादा जानकारी के लिए, OAuth 2.0 की खास जानकारी देखें.
MediationReportSpec
AdMob मीडिएशन (अलग-अलग नेटवर्क से विज्ञापन दिखाना) रिपोर्ट जनरेट करने के लिए ज़रूरी शर्तें. उदाहरण के लिए, 'US' के लिए, विज्ञापन सोर्स और ऐप्लिकेशन के हिसाब से ईसीपीएम का पता लगाने के लिए स्पेसिफ़िकेशन और '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"
}
}
बेहतर तरीके से समझने के लिए, पिछले स्पेसिफ़िकेशन के साथ, यहां दिए गए pseudo 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 |
रिपोर्ट डेटा की पंक्तियों की ज़्यादा से ज़्यादा संख्या, जितनी दिखाई जा सकती है. अगर वैल्यू सेट नहीं की जाती है, तो एपीआई ज़्यादा से ज़्यादा 1,00,000 लाइनें दिखाता है. स्वीकार की जाने वाली वैल्यू 1 से 10, 000 के बीच है. अगर वैल्यू 10,0000 से ज़्यादा हैं, तो गड़बड़ी का मैसेज दिखता है. |
timeZone |
रिपोर्ट का टाइम ज़ोन. IANA TZ के नाम की वैल्यू स्वीकार की जाती हैं, जैसे कि "America/Los_Angeles." अगर कोई टाइम ज़ोन तय नहीं किया गया है, तो खाते की डिफ़ॉल्ट सेटिंग लागू हो जाती है. 'खाते पाएं' कार्रवाई के हिसाब से डिफ़ॉल्ट वैल्यू देखें. चेतावनी: "America/Los_Angeles" फ़िलहाल, यह वैल्यू ही इस्तेमाल की जा सकती है. |
डाइमेंशन
मीडिएशन रिपोर्ट के डाइमेंशन. डाइमेंशन, डेटा एट्रिब्यूट होते हैं जिनका इस्तेमाल कुछ एट्रिब्यूट के आधार पर, क्वांटिटेटिव मेज़रमेंट (मेट्रिक) को बांटा या बेहतर किया जाता है. जैसे, विज्ञापन फ़ॉर्मैट या जिस प्लैटफ़ॉर्म पर विज्ञापन देखा गया था.
Enums | |
---|---|
DIMENSION_UNSPECIFIED |
सेट नहीं किए गए फ़ील्ड के लिए डिफ़ॉल्ट वैल्यू. इस्तेमाल न करें. |
DATE |
YYYYMMDD फ़ॉर्मैट में तारीख (उदाहरण के लिए, "20210701"). अनुरोध में सिर्फ़ एक बार वाले डाइमेंशन के बारे में बताया जा सकता है. |
MONTH |
YYYYMM फ़ॉर्मैट में कोई महीना (उदाहरण के लिए, "202107"). अनुरोध में सिर्फ़ एक बार वाले डाइमेंशन के बारे में बताया जा सकता है. |
WEEK |
YYYYMMDD फ़ॉर्मैट में हफ़्ते के पहले दिन की तारीख (उदाहरण के लिए, "20210701"). अनुरोध में सिर्फ़ एक बार वाले डाइमेंशन के बारे में बताया जा सकता है. |
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 के लिए ऐप्लिकेशन वर्शन का नाम, PackageInfo के versionName में देखा जा सकता है. iOS के लिए, ऐप्लिकेशन वर्शन का नाम CFBundleShortVersionString में मिल सकता है. |
SERVING_RESTRICTION |
विज्ञापन दिखाने पर पाबंदी मोड (उदाहरण के लिए, "लोगों के हिसाब से न दिखाए जाने वाले विज्ञापन"). |
मेट्रिक
मीडिएशन रिपोर्ट की मेट्रिक. मेट्रिक को गिना जा सकता है. इससे पता चलता है कि पब्लिशर का कारोबार कैसा परफ़ॉर्म कर रहा है. इन्हें अलग-अलग विज्ञापन इवेंट से एग्रीगेट किया जाता है और उन्हें रिपोर्ट के डाइमेंशन के हिसाब से ग्रुप में बांटा जाता है. मेट्रिक की वैल्यू पूर्णांक या दशमलव (बिना दशमलव वाली) होती है.
Enums | |
---|---|
METRIC_UNSPECIFIED |
सेट नहीं किए गए फ़ील्ड के लिए डिफ़ॉल्ट वैल्यू. इस्तेमाल न करें. |
AD_REQUESTS |
अनुरोधों की संख्या. वैल्यू एक पूर्णांक होती है. |
CLICKS |
किसी उपयोगकर्ता के किसी विज्ञापन पर क्लिक करने की संख्या. वैल्यू एक पूर्णांक होती है. |
ESTIMATED_EARNINGS |
AdMob प्रकाशक की अनुमानित आय. आय वाली मेट्रिक की मुद्रा की यूनिट (डॉलर, यूरो या अन्य) मुद्रा को स्थानीय भाषा के अनुसार सेट की जाती है. राशि माइक्रो में है. उदाहरण के लिए, $6.50 को 6500000 के रूप में दिखाया जाएगा. हर मीडिएशन ग्रुप और हर विज्ञापन स्रोत के इंस्टेंस लेवल पर अनुमानित आमदनी 20 अक्टूबर, 2019 से काम कर रही है. तीसरे पक्ष की अनुमानित आमदनी 20 अक्टूबर, 2019 से पहले की तारीखों के लिए 0 दिखेगी. |
IMPRESSIONS |
उपयोगकर्ताओं को दिखाए गए विज्ञापनों की कुल संख्या. वैल्यू एक पूर्णांक होती है. |
IMPRESSION_CTR |
इंप्रेशन के मुकाबले क्लिक का अनुपात. वैल्यू, डबल सटीक (अनुमानित) दशमलव वाली वैल्यू है. |
MATCHED_REQUESTS |
किसी अनुरोध के जवाब में विज्ञापन दिखाए जाने की संख्या. वैल्यू एक पूर्णांक होती है. |
MATCH_RATE |
कुल विज्ञापन अनुरोधों में मेल खाने वाले विज्ञापन अनुरोधों का अनुपात. वैल्यू, डबल सटीक (अनुमानित) दशमलव वाली वैल्यू है. |
OBSERVED_ECPM |
तीसरे पक्ष की विज्ञापन नेटवर्क कंपनी का अनुमानित औसत eCPM. आय वाली मेट्रिक की मुद्रा की यूनिट (डॉलर, यूरो या अन्य) मुद्रा को स्थानीय भाषा के अनुसार सेट की जाती है. राशि माइक्रो में है. उदाहरण के लिए, $2.30 को 2300000 के रूप में दिखाया जाएगा. हर मीडिएशन ग्रुप और विज्ञापन स्रोत के इंस्टेंस लेवल के लिए अनुमानित औसत eCPM, 20 अक्टूबर, 2019 से काम कर रहा है. तीसरे पक्ष की अनुमानित औसत eCPM, 20 अक्टूबर, 2019 से पहले की तारीखों के लिए 0 दिखेगा. |
DimensionFilter
इससे रिपोर्ट की उन लाइनों का पता चलता है जिन्हें उनकी डाइमेंशन वैल्यू के आधार पर मैच करना है.
JSON के काेड में दिखाना |
---|
{ "dimension": enum ( |
फ़ील्ड | |
---|---|
dimension |
बताए गए डाइमेंशन पर फ़िल्टर करने की शर्त लागू करता है. |
यूनियन फ़ील्ड operator . फ़िल्टर ऑपरेटर लागू किया जाना है. operator इनमें से सिर्फ़ एक हो सकता है: |
|
matchesAny |
अगर किसी डाइमेंशन के लिए उसकी वैल्यू, इस शर्त में बताई गई वैल्यू में से किसी एक में है, तो लाइन से मैच होता है. |
SortCondition
किसी डाइमेंशन या मेट्रिक पर लागू करने के लिए, क्रम से लगाने की दिशा.
JSON के काेड में दिखाना |
---|
{ "order": enum ( |
फ़ील्ड | |
---|---|
order |
डाइमेंशन या मेट्रिक का क्रम तय करना. |
यूनियन फ़ील्ड sort_on . यह पहचान करता है कि किन वैल्यू को क्रम से लगाना है. sort_on इनमें से सिर्फ़ एक हो सकता है: |
|
dimension |
चुने गए डाइमेंशन के हिसाब से क्रम से लगाएं. |
metric |
चुनी गई मेट्रिक के हिसाब से क्रम में लगाएं. |