有关此类资源的方法列表,请参阅本页面的结尾部分。
资源表示形式
表示查询。
{ "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 |
报告类型。 类型特有的限制:
可接受的值:
|
|
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
- 运行存储的查询来生成报告。