このリソースのメソッドの一覧は、このページの最後に掲載されています。
リソース表記
クエリを表します。
{
"kind": "doubleclickbidmanager#query",
"queryId": long,
"metadata": {
"title": string,
"dataRange": string,
"format": string,
"running": boolean,
"reportCount": integer,
"googleCloudStoragePathForLatestReport": string,
"latestReportRunTimeMs": long,
"googleDrivePathForLatestReport": string,
"sendNotification": boolean,
"shareEmailAddress": [
string
],
"locale": string
},
"params": {
"type": string,
"groupBys": [
string
],
"filters": [
{
"type": string,
"value": string
}
],
"metrics": [
string
],
"includeInviteData": boolean
},
"schedule": {
"frequency": string,
"endTimeMs": long,
"nextRunMinuteOfDay": integer,
"nextRunTimezoneCode": string
},
"reportDataStartTimeMs": long,
"reportDataEndTimeMs": long,
"timezoneCode": string
}| プロパティ名 | 値 | 説明 | メモ |
|---|---|---|---|
kind |
string |
リソースの種類を指定します。値: 固定文字列 "doubleclickbidmanager#query"。 |
|
metadata |
nested object |
メタデータをクエリします。 | |
metadata.dataRange |
string |
レポートデータの範囲。
有効な値は次のとおりです。
|
|
metadata.format |
string |
生成されるレポートの形式。
有効な値は次のとおりです。
|
|
metadata.googleCloudStoragePathForLatestReport |
string |
最新のレポートが保存される Google Cloud Storage 内の場所のパス。 | |
metadata.googleDrivePathForLatestReport |
string |
最新のレポートの Google ドライブ内のパス。 | |
metadata.latestReportRunTimeMs |
long |
最新のレポートの実行が開始された時刻。 | |
metadata.locale |
string |
生成されたレポートの言語 / 地域。以下の値を指定できます。
上記以外の言語 / 地域の文字列では、英語でレポートが生成されます。 |
|
metadata.reportCount |
integer |
クエリに対して生成されたレポートの数。 | |
metadata.running |
boolean |
最新のレポートが現在実行中かどうか。 | |
metadata.sendNotification |
boolean |
レポートの準備ができたときにメール通知を送信するかどうか。デフォルトは false です。 | |
metadata.shareEmailAddress[] |
list |
レポート完了時にメール通知を送信するメールアドレスのリスト。sendNotification とは別にします。 |
|
metadata.title |
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.type |
string |
レポートタイプ。 タイプ固有の制限事項:
指定できる値は次のとおりです。 <ph type="x-smartling-placeholder">
|
|
queryId |
long |
クエリ ID。 | |
reportDataEndTimeMs |
long |
レポートに表示されるデータの終了時間。metadata.dataRange が CUSTOM_DATES の場合、reportDataEndTimeMs は必須です。それ以外の場合は無視されます。 |
|
reportDataStartTimeMs |
long |
レポートに表示されるデータの開始時間。metadata.dataRange が CUSTOM_DATES の場合、reportDataStartTimeMs は必須です。それ以外の場合は無視されます。 |
|
schedule |
nested object |
クエリを実行する頻度とタイミングに関する情報。 | |
schedule.endTimeMs |
long |
クエリを実行する日時。 | |
schedule.frequency |
string |
クエリの実行頻度。
有効な値は次のとおりです。
|
|
schedule.nextRunMinuteOfDay |
integer |
非推奨です。このフィールドは無視されます。 | |
schedule.nextRunTimezoneCode |
string |
レポート生成時間の正規のタイムゾーン コード。デフォルトは America/New_York です。 |
|
timezoneCode |
string |
レポートデータの時刻の正規のタイムゾーン コード。デフォルトは America/New_York です。 |
メソッド
- createquery
- クエリを作成します。
- deletequery
- 保存したクエリと関連する保存済みレポートを削除します。
- getquery
- 保存されたクエリを取得します。
- listqueries
- 保存されたクエリを取得します。
- runquery
- 保存したクエリを実行してレポートを生成します。