Method: accounts.participationReportViews.query

توفّر إمكانية طلب (الحصول على تقرير وتقسيمه وتقسيمه) تقرير مشاركة لحساب معيّن.

طلب HTTP

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

يستخدم عنوان URL بنية gRPC Transcoding.

معلّمات المسار

المَعلمات
name

string

اسم مورد الحساب الذي يتم البحث عنه التنسيق هو accounts/{account_id}.

معامِلات طلب البحث

المَعلمات
filter

string

الشروط (الحقول والتعبيرات) المستخدَمة لفلترة مقاييس المشاركة للحساب الذي يتم البحث عنه. تتطلّب البنية تثبيت مسافات حول عامل التشغيل in. وإلا، يمكن حذف المسافات. يمكن ضم الشروط باستخدام عامل التشغيل and.

الحقل date مطلوب. وجميع الحقول الأخرى اختيارية.

في ما يلي أمثلة على الشروط الصالحة:

  • advanceBookingWindow = 2
  • advanceBookingWindow >= 0
  • advanceBookingWindow <= 5
  • advanceBookingWindow between 1 and 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
  • lengthOfStayDays between 1 and 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. لا يتم تضمين الحقول غير المحددة في نتيجة المشاركة.

سيؤدي استخدام مواصفات aggregateBy التي ينتج عنها عدد كبير من الصفوف إلى حدوث خطأ. ينطبق هذا الأمر بشكل خاص على التجميع حسب partnerHotelId أو أكثر من حقلَين. للحد من احتمالية حدوث خطأ، فلتِر البيانات حسب partnerHotelId وdate لتضمين عدد محدّد من الفنادق والتواريخ فقط. ستحتاج الحسابات التي تضمّ عددًا كبيرًا من الفنادق إلى تقليل البيانات بشكل أكبر من خلال فلترة أكبر.

pageSize

integer

الحد الأقصى لعدد نتائج المشاركة التي يمكن عرضها. قد تعرض الخدمة قيمة أقل من هذه القيمة. وفي حال عدم تحديدها، سيتم عرض 10,000 نتيجة على الأكثر. الحد الأقصى للقيمة هو 10000، وسيتم فرض القيم التي تزيد على 10000 على 10000.

pageToken

string

رمز مميز للصفحة، تم استلامه من طلب مشارك سابق في ReportViews.query. قدِّم هذا العنوان لاستلام الصفحة التالية.

عند التقسيم على صفحات، يجب أن تتطابق جميع المعلّمات الأخرى المقدَّمة إلى reviewReports.query مع المكالمة التي وفرت الرمز المميز للصفحة.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

رسالة الرد لـ ParticipationReportService.QueryParticipationReport.

تمثيل JSON
{
  "results": [
    {
      object (ParticipationResult)
    }
  ],
  "nextPageToken": string
}
الحقول
results[]

object (ParticipationResult)

قائمة النتائج التي تطابق طلب البحث

nextPageToken

string

يُستخدم الرمز المميّز للتقسيم على صفحات لاسترداد الصفحة التالية من النتائج.

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

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

للحصول على مزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على OAuth 2.0.

نتيجة المشاركة

ويمثل نتيجة لطلب البحث عن إحصاءات المشاركة لأحد الحسابات.

تمثيل 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)

إجمالي عدد الفرص التي كنت مؤهلاً للدخول فيها في عملية مزاد "إعلانات Google".

participationPercent

number

معدل النسبة المئوية للمشاركة حيث مقسومًا على عدد الفرص التي تمت مشاركتها بنجاح على إجمالي عدد الفرص. على سبيل المثال، إذا كان الموقع مؤهَّلاً للدخول في مزاد "إعلانات Google" 90 مرة من 100 فرصة، تكون نسبة المشاركة 90%.

missedParticipationCount

string (int64 format)

إجمالي عدد الفرص غير المؤهَّلة لعملية المزاد على "إعلانات Google". وتشمل ما يلي:

  • الصفحة المقصودة مفقودة
  • لم يتم إدخال السعر
  • مشكلة في السعر
  • السعر غير متاح
  • غير ذلك
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 لبلد/منطقة المستخدم.

إذا لم يكن 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)

إجمالي عدد المشاركات التي لم يتم تضمينها بسبب عدم توفّر السعر في ذاكرة التخزين المؤقت في Google\u39s أو تعذّر الاستجابة للأسعار المباشرة بنجاح. وتشمل ما يلي:

  • تم استنفاد معدل نقل البيانات
  • معدّل ذاكرة التخزين المؤقت مفقود
  • تم حظر مسار الرحلة
  • لم يتم إعداد السعر المباشر
  • انتهت مهلة التسعير المباشر
  • خطأ في السعر المباشر
