AdSense सेवा

AdSense सेवा की मदद से, Google Apps Script में AdSense Management API का इस्तेमाल किया जा सकता है. इस एपीआई की मदद से, AdSense के ग्राहक अपने खाते की संरचना के बारे में जानकारी पा सकते हैं. साथ ही, यह भी जान सकते हैं कि उनके खाते की परफ़ॉर्मेंस कैसी है.

यह एक ऐडवांस सेवा है. इसका इस्तेमाल करने से पहले, इसे चालू करना ज़रूरी है.

संदर्भ

इस सेवा के बारे में ज़्यादा जानकारी पाने के लिए, AdSense Management API के रेफ़रंस से जुड़ा दस्तावेज़ देखें. Apps Script की सभी ऐडवांस सेवाओं की तरह, AdSense सेवा भी सार्वजनिक एपीआई के जैसे ही ऑब्जेक्ट, तरीके, और पैरामीटर का इस्तेमाल करती है. ज़्यादा जानकारी के लिए, यह लेख पढ़ें कि किसी तरीके के सिग्नेचर कैसे तय किए जाते हैं.

समस्याओं की शिकायत करने और अन्य सहायता पाने के लिए, Stack Overflow पर adsense-api टैग का इस्तेमाल करके सवाल पूछें.

नमूना कोड

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

खातों की सूची बनाएं

इस नमूने में, उपयोगकर्ता के लिए उपलब्ध सभी खातों की सूची दी गई है. खातों को रिसॉर्स के नामों के तौर पर बताया गया है. जैसे, accounts/pub-12345. इनका इस्तेमाल, विज्ञापन क्लाइंट की सूची बनाने जैसे अन्य तरीकों में किया जा सकता है. नतीजों की पूरी सूची ऐक्सेस करने के लिए, पेज टोकन के इस्तेमाल पर ध्यान दें.

advanced/adsense.gs

GitHub पर देखें

/**
 * Lists available AdSense accounts.
 */
function listAccounts() {
  let pageToken;
  do {
    const response = AdSense.Accounts.list({ pageToken: pageToken });
    if (!response.accounts) {
      console.log("No accounts found.");
      return;
    }
    for (const account of response.accounts) {
      console.log(
        'Found account with resource name "%s" and display name "%s".',
        account.name,
        account.displayName,
      );
    }
    pageToken = response.nextPageToken;
  } while (pageToken);
}

विज्ञापन क्लाइंट की सूची बनाएं

इस नमूने में, किसी खाते के सभी विज्ञापन क्लाइंट की सूची दी गई है. खाते को रिसॉर्स के नाम के तौर पर बताएं. जैसे, accounts/pub-12345. खाते के रिसॉर्स का नाम पाने के लिए, खातों की सूची बनाने वाले नमूना कोड का इस्तेमाल किया जा सकता है.

advanced/adsense.gs

GitHub पर देखें

/**
 * Logs available Ad clients for an account.
 *
 * @param {string} accountName The resource name of the account that owns the
 *     collection of ad clients.
 */
function listAdClients(accountName) {
  let pageToken;
  do {
    const response = AdSense.Accounts.Adclients.list(accountName, {
      pageToken: pageToken,
    });
    if (!response.adClients) {
      console.log("No ad clients found for this account.");
      return;
    }
    for (const adClient of response.adClients) {
      console.log(
        'Found ad client for product "%s" with resource name "%s".',
        adClient.productCode,
        adClient.name,
      );
      console.log(
        "Reporting dimension ID: %s",
        adClient.reportingDimensionId ?? "None",
      );
    }
    pageToken = response.nextPageToken;
  } while (pageToken);
}

विज्ञापन यूनिट की सूची बनाएं

इस नमूने में, किसी विज्ञापन क्लाइंट की सभी विज्ञापन यूनिट की सूची दी गई है. विज्ञापन क्लाइंट को रिसॉर्स के नाम के तौर पर बताएं. जैसे, accounts/pub-12345/adclients/ca-pub-12345. विज्ञापन क्लाइंट के रिसॉर्स का नाम पाने के लिए, विज्ञापन क्लाइंट की सूची बनाने वाले नमूना कोड का इस्तेमाल किया जा सकता है.

advanced/adsense.gs

GitHub पर देखें

/**
 * Lists ad units.
 * @param {string} adClientName The resource name of the ad client that owns the collection
 *     of ad units.
 */
function listAdUnits(adClientName) {
  let pageToken;
  do {
    const response = AdSense.Accounts.Adclients.Adunits.list(adClientName, {
      pageSize: 50,
      pageToken: pageToken,
    });
    if (!response.adUnits) {
      console.log("No ad units found for this ad client.");
      return;
    }
    for (const adUnit of response.adUnits) {
      console.log(
        'Found ad unit with resource name "%s" and display name "%s".',
        adUnit.name,
        adUnit.displayName,
      );
    }

    pageToken = response.nextPageToken;
  } while (pageToken);
}

रिपोर्ट जनरेट करना

इस नमूने में, आपके AdSense खाते की रिपोर्ट जनरेट की जाती है. साथ ही, नतीजों को स्प्रेडशीट में दिखाया जाता है.

advanced/adsense.gs

GitHub पर देखें

/**
 * Generates a spreadsheet report for a specific ad client in an account.
 * @param {string} accountName The resource name of the account.
 * @param {string} adClientReportingDimensionId The reporting dimension ID
 *     of the ad client.
 */
function generateReport(accountName, adClientReportingDimensionId) {
  // Prepare report.
  const today = new Date();
  const oneWeekAgo = new Date(today.getTime() - 7 * 24 * 60 * 60 * 1000);

  const report = AdSense.Accounts.Reports.generate(accountName, {
    // Specify the desired ad client using a filter.
    filters: [
      `AD_CLIENT_ID==${escapeFilterParameter(adClientReportingDimensionId)}`,
    ],
    metrics: [
      "PAGE_VIEWS",
      "AD_REQUESTS",
      "AD_REQUESTS_COVERAGE",
      "CLICKS",
      "AD_REQUESTS_CTR",
      "COST_PER_CLICK",
      "AD_REQUESTS_RPM",
      "ESTIMATED_EARNINGS",
    ],
    dimensions: ["DATE"],
    ...dateToJson("startDate", oneWeekAgo),
    ...dateToJson("endDate", today),
    // Sort by ascending date.
    orderBy: ["+DATE"],
  });

  if (!report.rows) {
    console.log("No rows returned.");
    return;
  }
  const spreadsheet = SpreadsheetApp.create("AdSense Report");
  const sheet = spreadsheet.getActiveSheet();

  // Append the headers.
  sheet.appendRow(report.headers.map((header) => header.name));

  // Append the results.
  sheet
    .getRange(2, 1, report.rows.length, report.headers.length)
    .setValues(report.rows.map((row) => row.cells.map((cell) => cell.value)));

  console.log("Report spreadsheet created: %s", spreadsheet.getUrl());
}

/**
 * Escape special characters for a parameter being used in a filter.
 * @param {string} parameter The parameter to be escaped.
 * @return {string} The escaped parameter.
 */
function escapeFilterParameter(parameter) {
  return parameter.replace("\\", "\\\\").replace(",", "\\,");
}

/**
 * Returns the JSON representation of a Date object (as a google.type.Date).
 *
 * @param {string} paramName the name of the date parameter
 * @param {Date} value the date
 * @return {object} formatted date
 */
function dateToJson(paramName, value) {
  return {
    [`${paramName}.year`]: value.getFullYear(),
    [`${paramName}.month`]: value.getMonth() + 1,
    [`${paramName}.day`]: value.getDate(),
  };
}