Method: accounts.participationReportViews.query

Umożliwia wysyłanie zapytań (pobieranie, filtrowanie i segmentowanie) dotyczących raportu o udziałach w przypadku konkretnego konta.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
name

string

Nazwa zasobu konta, którego dotyczy zapytanie. Format to accounts/{account_id}.

Parametry zapytania

Parametry
filter

string

Warunki (pola i wyrażenia) używane do filtrowania danych o zaangażowaniu na koncie, na którym jest wykonywane zapytanie. Składnia wymaga spacji wokół operatora in. W przeciwnym razie spacje można pominąć. Warunki można łączyć za pomocą operatora AND.

Ważne: prawidłowa składnia dodawania wielu warunków to: "?filter=<condition>=<value>%20AND%20<condition>=<value>..."

Pole date jest wymagane. Wszystkie pozostałe pola są opcjonalne.

Przykłady prawidłowych warunków:

  • 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

Określa sposób segmentowania danych zwracanych przez zapytanie. Jeśli np. jako wartość parametru aggregateBy podasz userRegionCode, participationResult będzie dostarczać dane zagregowane według regionu użytkownika.

Wartość ciągu tekstowego to lista pól rozdzielonych przecinkami. Prawidłowe pola to: date, userRegionCode, deviceType, partnerHotelId, hotelRegionCode, advanceBookingWindow, lengthOfStayDays, checkinDate i occupancy. Pola, które nie są określone, nie są uwzględniane w obiekcie ParticipationResult.

Ważne: użycie parametru aggregateBy z parametrem partnerHotelId lub więcej niż 2 wartościami może spowodować błąd. Filtrowanie za pomocą znaków partnerHotelId i date w celu zmniejszenia liczby wierszy może zapobiec wystąpieniu błędów.
pageSize

integer

Maksymalna liczba wyników uczestnictwa do zwrócenia. Usługa może zwrócić mniej niż ta wartość. Jeśli nie podano tego argumentu, zwracanych jest maksymalnie 10 tys. wyników. Maksymalna wartość to 10 000. Wartości powyżej 10 000 zostaną ograniczone do 10 000.
pageToken

string

Token strony otrzymany z poprzedniego żądania participationReportViews.query. Podaj ten token, aby otrzymać kolejną stronę.

Podczas paginacji wszystkie inne parametry przekazane do participationReportViews.query muszą być zgodne z wywołaniem, które dostarczyło token strony.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Wiadomość z odpowiedzią dla ParticipationReportService.QueryParticipationReport.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "results": [
    {
      object (ParticipationResult)
    }
  ],
  "nextPageToken": string
}
Pola
results[]

object (ParticipationResult)

Lista wyników pasujących do zapytania.
nextPageToken

string

Token stronicowania używany do pobierania następnej strony wyników.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w sekcji OAuth 2.0 Overview.

ParticipationResult

Reprezentuje wynik zapytania o statystyki dotyczące zaangażowania na koncie.

Zapis JSON 
{
  "key": {
    object (Key)
  },
  "opportunityCount": string,
  "participationCount": string,
  "participationPercent": number,
  "missedParticipationCount": string,
  "missedParticipationCountDetails": {
    object (MissedParticipationCountDetails)
  },
  "partnerHotelDisplayName": string
}
Pola
key

object (Key)

Klucz wyniku.
opportunityCount

string (int64 format)

Łączna liczba dostępnych możliwości w przypadku konkretnego hotelu. Możliwości to łączna liczba przypadków, w których reklama hotelu mogła zostać wyświetlona użytkownikowi.
participationCount

string (int64 format)

Łączna liczba sytuacji, w których Twoje reklamy mogły wziąć udział w procesie aukcji Google Ads.
participationPercent

number

Współczynnik udziału to wartość procentowa obliczana przez podzielenie liczby wykorzystanych możliwości przez łączną liczbę możliwości. Jeśli np. usługa mogła wziąć udział w aukcji Google Ads 90 razy na 100 możliwości, współczynnik uczestnictwa wynosi 90%.
missedParticipationCount

