บริการ AdSense

AdSense Management API และจัดการบัญชีและรายงาน AdSense

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

นี่เป็นบริการขั้นสูงที่ต้องเปิดใช้ก่อนใช้งาน

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

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

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

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

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

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

ตัวอย่างนี้แสดงบัญชีทั้งหมดที่ผู้ใช้เข้าถึงได้ บัญชีจะระบุเป็นชื่อทรัพยากร เช่น accounts/pub-12345 ซึ่งใช้ได้ในวิธีอื่นๆ เช่น listing ad clients โปรดสังเกตการใช้โทเค็นหน้าเว็บเพื่อเข้าถึงรายการผลลัพธ์ทั้งหมด

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 คุณดูชื่อทรัพยากรของบัญชีได้โดยใช้โค้ดตัวอย่าง List accounts

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);
}

แสดงหน่วยโฆษณา

ตัวอย่างนี้แสดงหน่วยโฆษณาทั้งหมดสำหรับผู้ลงโฆษณาที่ระบุ ระบุ AdClient เป็นชื่อทรัพยากร เช่น 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(),
  };
}