レポートをすぐに生成して返します。実習をご覧ください。
リクエスト
HTTP リクエスト
POST https://www.googleapis.com/doubleclicksearch/v2/reports/generate
承認
このリクエストには、次のスコープによる認証が必要です。
範囲 |
---|
https://www.googleapis.com/auth/doubleclicksearch |
詳細については、認証と承認のページをご覧ください。
リクエスト本文
リクエストの本文には、以下の構造を使用してデータを指定してください。
{ "reportScope": { "agencyId": long, "advertiserId": long, "engineAccountId": long, "campaignId": long, "adGroupId": long, "keywordId": long, "adId": long }, "reportType": string, "columns": [ { "columnName": string, "savedColumnName": string, "customDimensionName": string, "customMetricName": string, "headerText": string, "startDate": string, "endDate": string, "groupByColumn": boolean, "platformSource": string, "productReportPerspective": string } ], "timeRange": { "startDate": string, "endDate": string, "changedMetricsSinceTimestamp": datetime, "changedAttributesSinceTimestamp": datetime }, "filters": [ { "column": { "columnName": string, "savedColumnName": string, "customDimensionName": string, "customMetricName": string, "headerText": string, "startDate": string, "endDate": string, "groupByColumn": boolean, "platformSource": string, "productReportPerspective": string }, "operator": string, "values": [ (value) ] } ], "orderBy": [ { "column": { "columnName": string, "savedColumnName": string, "customDimensionName": string, "customMetricName": string, "headerText": string, "startDate": string, "endDate": string, "groupByColumn": boolean, "platformSource": string, "productReportPerspective": string }, "sortOrder": string } ], "includeDeletedEntities": boolean, "includeRemovedEntities": boolean, "verifySingleTimeZone": boolean, "downloadFormat": string, "statisticsCurrency": string, "startRow": integer, "rowCount": integer, "maxRowsPerFile": integer }
プロパティ名 | 値 | 説明 | 備考 |
---|---|---|---|
reportScope |
object |
reportScope は、レポートで取得するエンティティのサブセットを判断するために使用される ID のセットです。最も下位のスコープレベルにある ID を、エージェントを通じて全体を通じて必要とします。 | |
reportScope.agencyId |
long |
DS 代理店 ID | |
reportScope.advertiserId |
long |
DS 広告主 ID | |
reportScope.engineAccountId |
long |
DS エンジン アカウント ID。 | |
reportScope.campaignId |
long |
DS キャンペーン ID。 | |
reportScope.adGroupId |
long |
DS 広告グループ ID。 | |
reportScope.keywordId |
long |
DS キーワード ID。 | |
reportScope.adId |
long |
DS 広告 ID。 | |
reportType |
string |
レポートで返される行の種類を指定します。たとえば、reportType: keyword を指定すると、レポートの各行にキーワードに関するデータが含まれます。各タイプで使用可能な列については、レポートのタイプのリファレンスをご覧ください。 |
|
columns[] |
list |
レポートに含める列。これには、DoubleClick Search の列と保存した列の両方が含まれます。DoubleClick Search の列では、columnName パラメータのみが必須です。保存済みの列では、savedColumnName パラメータのみが必要です。columnName と savedColumnName を同じスタンザに設定することはできません。リクエストあたりの最大列数は 300 です。 |
|
columns[].columnName |
string |
レポートに含める DoubleClick Search 列の名前。 | |
columns[].savedColumnName |
string |
レポートに含める保存済み列の名前。レポートのスコープは広告主以下である必要があります。また、この保存済み列は、DoubleClick Search の UI ですでに作成されている必要があります。 | |
columns[].headerText |
string |
レポート出力でこの列の識別に使用されるテキストです。指定しない場合、デフォルトは columnName または savedColumnName です。これを使用すると、DoubleClick Search の列と同じ名前の保存済み列との競合を回避できます。 |
|
columns[].startDate |
string |
YYYY-MM-DD 形式の日付を含む。指定すると、この列のレポート期間全体がオーバーライドされます。endDate と一緒に指定する必要があります。 |
|
columns[].endDate |
string |
YYYY-MM-DD 形式の日付を含む。指定すると、この列のレポート期間全体がオーバーライドされます。startDate と一緒に指定する必要があります。 |
|
columns[].groupByColumn |
boolean |
同期レポートのみ。この列でグループ化するには true に設定します。デフォルトは false です。 |
|
timeRange |
object |
レポートで指標がリクエストされた場合、この引数を使用して指標が特定の期間に限定されます。 | |
timeRange.startDate |
string |
YYYY-MM-DD 形式の日付を含む。 | |
timeRange.endDate |
string |
YYYY-MM-DD 形式の日付を含む。 | |
timeRange.changedMetricsSinceTimestamp |
datetime |
RFC 形式のインクルーシブな UTC タイムスタンプ(例:2013-07-16T10:16:23.555Z 。変更された指標レポートの仕組みに関する追加の参照情報をご覧ください。 |
|
timeRange.changedAttributesSinceTimestamp |
datetime |
RFC 形式のインクルーシブな UTC タイムスタンプ(例:2013-07-16T10:16:23.555Z 。変更済みの属性レポートの仕組みに関する追加情報もご覧ください。 |
|
filters[] |
list |
レポートに適用するフィルタのリスト。 リクエストあたりのフィルタの最大数は 300 です。 |
|
filters[].column |
nested object |
フィルタを実行する列。DoubleClick Search の列または保存した列を指定できます。 | |
filters[].column.columnName |
string |
レポートに含める DoubleClick Search 列の名前。 | |
filters[].column.savedColumnName |
string |
レポートに含める保存済み列の名前。レポートのスコープは広告主以下である必要があります。また、この保存済み列は、DoubleClick Search の UI ですでに作成されている必要があります。 | |
filters[].operator |
string |
フィルタで使用する演算子。使用可能な演算子のリストについては、フィルタのリファレンスをご覧ください。 | |
filters[].values[] |
list |
列の値をフィルタする値のリスト。 リクエストあたりのフィルタ値の最大数は 300 です。 |
|
orderBy[] |
list |
同期レポートのみ。レポートの行に対して実行する並べ替えを定義する列と方向のリスト。 1 回のリクエストあたりの注文の最大数は 300 です。 |
|
orderBy[].column |
nested object |
並べ替えを行う列。DoubleClick Search で定義された列または保存した列を指定できます。 | |
orderBy[].column.columnName |
string |
レポートに含める DoubleClick Search 列の名前。 | |
orderBy[].column.savedColumnName |
string |
レポートに含める保存済み列の名前。レポートのスコープは広告主以下である必要があります。また、この保存済み列は、DoubleClick Search の UI ですでに作成されている必要があります。 | |
orderBy[].sortOrder |
string |
並べ替えの方向(ascending または descending )。 |
|
includeDeletedEntities |
boolean |
削除されたエンティティをレポートに含めるかどうかを決定します。デフォルトは false です。非推奨です。代わりに includeRemovedEntities を使用してください。 |
|
verifySingleTimeZone |
boolean |
true の場合、リクエストされたすべての統計情報データが単一のタイムゾーンから得ている場合にのみ、レポートが作成されます。デフォルトは false です。 |
|
downloadFormat |
string |
レポートを返す形式を指定します。現在、csv または tsv がサポートされています。 |
|
statisticsCurrency |
string |
金額を返す通貨を指定します。有効な値は usd 、agency (レポートのスコープが代理店またはそれより低い場合は有効)、advertiser (レポートのスコープが * 広告主またはそれより低い場合は有効)、account (レポートのスコープがエンジン アカウント以下の場合に有効)です。 |
|
startRow |
integer |
同期レポートのみ。返される最初の行の 0 から始まるインデックス。{0 /} 以上 50000 以下の値を指定できます。デフォルトでは 0 に設定されます。 |
|
rowCount |
integer |
同期レポートのみ。返される最大行数。それ以上の行は破棄されます。{0 /} 以上 10000 以下の値を指定できます。デフォルトでは 10000 に設定されます。 |
|
maxRowsPerFile |
integer |
非同期レポートのみ。レポート ファイルあたりの最大行数。サイズの大きいレポートは、このフィールドに基づいて多数のファイルに分割されます。有効な値は 1000000 ~100000000 (指定した値を含む)です。 |
|
includeRemovedEntities |
boolean |
削除されたエンティティをレポートに含めるかどうかを決定します。デフォルトは false です。 |
|
columns[].customDimensionName |
string |
カスタム ディメンションでレポートを分割するレポートのスコープは広告主以下である必要があります。また、カスタム ディメンションは DoubleClick Search ですでに設定されている必要があります。DoubleClick Search で表示されるカスタム ディメンション名では大文字と小文字が区別されます。 コンバージョン レポートで使用している場合は、そのコンバージョンで指定されたカスタム ディメンションの値が返されます(指定した場合)。この列ではコンバージョン レポートを分割できません。 |
|
columns[].platformSource |
string |
カスタム ディメンションのデータを提供するために使用するプラットフォームです。使用できる値は「floodlight」です。 | |
filters[].column.customDimensionName |
string |
カスタム ディメンションでレポートを分割するレポートのスコープは広告主以下である必要があります。また、カスタム ディメンションは DoubleClick Search ですでに設定されている必要があります。DoubleClick Search で表示されるカスタム ディメンション名では大文字と小文字が区別されます。 コンバージョン レポートで使用している場合は、そのコンバージョンで指定されたカスタム ディメンションの値が返されます(指定した場合)。この列ではコンバージョン レポートを分割できません。 |
|
filters[].column.headerText |
string |
レポート出力でこの列の識別に使用されるテキストです。指定しない場合、デフォルトは columnName または savedColumnName です。これを使用すると、DoubleClick Search の列と同じ名前の保存済み列との競合を回避できます。 |
|
filters[].column.startDate |
string |
YYYY-MM-DD 形式の日付を含む。指定すると、この列のレポート期間全体がオーバーライドされます。endDate と一緒に指定する必要があります。 |
|
filters[].column.endDate |
string |
YYYY-MM-DD 形式の日付を含む。指定すると、この列のレポート期間全体がオーバーライドされます。startDate と一緒に指定する必要があります。 |
|
filters[].column.groupByColumn |
boolean |
同期レポートのみ。この列でグループ化するには true に設定します。デフォルトは false です。 |
|
filters[].column.platformSource |
string |
カスタム ディメンションのデータを提供するために使用するプラットフォームです。使用できる値は「floodlight」です。 | |
orderBy[].column.customDimensionName |
string |
カスタム ディメンションでレポートを分割するレポートのスコープは広告主以下である必要があります。また、カスタム ディメンションは DoubleClick Search ですでに設定されている必要があります。DoubleClick Search で表示されるカスタム ディメンション名では大文字と小文字が区別されます。 コンバージョン レポートで使用している場合は、そのコンバージョンで指定されたカスタム ディメンションの値が返されます(指定した場合)。この列ではコンバージョン レポートを分割できません。 |
|
orderBy[].column.headerText |
string |
レポート出力でこの列の識別に使用されるテキストです。指定しない場合、デフォルトは columnName または savedColumnName です。これを使用すると、DoubleClick Search の列と同じ名前の保存済み列との競合を回避できます。 |
|
orderBy[].column.startDate |
string |
YYYY-MM-DD 形式の日付を含む。指定すると、この列のレポート期間全体がオーバーライドされます。endDate と一緒に指定する必要があります。 |
|
orderBy[].column.endDate |
string |
YYYY-MM-DD 形式の日付を含む。指定すると、この列のレポート期間全体がオーバーライドされます。startDate と一緒に指定する必要があります。 |
|
orderBy[].column.groupByColumn |
boolean |
同期レポートのみ。この列でグループ化するには true に設定します。デフォルトは false です。 |
|
orderBy[].column.platformSource |
string |
カスタム ディメンションのデータを提供するために使用するプラットフォームです。使用できる値は「floodlight」です。 | |
columns[].customMetricName |
string |
レポートに含めるカスタム指標の名前。レポートのスコープは広告主以下である必要があります。また、カスタム指標は DoubleClick Search ですでに設定されている必要があります。DoubleClick Search に表示されるカスタム指標名では、大文字と小文字が区別されます。 | |
filters[].column.customMetricName |
string |
レポートに含めるカスタム指標の名前。レポートのスコープは広告主以下である必要があります。また、カスタム指標は DoubleClick Search ですでに設定されている必要があります。DoubleClick Search に表示されるカスタム指標名では、大文字と小文字が区別されます。 | |
orderBy[].column.customMetricName |
string |
レポートに含めるカスタム指標の名前。レポートのスコープは広告主以下である必要があります。また、カスタム指標は DoubleClick Search ですでに設定されている必要があります。DoubleClick Search に表示されるカスタム指標名では、大文字と小文字が区別されます。 | |
columns[].productReportPerspective |
string |
特定の種類の商品アクティビティについてのみ、指標を返します。次の値を使用できます。
|
|
filters[].column.productReportPerspective |
string |
特定の種類の商品アクティビティについてのみ、指標を返します。次の値を使用できます。
|
|
orderBy[].column.productReportPerspective |
string |
特定の種類の商品アクティビティについてのみ、指標を返します。次の値を使用できます。
|
レスポンス
成功すると、このメソッドはレスポンスの本文で Reports リソースを返します。
実習
以下の API Explorer を使用して、ライブデータでこのメソッドを呼び出し、レスポンスを確認します。 または、スタンドアロンの Explorer をお試しください。