Method: accounts.propertyPerformanceReportViews.query

توفر إمكانية طلب البحث (الحصول على تقرير أداء روابط الموقع وفلترته وتقسيمه) لحساب معيّن.

طلب HTTP

GET https://travelpartner.googleapis.com/v3/{name=accounts/*}/propertyPerformanceReportViews:query

يستخدم عنوان URL بنية gRPC Transcoding.

معلّمات المسار

المَعلمات
name

string

اسم مورد الحساب الذي يتم البحث عنه التنسيق: حسابات/{account_id}

معامِلات طلب البحث

المَعلمات
filter

string

الشروط (الحقول والتعبيرات) المستخدَمة لفلترة مقاييس أداء المواقع للحساب الذي يتم البحث عنه. تتطلّب البنية تثبيت مسافات حول عامل التشغيل in. وإلا، يمكن حذف المسافات. يمكن ضم الشروط باستخدام عامل التشغيل and.

الحقل date مطلوب. وجميع الحقول الأخرى اختيارية.

قيم الحقل date شاملة، ويجب أن تكون بتنسيق يوم/شهر/سنة. أقرب تاريخ مقبول هو 2021-03-09. سيتم فرض قيم التاريخ السابق في 09-2021.

تُطابق قيم partnerPropertyDisplayName وbrand بشكلٍ غير حساس لحالة الأحرف.

في ما يلي أمثلة على الشروط الصالحة:

  • advanceBookingWindow = 'ADVANCE_BOOKING_WINDOW_SAME_DAY'
  • advanceBookingWindow in ('ADVANCE_BOOKING_WINDOW_SAME_DAY', 'ADVANCE_BOOKING_WINDOW_DAYS_61_TO_90')
  • brand = 'Brand A'
  • brand in ('Brand A', 'brand B')
  • date = '2021-12-03'
  • date between '2021-12-03' and '2021-12-08'
  • deviceType = 'TABLET'
  • deviceType in ('MOBILE', 'TABLET')
  • highIntentUsers = 'TRUE'
  • highIntentUsers = 'FALSE'
  • lengthOfStay = 'LENGTH_OF_STAY_NIGHTS_2'
  • lengthOfStay in ('LENGTH_OF_STAY_NIGHTS_2', 'LENGTH_OF_STAY_NIGHTS_4_TO_7')
  • propertyRegionCode = 'US'
  • propertyRegionCode in ('US', 'CA')
  • occupancy = 'OCCUPANCY_2'
  • occupancy in ('OCCUPANCY_2', 'OCCUPANCY_OVER_4')
  • partnerPropertyId = 'AAA'
  • partnerPropertyId in ('AAA', 'BBB')
  • partnerPropertyDisplayName = 'hotel A'
  • partnerPropertyDisplayName in ('Hotel A', 'HOTEL b')
  • userRegionCode = 'US'
  • userRegionCode in ('US', 'CA')
aggregateBy

string

تحدّد كيفية تقسيم المقاييس التي يعرضها الطلب. على سبيل المثال، إذا تم تحديد userRegionCode، سيوفر PropertyPerformanceResult مقاييس مجمّعة حسب منطقة المستخدم.

قيمة السلسلة هي قائمة من الحقول مفصولة بفواصل. الحقول الصالحة هي: advanceBookingWindow وbrand وdate وdeviceType وhighIntentUsers وlengthOfStay وpropertyRegionCode وoccupancy وpartnerPropertyId وpartnerPropertyDisplayName وuserRegionCode. يتم فقط تضمين الحقول المحدّدة هنا في Propertyالأداءنتيجة.
pageSize

integer

الحد الأقصى لعدد نتائج المشاركة التي يمكن عرضها. قد تعرض الخدمة قيمة أقل من هذه القيمة. وفي حال عدم تحديدها، سيتم عرض 10,000 نتيجة على الأكثر. الحد الأقصى للقيمة هو 10000، وسيتم فرض القيم التي تزيد على 10000 على 10000.
pageToken

string

رمز مميز للصفحة، تم استلامه من طلب مشارك سابق في ReportViews.query. قدِّم هذا العنوان لاستلام الصفحة التالية.

