Method: accounts.participationReportViews.query

Umożliwia przeszukiwanie (pobieranie, filtrowanie i segmentowanie) raportu o konkretnym koncie.

Żą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. Użyj formatu accounts/{account_id}.

Parametry zapytania

Parametry
filter

string

Warunki (pola i wyrażenia) używane do filtrowania danych o aktywności konta, którego dotyczy zapytanie. Składnia wymaga spacji wokół operatora in. W przeciwnym razie spacje mogą zostać pominięte. Warunki można łączyć przy użyciu operatora and.

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

Przykłady prawidłowych warunków:

  • 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

Określa sposób podziału danych zwracanych przez zapytanie. Jeśli na przykład wartość userRegionCode jest podana jako wartość aggregateBy, participationResult dostarczy dane zbiorcze według regionu użytkownika.

Wartość ciągu znaków to rozdzielona przecinkami lista pól. Prawidłowe pola to: date, userRegionCode, deviceType, partnerHotelId, hotelRegionCode, advanceBookingWindow, lengthOfStayDays, checkinDate i occupancy. Nieokreślone pola nie są uwzględniane w wyniku uczestnictwa.

Używanie specyfikacji aggregateBy, która generuje dużą liczbę wierszy, spowoduje błąd. Dotyczy to szczególnie agregacji według wartości partnerHotelId lub więcej niż 2 pól. Aby zmniejszyć ryzyko wystąpienia błędu, przefiltruj dane według kryteriów partnerHotelId i date, aby uwzględnić tylko wybrane hotele i daty. Konta z dużą liczbą hoteli muszą dodatkowo zmniejszyć ilość danych przy użyciu dodatkowego filtrowania.

pageSize

integer

Maksymalna liczba wyników uczestnictwa, które zostaną zwrócone. Usługa może zwracać mniejszą wartość. Jeśli nie określono inaczej, zostanie zwróconych maksymalnie 10 000 wyników. Maksymalna wartość wynosi 10 000, a wartości powyżej 10 000 zostaną zmodyfikowane do 10 000.

pageToken

string

Token strony otrzymany z poprzedniego żądania uczestnictwa ReportReports.query. Podaj go, żeby wyświetlić następną stronę.

W podziale na strony wszystkie inne parametry podane w polu engagementReportViews.query muszą być zgodne z wywołaniem dostarczonym przez token strony.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

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

Odpowiedź na: ParticipationReportService.QueryParticipationReport.

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

object (ParticipationResult)

Lista wyników pasujących do zapytania.

nextPageToken

string

Token podziału na strony służący 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 artykule Omówienie OAuth 2.0.

Wynik uczestnictwa

Reprezentuje wynik zapytania o statystyki udziału konta.

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 konkretnym hotelu. Możliwości to łączna liczba przypadków, w których reklama hotelu mogła się wyświetlić użytkownikowi.

participationCount

string (int64 format)

Łączna liczba sytuacji, w których udało Ci się wziąć udział w aukcji Google Ads.

participationPercent

number

Odsetek zaangażowania, w którym liczba uczestniczących możliwości jest dzielona przez łączną liczbę możliwości. Jeśli np. dana usługa brała udział w aukcji Google Ads 90 razy na 100 możliwości, współczynnik uczestnictwa wynosi 90%.

missedParticipationCount

string (int64 format)

Łączna liczba możliwości niekwalifikujących się do udziału w aukcji Google Ads. Składają się z tych elementów:

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

object (MissedParticipationCountDetails)

przyczyny, dla których liczba utraconych uczestników (np. brak dostępności) oraz łączna liczba przyczyn dla każdego z nich;

partnerHotelDisplayName

string

Wyświetlana nazwa hotelu partnera. To pole jest wypełniane tylko wtedy, gdy wynik jest agregowany przez parametr 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 pobrać dane.

Jeśli date nie jest wartością parametru aggregateBy w żądaniu, pole date nie jest zwracane w polu Key.

userRegionCode

string

Kod regionu zgodny ze standardem ISO 3116 kraju.

