Reports: generate

認証が必要です

クエリパラメータで送信されたレポート リクエストに基づいて AdSense レポートを生成し、結果を JSON として返します。出力を CSV 形式で受け取るにはクエリパラメータとして "alt=csv" を指定します。実際に試す

リクエスト

HTTP リクエスト

GET https://www.googleapis.com/adsense/v1.4/reports

パラメータ

パラメータ名 説明
必須クエリパラメータ
endDate string レポートに含める期間の最終日。"YYYY-MM-DD" 形式で、指定した日付も範囲に含まれます。
startDate string レポートに含める期間の開始日。"YYYY-MM-DD" 形式で、指定した日付も範囲に含まれます。
省略可能なクエリパラメータ
accountId string レポート対象のアカウント。
currency string オプションの通貨。金額の統計情報をレポートする場合に使用します。設定しない場合は、デフォルトでアカウントの通貨が使用されます。
dimension string このディメンションに基づいてレポートが作成されます。利用できるディメンションをご確認ください。各ディメンションの詳細については、AdSense 用語集をご覧ください。
filter string レポートに適用するフィルタ
locale string オプション。レポートを特定の言語に翻訳するために使用される言語/地域。指定しない場合、デフォルトは "en_US" です。
maxResults integer 取得するレポート データの最大行数。startIndex が未設定またはゼロの場合、API は maxResults の値で指定された数の行を返します。maxResults が未設定の場合、API は 50,000 を上限としてできるだけ多くの行を返します。startIndex にゼロ以外の値を指定した場合、startIndex と maxResults の合計数は 5,000 以下である必要があります。5,000 行を超えるページ割り付けはサポートされていないことを示すエラーが表示されます。有効な値は 050000(指定した値を含む)です。
metric string この指標に基づいてレポートが作成されます。利用できる指標をご確認ください。各指標の詳細については、AdSense 用語集をご覧ください。
sort string 生成したレポートを並べ替える基準となるディメンションまたは指標の名前。必要に応じて昇順に並べ替えるには "+" を、降順に並べ替えるには "-" を前に付けます。指定しない場合、列は昇順になります。
startIndex integer 取得するレポート データの最初の行のインデックス。startIndex が未設定またはゼロの場合、API は maxResults の値で指定された数の行を返します。maxResults が未設定の場合、API は 50,000 を上限としてできるだけ多くの行を返します。startIndex にゼロ以外の値を指定した場合、startIndex と maxResults の合計数は 5,000 以下である必要があります。5,000 行を超えるページ割り付けはサポートされていないことを示すエラーが表示されます。有効な値は 05000(指定した値を含む)です。
useTimezoneReporting boolean レポートを AdSense アカウントのローカル タイムゾーンに基づいて作成するかを指定します。false の場合、デフォルトの太平洋時間(PST、PDT)がタイムゾーンとして使用されます。

認証

このリクエストには、次の 1 つ以上の範囲の認証が必要です(詳細については、認証と承認に関する記事をご覧ください)。

範囲
https://www.googleapis.com/auth/adsense
https://www.googleapis.com/auth/adsense.readonly

リクエスト本文

このメソッドをリクエストの本文に含めないでください。

レスポンス

正常終了すると、このメソッドは次の構造でレスポンスの本体を返します。

JSON

{
  "kind": "adsense#report",
  "totalMatchedRows": long,
  "headers": [
    {
      "name": string,
      "type": string,
      "currency": string
    }
  ],
  "rows": [
    [
      string
    ]
  ],
  "totals": [
    string
  ],
  "averages": [
    string
  ],
  "warnings": [
    string
  ],
  "startDate": string,
  "endDate": string
}
プロパティ名 説明 備考
kind string 種類。この例では adsense#report です。
totalMatchedRows long レポート リクエストごとに照合される行数の合計。リクエストされた行数による制限、またはレポート行数制限により、レスポンスで返される行数が少なくなる場合があります。
headers[] list レポートでリクエストされている列のヘッダー情報。これはヘッダーのリストです。リクエストの各ディメンションのヘッダーの後に各統計情報のヘッダーが続きます。
headers[].name string ヘッダーの名前。
headers[].type string ヘッダーのタイプ。DIMENSION、METRIC_TALLY、METRIC_RATIO、METRIC_CURRENCY のいずれかです。

有効な値は次のとおりです。
  • "DIMENSION":
  • "METRIC_CURRENCY":
  • "METRIC_RATIO":
  • "METRIC_TALLY":
headers[].currency string この列の通貨。ヘッダーのタイプが METRIC_CURRENCY の場合のみ。
rows[] list レポートの出力行。各行はセルのリストです。リクエストの各ディメンションのセルの後に各統計情報のセルが続きます。ディメンションのセルには文字列が、統計情報のセルには数値が入ります。
totals[] list レポートの各種合計。レポート内の他の行と同じ長さですが、ディメンション列に対応するセルは空です。
averages[] list レポートの各種平均。レポート内の他の行と同じ長さですが、ディメンション列に対応するセルは空です。
warnings[] list レポートの生成に関連する警告。
startDate string リクエスト済みの開始日。形式は yyyy-mm-dd になります。
endDate string リクエスト済みの終了日。形式は yyyy-mm-dd になります。

CSV

"(dynamic)"
(foreach)
  string
(/foreach)
プロパティ名 説明 備考
(dynamic) string

実際に試す

このメソッドを呼び出してレスポンスを確認するには、以下のテスト ツールをご利用ください。

フィードバックを送信...