บริการ AdSense

บริการ AdSense ช่วยให้คุณสามารถใช้ AdSense Management API ใน Apps Script API นี้ ทำให้ลูกค้า AdSense สามารถดูข้อมูลเกี่ยวกับโครงสร้าง ของบัญชี และเรียกใช้รายงานเกี่ยวกับประสิทธิภาพของบัญชี

ข้อมูลอ้างอิง

สำหรับข้อมูลโดยละเอียดเกี่ยวกับบริการนี้ โปรดดูที่ เอกสารอ้างอิงสำหรับ AdSense API การจัดการ เช่นเดียวกับบริการขั้นสูงทั้งหมดใน Apps Script บริการ AdSense ใช้ออบเจ็กต์ เมธอด และพารามิเตอร์เดียวกันกับ API สาธารณะ ดูข้อมูลเพิ่มเติมได้ที่วิธีกำหนดลายเซ็นของเมธอด

หากต้องการรายงานปัญหาและค้นหาการสนับสนุนอื่นๆ โปรดสอบถามใน Stack Overflow โดยใช้ adsense-api แท็ก

โค้ดตัวอย่าง

โค้ดตัวอย่างด้านล่างใช้เวอร์ชัน 2 ของ API

แสดงรายการบัญชี

ตัวอย่างนี้แสดงบัญชีทั้งหมดที่ผู้ใช้สามารถใช้ได้ บัญชีเหล่านี้ ระบุเป็นชื่อทรัพยากร เช่น 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()
  };
}