Method: accounts.mediationReport.generate

यह सुविधा, दी गई रिपोर्ट की खास बातों के आधार पर, AdMob मीडिएशन (अलग-अलग नेटवर्क से विज्ञापन दिखाना) रिपोर्ट जनरेट करती है. सर्वर साइड स्ट्रीमिंग RPC का नतीजा दिखाता है. नतीजा, जवाबों के क्रम में दिया जाता है.

एचटीटीपी अनुरोध

POST https://admob.googleapis.com/v1/{parent=accounts/*}/mediationReport:generate

यह यूआरएल gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

पाथ के पैरामीटर

पैरामीटर
parent

string

खाते के लिए संसाधन का नाम, जिसके लिए रिपोर्ट जनरेट करनी है. उदाहरण के लिए: accounts/pub-9876543210987654

अनुरोध का मुख्य भाग

अनुरोध के मुख्य हिस्से में, इस तरह का डेटा शामिल होता है:

जेएसओएन के काेड में दिखाना 
{
  "reportSpec": {
    object (MediationReportSpec)
  }
}
फ़ील्ड
reportSpec

object (MediationReportSpec)

नेटवर्क रिपोर्ट की खास बातें.

जवाब का मुख्य भाग

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}
}]

अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.

जेएसओएन के काेड में दिखाना 
{

  // Union field payload can be only one of the following:
  "header": {
    object (ReportHeader)
  },
  "row": {
    object (ReportRow)
  },
  "footer": {
    object (ReportFooter)
  }
  // End of list of possible types for union field payload.
}
फ़ील्ड
यूनियन फ़ील्ड payload. स्ट्रीम के जवाब के हर मैसेज में एक तरह का पेलोड होता है. payload इनमें से सिर्फ़ एक हो सकती है:
header

object (ReportHeader)

रिपोर्ट जनरेट करने की सेटिंग, जिनसे रिपोर्ट के कॉन्टेंट के बारे में जानकारी मिलती है. जैसे, रिपोर्ट की तारीख की सीमा और स्थानीय भाषा के हिसाब से बनाने की सेटिंग.
row

object (ReportRow)

रिपोर्ट का असल डेटा.
footer

object (ReportFooter)

जनरेट की गई रिपोर्ट के बारे में ज़्यादा जानकारी, जैसे कि डेटा के बारे में चेतावनियां.

अनुमति के दायरे

इनमें से किसी एक OAuth दायरों की ज़रूरत होती है:

  • https://www.googleapis.com/auth/admob.readonly
  • https://www.googleapis.com/auth/admob.report

ज़्यादा जानकारी के लिए, OAuth 2.0 की खास जानकारी देखें.

MediationReportSpec

AdMob मीडिएशन (अलग-अलग नेटवर्क से विज्ञापन दिखाना) रिपोर्ट जनरेट करने से जुड़ी खास जानकारी. उदाहरण के लिए, 'अमेरिका' और 'CN' देशों के लिए, विज्ञापन स्रोत और ऐप्लिकेशन से बांटे गए ECPM की खास जानकारी पाने के निर्देश इस उदाहरण में दिए गए हैं:

{
  "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"
  }
}

बेहतर समझ के लिए, पहले दिए गए स्पेसिफ़िकेशन को नीचे दिए गए सूडो एसक्यूएल की तरह ही माना जा सकता है:

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;
जेएसओएन के काेड में दिखाना 
{
  "dateRange": {
    object (DateRange)
  },
  "dimensions": [
    enum (Dimension)
  ],
  "metrics": [
    enum (Metric)
  ],
  "dimensionFilters": [
    {
      object (DimensionFilter)
    }
  ],
  "sortConditions": [
    {
      object (SortCondition)
    }
  ],
  "localizationSettings": {
    object (LocalizationSettings)
  },
  "maxReportRows": integer,
  "timeZone": string
}
फ़ील्ड
dateRange

object (DateRange)

तारीख की वह सीमा जिसके लिए रिपोर्ट जनरेट की जाती है.
dimensions[]

enum (Dimension)

रिपोर्ट के डाइमेंशन की सूची. इन डाइमेंशन के वैल्यू कॉम्बिनेशन से, रिपोर्ट की लाइन तय होती है. अगर कोई डाइमेंशन नहीं चुना गया है, तो रिपोर्ट, अनुरोध की गई मेट्रिक की एक पंक्ति पूरे खाते के लिए दिखाती है.
metrics[]

enum (Metric)

रिपोर्ट की मेट्रिक की सूची. किसी रिपोर्ट में कम से कम एक मेट्रिक मौजूद होनी चाहिए.
dimensionFilters[]

object (DimensionFilter)

इससे यह पता चलता है कि डाइमेंशन वैल्यू के आधार पर, रिपोर्ट की किन लाइनों को मैच करना है.
sortConditions[]

object (SortCondition)

रिपोर्ट की पंक्तियों को क्रम से लगाने की जानकारी देता है. सूची में शर्त का क्रम इसकी प्राथमिकता तय करता है; स्थिति जितनी पहले होगी, उसकी प्राथमिकता उतनी ही ज़्यादा होगी. अगर क्रम से जुड़ी कोई शर्त तय नहीं की गई है, तो लाइन के क्रम की जानकारी नहीं दी जाएगी.
localizationSettings