Jeśli userRegionCode nie jest wartością parametru aggregateBy w żądaniu, pole userRegionCode nie jest zwracane w polu Key.

deviceType

enum (Device)

Typ urządzenia użytkownika.

Jeśli deviceType nie jest wartością parametru aggregateBy w żądaniu, pole deviceType nie jest zwracane w polu Key.

partnerHotelId

string

Identyfikator hotelu partnera.

Jeśli partnerHotelId nie jest wartością parametru aggregateBy w żądaniu, pole partnerHotelId nie jest zwracane w polu Key.

hotelRegionCode

string

Kod regionu CLDR kraju lub regionu hotelu.

Jeśli hotelRegionCode nie jest wartością parametru aggregateBy w żądaniu, pole hotelRegionCode nie jest zwracane w polu 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 żądaniu, pole advanceBookingWindow nie jest zwracane w polu Key.

lengthOfStayDays

integer

Liczba nocy w planie podróży.

Jeśli lengthOfStayDays nie jest wartością parametru aggregateBy w żądaniu, pole lengthOfStayDays nie jest zwracane w polu Key.

checkinDate

object (Date)

Data zameldowania w planie podróży.

Jeśli checkinDate nie jest wartością parametru aggregateBy w żądaniu, pole checkinDate nie jest zwracane w polu Key.

occupancy

integer

Łączna liczba osób korzystających z planu podróży.

Jeśli occupancy nie jest wartością parametru aggregateBy w żądaniu, pole occupancy nie jest zwracane w polu Key.

Szczegóły nieuwzględnionego udziału

Liczba niewykorzystanych środków z podziałem 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 nieodebranych rezerwacji z powodu niedostępnej kombinacji hotelu i planu podróży lub podróżnych nie spełniało tych cen. Aby wziąć udział w tych aukcjach, konieczne może być podanie dodatkowych informacji o cenie.

hotelSuspendedCount
(deprecated)

string (int64 format)

Łączna liczba utraconych uczestnictwa z powodu co najmniej jednego z Twoich hoteli zawieszonych z powodu naruszenia zasad dotyczących dokładności cen.

noTaxBreakdownCount
(deprecated)

string (int64 format)

Łączna liczba utraconych udziału z powodu co najmniej jednego z Twoich hoteli, który nie określa jednoznacznie podatków i opłat.

noLandingPageCount

string (int64 format)

Strona docelowa nie pasuje do użytkownika.

noPriceCount
(deprecated)

string (int64 format)

Łączna liczba pominiętych udziału ze względu na to, że cena za wybrany plan podróży nie jest oferowana.

noPriceCountDetails
(deprecated)

object (NoPriceCountDetails)

informacje o przyczynach, dla których nie określono ceny (np. niedostępne ceny bieżące), oraz o łącznej liczbie poszczególnych przyczyn;

otherReasonCount

string (int64 format)

Z nieznanego powodu hotel nie brał udziału.

priceMissingCount

string (int64 format)

Łączna liczba pominiętych uczestnictwa z powodu braku ceny w pamięci podręcznej Google lub braku odpowiedzi na aktualne ceny. Składają się z tych elementów:

  • Przepustowość wyczerpana
  • Brak pamięci podręcznej
  • Zablokuj plan podróży
  • Nie skonfigurowano aktywnej ceny
  • Upłynął termin naliczania opłat
  • Błąd aktywnej ceny
priceMissingCountDetails

object (PriceMissingCountDetails)

Przyczyny wystąpienia ceny.

priceProblemCount

string (int64 format)

Łączna liczba nieodebranych połączeń z powodu problemu z dokładnością ceny planu podróży. Składają się z tych elementów:

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

object (PriceProblemCountDetails)

Przyczyny, dla których wystąpił problem z ceną.

priceUnavailableCount

string (int64 format)

Łączna liczba niewykorzystanych środków z powodu ceny widocznej jako niedostępna (-1) w przypadku wybranego planu podróży. Składają się z tych elementów:

  • Cena niedostępna
  • Nieprawdopodobne uczestnictwo
  • Inny
