Method: accounts.campaignReport.generate

दी गई जानकारी के आधार पर, कैंपेन रिपोर्ट जनरेट करता है.

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

POST https://admob.googleapis.com/v1beta/{parent=accounts/*}/campaignReport:generate

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

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

पैरामीटर
parent

string

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

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

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

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

object (CampaignReportSpec)

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

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

Campaign Report API रिस्पॉन्स.

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

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

object (ReportRow)

चुने गए पब्लिशर से मिला कैंपेन रिपोर्ट डेटा. एपीआई से ज़्यादा से ज़्यादा 1,00,000 लाइनें दिखाई जाएंगी.

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

इनमें से कोई एक OAuth स्कोप ज़रूरी है:

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

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

CampaignReportSpec

कैंपेन रिपोर्ट जनरेट करने का ब्यौरा. उदाहरण के लिए, CAMPAIGN_ID के ज़रिए निकालने के लिए निकालने के लिए आपको एक उदाहरण दिया गया है.

{
  "dateRange": {
    "startDate": {"year": 2021, "month": 12, "day": 1},
    "endDate": {"year": 2021, "month": 12, "day": 30}
  },
  "dimensions": ["CAMPAIGN_ID"],
  "metrics": ["IMPRESSIONS", "CLICKS"],
}
जेएसओएन के काेड में दिखाना
{
  "dateRange": {
    object (DateRange)
  },
  "dimensions": [
    enum (Dimension)
  ],
  "metrics": [
    enum (Metric)
  ],
  "languageCode": string
}
फ़ील्ड
dateRange

object (DateRange)

तारीख की वह सीमा जिसके लिए रिपोर्ट जनरेट की जाती है. ज़्यादा से ज़्यादा 30 दिन की हो सकती है.

dimensions[]

enum (Dimension)

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

metrics[]

enum (Metric)

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

languageCode

string

किसी भी स्थानीय जगह के अनुसार टेक्स्ट के लिए इस्तेमाल की जाने वाली भाषा, जैसे कि लागू होने वाली कुछ डाइमेंशन वैल्यू. भाषा वाले टैग की जानकारी, आईईटीएफ़ BCP47 में दी गई है. जानकारी न होने या अमान्य होने पर, डिफ़ॉल्ट वैल्यू 'en-US' होती है.

डाइमेंशन

कैंपेन रिपोर्ट के डाइमेंशन.

Enums
DIMENSION_UNSPECIFIED किसी ऐसे डाइमेंशन की डिफ़ॉल्ट वैल्यू जिसके बारे में जानकारी नहीं दी गई है. इस्तेमाल न करें.
DATE YYYYMMDD फ़ॉर्मैट में तारीख (उदाहरण के लिए, "20210701").
CAMPAIGN_ID कैंपेन का यूनीक आईडी, जैसे कि "123456789", जो कैंपेन लिस्ट एपीआई के कैंपेन आईडी से मेल खाता है.
CAMPAIGN_NAME अभियान का नाम.
AD_ID विज्ञापन का यूनीक आईडी, जैसे कि "123456789".
AD_NAME विज्ञापन का नाम, जो यूनीक नहीं भी हो सकता.
PLACEMENT_ID ऐप्लिकेशन का वेंडर का यूनीक आईडी, जहां विज्ञापन दिया गया है. उदाहरण के लिए, Android के लिए com.goog.bar और iOS ऐप्लिकेशन के लिए 123456789.
PLACEMENT_NAME उस ऐप्लिकेशन का नाम जहां विज्ञापन दिखाया गया है.
PLACEMENT_PLATFORM ऐप्लिकेशन का वह प्लैटफ़ॉर्म जहां विज्ञापन दिखाया जाता है.
COUNTRY टारगेट किए गए देश का नाम.
FORMAT विज्ञापन यूनिट का फ़ॉर्मैट (उदाहरण के लिए, "banner", "native"), विज्ञापन डिलीवरी डाइमेंशन.

मेट्रिक

कैंपेन रिपोर्ट की मेट्रिक.

Enums
METRIC_UNSPECIFIED सेट नहीं किए गए फ़ील्ड के लिए डिफ़ॉल्ट वैल्यू. इस्तेमाल न करें.
IMPRESSIONS उपयोगकर्ता को कोई विज्ञापन कितनी बार दिखाया गया.
CLICKS उपयोगकर्ता किसी विज्ञापन पर कितनी बार क्लिक करता है.
CLICK_THROUGH_RATE विज्ञापन को मिलने वाले क्लिक की संख्या को, विज्ञापन दिखाए जाने की संख्या से भाग देने पर मिलने वाली दर.
INSTALLS डिवाइसों पर ऐप्लिकेशन डाउनलोड किए जाने की संख्या.
ESTIMATED_COST कमाई करने वाले विज्ञापन के बजाय कैंपेन विज्ञापन दिखाने की अनुमानित लागत. मुद्रा, कैंपेन की तैयार होने वाली रिपोर्ट की मुद्रा होती है.
AVERAGE_CPI हर इंस्टॉल की औसत लागत. इसका मतलब है, वह औसत रकम जो नया उपयोगकर्ता हासिल करने में खर्च की गई थी. मुद्रा, कैंपेन की तैयार होने वाली रिपोर्ट की मुद्रा होती है.
INTERACTIONS उपयोगकर्ता ने किसी विज्ञापन से कितनी बार इंटरैक्ट किया. इसमें क्लिक और यूज़र ऐक्टिविटी शामिल होती हैं.