Để biết danh sách các phương thức cho tài nguyên này, hãy xem ở cuối trang.
Biểu diễn tài nguyên
Biểu thị một truy vấn.
{
"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
}| Tên tài sản | Giá trị | Mô tả | Ghi chú |
|---|---|---|---|
kind |
string |
Xác định loại tài nguyên này. Giá trị: chuỗi cố định "doubleclickbidmanager#query". |
|
metadata |
nested object |
Siêu dữ liệu truy vấn. | |
metadata.dataRange |
string |
Phạm vi của dữ liệu báo cáo.
Các giá trị được chấp nhận là:
|
|
metadata.format |
string |
Định dạng của báo cáo được tạo.
Các giá trị được chấp nhận là:
|
|
metadata.googleCloudStoragePathForLatestReport |
string |
Đường dẫn đến vị trí trong Google Cloud Storage nơi lưu trữ báo cáo mới nhất. | |
metadata.googleDrivePathForLatestReport |
string |
Đường dẫn trong Google Drive để tải báo cáo mới nhất. | |
metadata.latestReportRunTimeMs |
long |
Thời điểm báo cáo mới nhất bắt đầu chạy. | |
metadata.locale |
string |
Ngôn ngữ của các báo cáo đã tạo. Các giá trị được chấp nhận là:
Chuỗi ngôn ngữ không có trong danh sách ở trên sẽ tạo báo cáo bằng tiếng Anh. |
|
metadata.reportCount |
integer |
Số báo cáo đã được tạo cho truy vấn. | |
metadata.running |
boolean |
Liệu báo cáo mới nhất có đang chạy hay không. | |
metadata.sendNotification |
boolean |
Liệu có gửi thông báo qua email khi báo cáo đã sẵn sàng hay không. Giá trị mặc định là false. | |
metadata.shareEmailAddress[] |
list |
Danh sách các địa chỉ email nhận được thông báo qua email khi báo cáo hoàn tất. Tách biệt với sendNotification. |
|
metadata.title |
string |
Tiêu đề truy vấn. Tham số này được dùng để đặt tên cho các báo cáo được tạo từ truy vấn này. | |
params |
nested object |
Tham số truy vấn. | |
params.filters[] |
list |
Bộ lọc dùng để khớp với dữ liệu lưu lượng truy cập trong báo cáo của bạn. | |
params.filters[].type |
string |
Loại bộ lọc.
Các giá trị được chấp nhận là:
|
|
params.filters[].value |
string |
Giá trị bộ lọc. | |
params.groupBys[] |
list |
Dữ liệu được nhóm theo những bộ lọc được liệt kê trong trường này. | |
params.includeInviteData |
boolean |
Không dùng nữa. Trường này không còn được sử dụng nữa. | |
params.metrics[] |
list |
Chỉ số cần đưa vào dưới dạng cột trong báo cáo. | |
params.type |
string |
Loại báo cáo. Giới hạn theo loại cụ thể:
Các giá trị được chấp nhận là:
|
|
queryId |
long |
Mã truy vấn. | |
reportDataEndTimeMs |
long |
Thời gian kết thúc của dữ liệu xuất hiện trong báo cáo. Lưu ý rằng bạn phải nhập reportDataEndTimeMs nếu metadata.dataRange là CUSTOM_DATES và sẽ bị bỏ qua nếu không được tính. |
|
reportDataStartTimeMs |
long |
Thời gian bắt đầu cho dữ liệu xuất hiện trong báo cáo. Lưu ý rằng bạn phải nhập reportDataStartTimeMs nếu metadata.dataRange là CUSTOM_DATES và sẽ bị bỏ qua nếu không được tính. |
|
schedule |
nested object |
Thông tin về tần suất và thời điểm chạy truy vấn. | |
schedule.endTimeMs |
long |
Ngày giờ để chạy truy vấn định kỳ cho đến. | |
schedule.frequency |
string |
Tần suất chạy truy vấn.
Các giá trị được chấp nhận là:
|
|
schedule.nextRunMinuteOfDay |
integer |
Không dùng nữa. Trường này không có tác dụng. | |
schedule.nextRunTimezoneCode |
string |
Mã múi giờ chuẩn cho thời gian tạo báo cáo. Giá trị mặc định là America/New_York. |
|
timezoneCode |
string |
Mã múi giờ chuẩn cho thời gian dữ liệu báo cáo. Giá trị mặc định là America/New_York. |
Phương thức
- createquery
- Tạo một truy vấn.
- deletequery
- Xoá truy vấn đã lưu trữ cũng như các báo cáo được lưu trữ có liên quan.
- getquery
- Truy xuất truy vấn đã lưu trữ.
- listqueries
- Truy xuất các truy vấn đã lưu trữ.
- chạy truy vấn
- Chạy truy vấn đã lưu trữ để tạo báo cáo.