عند التقسيم على صفحات، يجب أن تتطابق جميع المعلّمات الأخرى المقدَّمة إلى reviewReports.query مع المكالمة التي وفرت الرمز المميز للصفحة.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

رسالة الرد لـ PropertyPerformanceReportService.QueryPropertyPerformanceReport.

تمثيل JSON 
{
  "results": [
    {
      object (PropertyPerformanceResult)
    }
  ],
  "nextPageToken": string
}
الحقول
results[]

object (PropertyPerformanceResult)

قائمة النتائج التي تطابق طلب البحث
nextPageToken

string

يُستخدم الرمز المميّز للتقسيم على صفحات لاسترداد الصفحة التالية من النتائج. في حال حذف هذا الحقل، لن تكون هناك صفحات لاحقة.

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/travelpartner

للحصول على مزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على OAuth 2.0.

نتيجة أداء الموقع

يمثّل نتيجة طلب البحث عن تقرير أداء الموقع في حساب.

تمثيل JSON 
{
  "date": {
    object (Date)
  },
  "advanceBookingWindow": enum (AdvanceBookingWindow),
  "brand": string,
  "deviceType": enum (Device),
  "highIntentUsers": boolean,
  "lengthOfStay": enum (LengthOfStay),
  "propertyRegionCode": string,
  "occupancy": enum (Occupancy),
  "partnerPropertyId": string,
  "partnerPropertyDisplayName": string,
  "userRegionCode": string,
  "clickCount": string,
  "impressionCount": string,
  "clickthroughRate": number
}
الحقول
date

object (Date)

تاريخ في النطاق الزمني المطلوب

لا تتوفر هذه السمة إلا إذا تم تحديد date في aggregateBy في الطلب.
advanceBookingWindow

enum (AdvanceBookingWindow)

الفرق بين الأيام بين تاريخ طلب البحث وتاريخ تسجيل الوصول في المنطقة الزمنية المحلية للموقع.

لا تتوفر هذه السمة إلا إذا تم تحديد advanceBookingWindow في aggregateBy في الطلب.
brand

string

العلامة التجارية التي يحدّدها الشريك للموقع

لا تتوفر هذه السمة إلا إذا تم تحديد brand في aggregateBy في الطلب.
deviceType

enum (Device)

نوع جهاز المستخدم

لا تتوفر هذه السمة إلا إذا تم تحديد deviceType في aggregateBy في الطلب.
highIntentUsers

boolean

ما إذا كان طلب بحث المستخدم أشار إلى اهتمام كبير بالحجز.

لا تتوفر هذه السمة إلا إذا تم تحديد highIntentUsers في aggregateBy في الطلب.
lengthOfStay

enum (LengthOfStay)

عدد الليالي بين تواريخ تسجيل الوصول والمغادرة التي يحدّدها المستخدم.

لا تتوفر هذه السمة إلا إذا تم تحديد lengthOfStay في aggregateBy في الطلب.
propertyRegionCode

string

رمز منطقة ISO 3116 للبلد/المنطقة من الموقع.

لا تتوفر هذه السمة إلا إذا تم تحديد propertyRegionCode في aggregateBy في الطلب
occupancy

enum (Occupancy)

عدد الأشخاص المقيمين في الفندق المطلوب

لا تتوفر هذه السمة إلا إذا تم تحديد partnerPropertyId في aggregateBy في الطلب.
partnerPropertyId

string

رقم تعريف موقع الشريك.

لا تتوفر هذه السمة إلا إذا تم تحديد partnerPropertyId في aggregateBy في الطلب.
partnerPropertyDisplayName

string

اسم موقع الشريك.

لا تتوفر هذه السمة إلا إذا تم تحديد partnerPropertyDisplayName في aggregateBy في الطلب.
userRegionCode

string

رمز منطقة ISO 3116 لبلد/منطقة المستخدم.

لا تتوفر هذه السمة إلا إذا تم تحديد userRegionCode في aggregateBy في الطلب
clickCount

string (int64 format)

إجمالي عدد النقرات التي تم تسجيلها لهذه النتيجة.
impressionCount

string (int64 format)

