Method: accounts.propertyPerformanceReportViews.query

امکان پرس‌وجو (دریافت، فیلتر و بخش‌بندی) گزارش لینک‌های رزرو رایگان برای یک حساب کاربری خاص را فراهم می‌کند. این نسخه جدید، تعداد نمایش‌ها و کلیک‌ها و همچنین مجموعه‌ای بسیار بزرگتر از فیلترها/جمع‌بندی‌ها را برمی‌گرداند.

درخواست HTTP

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

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

پارامترهای مسیر

پارامترها
name

string

نام منبع حساب کاربری مورد نظر. قالب: accounts/{account_id}

پارامترهای پرس و جو

پارامترها
filter

string

شرط‌ها (فیلدها و عبارات) مورد استفاده برای فیلتر کردن معیارهای عملکرد ویژگی برای حسابی که مورد پرس و جو قرار می‌گیرد. این سینتکس به فاصله در اطراف عملگر in نیاز دارد. در غیر این صورت، می‌توان فاصله‌ها را حذف کرد. شرط‌ها را می‌توان با استفاده از عملگر AND به هم متصل کرد.

مهم: سینتکس صحیح برای اضافه کردن چندین شرط به این صورت است: "?filter=<condition>=<value>%20AND%20<condition>=<value>..."

فیلد date الزامی است. سایر فیلدها اختیاری هستند.

The date field values are inclusive and must be in YYYY-MM-DD format. The earliest acceptable date is 2021-03-09; earlier date values will be coerced to 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

حداکثر تعداد نتایج مشارکت برای بازگشت. سرویس ممکن است کمتر از این مقدار را برگرداند. در صورت عدم تعیین، حداکثر ۱۰۰۰۰ نتیجه بازگردانده خواهد شد. حداکثر مقدار ۱۰۰۰۰ است؛ مقادیر بالاتر از ۱۰۰۰۰ به ۱۰۰۰۰ کاهش می‌یابد.

pageToken

string

یک توکن صفحه، که از درخواست قبلی partnershipReportViews.query دریافت شده است. برای دریافت صفحه بعدی، این توکن را ارائه دهید.

هنگام صفحه‌بندی، تمام پارامترهای دیگر ارائه شده به partnershipReportViews.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 .

نتیجه عملکرد ویژگی

نتیجه‌ی حاصل از جستجوی گزارش عملکرد دارایی برای یک حساب را نشان می‌دهد.

نمایش 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)

تعداد کل کلیک‌ها روی دکمه «وب‌سایت» در گوگل برای اجاره خانه برای تعطیلات.

پنجره رزرو پیشرفته

پنجره‌های رزرو از پیش پشتیبانی‌شده (ABW) را فهرست می‌کند. همه مقایسه‌های تاریخ در منطقه زمانی ملک هستند.

انوم‌ها
ADVANCE_BOOKING_WINDOW_UNSPECIFIED مشخص نشده است.
ADVANCE_BOOKING_WINDOW_SAME_DAY تاریخ ورود با تاریخ استعلام یکی بود.
ADVANCE_BOOKING_WINDOW_NEXT_DAY تاریخ ورود، روز بعد از تاریخ استعلام بود.
ADVANCE_BOOKING_WINDOW_DAYS_2_TO_7 تاریخ ورود ۲ تا ۷ روز پس از تاریخ استعلام بود.
ADVANCE_BOOKING_WINDOW_DAYS_8_TO_14 تاریخ ورود ۸ تا ۱۴ روز پس از تاریخ استعلام بود.
ADVANCE_BOOKING_WINDOW_DAYS_15_TO_30 تاریخ ورود ۱۵ تا ۳۰ روز پس از تاریخ استعلام بود.
ADVANCE_BOOKING_WINDOW_DAYS_31_TO_60 تاریخ ورود ۳۱ تا ۶۰ روز پس از تاریخ استعلام بود.
ADVANCE_BOOKING_WINDOW_DAYS_61_TO_90 تاریخ ورود ۶۱ تا ۹۰ روز پس از تاریخ استعلام بود.
ADVANCE_BOOKING_WINDOW_DAYS_91_TO_120 تاریخ ورود ۹۱ تا ۱۲۰ روز پس از تاریخ استعلام بود.
ADVANCE_BOOKING_WINDOW_DAYS_121_TO_150 تاریخ ورود ۱۲۱ تا ۱۵۰ روز پس از تاریخ استعلام بود.
ADVANCE_BOOKING_WINDOW_DAYS_151_TO_180 تاریخ ورود ۱۵۱ تا ۱۸۰ روز پس از تاریخ استعلام بود.
ADVANCE_BOOKING_WINDOW_DAYS_OVER_180 تاریخ ورود بیش از ۱۸۰ روز پس از تاریخ درخواست بوده است.

مدت اقامت

مدت زمان اقامت (LOS) پشتیبانی شده را شمارش می‌کند.

انوم‌ها
LENGTH_OF_STAY_UNSPECIFIED مشخص نشده است.
LENGTH_OF_STAY_NIGHTS_1 اقامت تک شب.
LENGTH_OF_STAY_NIGHTS_2 مدت اقامت ۲ شب.
LENGTH_OF_STAY_NIGHTS_3 مدت اقامت ۳ شب.
LENGTH_OF_STAY_NIGHTS_4_TO_7 مدت اقامت ۴ تا ۷ شب.
LENGTH_OF_STAY_NIGHTS_8_TO_14 مدت اقامت ۸ تا ۱۴ شب
LENGTH_OF_STAY_NIGHTS_15_TO_21 مدت اقامت ۱۵ تا ۲۱ شب
LENGTH_OF_STAY_NIGHTS_22_TO_30 مدت اقامت ۲۲ تا ۳۰ شب
LENGTH_OF_STAY_NIGHTS_OVER_30 اقامت بیش از 30 شب.

اشغال

تعداد کل اشغال اتاق پشتیبانی شده را شمارش می‌کند.

انوم‌ها
OCCUPANCY_UNSPECIFIED مشخص نشده است.
OCCUPANCY_1 فرد مجرد.
OCCUPANCY_2 دو نفر.
OCCUPANCY_3 سه نفر.
OCCUPANCY_4 چهار نفر.
OCCUPANCY_OVER_4 بالای ۴ نفر.