AdSense सेवा

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

रेफ़रंस

इस सेवा के बारे में ज़्यादा जानकारी के लिए, AdSense मैनेजमेंट एपीआई के रेफ़रंस दस्तावेज़ देखें. 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()
  };
}