Method: accounts.networkReport.generate

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

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

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

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

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

पैरामीटर
parent

string

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

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

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

जेएसओएन के काेड में दिखाना 
{
  "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}
}]

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

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

  // 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 की खास जानकारी देखें.

NetworkReportSpec

AdMob नेटवर्क रिपोर्ट जनरेट करने के लिए खास जानकारी. उदाहरण के लिए, सिर्फ़ 'अमेरिका' और '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;
जेएसओएन के काेड में दिखाना 
{
  "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 से 10,00,000 है. अगर वैल्यू 10,0000 से ज़्यादा है, तो गड़बड़ी का मैसेज दिखता है.
timeZone

string

रिपोर्ट का टाइम ज़ोन. IANA TZ नाम की वैल्यू स्वीकार की जाती है, जैसे कि "अमेरिका/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 विज्ञापन यूनिट का फ़ॉर्मैट (उदाहरण के लिए, "banner", "native"), विज्ञापन डिलीवरी डाइमेंशन.
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 पब्लिशर की अनुमानित आमदनी. कमाई की मेट्रिक की मुद्रा की यूनिट (डॉलर, यूरो या अन्य) स्थानीय भाषा के हिसाब से तय की गई सेटिंग से तय होती है. यह रकम माइक्रो में होती है. उदाहरण के लिए, 6.50 डॉलर को 65,00,000 के तौर पर दिखाया जाएगा.
IMPRESSIONS उपयोगकर्ताओं को दिखाए गए विज्ञापनों की कुल संख्या. मान एक पूर्णांक होता है.
IMPRESSION_CTR इंप्रेशन के मुकाबले क्लिक का अनुपात. यह मान दो बार सटीक (अनुमानित) दशमलव मान है.
IMPRESSION_RPM

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

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

कुल विज्ञापन अनुरोधों के मुकाबले, मेल खाने वाले विज्ञापन अनुरोधों का अनुपात. यह मान दो बार सटीक (अनुमानित) दशमलव मान है.

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

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)

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