Method: accounts.participationReportViews.query

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

درخواست HTTP

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

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

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

پارامترها
name

string

نام منبع حساب کاربری مورد جستجو. فرمت آن accounts/{account_id} است.

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

پارامترها
filter

string

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

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

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

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

  • advanceBookingWindow = 2
  • advanceBookingWindow >= 0
  • advanceBookingWindow <= 5
  • checkinDate = '2020-10-01'
  • checkinDate >= '2020-10-01'
  • checkinDate <= '2020-10-01'
  • checkinDate between '2020-10-01' and '2020-10-05'
  • date = '2020-02-04'
  • date between '2020-02-04' and '2020-02-09'
  • deviceType = 'TABLET'
  • deviceType in ('MOBILE', 'TABLET')
  • hotelRegionCode = 'US'
  • hotelRegionCode in ('US', 'CA')
  • lengthOfStayDays = 2
  • lengthOfStayDays >= 0
  • lengthOfStayDays <= 5
  • occupancy = 2
  • occupancy >= 0
  • occupancy <= 5
  • occupancy between 1 and 5
  • partnerHotelId = 'AAA'
  • partnerHotelId in ('AAA', 'BBB')
  • userRegionCode = 'US'
  • userRegionCode in ('US', 'CA')
aggregateBy

string

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

مقدار رشته‌ای، فهرستی از فیلدها است که با کاما از هم جدا شده‌اند. فیلدهای معتبر عبارتند از: date ، userRegionCode ، deviceType ، partnerHotelId ، hotelRegionCode ، advanceBookingWindow ، lengthOfStayDays ، checkinDate و occupancy . فیلدهایی که مشخص نشده باشند، در ParticipationResult لحاظ نمی‌شوند.

مهم : استفاده از پارامتر aggregateBy با partnerHotelId یا بیش از دو مقدار می‌تواند منجر به خطا شود. فیلتر کردن با partnerHotelId و date برای کاهش تعداد ردیف‌ها می‌تواند از بروز خطاها جلوگیری کند.

pageSize

integer

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

pageToken

string

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

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

درخواست بدنه

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

بدنه پاسخ

پیام پاسخ برای ParticipationReportService.QueryParticipationReport .

در صورت موفقیت، بدنه پاسخ شامل داده‌هایی با ساختار زیر است:

نمایش JSON 
{
  "results": [
    {
      object (ParticipationResult)
    }
  ],
  "nextPageToken": string
}
فیلدها
results[]

object ( ParticipationResult )

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

nextPageToken

string

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

دامنه‌های مجوز

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

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

برای اطلاعات بیشتر، بهOAuth 2.0 Overview .

نتیجه مشارکت

نتیجه‌ای از جستجوی آمار مشارکت برای یک حساب کاربری را نشان می‌دهد.

نمایش JSON 
{
  "key": {
    object (Key)
  },
  "opportunityCount": string,
  "participationCount": string,
  "participationPercent": number,
  "missedParticipationCount": string,
  "missedParticipationCountDetails": {
    object (MissedParticipationCountDetails)
  },
  "partnerHotelDisplayName": string
}
فیلدها
key

object ( Key )

کلید نتیجه.

opportunityCount

string ( int64 format)

برای یک هتل خاص، تعداد کل فرصت‌های موجود. فرصت‌ها تعداد کل مواردی هستند که یک تبلیغ هتل می‌توانست به کاربر نمایش داده شود.

participationCount

string ( int64 format)

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

participationPercent

number

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

missedParticipationCount

string ( int64 format)

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

  • صفحه فرود وجود ندارد
  • قیمت موجود نیست
  • مشکل قیمت
  • قیمت موجود نیست
  • دیگر
missedParticipationCountDetails

object ( MissedParticipationCountDetails )

دلایلی که در تعداد شرکت‌کنندگان از دست رفته نقش داشته‌اند (برای مثال، عدم حضور) و تعداد کل هر دلیل.

partnerHotelDisplayName

string

نام نمایشی هتل همکار. این فیلد فقط زمانی پر می‌شود که نتیجه توسط partnerHotelId تجمیع شود.

کلید

کلید یک نتیجه.