إجمالي عدد مرات الظهور التي تم تسجيلها لهذه النتيجة. يتم تقريب هذه القيمة للحفاظ على خصوصية المستخدم.
clickthroughRate

number

يساوي clickCount مقسومًا على impressionCount.

تذكرة AdvanceBookingWindow

تعداد نوافذ الحجز المسبق المتاحة (ABW). تستند جميع مقارنات التاريخ إلى المنطقة الزمنية للموقع.

عمليات التعداد
ADVANCE_BOOKING_WINDOW_UNSPECIFIED غير محدد
ADVANCE_BOOKING_WINDOW_SAME_DAY تاريخ تسجيل الوصول هو نفسه تاريخ طلب البحث.
ADVANCE_BOOKING_WINDOW_NEXT_DAY كان تاريخ تسجيل الوصول في اليوم التالي بعد تاريخ طلب البحث.
ADVANCE_BOOKING_WINDOW_DAYS_2_TO_7 كان تاريخ تسجيل الوصول بعد تاريخ يومين إلى 7 أيام من تاريخ طلب البحث.
ADVANCE_BOOKING_WINDOW_DAYS_8_TO_14 كان تاريخ تسجيل الوصول بعد 8-14 يومًا من تاريخ طلب البحث.
ADVANCE_BOOKING_WINDOW_DAYS_15_TO_30 كان تاريخ تسجيل الوصول بعد 15 إلى 30 يومًا من تاريخ طلب البحث.
ADVANCE_BOOKING_WINDOW_DAYS_31_TO_60 كان تاريخ تسجيل الوصول بعد 31 إلى 60 يومًا من تاريخ طلب البحث.
ADVANCE_BOOKING_WINDOW_DAYS_61_TO_90 كان تاريخ تسجيل الوصول بعد 61 إلى 90 يومًا من تاريخ طلب البحث.
ADVANCE_BOOKING_WINDOW_DAYS_91_TO_120 كان تاريخ تسجيل الوصول بعد 91 إلى 120 يومًا من تاريخ طلب البحث.
ADVANCE_BOOKING_WINDOW_DAYS_121_TO_150 كان تاريخ تسجيل الوصول بعد 121 إلى 150 يومًا من تاريخ طلب البحث.
ADVANCE_BOOKING_WINDOW_DAYS_151_TO_180 كان تاريخ تسجيل الوصول بعد 151 إلى 180 يومًا من تاريخ طلب البحث.
ADVANCE_BOOKING_WINDOW_DAYS_OVER_180 كان تاريخ تسجيل الوصول بعد أكثر من 180 يومًا من تاريخ طلب البحث.

مدة الإقامة

تعدد مدة الإقامة (LOS) المتاحة.

عمليات التعداد
LENGTH_OF_STAY_UNSPECIFIED غير محدد
LENGTH_OF_STAY_NIGHTS_1 إقامة لمدة ليلة واحدة
LENGTH_OF_STAY_NIGHTS_2 إقامة لمدة ليلتين
LENGTH_OF_STAY_NIGHTS_3 إقامة لمدة 3 ليالٍ
LENGTH_OF_STAY_NIGHTS_4_TO_7 إقامة لمدة تتراوح بين 4 و7 ليالٍ
LENGTH_OF_STAY_NIGHTS_8_TO_14 إقامة لمدة تتراوح بين 8 و14 ليلة
LENGTH_OF_STAY_NIGHTS_15_TO_21 إقامة لمدة تتراوح بين 15 و21 ليلة
LENGTH_OF_STAY_NIGHTS_22_TO_30 إقامة لمدة تتراوح بين 22 و30 ليلةً
LENGTH_OF_STAY_NIGHTS_OVER_30 الإقامة لمدة تزيد عن 30 ليلةً

الإشغال

يشير إلى عدد الإشغال الإجمالي المسموح به في الغرفة.

عمليات التعداد
OCCUPANCY_UNSPECIFIED غير محدد
OCCUPANCY_1 شخص واحد
OCCUPANCY_2 شخصان
OCCUPANCY_3 ثلاثة أشخاص.
OCCUPANCY_4 أربعة أشخاص.
OCCUPANCY_OVER_4 أكثر من 4 أشخاص.