object (LocalizationSettings)

रिपोर्ट की स्थानीय भाषा के अनुसार सेटिंग.
maxReportRows

integer

दिखाई जाने वाली रिपोर्ट की डेटा लाइनों की ज़्यादा से ज़्यादा संख्या. अगर वैल्यू सेट नहीं की जाती है, तो एपीआई ज़्यादा से ज़्यादा 1,00,000 लाइनें दिखाता है. स्वीकार की जाने वाली वैल्यू 1 से 1,00,000 तक हो सकती हैं. अगर वैल्यू 10,0000 से ज़्यादा है, तो गड़बड़ी का मैसेज दिखता है.
timeZone

string

रिपोर्ट का टाइम ज़ोन. 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 पब्लिशर की अनुमानित आमदनी. मुद्रा की मेट्रिक की मुद्रा की यूनिट (USD, EUR या अन्य) मुद्रा के लिए, स्थानीय भाषा के हिसाब से बनाई गई सेटिंग से तय होती है. यह रकम माइक्रो में होती है. उदाहरण के लिए, 6.50 डॉलर को 65,00,000 के तौर पर दिखाया जाएगा.

हर मीडिएशन ग्रुप और विज्ञापन स्रोत के हर इंस्टेंस लेवल पर होने वाली अनुमानित आमदनी, 20 अक्टूबर, 2019 तक की है. तीसरे पक्ष की अनुमानित आमदनी, 20 अक्टूबर, 2019 से पहले की तारीखों के लिए 0 दिखेगी.
IMPRESSIONS उपयोगकर्ताओं को दिखाए गए विज्ञापनों की कुल संख्या. मान एक पूर्णांक होता है.
IMPRESSION_CTR इंप्रेशन के मुकाबले क्लिक का अनुपात. यह मान दोगुने सटीक (अनुमानित) दशमलव मान है.
MATCHED_REQUESTS किसी अनुरोध के जवाब में विज्ञापन दिखाए जाने की संख्या. मान एक पूर्णांक होता है.
MATCH_RATE कुल विज्ञापन अनुरोधों के मुकाबले, मेल खाने वाले विज्ञापन अनुरोधों का अनुपात. यह मान दोगुने सटीक (अनुमानित) दशमलव मान है.
OBSERVED_ECPM

तीसरे पक्ष की विज्ञापन नेटवर्क कंपनी का अनुमानित औसत eCPM. मुद्रा की मेट्रिक की मुद्रा की यूनिट (USD, EUR या अन्य) मुद्रा के लिए, स्थानीय भाषा के हिसाब से बनाई गई सेटिंग से तय होती है. यह रकम माइक्रो में होती है. उदाहरण के लिए, 2.30 डॉलर को 23,00,000 के तौर पर दिखाया जाएगा.

हर मीडिएशन ग्रुप और हर विज्ञापन स्रोत के इंस्टेंस लेवल के हिसाब से, अनुमानित औसत eCPM 20 अक्टूबर, 2019 से इस्तेमाल किया जा सकता है. तीसरे पक्ष का अनुमानित औसत eCPM, 20 अक्टूबर, 2019 से पहले की तारीखों के लिए 0 दिखाएगा.

DimensionFilter

इससे यह पता चलता है कि डाइमेंशन वैल्यू के आधार पर, रिपोर्ट की किन लाइनों को मैच करना है.

जेएसओएन के काेड में दिखाना 
{
  "dimension": enum (Dimension),

  // Union field operator can be only one of the following:
  "matchesAny": {
    object (StringList)
  }
  // End of list of possible types for union field operator.
}
फ़ील्ड
dimension

enum (Dimension)

किसी डाइमेंशन पर फ़िल्टर करने की शर्त लागू करता है.
यूनियन फ़ील्ड operator. लागू करने के लिए फ़िल्टर ऑपरेटर. operator इनमें से सिर्फ़ एक हो सकती है:
matchesAny

object (StringList)

पंक्ति से तब मैच होता है, जब किसी खास डाइमेंशन के लिए उसकी वैल्यू, इस शर्त में दी गई वैल्यू में से किसी एक में हो.

SortCondition

डाइमेंशन या मेट्रिक पर लागू करने के लिए, क्रम से लगाने की दिशा.

जेएसओएन के काेड में दिखाना 
{
  "order": enum (SortOrder),

  // Union field sort_on can be only one of the following:
  "dimension": enum (Dimension),
  "metric": enum (Metric)
  // End of list of possible types for union field sort_on.
}
फ़ील्ड
order

enum (SortOrder)

डाइमेंशन या मेट्रिक को क्रम से लगाने के लिए.
यूनियन फ़ील्ड sort_on. इससे पता चलता है कि किन वैल्यू को क्रम से लगाना है. sort_on इनमें से सिर्फ़ एक हो सकती है:
dimension

enum (Dimension)

बताए गए डाइमेंशन के हिसाब से क्रम में लगाएं.
metric

enum (Metric)

चुने गए मेट्रिक के हिसाब से क्रम में लगाएं.