للحصول على قائمة من الطرق لهذا المورد، راجِع نهاية هذه الصفحة.
تمثيلات الموارد
يمثل طلب بحث.
{
"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 Drive لعرض أحدث تقرير. | |
metadata.latestReportRunTimeMs |
long |
الوقت الذي بدأ فيه أحدث تقرير في التشغيل. | |
metadata.locale |
string |
لغة التقارير التي تم إنشاؤها القيم المقبولة هي:
ستنشئ سلسلة لغة غير واردة في القائمة أعلاه تقارير باللغة الإنجليزية. |
|
metadata.reportCount |
integer |
عدد التقارير التي تم إنشاؤها لطلب البحث | |
metadata.running |
boolean |
ما إذا كان التقرير الأخير قيد التشغيل في الوقت الحالي. | |
metadata.sendNotification |
boolean |
يمكنك اختيار ما إذا كنت تريد إرسال إشعار عبر البريد الإلكتروني عندما يكون التقرير جاهزًا. الإعداد التلقائي على "خطأ". | |
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 |
رمز المنطقة الزمنية الأساسي لوقت إنشاء التقرير. وتكون القيمة التلقائية هي America/New_York. |
|
timezoneCode |
string |
رمز المنطقة الزمنية الأساسية لوقت بيانات التقرير. وتكون القيمة التلقائية هي America/New_York. |
الطُرق
- createquery
- يتم إنشاء طلب بحث.
- deletequery
- حذف طلب بحث مخزَّن بالإضافة إلى التقارير المخزَّنة المرتبطة به.
- getquery
- يسترد طلب بحث مخزَّن.
- listqueries
- يسترد طلبات البحث المخزَّنة.
- runquery
- يجري طلب بحث مخزّنًا لإنشاء تقرير.