string (int64 format)

Łączna liczba okazji, które nie kwalifikują się do procesu aukcji Google Ads. Składa się z tych elementów:

  • Brak strony docelowej
  • Brak ceny
  • Problem z ceną
  • Cena niedostępna
  • Inne
missedParticipationCountDetails

object (MissedParticipationCountDetails)

Przyczyny, które przyczyniły się do braku udziału (np. brak dostępności), oraz łączna liczba dla każdej przyczyny.
partnerHotelDisplayName

string

Wyświetlana nazwa hotelu partnera. To pole jest wypełniane tylko wtedy, gdy wynik jest agregowany według wartości partnerHotelId.

Klucz

Klucz wyniku.

Zapis JSON 
{
  "date": {
    object (Date)
  },
  "userRegionCode": string,
  "deviceType": enum (Device),
  "partnerHotelId": string,
  "hotelRegionCode": string,
  "advanceBookingWindow": integer,
  "lengthOfStayDays": integer,
  "checkinDate": {
    object (Date)
  },
  "occupancy": integer
}
Pola
date

object (Date)

Data, dla której chcesz uzyskać dane.

Jeśli date nie jest wartością parametru aggregateBy w wywołaniu żądania, pole date nie jest zwracane w Key.
userRegionCode

string

Kod regionu w formacie ISO 3116 kraju lub regionu użytkownika.

Jeśli userRegionCode nie jest wartością parametru aggregateBy w wywołaniu żądania, pole userRegionCode nie jest zwracane w Key.
deviceType

enum (Device)

Typ urządzenia użytkownika.

Jeśli deviceType nie jest wartością parametru aggregateBy w wywołaniu żądania, pole deviceType nie jest zwracane w Key.
partnerHotelId

string

Identyfikator hotelu partnera.

Jeśli partnerHotelId nie jest wartością parametru aggregateBy w wywołaniu żądania, pole partnerHotelId nie jest zwracane w Key.
hotelRegionCode

string

Kod regionu CLDR kraju lub regionu, w którym znajduje się hotel.

Jeśli hotelRegionCode nie jest wartością parametru aggregateBy w wywołaniu żądania, pole hotelRegionCode nie jest zwracane w Key.
advanceBookingWindow

integer

Liczba dni wyprzedzenia, z jakim użytkownik chce zarezerwować plan podróży.

Jeśli advanceBookingWindow nie jest wartością parametru aggregateBy w wywołaniu żądania, pole advanceBookingWindow nie jest zwracane w Key.
lengthOfStayDays

integer

Liczba nocy w planie podróży.

Jeśli lengthOfStayDays nie jest wartością parametru aggregateBy w wywołaniu żądania, pole lengthOfStayDays nie jest zwracane w Key.
checkinDate

object (Date)

Data zameldowania w ramach planu podróży.

Jeśli checkinDate nie jest wartością parametru aggregateBy w wywołaniu żądania, pole checkinDate nie jest zwracane w Key.
occupancy

integer

Łączna liczba osób w ramach planu podróży.

Jeśli occupancy nie jest wartością parametru aggregateBy w wywołaniu żądania, pole occupancy nie jest zwracane w Key.

MissedParticipationCountDetails

Liczba przegapionych szans na udział w podziale na przyczyny.

Zapis 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)
  }
}
Pola
noAvailabilityCount
(deprecated)

string (int64 format)

Łączna liczba utraconych możliwości udziału z powodu niedostępności kombinacji hotelu i planu podróży lub braku możliwości skorzystania przez podróżnego z cen. Aby brać udział w tych aukcjach, możesz musieć podać więcej informacji o cenach.
hotelSuspendedCount
(deprecated)

string (int64 format)

Łączna liczba utraconych udziałów z powodu zawieszenia co najmniej jednego z Twoich hoteli z powodu naruszeń zasad dotyczących dokładności cen.
noTaxBreakdownCount
(deprecated)

string (int64 format)