نمایش JSON 
{
  "date": {
    object (Date)
  },
  "userRegionCode": string,
  "deviceType": enum (Device),
  "partnerHotelId": string,
  "hotelRegionCode": string,
  "advanceBookingWindow": integer,
  "lengthOfStayDays": integer,
  "checkinDate": {
    object (Date)
  },
  "occupancy": integer
}
فیلدها
date

object ( Date )

تاریخی که برای آن درخواست معیارها را دارید.

اگر date مقداری از پارامتر aggregateBy در فراخوانی درخواست نباشد، فیلد date در Key برگردانده نمی‌شود.

userRegionCode

string

ISO 3116 region code of the country/region of the user.

اگر userRegionCode مقداری از پارامتر aggregateBy در فراخوانی درخواست نباشد، فیلد userRegionCode در Key برگردانده نمی‌شود.

deviceType

enum ( Device )

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

اگر deviceType مقداری از پارامتر aggregateBy در فراخوانی درخواست نباشد، فیلد deviceType در Key برگردانده نمی‌شود.

partnerHotelId

string

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

اگر partnerHotelId مقداری از پارامتر aggregateBy در فراخوانی درخواست نباشد، آنگاه فیلد partnerHotelId در Key برگردانده نمی‌شود.

hotelRegionCode

string

کد منطقه CLDR کشور/منطقه هتل.

اگر hotelRegionCode مقداری از پارامتر aggregateBy در فراخوانی درخواست نباشد، فیلد hotelRegionCode در Key برگردانده نمی‌شود.

advanceBookingWindow

integer

تعداد روزهایی که کاربر می‌خواهد برنامه سفر را از قبل رزرو کند.

اگر advanceBookingWindow مقداری از پارامتر aggregateBy در فراخوانی درخواست نباشد، آنگاه فیلد advanceBookingWindow در Key برگردانده نمی‌شود.

lengthOfStayDays

integer

تعداد شب‌های برنامه سفر.

اگر lengthOfStayDays مقداری از پارامتر aggregateBy در فراخوانی درخواست نباشد، فیلد lengthOfStayDays در Key برگردانده نمی‌شود.

checkinDate

object ( Date )

تاریخ ورود به برنامه سفر.

اگر checkinDate مقداری از پارامتر aggregateBy در فراخوانی درخواست نباشد، فیلد checkinDate در Key برگردانده نمی‌شود.

occupancy

integer

کل ظرفیت برنامه سفر.

اگر occupancy مقداری از پارامتر aggregateBy در فراخوانی درخواست نباشد، فیلد occupancy در Key برگردانده نمی‌شود.

جزئیات تعداد مشارکت از دست رفته

تعداد شرکت‌کنندگان از دست رفته به تفکیک دلیل.

نمایش JSON 
{
  "noAvailabilityCount": string,
  "hotelSuspendedCount": string,
  "noTaxBreakdownCount": string,
  "noLandingPageCount": string,
  "noPriceCount": string,
  "noPriceCountDetails": {
    object (NoPriceCountDetails)
  },
  "otherReasonCount": string,
  "priceMissingCount": string,
  "priceMissingCountDetails": {
    object (PriceMissingCountDetails)
  },
  "priceProblemCount": string,
  "priceProblemCountDetails": {
    object (PriceProblemCountDetails)
  },
  "priceUnavailableCount": string,
  "priceUnavailableCountDetails": {
    object (PriceUnavailableCountDetails)
  }
}
فیلدها
noAvailabilityCount
(deprecated)

string ( int64 format)

تعداد کل شرکت‌کنندگان از دست رفته به دلیل در دسترس نبودن ترکیب هتل/برنامه سفر، یا واجد شرایط نبودن مسافر برای نرخ‌ها. برای شرکت در این مزایده‌ها، ممکن است لازم باشد اطلاعات قیمت‌گذاری بیشتری ارائه دهید.

hotelSuspendedCount
(deprecated)

string ( int64 format)

تعداد کل شرکت‌کنندگان از دست رفته به دلیل تعلیق یک یا چند هتل شما به دلیل نقض دقت قیمت.

noTaxBreakdownCount
(deprecated)

string ( int64 format)

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

