AdSense सेवा

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

रेफ़रंस

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

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

नमूना कोड

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

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

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

advanced/adsense.gs
/**
 * 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
/**
 * 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
/**
 * 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
/**
 * 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()
  };
}