priceUnavailableCountDetails

object (PriceUnavailableCountDetails)

Przyczyny, dla których cena jest niedostępna.

NoPriceCountDetails

Przyczyny, dla których nie określono ceny ani łączna liczba dla każdego z nich.

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

string (int64 format)

Łączna liczba nieodebranych połączeń z powodu problemów technicznych z cenami na żywo z dowolnego z tych powodów:

  • Nie odpowiadasz zbyt szybko i przekroczono termin odpowiedzi (około 4000 milisekund).
  • Zwrócono błąd.
  • Twoja odpowiedź jest zniekształcona.
livePricingNotTriggeredCount

string (int64 format)

Łączna liczba utraconych udziału z powodu aktywnej ceny, która nie została wywołana 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 ceny.
livePricingConfigIssueCount

string (int64 format)

Łączna liczba utraconych udziału z powodu aktywnej ceny, która nie została wywołana z jednego z tych powodów:

  • Nie masz skonfigurowanych cen na żywo dla tych wyszukiwań.
  • Ograniczasz Google dostęp do tego planu podróży.
livePricingNotAvailableCount

string (int64 format)

Łączna liczba pominiętych udziału z powodu niedostępnych cen na żywo. Bieżące ceny nie będą uruchamiane w przypadku niektórych planów podróży ani interfejsów użytkownika. W tym przypadku partnerzy muszą mieć cenę w pamięci podręcznej, aby wziąć udział w programie.

livePricingOtherReasonCount

string (int64 format)

Liczba przypadków, które nie zostały uwzględnione z powodu innych problemów z cenami na żywo.

PriceMissingCountDetails

Przyczyny, dla których brakuje ceny i łączna liczba w każdym z nich.

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

string (int64 format)

Cena za ten plan podróży nie jest przechowywana w pamięci podręcznej. Bieżące zapytanie nie zostało wykonane z powodu ograniczeń strony.

itineraryBlockedCount

string (int64 format)

Plan podróży wykracza poza podstawowe parametry, więc nie pobieramy ceny za plan z użyciem zapytania na żywo lub wypełnienia pamięci podręcznej.

livePricingNotSetupCount

string (int64 format)

Cena nie została zapisana w pamięci podręcznej na ten plan podróży, a zapytanie na żywo nie zostało skonfigurowane na tym koncie.

bandwidthDepletedCount

string (int64 format)

Cena nie została zapisana w pamięci podręcznej na ten plan podróży i nie ma już limitu aktywnych zapytań.

livePricingTimeoutCount

string (int64 format)

Cena nie została zapisana w pamięci podręcznej na ten plan podróży, a zapytanie na żywo wysłane do Twojego systemu przekroczyło limit czasu.

livePricingErrorCount

string (int64 format)

Cena z tego planu podróży nie została zapisana w pamięci podręcznej. Przekroczono limit czasu zapytania na żywo, ale Twój system zwrócił błąd.

PriceProblemCountDetails

informacje o przyczynach wystąpienia problemu z ceną i łącznej liczbie poszczególnych przyczyn;

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

string (int64 format)

Hotel został zawieszony. Przyczyną mogą być ciągłe problemy w takich obszarach jak nieprawidłowe podatki i opłaty.

priceUnusuallyHighCount

string (int64 format)

Cena tego planu podróży wydaje się dziwnie wysoka w porównaniu z trendami regionalnymi.

priceUnusuallyLowCount

string (int64 format)

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

taxesAndFeesMissingCount

string (int64 format)

Brak cen i podatków.

PricebitCountDetails

Przyczyny, dla których cena jest niedostępna, a także łączna liczba z poszczególnych przyczyn.

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

string (int64 format)

Hotel nie brał udziału w tym wydarzeniu, ponieważ w danym planie podróży był on niedostępny.

participationNotLikelyCount

string (int64 format)

Cena nie została zapisana w pamięci podręcznej na ten plan podróży, a zapytanie nie zostało wykonane na serwerze, ponieważ zazwyczaj serwer informuje, że hotel jest niedostępny lub wyprzedany.