priceMissingCountDetails

object (PriceMissingCountDetails)

الأسباب التي ساهمت في عدم تضمين السعر.

priceProblemCount

string (int64 format)

إجمالي عدد المشاركات الفائتة بسبب مشكلة في دقة السعر المقدَّم لبرنامج الرحلة. وتشمل ما يلي:

  • تم تعليق الفندق
  • السعر مرتفع بشكل غير معتاد
  • السعر منخفض بشكل غير معتاد
  • الضرائب والخلاصات غير متوفّرة
priceProblemCountDetails

object (PriceProblemCountDetails)

الأسباب التي ساهمت في احتساب مشكلة السعر

priceUnavailableCount

string (int64 format)

إجمالي عدد المشاركات الفائتة بسبب السعر المدرج على أنه غير متاح (-1) لبرنامج الرحلة المطلوب. وتشمل ما يلي:

  • السعر غير متاح
  • احتمال عدم المشاركة
  • غير ذلك
priceUnavailableCountDetails

object (PriceUnavailableCountDetails)

الأسباب التي ساهمت في ظهور السعر غير المتوفّر.

NoPriceCountDetails

الأسباب التي ساهمت في عدم احتساب السعر والعدد الإجمالي لكل سبب

تمثيل JSON
{
  "livePricingTechnicalIssueCount": string,
  "livePricingNotTriggeredCount": string,
  "livePricingConfigIssueCount": string,
  "livePricingNotAvailableCount": string,
  "livePricingOtherReasonCount": string
}
الحقول
livePricingTechnicalIssueCount

string (int64 format)

إجمالي عدد المشاركات الفائتة بسبب مشاكل فنية في السعر المباشر لأيٍّ من الأسباب التالية:

  • لم تستجب بسرعة كافية وتجاوزت الموعد النهائي للرد (حوالي 4000 مللي ثانية).
  • عرضت رسالة خطأ.
  • ردودك غير صحيحة.
livePricingNotTriggeredCount

string (int64 format)

إجمالي عدد المشاركات الفائتة بسبب عدم عمل الأسعار المباشرة لأيٍّ من الأسباب التالية:

  • لم تُحدِّد عرض سعر.
  • لم تكن لديك صفحة مقصودة صالحة.
  • لم تكن هناك أسعار كافية في ذاكرة التخزين المؤقت.
livePricingConfigIssueCount

string (int64 format)

إجمالي عدد المشاركات الفائتة بسبب عدم عمل الأسعار المباشرة لأيٍّ من الأسباب التالية:

  • لم يتم ضبط السعر المباشر لعمليات البحث هذه.
  • لقد حظرت وصول Google إلى برنامج رحلة الفندق المعني.
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
}
الحقول
hotelSuspendedCount

string (int64 format)

تم تعليق الفندق. وقد يعود ذلك إلى مشاكل مستمرة في مجالات مثل الضرائب والرسوم غير الصحيحة.

priceUnusuallyHighCount

string (int64 format)

يبدو أنّ السعر المُقدّم لبرنامج الرحلة هذا مرتفع بشكلٍ غريب مقارنةً بالمؤشرات الإقليمية.

priceUnusuallyLowCount

string (int64 format)

إنّ السعر الذي تم تقديمه لبرنامج الرحلة هذا يبدو منخفضًا إلى حدٍّ كبير مقارنةً بالمؤشرات الإقليمية.

taxesAndFeesMissingCount

string (int64 format)

لم يتم تحديد الأسعار بسبب الضرائب والرسوم.

PriceUnavailableCountDetails

الأسباب التي ساهمت في ظهور السعر غير المتوفّر والعدد الإجمالي لكل سبب.

تمثيل JSON
{
  "priceUnavailableCount": string,
  "participationNotLikelyCount": string
}
الحقول
priceUnavailableCount

string (int64 format)

لم يشارك الفندق بسبب عدم توفّره في تواريخ برنامج الرحلة.

participationNotLikelyCount

string (int64 format)

لم يتم تخزين أي أسعار مؤقتًا لبرنامج الرحلة هذا، ولم يتم إجراء طلب بحث مباشر لأن الخادم عادةً ما يخبرنا أن الفندق غير متوفر أو نفدت.