- طلب HTTP
- مَعلمات المسار
- معامِلات طلب البحث
- نص الطلب
- نص الاستجابة
- نطاقات الأذونات
- FreeBookingLinksResult
تم إيقافها نهائيًا: استخدِم PropertyPerformanceReportService.QueryPropertyPerformanceReport بدلاً من ذلك، إذ تتضمّن هذه السمة أيضًا إعداد تقارير عن مرات الظهور. تتيح إمكانية طلب (الحصول على تقرير روابط الحجز المجانية وفلترته وتقسيمه) لحساب معيّن.
طلب HTTP
GET https://travelpartner.googleapis.com/v3/{name=accounts/*}/freeBookingLinksReportViews:query
يستخدم عنوان URL بنية تحويل الترميز إلى gRPC.
مَعلمات المسار
| المعلمات | |
|---|---|
name |
اسم مورد الحساب الذي يتمّ طلب البحث عنه. التنسيق: accounts/{account_id} |
مَعلمات طلب البحث
| المعلمات | |
|---|---|
filter |
الشروط (الحقول والعبارات) المستخدَمة لفلترة مقاييس رابط الحجز المجاني للحساب الذي يتم الاستعلام عنه تتطلّب بنية الجملة مسافات تحيط بالعامل يجب ملء حقل تكون قيم الحقل تتم مطابقة قيم في ما يلي أمثلة على الشروط الصالحة:
|
aggregateBy |
تحدّد هذه السمة كيفية تقسيم المقاييس التي يعرضها طلب البحث. على سبيل المثال، إذا تم تحديد قيمة السلسلة هي قائمة حقول مفصولة بفواصل. الحقول الصالحة هي: |
pageSize |
الحد الأقصى لعدد نتائج المشاركة التي سيتم عرضها قد تعرض الخدمة عددًا أقل من هذه القيمة. إذا لم يتم تحديدها، سيتم عرض 10,000 نتيجة كحدّ أقصى. الحد الأقصى للقيمة هو 10,000، وسيتم فرض القيمة 10,000 على القيم الأكبر من 10,000. |
pageToken |
رمز مميّز للصفحة تم تلقّيه من طلب سابق من طلبات participationReportViews.query. يجب تقديم هذا الرمز لتلقّي الصفحة التالية. عند تقسيم النتائج إلى صفحات، يجب أن تتطابق جميع المَعلمات الأخرى المقدَّمة إلى participationReportViews.query مع الطلب الذي قدّم رمز الصفحة المميّز. |
نص الطلب
يجب أن يكون نص الطلب فارغًا.
نص الاستجابة
تم إيقافها نهائيًا: استخدِم QueryPropertyPerformanceReportResponse مع PropertyPerformanceReportService بدلاً من ذلك. رسالة الردّ على FreeBookingLinksReportService.QueryFreeBookingLinksReport
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
| تمثيل JSON |
|---|
{
"results": [
{
object ( |
| الحقول | |
|---|---|
results[] |
قائمة النتائج المطابقة لطلب البحث |
nextPageToken |
رمز مميّز للتقسيم على صفحات يُستخدَم لاسترداد الصفحة التالية من النتائج. في حال حذف هذا الحقل، لن تكون هناك صفحات لاحقة. |
نطاقات الأذونات
يجب توفير نطاق OAuth التالي:
https://www.googleapis.com/auth/travelpartner
لمزيد من المعلومات، يُرجى الاطّلاع على OAuth 2.0 Overview.
FreeBookingLinksResult
تم إيقافها نهائيًا: استخدِم PropertyPerformanceResult مع PropertyPerformanceReportService بدلاً من ذلك. تمثّل هذه السمة نتيجة طلب البحث عن إحصاءات الروابط المجانية للحجز الخاصة بحساب معيّن.
| تمثيل JSON |
|---|
{ "date": { object ( |
| الحقول | |
|---|---|
date |
تاريخ ضمن النطاق الزمني المطلوب يتم عرضها فقط إذا تم تحديد |
userRegionCode |
تمثّل هذه السمة رمز المنطقة وفقًا لمعيار ISO 3116 الخاص ببلد المستخدِم أو منطقته. لا تظهر إلا إذا تم تحديد |
deviceType |
نوع جهاز المستخدم يتم عرضها فقط إذا تم تحديد |
partnerHotelId |
رقم تعريف الفندق الشريك يتم عرضها فقط إذا تم تحديد |
partnerHotelDisplayName |
اسم الفندق الخاص بالشريك يتم عرضها فقط إذا تم تحديد |
clickCount |
تمثّل هذه السمة إجمالي عدد النقرات التي تم تسجيلها لهذه النتيجة. |