noLandingPageCount

string ( int64 format)

هیچ صفحه فرودی با کاربر مطابقت نداشت.

noPriceCount
(deprecated)

string ( int64 format)

تعداد کل شرکت‌کنندگان از دست رفته به دلیل عدم ارائه قیمت برای برنامه سفر درخواستی.

noPriceCountDetails
(deprecated)

object ( NoPriceCountDetails )

دلایلی که باعث عدم شمارش قیمت شده‌اند (برای مثال، عدم دسترسی به قیمت‌گذاری زنده) و تعداد کل برای هر دلیل.

otherReasonCount

string ( int64 format)

هتل به دلیل نامعلومی شرکت نکرد.

priceMissingCount

string ( int64 format)

تعداد کل مشارکت‌های از دست رفته به دلیل عدم وجود قیمت در حافظه پنهان گوگل یا عدم پاسخگویی موفق به قیمت‌گذاری زنده. شامل موارد زیر است:

  • پهنای باند تمام شد
  • نرخ حافظه پنهان وجود ندارد
  • برنامه سفر مسدود شده است
  • قیمت‌گذاری زنده تنظیم نشده است
  • مهلت قیمت‌گذاری زنده به پایان رسید
  • خطای قیمت‌گذاری زنده
priceMissingCountDetails

object ( PriceMissingCountDetails )

دلایلی که در شمارش از دست رفته قیمت نقش داشته‌اند.

priceProblemCount

string ( int64 format)

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

  • هتل به حالت تعلیق درآمد
  • قیمت به طور غیرمعمول بالا
  • قیمت به طور غیرمعمول پایین است
  • مالیات و خوراک گم شده است
priceProblemCountDetails

object ( PriceProblemCountDetails )

دلایلی که در ایجاد مشکل قیمت نقش داشته‌اند، عبارتند از:

priceUnavailableCount

string ( int64 format)

تعداد کل شرکت‌کنندگان از دست رفته به دلیل قیمت ذکر شده به عنوان "ناموجود" (-1) برای برنامه سفر درخواستی. شامل موارد زیر است:

  • قیمت موجود نیست
  • مشارکت بعید است
  • دیگر
priceUnavailableCountDetails

object ( PriceUnavailableCountDetails )

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

جزئیات بدون قیمت

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

نمایش JSON 
{
  "livePricingTechnicalIssueCount": string,
  "livePricingNotTriggeredCount": string,
  "livePricingConfigIssueCount": string,
  "livePricingNotAvailableCount": string,
  "livePricingOtherReasonCount": string
}
فیلدها
livePricingTechnicalIssueCount

string ( int64 format)

تعداد کل شرکت‌کنندگان از دست رفته به دلیل مشکلات فنی در قیمت‌گذاری زنده به هر یک از دلایل زیر:

  • شما به اندازه کافی سریع پاسخ ندادید و از مهلت پاسخ (حدود ۴۰۰۰ میلی‌ثانیه) فراتر رفتید.
  • شما یک خطا را برگرداندید.
  • پاسخ شما ناقص و ناقص بود.
livePricingNotTriggeredCount

string ( int64 format)

تعداد کل مشارکت‌های از دست رفته به دلیل عدم فعال شدن قیمت‌گذاری زنده به هر یک از دلایل زیر:

  • شما پیشنهادی تعیین نکردید.
  • شما صفحه فرود معتبری نداشتید.
  • قیمت‌های کافی در حافظه پنهان وجود نداشت.
livePricingConfigIssueCount

string ( int64 format)

تعداد کل مشارکت‌های از دست رفته به دلیل عدم فعال شدن قیمت‌گذاری زنده به هر یک از دلایل زیر:

  • شما برای این جستجوها قیمت‌گذاری زنده را پیکربندی نکرده‌اید.
  • شما دسترسی گوگل به برنامه سفر هتل مورد نظر را محدود کرده‌اید.
livePricingNotAvailableCount

string ( int64 format)

تعداد کل شرکت‌کنندگان از دست رفته به دلیل عدم دسترسی به قیمت‌گذاری زنده. قیمت‌گذاری زنده برای برخی از برنامه‌های سفر یا رابط‌های کاربری پیش‌فرض فعال نمی‌شود. در این سناریو، شرکا برای شرکت به قیمت ذخیره‌شده نیاز دارند.

