AdSense-Dienst

Mit dem AdSense-Dienst können Sie die AdSense Management API in Google Apps Script verwenden. Mit dieser API können AdSense-Kunden Informationen zur Struktur ihres Kontos abrufen und Berichte zur Leistung erstellen.

Dies ist ein erweiterter Dienst, der vor der Verwendung aktiviert werden muss werden.

Referenz

Ausführliche Informationen zu diesem Dienst finden Sie in der Referenzdokumentation zur AdSense Management API. Wie alle erweiterten Dienste in Apps Script verwendet der AdSense-Dienst dieselben Objekte, Methoden und Parameter wie die öffentliche API. Weitere Informationen finden Sie unter Bestimmen von Methodensignaturen.

Wenn Sie Probleme melden oder weitere Unterstützung erhalten möchten, stellen Sie Ihre Fragen auf Stack Overflow mit dem adsense-api Tag.

Beispielcode

Im folgenden Beispielcode wird Version 2 von der API verwendet.

Konten auflisten

In diesem Beispiel werden alle Konten aufgelistet, die dem Nutzer zur Verfügung stehen. Die Konten werden als Ressourcennamen angegeben, z. B. accounts/pub-12345, die in anderen Methoden verwendet werden können , z. B. zum Auflisten von Werbekunden. Beachten Sie die Verwendung von Seitentokens, um auf die vollständige Liste der Ergebnisse zuzugreifen.

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

Werbekunden auflisten

In diesem Beispiel werden alle Werbekunden für ein bestimmtes Konto aufgelistet. Geben Sie das Konto als Ressourcennamen an, z. B. accounts/pub-12345. Sie können den Kontoresourcennamen mit dem Beispielcode Konten auflisten abrufen.

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

Anzeigenblöcke auflisten

In diesem Beispiel werden alle Anzeigenblöcke für einen bestimmten Werbekunden aufgelistet. Geben Sie den Werbekunden als Ressourcennamen an, z. B. accounts/pub-12345/adclients/ca-pub-12345. Sie können den Ressourcennamen des Werbekunden mit dem Beispielcode Werbekunden auflisten abrufen.

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

Bericht generieren

In diesem Beispiel wird ein Bericht zu Ihrem AdSense-Konto erstellt und die Ergebnisse in einer Tabelle ausgegeben.

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