Method: accounts.freeBookingLinksReportViews.query

منسوخ شده: به جای آن از PropertyPerformanceReportService.QueryPropertyPerformanceReport استفاده کنید که دارای گزارش نمایش نیز است. امکان پرس و جو (دریافت، فیلتر کردن، و بخش بندی) یک گزارش پیوندهای رزرو رایگان برای یک حساب خاص را فراهم می کند.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

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

مولفه های
name

string

نام منبع حساب مورد نظر. قالب: حساب‌ها/{account_id}

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

مولفه های
filter

string

شرایط (فیلدها و عبارات) مورد استفاده برای فیلتر کردن معیارهای پیوند رزرو رایگان برای حساب مورد نظر. سینتکس به فضاهایی در اطراف عملگر in نیاز دارد. در غیر این صورت، فاصله ها را می توان حذف کرد. شرایط را می توان با استفاده از عملگر and وصل کرد.

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

مقادیر فیلد date شامل هستند و باید در قالب YYYY-MM-DD باشند. اولین تاریخ قابل قبول 09-03-2021 است. مقادیر تاریخ قبلی به 09-03-2021 تحمیل می شوند.

مقادیر برای partnerHotelDisplayName به حروف بزرگ و کوچک مطابقت دارند.

نمونه هایی از شرایط معتبر به شرح زیر است:

  • date = '2021-12-03'
  • date between '2021-12-03' and '2021-12-08'
  • deviceType = 'TABLET'
  • deviceType in ('MOBILE', 'TABLET')
  • partnerHotelId = 'AAA'
  • partnerHotelId in ('AAA', 'BBB')
  • partnerHotelDisplayName = 'hotel A'
  • partnerHotelDisplayName in ('Hotel A', 'HOTEL b')
  • userRegionCode = 'US'
  • userRegionCode in ('US', 'CA')
aggregateBy

string

نحوه تقسیم بندی معیارهای بازگشتی توسط پرس و جو را مشخص می کند. به عنوان مثال، اگر userRegionCode مشخص شده باشد، freeBookingLinksResult معیارهای جمع‌آوری شده بر اساس منطقه کاربر را ارائه می‌کند.

مقدار رشته لیستی از فیلدها است که با کاما از هم جدا شده اند. فیلدهای معتبر عبارتند از: date ، userRegionCode ، deviceType ، partnerHotelId ، و partnerHotelDisplayName . فقط فیلدهای مشخص شده در اینجا در FreeBookingLinksResult گنجانده شده است.

pageSize

integer

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

pageToken

string

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

هنگام صفحه بندی، تمام پارامترهای دیگر ارائه شده به ParticipationReportViews.query باید با فراخوانی که نشانه صفحه را ارائه می کند مطابقت داشته باشد.

درخواست بدن

بدنه درخواست باید خالی باشد.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

منسوخ شده: به جای آن از QueryPropertyPerformanceReportResponse با PropertyPerformanceReportService استفاده کنید. پیام پاسخ برای FreeBookingLinksReportService.QueryFreeBookingLinksReport .

نمایندگی JSON
{
  "results": [
    {
      object (FreeBookingLinksResult)
    }
  ],
  "nextPageToken": string
}
زمینه های
results[]

object ( FreeBookingLinksResult )

فهرست نتایجی که با پرس و جو مطابقت دارند.

nextPageToken

string

نشانه صفحه بندی برای بازیابی صفحه بعدی نتایج استفاده می شود. اگر این قسمت حذف شود، هیچ صفحه بعدی وجود ندارد.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.

FreeBookingLinks Result

منسوخ شده: به جای آن از PropertyPerformanceResult با PropertyPerformanceReportService استفاده کنید. نشان دهنده نتیجه پرس و جو برای آمار پیوند رزرو رایگان برای یک حساب است.

نمایندگی JSON
{
  "date": {
    object (Date)
  },
  "userRegionCode": string,
  "deviceType": enum (Device),
  "partnerHotelId": string,
  "partnerHotelDisplayName": string,
  "clickCount": string
}
زمینه های
date

object ( Date )

تاریخی در محدوده تاریخ درخواستی.

فقط در صورتی ارائه شود که date به صورت aggregateBy در درخواست مشخص شده باشد.

userRegionCode

string

کد منطقه ایزو 3116 کشور/منطقه کاربر.

فقط در صورتی ارائه می شود که userRegionCode در aggregateBy در درخواست مشخص شده باشد

deviceType

enum ( Device )

نوع دستگاه کاربر

فقط در صورتی نمایش داده شود که deviceType در aggregateBy در درخواست مشخص شده باشد.

partnerHotelId

string

شناسه هتل شریک

فقط در صورتی ارائه شود که partnerHotelId به صورت aggregateBy در درخواست مشخص شده باشد.

partnerHotelDisplayName

string

نام هتل شریک

فقط در صورتی ارائه شود که partnerHotelDisplayName به صورت aggregateBy در درخواست مشخص شده باشد.

clickCount

string ( int64 format)

تعداد کل کلیک هایی که برای این نتیجه ثبت شد.