livePricingOtherReasonCount

string ( int64 format)

تعداد مشارکت‌های از دست رفته به دلیل سایر مشکلات مربوط به قیمت‌گذاری زنده.

جزئیات تعداد قیمت‌های از دست رفته

دلایلی که در تعداد قیمت‌های از دست رفته نقش داشته‌اند و تعداد کل برای هر دلیل.

نمایش JSON 
{
  "cacheRateMissingCount": string,
  "itineraryBlockedCount": string,
  "livePricingNotSetupCount": string,
  "bandwidthDepletedCount": string,
  "livePricingTimeoutCount": string,
  "livePricingErrorCount": string
}
فیلدها
cacheRateMissingCount

string ( int64 format)

هیچ قیمتی برای این برنامه سفر در حافظه پنهان وجود ندارد. به دلیل محدودیت‌های صفحه، جستجوی زنده انجام نشد.

itineraryBlockedCount

string ( int64 format)

برنامه سفر خارج از پارامترهای اساسی شما بود، بنابراین هیچ قیمتی برای برنامه سفر از طریق پرس و جوی زنده یا پر کردن حافظه پنهان استخراج نشد.

livePricingNotSetupCount

string ( int64 format)

هیچ قیمتی برای این برنامه سفر ذخیره نشده است و جستجوی زنده برای این حساب پیکربندی نشده است.

bandwidthDepletedCount

string ( int64 format)

هیچ قیمتی برای این برنامه سفر ذخیره نشده بود و سهمیه‌ای برای درخواست‌های زنده باقی نمانده بود.

livePricingTimeoutCount

string ( int64 format)

هیچ قیمتی برای این برنامه سفر ذخیره نشده است و مهلت ارسال درخواست زنده به سیستم شما به پایان رسیده است.

livePricingErrorCount

string ( int64 format)

هیچ قیمتی برای این برنامه سفر ذخیره نشده است. یک پرس و جوی زنده به پایان نرسید، اما سیستم شما خطایی را نشان داد.

جزئیات تعداد مشکل قیمت

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

نمایش JSON 
{
  "hotelSuspendedCount": string,
  "priceUnusuallyHighCount": string,
  "priceUnusuallyLowCount": string,
  "taxesAndFeesMissingCount": string,
  "basePriceViolationsCount": string,
  "priceAccuracyIssueCount": string
}
فیلدها
hotelSuspendedCount

string ( int64 format)

هتل به حالت تعلیق درآمد. این ممکن است به دلیل مشکلات مداوم در زمینه‌هایی مانند مالیات و هزینه‌های نادرست باشد.

priceUnusuallyHighCount

string ( int64 format)

قیمتی که برای این برنامه سفر در نظر گرفته شده بود، در مقایسه با روندهای منطقه‌ای، به طرز عجیبی بالا به نظر می‌رسید.

priceUnusuallyLowCount

string ( int64 format)

قیمتی که برای این برنامه سفر در نظر گرفته شده بود، در مقایسه با روندهای منطقه‌ای، به طرز عجیبی پایین به نظر می‌رسید.

taxesAndFeesMissingCount

string ( int64 format)

مالیات و هزینه‌ها از قیمت‌گذاری حذف شده بودند.

basePriceViolationsCount

string ( int64 format)

قیمت پایه نسبت به قیمت کل خیلی پایینه.

priceAccuracyIssueCount

string ( int64 format)

مشکل دقت قیمت

قیمتناموجودتعدادجزئیات

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

نمایش JSON 
{
  "priceUnavailableCount": string,
  "participationNotLikelyCount": string
}
فیلدها
priceUnavailableCount

string ( int64 format)

هتل شرکت نکرد زیرا برای تاریخ‌های برنامه سفر جا نداشت.

participationNotLikelyCount

string ( int64 format)

هیچ قیمتی برای این برنامه سفر ذخیره نشده است و هیچ درخواست زنده‌ای انجام نشده است زیرا سرور شما معمولاً به ما می‌گوید که هتل در دسترس نیست یا تمام شده است.