このリソースのメソッドの一覧は、このページの最後に掲載されています。
リソース表記
レポートを表します。
{ "key": { "queryId": long, "reportId": long }, "metadata": { "status": { "state": string, "failure": { "errorCode": string }, "finishTimeMs": long, "format": string }, "reportDataStartTimeMs": long, "reportDataEndTimeMs": long, "googleCloudStoragePath": string }, "params": { "type": string, "groupBys": [ string ], "filters": [ { "type": string, "value": string } ], "metrics": [ string ], "includeInviteData": boolean, "options": { "includeOnlyTargetedUserLists": boolean, "pathQueryOptions": { "channelGrouping": { "name": string, "rules": [ { "name": string, "disjunctiveMatchStatements": [ { "eventFilters": [ { "dimensionFilter": { "filter": string, "match": string, "values": [ string ] } } ] } ] } ], "fallbackName": string }, "pathFilters": [ { "eventFilters": [ { "dimensionFilter": { "filter": string, "match": string, "values": [ string ] } } ], "pathMatchPosition": string } ] } } } }
プロパティ名 | 値 | 説明 | メモ |
---|---|---|---|
key |
nested object |
レポートの識別に使用されるキー。 | |
key.queryId |
long |
クエリ ID。 | |
key.reportId |
long |
レポート ID。 | |
metadata |
nested object |
レポートのメタデータ。 | |
metadata.googleCloudStoragePath |
string |
レポートが保存される Google Cloud Storage 内の場所のパス。 | |
metadata.reportDataEndTimeMs |
long |
レポートに表示されるデータの終了時間。 | |
metadata.reportDataStartTimeMs |
long |
レポートに表示されるデータの開始時間。 | |
metadata.status |
nested object |
ステータスを報告します。 | |
metadata.status.failure |
nested object |
レポートが失敗した場合は、原因が記録されます。 | |
metadata.status.failure.errorCode |
string |
レポートが作成されなかった理由を示すエラーコード。
有効な値は次のとおりです。
|
|
metadata.status.finishTimeMs |
long |
このレポートが正常に完了した時刻または失敗した時刻。 | |
metadata.status.format |
string |
レポートのファイル形式。
有効な値は次のとおりです。
|
|
metadata.status.state |
string |
レポートの状態。
有効な値は次のとおりです。
|
|
params |
nested object |
レポート パラメータ。 | |
params.filters[] |
list |
レポート内のトラフィック データを照合するために使用されるフィルタ。 | |
params.filters[].type |
string |
フィルタの種類です。
有効な値は次のとおりです。
|
|
params.filters[].value |
string |
フィルタ値。 | |
params.groupBys[] |
list |
データは、このフィールドにリストされているフィルタによってグループ化されます。 | |
params.includeInviteData |
boolean |
非推奨です。このフィールドは使用されなくなりました。 | |
params.metrics[] |
list |
レポートの列として追加する指標。 | |
params.options |
nested object |
追加のクエリ オプション。 | |
params.options.includeOnlyTargetedUserLists |
boolean |
広告掲載オーダーまたは広告申込情報で明確にターゲットに設定されているオーディエンス リストのデータのみを含めるかどうか。TYPE_GENERAL レポートにのみ適用されます。FILTER_AUDIENCE_LIST はフィルタまたはディメンションとして含める必要があります。FILTER_INSERTION_ORDER または FILTER_LINE_ITEM をフィルタとして含める必要があります。 |
|
params.options.pathQueryOptions |
nested object |
経路フィルタとカスタム チャネル グループを含むオプション。TYPE_PATH および TYPE_PATH_ATTRIBUTION レポートにのみ適用されます。 |
|
params.options.pathQueryOptions.channelGrouping |
nested object |
カスタム チャネル グループTYPE_PATH および TYPE_PATH_ATTRIBUTION レポートにのみ適用されます。 |
|
params.options.pathQueryOptions.channelGrouping.fallbackName |
string |
チャネル グループのどのルールにも一致しないイベントに適用する名前。 | |
params.options.pathQueryOptions.channelGrouping.name |
string |
チャネル グループ名。 | |
params.options.pathQueryOptions.channelGrouping.rules[] |
list |
チャネル グループに含まれるルール。チャネル グループごとに設定できるルールは 100 件までです。 | |
params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[] |
list |
ルール内の DisjuctiveMatchStatements があります。DisjunctiveMatchStatement OR に含まれるすべてのフィルタ。 | |
params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[] |
list |
フィルタ。分離句の match ステートメントごとに設定できるフィルタは 100 個までです。 | |
params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter |
nested object |
ディメンションでフィルタします。 | |
params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.filter |
string |
フィルタが適用されるディメンション。
有効な値は次のとおりです。
|
|
params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.match |
string |
フィルタを値とどのように照合するかを示します。
有効な値は次のとおりです。
|
|
params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.values[] |
list |
フィルタする値。 | |
params.options.pathQueryOptions.channelGrouping.rules[].name |
string |
ルール名。 | |
params.options.pathQueryOptions.pathFilters[] |
list |
パスフィルタ。レポートごとに設定できるパスフィルタは 100 個までです。TYPE_PATH および TYPE_PATH_ATTRIBUTION レポートにのみ適用されます。 |
|
params.options.pathQueryOptions.pathFilters[].eventFilters[] |
list |
パスの一部に適用されるイベントをフィルタします。 | |
params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter |
nested object |
ディメンションでフィルタします。 | |
params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.filter |
string |
フィルタが適用されるディメンション。
有効な値は次のとおりです。
|
|
params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.match |
string |
フィルタを値とどのように照合するかを示します。
有効な値は次のとおりです。
|
|
params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.values[] |
list |
フィルタする値。 | |
params.options.pathQueryOptions.pathFilters[].pathMatchPosition |
string |
フィルタが一致するパスの位置(最初、最後、またはパス内の任意のイベント)を示します。
有効な値は次のとおりです。
|
|
params.type |
string |
レポートタイプ。 タイプ固有の制限事項:
指定できる値は次のとおりです。 <ph type="x-smartling-placeholder">
|
メソッド
- listreports
- 保存されているレポートを取得します。