認証が必要です
クエリ パラメータで送信されたレポート リクエストに基づいて AdSense レポートを生成し、結果を JSON として返します。出力を CSV 形式で受け取るにはクエリ パラメータとして "alt=csv" を指定します。 今すぐ試す
リクエスト
HTTP リクエスト
GET https://www.googleapis.com/adsensehost/v4.1/reports
パラメータ
パラメータ名 | 値 | 説明 | ||
---|---|---|---|---|
必須パラメータ | ||||
endDate |
string |
レポートに含める期間の最終日。"YYYY-MM-DD" 形式で、指定した日付も範囲に含まれます。 | ||
startDate |
string |
レポートに含める期間の開始日。"YYYY-MM-DD" 形式で、指定した日付も範囲に含まれます。 | ||
オプション パラメータ | ||||
dimension |
string |
ディメンション。このディメンションに基づいてレポートが作成されます。使用可能なディメンションは次のとおりです。
|
||
filter |
string |
レポートで実行するフィルタ。 | ||
locale |
string |
オプション。レポートを特定の言語に翻訳するために使用される言語/地域。指定しない場合、デフォルトは "en_US" です。 | ||
maxResults |
unsigned integer |
取得するレポート データの最大行数。
0 ~50000 (指定した値を含む)です。
|
||
metric |
string |
レポートに含める数値列。使用可能な統計情報は次のとおりです。
|
||
sort |
string |
生成したレポートを並べ替える基準となるディメンション名または統計情報名。必要に応じて昇順に並べ替えるには「+」を、降順に並べ替えるには「-」を前に付けます。指定しない場合、列は昇順になります。 以下は、ディメンションと統計情報のユニオンです。
|
||
startIndex |
unsigned integer |
取得するレポート データの最初の行のインデックス。
0 ~5000 (指定した値を含む)です。
|
認証
このリクエストには、次の 1 つ以上の範囲の認証が必要です(詳細については、認証と承認に関する記事をご覧ください)。
範囲 |
---|
https://www.googleapis.com/auth/adsensehost |
リクエスト本文
このメソッドをリクエストの本文に含めないでください。
レスポンス
成功した場合、このメソッドは次の構造を持つレスポンス本文を返します。
JSON
{ "kind": "adsensehost#report", "totalMatchedRows": long, "headers": [ { "name": string, "type": string, "currency": string } ], "rows": [ [ string ] ], "totals": [ string ], "averages": [ string ], "warnings": [ string ] }
プロパティ名 | 値 | 説明 | 備考 |
---|---|---|---|
kind |
string |
種類。この例では adsensehost#report です。 | |
totalMatchedRows |
long |
レポート リクエストごとに照合される行数の合計。リクエストされた行数による制限、またはレポート行数制限により、レスポンスで返される行数が少なくなる場合があります。 | |
headers[] |
list |
レポートでリクエストされている列のヘッダー情報。これはヘッダーのリストです。リクエストの各ディメンションのヘッダーの後に各統計情報のヘッダーが続きます。 | |
headers[].name |
string |
ヘッダーの名前。 | |
headers[].type |
string |
ヘッダーのタイプ。DIMENSION、METRIC_TALLY、METRIC_RATIO、METRIC_CURRENCY のいずれかです。 | |
headers[].currency |
string |
この列の通貨。ヘッダーのタイプが METRIC_CURRENCY の場合のみ。 | |
rows[] |
list |
レポートの出力行。各行はセルのリストです。リクエストの各ディメンションのセルの後に各統計情報のセルが続きます。ディメンションのセルには文字列が、統計情報のセルには数値が入ります。 | |
totals[] |
list |
レポートの各種合計。レポート内の他の行と同じ長さですが、ディメンション列に対応するセルは空です。 | |
averages[] |
list |
レポートの各種平均。レポート内の他の行と同じ長さですが、ディメンション列に対応するセルは空です。 | |
warnings[] |
list |
レポートの生成に関連する警告。 |
CSV
"(dynamic)" (foreach) (value) (/foreach)
プロパティ名 | 値 | 説明 | 備考 | |
---|---|---|---|---|
(dynamic)"> | (dynamic) |
(any) |
今すぐ試す
このメソッドを呼び出してレスポンスを確認するには、以下のテスト ツールをご利用ください。