ดูรายการเมธอดของทรัพยากรนี้ในส่วนท้ายของหน้านี้
แหล่งข้อมูล
แสดงถึงข้อความค้นหา
{
"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 |
รหัสคําค้นหา | |
reportDataEndTimeMs |
long |
เวลาสิ้นสุดสําหรับข้อมูลที่แสดงในรายงาน โปรดทราบว่าคุณต้องใช้ reportDataEndTimeMs หาก metadata.dataRange เป็น CUSTOM_DATES และไม่สนใจเป็นอย่างอื่น |
|
reportDataStartTimeMs |
long |
เวลาเริ่มต้นสําหรับข้อมูลที่แสดงในรายงาน โปรดทราบว่าคุณต้องใช้ reportDataStartTimeMs หาก metadata.dataRange เป็น CUSTOM_DATES และไม่สนใจเป็นอย่างอื่น |
|
schedule |
nested object |
ข้อมูลเกี่ยวกับความถี่ในการเรียกใช้คําค้นหา | |
schedule.endTimeMs |
long |
วันที่และเวลาที่จะเรียกใช้การค้นหาเป็นระยะจนถึง | |
schedule.frequency |
string |
ความถี่ในการค้นหา
ค่าที่ยอมรับได้ ได้แก่
|
|
schedule.nextRunMinuteOfDay |
integer |
เลิกใช้งานแล้ว ช่องนี้ไม่มีผล | |
schedule.nextRunTimezoneCode |
string |
โค้ด Canonical เขตเวลาสําหรับเวลาที่ใช้ในการสร้างรายงาน ค่าเริ่มต้นคือ America/New_York |
|
timezoneCode |
string |
โค้ดเขตเวลา Canonical สําหรับเวลารายงานข้อมูล ค่าเริ่มต้นคือ America/New_York |
วิธีการ
- สร้างคําค้นหา
- สร้างการค้นหา
- ลบคําค้นหา
- ลบการค้นหาที่จัดเก็บไว้ รวมถึงรายงานที่เก็บไว้ซึ่งเกี่ยวข้องกัน
- รับข้อความค้นหา
- ดึงการค้นหาที่จัดเก็บไว้
- รายการ
- ดึงการค้นหาที่จัดเก็บไว้
- เรียกใช้คําค้นหา
- เรียกใช้การค้นหาที่จัดเก็บไว้เพื่อสร้างรายงาน