- درخواست HTTP
- پارامترهای مسیر
- پارامترهای پرس و جو
- درخواست بدن
- بدن پاسخگو
- محدوده مجوز
- PropertyPerformanceResult
- پنجره AdvanceBooking
- مدت اقامت
- تصرف
امکان پرس و جو (دریافت، فیلتر کردن، و بخش بندی) گزارش پیوندهای عملکرد دارایی را برای یک حساب خاص فراهم می کند.
درخواست HTTP
GET https://travelpartner.googleapis.com/v3/{name=accounts/*}/propertyPerformanceReportViews:query
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
مولفه های | |
---|---|
name | نام منبع حساب مورد نظر. قالب: حسابها/{account_id} |
پارامترهای پرس و جو
مولفه های | |
---|---|
filter | شرایط (فیلدها و عبارات) مورد استفاده برای فیلتر کردن معیارهای عملکرد دارایی برای حساب مورد نظر. سینتکس به فضاهایی در اطراف عملگر فیلد مقادیر فیلد مقادیر برای نمونه هایی از شرایط معتبر به شرح زیر است:
|
aggregateBy | نحوه تقسیم بندی معیارهای بازگشتی توسط پرس و جو را مشخص می کند. به عنوان مثال، اگر مقدار رشته لیستی از فیلدها است که با کاما از هم جدا شده اند. فیلدهای معتبر عبارتند از: |
pageSize | حداکثر تعداد نتایج مشارکت برای بازگشت. این سرویس ممکن است کمتر از این مقدار را بازگرداند. اگر نامشخص باشد، حداکثر 10000 نتیجه برگردانده می شود. حداکثر مقدار 10000 است. مقادیر بالای 10000 به 10000 اجباری می شود. |
pageToken | یک نشانه صفحه، دریافت شده از یک درخواست مشارکتReportViews.query قبلی. این را برای دریافت صفحه بعدی ارائه دهید. هنگام صفحه بندی، تمام پارامترهای دیگر ارائه شده به ParticipationReportViews.query باید با فراخوانی که نشانه صفحه را ارائه می کند مطابقت داشته باشد. |
درخواست بدن
بدنه درخواست باید خالی باشد.
بدن پاسخگو
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
پیام پاسخ برای PropertyPerformanceReportService.QueryPropertyPerformanceReport
.
نمایندگی JSON |
---|
{
"results": [
{
object ( |
زمینه های | |
---|---|
results[] | فهرست نتایجی که با پرس و جو مطابقت دارند. |
nextPageToken | نشانه صفحه بندی برای بازیابی صفحه بعدی نتایج استفاده می شود. اگر این قسمت حذف شود، هیچ صفحه بعدی وجود ندارد. |
محدوده مجوز
به محدوده OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/travelpartner
برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.
PropertyPerformanceResult
نشان دهنده نتیجه پرس و جو برای گزارش عملکرد دارایی برای یک حساب است.
نمایندگی JSON |
---|
{ "date": { object ( |
زمینه های | |
---|---|
date | تاریخی در محدوده تاریخ درخواستی. فقط در صورتی ارائه شود که |
advanceBookingWindow | تفاوت در روزهای بین تاریخ درخواست و تاریخ ورود در منطقه زمانی محلی ملک. فقط در صورتی ارائه شود که |
brand | نام تجاری مشخص شده توسط شریک برای ملک. فقط در صورتی ارائه شود که |
deviceType | نوع دستگاه کاربر فقط در صورتی ارائه می شود که |
highIntentUsers | آیا درخواست کاربر نشان دهنده علاقه شدید به رزرو است یا خیر. فقط در صورتی ارائه می شود که |
lengthOfStay | تعداد شب های بین تاریخ ورود و خروج که توسط کاربر مشخص شده است. فقط در صورتی ارائه می شود که |
propertyRegionCode | کد منطقه ایزو 3116 کشور/منطقه ملک. فقط در صورتی ارائه شود که |
occupancy | تعداد افرادی که در ملک اقامت دارند درخواست شده است. فقط در صورتی ارائه شود که |
partnerPropertyId | شناسه ملک شریک فقط در صورتی ارائه شود که |
partnerPropertyDisplayName | نام ملک شریک فقط در صورتی ارائه شود که |
userRegionCode | کد منطقه ایزو 3116 کشور/منطقه کاربر. فقط در صورتی ارائه می شود که |
clickCount | تعداد کل کلیک هایی که برای این نتیجه ثبت شد. |
impressionCount | تعداد کل برداشت هایی که برای این نتیجه ثبت شد. این مقدار برای حفظ حریم خصوصی کاربر گرد شده است. |
clickthroughRate | برابر است با |
پنجره AdvanceBooking
پنجرههای رزرو قبلی پشتیبانی شده (ABW) را برمیشمارد. همه مقایسههای تاریخ در منطقه زمانی ملک هستند.
Enums | |
---|---|
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 روز پس از تاریخ درخواست بود. |
مدت اقامت
مدت اقامت پشتیبانی شده (LOS) را برمی شمارد.
Enums | |
---|---|
LENGTH_OF_STAY_UNSPECIFIED | مشخص نشده است. |
LENGTH_OF_STAY_NIGHTS_1 | اقامت یک شبه. |
LENGTH_OF_STAY_NIGHTS_2 | اقامت 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 شب |
تصرف
اشغال کل اتاق پشتیبانی شده را برمی شمارد.
Enums | |
---|---|
OCCUPANCY_UNSPECIFIED | مشخص نشده است. |
OCCUPANCY_1 | شخص مجرد. |
OCCUPANCY_2 | دو نفر. |
OCCUPANCY_3 | سه نفر. |
OCCUPANCY_4 | چهار نفر. |
OCCUPANCY_OVER_4 | بالای 4 نفر |