Method: accounts.propertyPerformanceReportViews.query

تتيح إمكانية طلب (الحصول على تقرير روابط الحجز المجانية وفلترته وتقسيمه) لحساب معيّن. يعرض هذا الإصدار الجديد مرات الظهور والنقرات، بالإضافة إلى مجموعة فرعية أكبر بكثير من الفلاتر/عمليات التجميع.

طلب HTTP

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

يستخدم عنوان URL بنية تحويل الترميز إلى gRPC.

مَعلمات المسار

المعلمات
name

string

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

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

المعلمات
filter

string

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

ملاحظة مهمة: الصيغة الصحيحة لإضافة شروط متعددة هي: "?filter=<condition>=<value>%20AND%20<condition>=<value>..."

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

تكون قيم الحقل date شاملة ويجب أن تكون بالتنسيق YYYY-MM-DD. أول تاريخ مقبول هو 2021-03-09، وسيتم تحويل قيم التاريخ السابقة إلى 2021-03-09.

تتم مطابقة قيم 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. يتم تضمين الحقول المحدّدة هنا فقط في PropertyPerformanceResult.

ملاحظة مهمة: قد يؤدي استخدام المَعلمة aggregateBy مع partnerHotelId أو أكثر من قيمتَين إلى حدوث خطأ. يمكن أن يؤدي الفلترة باستخدام partnerHotelId وdate لتقليل عدد الصفوف إلى منع حدوث الأخطاء.
pageSize

integer

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

string

رمز مميّز للصفحة تم تلقّيه من طلب سابق من طلبات participationReportViews.query. يجب تقديم هذا الرمز لتلقّي الصفحة التالية.

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

نص الطلب

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

نص الاستجابة

رسالة الردّ على PropertyPerformanceReportService.QueryPropertyPerformanceReport

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

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

object (PropertyPerformanceResult)

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

string

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

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

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

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

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

PropertyPerformanceResult

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

تمثيل 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,
  "adsClickCount": string,
  "adsImpressionCount": string,
  "adsClickthroughRate": number,
  "vrWebsiteButtonClicks": string
}
الحقول
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.
adsClickCount

string (int64 format)

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

string (int64 format)

إجمالي عدد مرّات ظهور الإعلان التي تم تسجيلها لهذه النتيجة.
adsClickthroughRate

number

يساوي adsClickCount مقسومًا على adsImpressionCount.
vrWebsiteButtonClicks

string (int64 format)

إجمالي عدد النقرات على الزر "الموقع الإلكتروني" في Google للأماكن المتاحة للاستئجار

AdvanceBookingWindow

تعدّد القيم المسموح بها لفترات الحجز المُسبَق (ABW). تتم جميع مقارنات التواريخ وفقًا للمنطقة الزمنية للموقع.

عمليات التعداد
ADVANCE_BOOKING_WINDOW_UNSPECIFIED لم يتم تحديد أي قيمة.
ADVANCE_BOOKING_WINDOW_SAME_DAY كان تاريخ تسجيل الوصول هو نفسه تاريخ طلب البحث.
ADVANCE_BOOKING_WINDOW_NEXT_DAY كان تاريخ تسجيل الوصول هو اليوم التالي لتاريخ طلب البحث.
ADVANCE_BOOKING_WINDOW_DAYS_2_TO_7 كان تاريخ تسجيل الوصول بعد 2 إلى 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 يومًا من تاريخ البحث.

LengthOfStay

تعدّد مدة الإقامة المتاحة (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 أشخاص