Łączna liczba utraconych możliwości udziału z powodu braku oddzielnego określenia podatków i opłat w przypadku co najmniej jednego z Twoich hoteli.
noLandingPageCount

string (int64 format)

Żadna strona docelowa nie pasuje do użytkownika.
noPriceCount
(deprecated)

string (int64 format)

Łączna liczba pominiętych udziałów z powodu braku ceny dla żądanego planu podróży.
noPriceCountDetails
(deprecated)

object (NoPriceCountDetails)

Przyczyny, które przyczyniły się do braku ceny (np. niedostępność cen rzeczywistych), oraz łączna liczba wystąpień każdej z nich.
otherReasonCount

string (int64 format)

Hotel nie uczestniczył w programie z nieznanego powodu.
priceMissingCount

string (int64 format)

Łączna liczba pominiętych udziałów z powodu braku ceny w pamięci podręcznej Google lub nieudanej odpowiedzi na cenę rzeczywistą. Składa się z tych elementów:

  • Wykorzystana przepustowość
  • Brak współczynnika pamięci podręcznej
  • Plan podróży zablokowany
  • Nie skonfigurowano cen na żywo
  • Przekroczono czas oczekiwania na rzeczywistą cenę
  • Błąd rzeczywistej ceny
priceMissingCountDetails

object (PriceMissingCountDetails)

Przyczyny, które przyczyniły się do liczby brakujących cen.
priceProblemCount

string (int64 format)

Łączna liczba utraconych udziałów z powodu problemu z dokładnością ceny podanej dla planu podróży. Składa się z tych elementów:

  • Hotel zawieszony
  • Cena jest nietypowo wysoka
  • Cena jest wyjątkowo niska
  • Brak podatków i plików danych
priceProblemCountDetails

object (PriceProblemCountDetails)

Przyczyny, które przyczyniły się do liczby problemów z cenami.
priceUnavailableCount

string (int64 format)

Łączna liczba utraconych udziałów z powodu ceny podanej jako niedostępna (-1) w przypadku żądanego planu podróży. Składa się z tych elementów:

  • Cena niedostępna
  • Mało prawdopodobne
  • Inne
priceUnavailableCountDetails

object (PriceUnavailableCountDetails)

Przyczyny, które przyczyniły się do liczby niedostępnych cen.

NoPriceCountDetails

Przyczyny, które przyczyniły się do braku ceny, oraz łączna liczba dla każdej przyczyny.

Zapis JSON 
{
  "livePricingTechnicalIssueCount": string,
  "livePricingNotTriggeredCount": string,
  "livePricingConfigIssueCount": string,
  "livePricingNotAvailableCount": string,
  "livePricingOtherReasonCount": string
}
Pola
livePricingTechnicalIssueCount

string (int64 format)

Łączna liczba pominiętych udziałów z powodu problemów technicznych z cenami rzeczywistymi z jednego z tych powodów:

  • Nie udało Ci się odpowiedzieć wystarczająco szybko i przekroczono termin odpowiedzi (około 4000 milisekund).
  • Zwrócono błąd.
  • Odpowiedź była nieprawidłowa.
livePricingNotTriggeredCount

string (int64 format)

Łączna liczba przypadków, w których nie udało się wziąć udziału w aukcji z powodu nieuruchomienia cen rzeczywistych z jednego z tych powodów:

  • Nie ustawiono stawki.
  • Nie masz prawidłowej strony docelowej.
  • W pamięci podręcznej nie było wystarczającej liczby cen.
livePricingConfigIssueCount

string (int64 format)

Łączna liczba przypadków, w których nie udało się wziąć udziału w aukcji z powodu nieuruchomienia cen rzeczywistych z jednego z tych powodów:

  • W przypadku tych wyszukiwań nie masz skonfigurowanych cen na żywo.
  • Ograniczono dostęp Google do danego planu podróży.
livePricingNotAvailableCount

string (int64 format)

