Method: accounts.freeBookingLinksReportViews.query

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

درخواست HTTP

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

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

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

پارامترها
name

string

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

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

پارامترها
filter

string

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

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

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

مقادیر مربوط به 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

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

pageToken

string

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

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

لینک‌های رزرو رایگاننتیجه

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

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

object ( Date )

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

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

userRegionCode

string

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

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

deviceType

enum ( Device )

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

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

partnerHotelId

string

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

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

partnerHotelDisplayName

string

نام هتل شریک.

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

clickCount

string ( int64 format)

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