Method: accounts.networkReport.generate

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

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

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

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

पाथ पैरामीटर

पैरामीटर
parent

string

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

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

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

JSON के काेड में दिखाना 
{
  "reportSpec": {
    object (NetworkReportSpec)
  }
}
फ़ील्ड
reportSpec

object (NetworkReportSpec)

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

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

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": {"microsValue": 6500000}
    }
  }
},
{
  "footer": {"matchingRowCount": 1}
}]

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

JSON फ़ॉर्मैट में दिखाया गया है 
{

  // 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 Overview देखें.

NetworkReportSpec

AdMob नेटवर्क रिपोर्ट जनरेट करने के लिए ज़रूरी जानकारी. उदाहरण के लिए, सिर्फ़ 'US' और 'CN' देशों के लिए क्लिक और अनुमानित कमाई पाने की खास जानकारी, इस उदाहरण की तरह दिख सकती है:

{
  'dateRange': {
    'startDate': {'year': 2021, 'month': 9, 'day': 1},
    'endDate': {'year': 2021, 'month': 9, 'day': 30}
  },
  'dimensions': ['DATE', 'APP', 'COUNTRY'],
  'metrics': ['CLICKS', 'ESTIMATED_EARNINGS'],
  'dimensionFilters': [
    {
      'dimension': 'COUNTRY',
      'matchesAny': {'values': [{'value': 'US', 'value': 'CN'}]}
    }
  ],
  'sortConditions': [
    {'dimension':'APP', order: 'ASCENDING'},
    {'metric':'CLICKS', order: 'DESCENDING'}
  ],
  'localizationSettings': {
    'currencyCode': 'USD',
    'languageCode': 'en-US'
  }
}

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

SELECT DATE, APP, COUNTRY, CLICKS, ESTIMATED_EARNINGS
FROM NETWORK_REPORT
WHERE DATE >= '2021-09-01' AND DATE <= '2021-09-30'
    AND COUNTRY IN ('US', 'CN')
GROUP BY DATE, APP, COUNTRY
ORDER BY APP ASC, CLICKS DESC;
JSON के काेड में दिखाना 
{
  "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 के बीच की होनी चाहिए. 1,00,000 से बड़ी वैल्यू के लिए, गड़बड़ी का मैसेज दिखता है.
timeZone

string

रिपोर्ट का टाइम ज़ोन. यह IANA TZ के नाम की वैल्यू स्वीकार करता है. जैसे, "America/Los_Angeles." अगर कोई समय क्षेत्र तय नहीं किया गया है, तो खाते का डिफ़ॉल्ट समय क्षेत्र लागू होगा. खाता पाने के ऐक्शन से डिफ़ॉल्ट वैल्यू की जांच करें.

चेतावनी: फ़िलहाल, सिर्फ़ "America/Los_Angeles" वैल्यू का इस्तेमाल किया जा सकता है.

डाइमेंशन

नेटवर्क रिपोर्ट के डाइमेंशन. डाइमेंशन, डेटा एट्रिब्यूट होते हैं. इनकी मदद से, आंकड़ों वाले मेज़रमेंट (मेट्रिक) को कुछ एट्रिब्यूट के हिसाब से बांटा या बेहतर बनाया जा सकता है. जैसे, विज्ञापन फ़ॉर्मैट या वह प्लैटफ़ॉर्म जिस पर कोई विज्ञापन देखा गया था.

Enums
DIMENSION_UNSPECIFIED सेट नहीं किए गए फ़ील्ड के लिए डिफ़ॉल्ट वैल्यू. इस्तेमाल न करें.
DATE YYYYMMDD फ़ॉर्मैट में तारीख (उदाहरण के लिए, "20210701"). अनुरोधों में ज़्यादा से ज़्यादा एक टाइम डाइमेंशन तय किया जा सकता है.
MONTH YYYYMM फ़ॉर्मैट में महीना. उदाहरण के लिए, "202107". अनुरोधों में ज़्यादा से ज़्यादा एक टाइम डाइमेंशन तय किया जा सकता है.
WEEK हफ़्ते के पहले दिन की तारीख, YYYYMMDD फ़ॉर्मैट में (उदाहरण के लिए, "20210701"). अनुरोधों में ज़्यादा से ज़्यादा एक टाइम डाइमेंशन तय किया जा सकता है.
AD_UNIT विज्ञापन यूनिट का यूनीक आईडी. उदाहरण के लिए, "ca-app-pub-1234/1234". अगर AD_UNIT डाइमेंशन तय किया गया है, तो APP अपने-आप शामिल हो जाता है.
APP मोबाइल ऐप्लिकेशन का यूनीक आईडी. उदाहरण के लिए, "ca-app-pub-1234~1234".
AD_TYPE

विज्ञापन का टाइप (उदाहरण के लिए, "टेक्स्ट" या "इमेज"), विज्ञापन डिलीवरी डाइमेंशन.

चेतावनी: यह डाइमेंशन, AD_REQUESTS, MATCH_RATE, और IMPRESSION_RPM मेट्रिक के साथ काम नहीं करता.
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

विज्ञापन अनुरोधों की संख्या. यह वैल्यू एक पूर्णांक है.

चेतावनी: यह मेट्रिक, AD_TYPE डाइमेंशन के साथ काम नहीं करती.
CLICKS किसी उपयोगकर्ता ने किसी विज्ञापन पर कितनी बार क्लिक किया. यह वैल्यू एक पूर्णांक है.
ESTIMATED_EARNINGS AdMob पब्लिशर की अनुमानित आमदनी. कमाई की मेट्रिक की मुद्रा इकाई (USD, EUR या अन्य) को मुद्रा के लिए स्थानीय भाषा की सेटिंग के हिसाब से तय किया जाता है. यह रकम माइक्रो में होती है. उदाहरण के लिए, 6.50 डॉलर को 6500000 के तौर पर दिखाया जाएगा.
IMPRESSIONS उपयोगकर्ताओं को दिखाए गए विज्ञापनों की कुल संख्या. यह वैल्यू एक पूर्णांक है.
IMPRESSION_CTR इंप्रेशन की तुलना में क्लिक का अनुपात. यह वैल्यू, डबल प्रिसिशन (लगभग) वाली दशमलव वैल्यू होती है.
IMPRESSION_RPM

हर हज़ार विज्ञापन इंप्रेशन पर मिलने वाली अनुमानित आय. वैल्यू माइक्रो में दी गई है. उदाहरण के लिए, 103 रुपये को 1030000 के तौर पर दिखाया जाएगा. यह AdMob के यूज़र इंटरफ़ेस (यूआई) में मौजूद ईसीपीएम के बराबर होता है.

चेतावनी: यह मेट्रिक, AD_TYPE डाइमेंशन के साथ काम नहीं करती.
MATCHED_REQUESTS किसी अनुरोध के जवाब में, विज्ञापन कितनी बार दिखाए गए. यह वैल्यू एक पूर्णांक है.
MATCH_RATE

यह कुल विज्ञापन अनुरोधों में से, मैच किए गए विज्ञापन अनुरोधों का अनुपात होता है. यह वैल्यू, डबल प्रिसिशन (लगभग) वाली दशमलव वैल्यू होती है.

चेतावनी: यह मेट्रिक, AD_TYPE डाइमेंशन के साथ काम नहीं करती.
SHOW_RATE यह दिखाए गए विज्ञापनों और दिखाए जा सकने वाले विज्ञापनों का अनुपात होता है. इसे इंप्रेशन / मैच किए गए अनुरोधों के तौर पर तय किया जाता है. यह वैल्यू, डबल प्रिसिशन (लगभग) वाली दशमलव वैल्यू होती है.

DimensionFilter

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

JSON के काेड में दिखाना 
{
  "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

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

JSON के काेड में दिखाना 
{
  "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)

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