Łączna liczba pominiętych udziałów z powodu niedostępności cen rzeczywistych. Ceny na żywo nie będą wywoływane w przypadku niektórych domyślnych planów podróży ani interfejsów. W takim przypadku partnerzy będą musieli mieć zapisaną w pamięci podręcznej cenę, aby wziąć udział w programie.
livePricingOtherReasonCount

string (int64 format)

Liczba pominiętych udziałów z powodu innych problemów z cenami rzeczywistymi.

PriceMissingCountDetails

Przyczyny, które przyczyniły się do braku ceny, oraz łączna liczba wystąpień każdej z nich.

Zapis JSON 
{
  "cacheRateMissingCount": string,
  "itineraryBlockedCount": string,
  "livePricingNotSetupCount": string,
  "bandwidthDepletedCount": string,
  "livePricingTimeoutCount": string,
  "livePricingErrorCount": string
}
Pola
cacheRateMissingCount

string (int64 format)

W pamięci podręcznej nie ma ceny dla tego planu podróży. Zapytanie na żywo nie zostało wykonane z powodu ograniczeń strony.
itineraryBlockedCount

string (int64 format)

Plan podróży wykraczał poza podstawowe parametry, więc nie pobrano ceny planu podróży ani z zapytania na żywo, ani z pamięci podręcznej.
livePricingNotSetupCount

string (int64 format)

Dla tego planu podróży nie ma ceny w pamięci podręcznej, a na tym koncie nie skonfigurowano zapytania na żywo.
bandwidthDepletedCount

string (int64 format)

W przypadku tego planu podróży nie było ceny w pamięci podręcznej i nie pozostał żaden limit zapytań w czasie rzeczywistym.
livePricingTimeoutCount

string (int64 format)

W przypadku tego planu podróży nie ma ceny w pamięci podręcznej, a zapytanie wysłane do Twojego systemu przekroczyło limit czasu.
livePricingErrorCount

string (int64 format)

Nie mamy zapisanej w pamięci podręcznej ceny dla tego planu podróży. Zapytanie na żywo nie przekroczyło limitu czasu, ale Twój system zwrócił błąd.

PriceProblemCountDetails

Przyczyny, które przyczyniły się do problemu z ceną, oraz łączna liczba wystąpień każdej przyczyny.

Zapis JSON 
{
  "hotelSuspendedCount": string,
  "priceUnusuallyHighCount": string,
  "priceUnusuallyLowCount": string,
  "taxesAndFeesMissingCount": string,
  "basePriceViolationsCount": string,
  "priceAccuracyIssueCount": string
}
Pola
hotelSuspendedCount

string (int64 format)

Hotel został zawieszony. Może to wynikać z trwałych problemów w takich obszarach jak nieprawidłowe podatki i opłaty.
priceUnusuallyHighCount

string (int64 format)

Cena podana dla tego planu podróży wydawała się dziwnie wysoka w porównaniu z trendami regionalnymi.
priceUnusuallyLowCount

string (int64 format)

Cena podana dla tego planu podróży wydawała się dziwnie niska w porównaniu z trendami regionalnymi.
taxesAndFeesMissingCount

string (int64 format)

W cenach brakowało podatków i opłat.
basePriceViolationsCount

string (int64 format)

Cena podstawowa jest zbyt niska w porównaniu z ceną całkowitą.
priceAccuracyIssueCount

string (int64 format)

Problem z dokładnością cen.

PriceUnavailableCountDetails

Przyczyny, które przyczyniły się do liczby niedostępnych cen, oraz łączna liczba dla każdej przyczyny.

Zapis JSON 
{
  "priceUnavailableCount": string,
  "participationNotLikelyCount": string
}
Pola
priceUnavailableCount

string (int64 format)

Hotel nie uczestniczył w programie, ponieważ był niedostępny w datach planu podróży.
participationNotLikelyCount

string (int64 format)

W przypadku tego planu podróży nie ma ceny w pamięci podręcznej i nie wykonano zapytania na żywo, ponieważ Twój serwer zwykle informuje nas, że hotel jest niedostępny lub wyprzedany.