Engage SDK Travel: instrukcje integracji technicznej firm zewnętrznych

Zwiększ zaangażowanie w aplikację, docierając do użytkowników tam, gdzie się znajdują. Zintegruj pakiet Engage SDK, aby wyświetlać spersonalizowane rekomendacje i treści kontynuacji bezpośrednio użytkownikom na różnych platformach na urządzeniu, takich jak Kolekcje, Entertainment Space i Sklep Play. Integracja zwiększa rozmiar średniego pliku APK (skompresowany) o mniej niż 50 KB i zajmuje deweloperom około tygodnia pracy. Więcej informacji znajdziesz na naszej stronie.

Ten przewodnik zawiera instrukcje dla deweloperów, którzy chcą dostarczać treści związane z podróżami i wydarzeniami na platformy treści Engage.

Obsługa kategorii i platformy

Dostępność platformy Engage SDK zależy od kategorii treści aplikacji. W tabeli poniżej możesz sprawdzić, czy kwalifikujesz się do korzystania z określonych platform:

Stan Kategoria treści lub przypadek użycia Obsługiwane platformy
Obsługiwane
(Kwalifikuje się do wyświetlania na wszystkich platformach)
  • Wszystkie podkategorie w kategorii Podróże i informacje lokalne (z wyjątkiem nieobsługiwanych podkategorii wymienionych w tej tabeli)
  • Wydarzenia (wszystkie podkategorie)
  • Aktywność, monitorowanie, opieka i wyprowadzanie zwierząt domowych
  • Kolekcje
  • Karta Aplikacje w Sklepie Play
  • Karta Ty w Sklepie Play
  • strona z informacjami o aplikacji w Sklepie Play,
Nieobsługiwane
  • Śledzenie lotów

Szczegóły integracji

W tej sekcji znajdziesz szczegółowe informacje o krokach, modelach danych i terminologii wymaganych do integracji z pakietem Engage SDK w przypadku treści związanych z podróżami i wydarzeniami.

Terminologia

Ta integracja obejmuje te typy klastrów: Rekomendacja, Polecane, Rezerwacja i Kontynuuj wyszukiwanie.

  • Rekomendacje to grupy zawierające spersonalizowane sugestie dotyczące podróży i wydarzeń od konkretnego partnera deweloperskiego. Rekomendacje mogą być spersonalizowane dla danego użytkownika lub ogólne (np. popularne produkty). Używaj ich do polecania artykułów, wydarzeń, noclegów lub ciekawych miejsc.

    • Klaster rekomendacji może składać się z wizytówek ArticleEntity, EventEntity, LodgingEntity, PointOfInterestEntity lub StoreEntity, ale nie może zawierać różnych typów encji.

    Rekomendacje mają taką strukturę:

    • Grupa rekomendacji: widok interfejsu zawierający grupę rekomendacji od tego samego partnera deweloperskiego.

    • Element: obiekt reprezentujący pojedynczy element w klastrze. Ta integracja udostępnia pewne elementy, które będą wyświetlane za pomocą klastra rekomendacji:

      • ArticleEntity: ArticleEntity reprezentuje rekomendację dotyczącą treści tekstowych związanych z podróżami i wydarzeniami. Można go używać w przypadku artykułów, postów na blogu, treści marketingowych, fragmentów wiadomości itp.

        Ilustracja 1. Interfejs pokazujący pojedynczy element ArticleEntity w klastrze rekomendacji.
      • EventEntity: EventEntity reprezentuje wydarzenie, które odbędzie się w przyszłości. Godzina rozpoczęcia wydarzenia to kluczowa informacja, którą należy przekazać użytkownikom.

        Ilustracja 2. Interfejs pokazujący pojedynczy element EventEntity w klastrze rekomendacji.
      • LodgingEntity: LodgingEntity reprezentuje zakwaterowanie, takie jak hotel, apartament czy dom wakacyjny, na wynajem krótko- i długoterminowy.

        Rysunek 3. Interfejs pokazujący pojedynczy element LodgingEntity w klastrze rekomendacji.
      • StoreEntity: StoreEntity reprezentuje sklep, restaurację, kawiarnię itp. Wyróżnia treści, w których lokal gastronomiczny lub sklep jest kluczową informacją, którą należy przekazać użytkownikom.

        Rysunek 4. Interfejs pokazujący pojedynczy element StoreEntity w klastrze rekomendacji.
      • PointOfInterestEntity: PointOfInterestEntity reprezentuje interesujące miejsce, takie jak stacja benzynowa, miejsce wydarzenia, park rozrywki, muzeum, atrakcja turystyczna, szlak pieszy itp. Wyróżnia treści, w których lokalizacja jest kluczową informacją, którą należy przekazać użytkownikom. Nie powinien być używany do noclegów, jako sklep ani lokal gastronomiczny.

        Rysunek 5. Interfejs przedstawiający pojedynczy element PointOfInterestEntity w klastrze rekomendacji.
  • Grupa Rezerwacja zawiera treści, z którymi użytkownicy niedawno wchodzili w interakcję, od wielu partnerów deweloperskich w jednym układzie interfejsu. Każdy partner deweloper może transmitować maksymalnie 10 elementów w klastrze Rezerwacja.

    Treść rezerwacji może mieć następującą strukturę:

    • RestaurantReservationEntity: RestaurantReservationEntity reprezentuje rezerwację w restauracji lub kawiarni i pomaga użytkownikom śledzić nadchodzące lub trwające rezerwacje w restauracjach.

      Rysunek 6. Interfejs użytkownika wyświetlający pojedynczy element RestaurantReservationEntity w klastrze rezerwacji.
    • EventReservationEntity: EventReservationEntity reprezentuje rezerwację na wydarzenie i pomaga użytkownikom śledzić nadchodzące lub trwające rezerwacje na wydarzenia. Zdarzenia mogą obejmować między innymi:

      • wydarzenia sportowe, np. rezerwacja biletu na mecz piłki nożnej;
      • wydarzenia związane z grami, np. rezerwacja na e-sport;
      • wydarzenia rozrywkowe, takie jak rezerwacja biletów do kina, na koncert, do teatru czy na spotkanie autorskie;
      • rezerwacje podróży lub atrakcji, np. oprowadzania, biletów do muzeum;
      • Rezerwacje na spotkania towarzyskie, seminaria i konferencje
      • Rezerwacje sesji edukacyjnych/szkoleniowych
      Rysunek 7. Interfejs pokazujący pojedynczy element EventReservationEntity w klastrze rezerwacji.
    • LodgingReservationEntity: LodgingEntityReservation reprezentuje rezerwację zakwaterowania i pomaga użytkownikom śledzić nadchodzące lub trwające rezerwacje hoteli lub kwater wakacyjnych.

      Rysunek 8. Interfejs użytkownika wyświetlający pojedynczy element LodgingReservationEntity w grupie rezerwacji.
    • TransportationReservationEntity: TransportationReservationEntity reprezentuje rezerwację transportu dowolnym środkiem i pomaga użytkownikom śledzić rezerwacje nadchodzących lub trwających lotów, rejsów promem, przejazdów pociągiem, autobusem, prywatnych przejazdów lub rejsów wycieczkowych.

      Rysunek 9. Interfejs z jednym elementem TransportationReservationEntity w grupie rezerwacji.
    • VehicleRentalReservationEntity: VehicleRentalReservationEntity reprezentuje rezerwację wynajmu pojazdu i pomaga użytkownikom śledzić nadchodzące lub trwające rezerwacje wynajmu pojazdów.

      Rysunek 10. Interfejs użytkownika wyświetlający pojedynczy element VehicleRentalReservationEntity w klastrze rezerwacji.
  • Grupa Polecane zawiera wybrane elementy od wielu partnerów programistów w jednym układzie interfejsu. Jeden wyróżniony klaster będzie wyświetlany u góry interfejsu w priorytetowym miejscu nad wszystkimi innymi klastrami rekomendacji. Każdy partner deweloper może transmitować maksymalnie 10 elementów w klastrze Polecane.

    • GenericFeaturedEntity: GenericFeaturedEntity różni się od elementu rekomendacji tym, że polecany element powinien być używany w przypadku pojedynczych najlepszych treści od deweloperów i powinien reprezentować pojedyncze najważniejsze treści, które będą interesujące i przydatne dla użytkowników.

      Ilustracja 11. Interfejs pokazujący FeaturedCluster z listą GenericFeaturedEntity
  • Grupa Kontynuuj wyszukiwanie pomaga użytkownikom wznowić poprzednie wyszukiwanie podróży, wyświetlając listę zapytań, które użytkownik niedawno wyszukiwał we wszystkich swoich aplikacjach podróżniczych. Klaster zostanie przypięty na drugiej pozycji, po rezerwacjach i przed klastrami polecanymi i rekomendowanymi. Każdy partner deweloper może transmitować maksymalnie 3 elementy w klastrze Kontynuuj wyszukiwanie.

    • PointOfInterestEntity: PointOfInterestEntity reprezentuje ciekawe miejsce, takie jak stacja benzynowa, miejsce wydarzenia, park rozrywki, muzeum, atrakcja turystyczna, szlak turystyczny itp. Wyróżnia treści, których użytkownik wcześniej szukał.

Przygotowanie

Minimalny poziom interfejsu API: 19

Dodaj bibliotekę com.google.android.engage:engage-core do aplikacji:

dependencies {
    // Make sure you also include that repository in your project's build.gradle file.
    implementation 'com.google.android.engage:engage-core:1.6.0'
}

Podsumowanie

Projekt jest oparty na implementacji powiązanej usługi.

Dane, które klient może opublikować, podlegają tym limitom w przypadku różnych typów klastrów:

Typ klastra Limity klastra Minimalne limity elementów w klastrze Maksymalne limity elementów w klastrze
Klastry rekomendacji Maksymalnie 7 Co najmniej 1 Maksymalnie 50 (ArticleEntity, EventEntity, LodgingEntity, StoreEntity lub PointOfInterestEntity)
Klaster rezerwacji Maksymalnie 1 Co najmniej 1 Maksymalnie 20 (RestaurantReservationEntity, EventReservationEntity, LodgingReservationEntity, TransportationReservationEntity lub VehicleRentalReservationEntity)
Polecany klaster Maksymalnie 1 Co najmniej 1 Maksymalnie 20 (GenericFeaturedEntity)
Kontynuuj wyszukiwanie klastra Maksymalnie 1 Co najmniej 1 Maksymalnie 3 (PointOfInterestEntity)

Krok 1. Podaj dane podmiotu

Pakiet SDK definiuje różne encje reprezentujące poszczególne typy produktów. W przypadku kategorii Podróże i wydarzenia obsługujemy te encje:

  1. GenericFeaturedEntity
  2. ArticleEntity
  3. EventEntity
  4. LodgingEntity
  5. StoreEntity
  6. PointOfInterestEntity
  7. RestaurantReservationEntity
  8. EventReservationEntity
  9. LodgingReservationEntity
  10. TransportationReservationEntity
  11. VehicleRentalReservationEntity

W tabelach poniżej znajdziesz dostępne atrybuty i wymagania dotyczące poszczególnych typów.

GenericFeaturedEntity

Atrybut Wymaganie Opis Format
Identyfikator URI działania Wymagany

Precyzyjny link do elementu w aplikacji dostawcy.

Uwaga: do atrybucji możesz używać precyzyjnych linków. Zapoznaj się z odpowiedziami na najczęstsze pytania.

Uri
Obrazy plakatu Wymagany

Jeśli podasz kilka obrazów, wyświetlimy tylko 1 z nich. Zalecany format obrazu to 16:9.

Uwaga: jeśli podano plakietkę, upewnij się, że u góry i u dołu obrazu jest bezpieczny obszar o szerokości 24 dp.

Wskazówki znajdziesz w specyfikacji obrazu.
Tytuł Opcjonalny Tytuł elementu.

Dowolny tekst

Zalecany rozmiar tekstu: 50 znaków

Opis Opcjonalny

Pojedynczy akapit tekstu opisujący encję.

Uwaga: użytkownikowi wyświetli się opis lub lista podtytułów, ale nie oba te elementy.

Dowolny tekst

Zalecana długość tekstu: 180 znaków

Lista napisów Opcjonalny

Maksymalnie 3 podtytuły, każdy w jednym wierszu tekstu.

Uwaga: użytkownikowi wyświetli się opis lub lista podtytułów, ale nie oba te elementy.

Dowolny tekst

Zalecany rozmiar tekstu dla każdego podtytułu: maks. 50 znaków

Plakietki Opcjonalny

Każda plakietka to dowolny tekst (maks. 15 znaków) lub mały obraz.

Specjalne traktowanie UX na obrazie lub filmie, na przykład jako nakładka plakietki na obrazie

  • „Aktualizacja na żywo”
  • Czas czytania artykułu
Plakietka – tekst Opcjonalny

Tytuł plakietki

Uwaga: plakietka musi zawierać tekst lub obraz.

Dowolny tekst

Zalecany rozmiar tekstu: maksymalnie 15 znaków

Plakietka – obraz Opcjonalny

Mały obraz

Specjalne traktowanie pod kątem wygody użytkownika, np. plakietka na miniaturze obrazu lub filmu.

Uwaga: plakietka musi zawierać tekst lub obraz.

Wskazówki znajdziesz w specyfikacji obrazu.
Kategorie treści Opcjonalny Opisz kategorię treści w encji.

Lista wartości w polu enum

Wskazówki znajdziesz w sekcji dotyczącej kategorii treści.

DisplayTimeWindow (opcjonalnie) – ustaw przedział czasu, w którym treści mają być wyświetlane na danej platformie.
Sygnatura czasowa rozpoczęcia Opcjonalny

Sygnatura czasowa epoki, po której treści powinny być wyświetlane na danej platformie.

Jeśli nie jest ustawiona, treści mogą być wyświetlane na danej platformie.

Sygnatura czasowa epoki w milisekundach
Sygnatura czasowa zakończenia Opcjonalny

Sygnatura czasowa epoki, po której treści nie są już wyświetlane na danej platformie.

Jeśli nie jest ustawiona, treści mogą być wyświetlane na danej platformie.

Sygnatura czasowa epoki w milisekundach

ArticleEntity

Atrybut Wymaganie Opis Format
Identyfikator URI działania Wymagany

Precyzyjny link do elementu w aplikacji dostawcy.

Uwaga: do atrybucji możesz używać precyzyjnych linków. Zapoznaj się z odpowiedziami na najczęstsze pytania.

Uri
Tytuł Wymagany Tytuł elementu.

Dowolny tekst

Zalecana długość tekstu: maks. 50 znaków

Obrazy plakatu Opcjonalny

Jeśli podasz kilka obrazów, wyświetlimy tylko 1 z nich. Zalecany format obrazu to 16:9.

Uwaga: zdecydowanie zalecamy dodanie obrazu. Jeśli podano plakietkę, upewnij się, że u góry i u dołu obrazu jest bezpieczny obszar o wielkości 24 dp.

Wskazówki znajdziesz w specyfikacji obrazu.
Źródło – tytuł Opcjonalny Imię i nazwisko autora lub reportera albo nazwa organizacji.

Dowolny tekst

Zalecany rozmiar tekstu: poniżej 25 znaków

Źródło – obraz Opcjonalny obraz źródła, np. autora, organizacji, reportera; Wskazówki znajdziesz w specyfikacji obrazu.
Opis Opcjonalny

Pojedynczy akapit tekstu opisujący encję.

Uwaga: użytkownikowi wyświetli się opis lub lista podtytułów, ale nie oba te elementy.

Dowolny tekst

Zalecana długość tekstu: 180 znaków

Lista napisów Opcjonalny

Maksymalnie 3 podtytuły, każdy w jednym wierszu tekstu.

Uwaga: użytkownikowi wyświetli się opis lub lista podtytułów, ale nie oba te elementy.

Dowolny tekst

Zalecany rozmiar tekstu dla każdego podtytułu: maks. 50 znaków

Plakietki Opcjonalny

Każda plakietka to dowolny tekst (maks. 15 znaków) lub mały obraz.

Specjalne traktowanie UX na obrazie lub filmie, na przykład jako nakładka plakietki na obrazie.

  • „Aktualizacja na żywo”
  • Czas czytania artykułu
Plakietka – tekst Opcjonalny

Tytuł plakietki

Uwaga: plakietka musi zawierać tekst lub obraz.

Dowolny tekst

Zalecany rozmiar tekstu: maksymalnie 15 znaków

Plakietka – obraz Opcjonalny

Mały obraz

Specjalne traktowanie pod kątem wygody użytkownika, np. plakietka na miniaturze obrazu lub filmu.

Uwaga: plakietka musi zawierać tekst lub obraz.

Wskazówki znajdziesz w specyfikacji obrazu.
Czas publikacji treści Opcjonalny Jest to sygnatura czasowa epoki w milisekundach, która wskazuje, kiedy treść została opublikowana lub zaktualizowana w aplikacji. Sygnatura czasowa epoki w milisekundach
Czas ostatniego zaangażowania Opcjonalny

Sygnatura czasowa epoki w milisekundach, kiedy użytkownik ostatnio wszedł w interakcję z tym elementem.

Sygnatura czasowa epoki w milisekundach
Procent postępu Opcjonalny

Odsetek pełnej treści, którą użytkownik do tej pory obejrzał.

Wartość całkowita z zakresu od 0 do 100 (włącznie).
Kategorie treści Opcjonalny Opisz kategorię treści w encji.

Lista wartości w polu enum

Wskazówki znajdziesz w sekcji dotyczącej kategorii treści.

DisplayTimeWindow (opcjonalnie) – ustaw przedział czasu, w którym treści mają być wyświetlane na danej platformie.
Sygnatura czasowa rozpoczęcia Opcjonalny

Sygnatura czasowa epoki, po której treści powinny być wyświetlane na danej platformie.

Jeśli nie jest ustawiona, treści mogą być wyświetlane na danej platformie.

Sygnatura czasowa epoki w milisekundach
Sygnatura czasowa zakończenia Opcjonalny

Sygnatura czasowa epoki, po której treści nie są już wyświetlane na danej platformie.

Jeśli nie jest ustawiona, treści mogą być wyświetlane na danej platformie.

Sygnatura czasowa epoki w milisekundach

EventEntity

Atrybut Wymaganie Opis Format
Identyfikator URI działania Wymagany

Precyzyjny link do elementu w aplikacji dostawcy.

Uwaga: do atrybucji możesz używać precyzyjnych linków. Zapoznaj się z odpowiedziami na najczęstsze pytania.

Uri
Tytuł Wymagany Tytuł elementu.

Ciąg znaków

Zalecana długość tekstu: maks. 50 znaków

Zlokalizowany czas rozpoczęcia – sygnatura czasowa Wymagany

Sygnatura czasowa epoki, kiedy wydarzenie ma się rozpocząć.

Joda-Time Instant
Zlokalizowany czas rozpoczęcia – strefa czasowa Wymagany

Strefa czasowa, w której ma się rozpocząć wydarzenie.

Joda-Time DateTimeZone

Wskazówki znajdziesz w specyfikacji stref czasowych.

Tryb zdarzenia Wymagany

Pole wskazujące, czy wydarzenie będzie miało charakter wirtualny, stacjonarny czy mieszany.

Lista wartości: VIRTUAL, IN_PERSON lub HYBRID
Obrazy plakatu Wymagany

Jeśli podasz kilka obrazów, wyświetlimy tylko 1 z nich. Zalecany format obrazu to 16:9.

Uwaga: zdecydowanie zalecamy dodanie obrazu. Jeśli podano plakietkę, upewnij się, że u góry i u dołu obrazu jest bezpieczny obszar o wielkości 24 dp.

Wskazówki znajdziesz w specyfikacji obrazu.
Lokalizacja – kraj Wymagane warunkowo

Kraj, w którym odbywa się wydarzenie.

Uwaga: jest to wymagane w przypadku wydarzeń, które są IN_PERSON lub HYBRID.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Lokalizacja – miasto Wymagane warunkowo

Miasto, w którym odbywa się wydarzenie.

Uwaga: jest to wymagane w przypadku wydarzeń, które są IN_PERSON lub HYBRID.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Lokalizacja – wyświetlany adres Wymagane warunkowo

Adres lub nazwa miejsca, w którym odbędzie się wydarzenie, które powinno być wyświetlane użytkownikowi.

Uwaga: jest to wymagane w przypadku wydarzeń, które są IN_PERSON lub HYBRID.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Lokalizacja – adres Opcjonalny Adres (jeśli dotyczy) miejsca, w którym odbywa się wydarzenie.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Lokalizacja – stan Opcjonalny Stan lub prowincja (jeśli dotyczy), w której odbywa się wydarzenie.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Lokalizacja – kod pocztowy Opcjonalny Kod pocztowy (w stosownych przypadkach) lokalizacji, w której odbywa się wydarzenie.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Lokalizacja – dzielnica Opcjonalny Dzielnica (jeśli dotyczy), w której odbywa się wydarzenie.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Czas zakończenia Opcjonalny

Sygnatura czasowa epoki, kiedy wydarzenie ma się zakończyć.

Uwaga: ta wartość jest podawana w milisekundach.

Sygnatura czasowa epoki w milisekundach
Opis Opcjonalny

Pojedynczy akapit tekstu opisujący encję.

Uwaga: użytkownikowi wyświetli się opis lub lista podtytułów, ale nie oba te elementy.

Dowolny tekst

Zalecana długość tekstu: 180 znaków

Lista napisów Opcjonalny

Maksymalnie 3 podtytuły, każdy w jednym wierszu tekstu.

Uwaga: użytkownikowi wyświetli się opis lub lista podtytułów, ale nie oba te elementy.

Dowolny tekst

Zalecany rozmiar tekstu dla każdego podtytułu: maks. 50 znaków

Plakietki Opcjonalny

Każda plakietka to dowolny tekst (maks. 15 znaków) lub mały obraz.

Plakietka – tekst Opcjonalny

Tytuł plakietki

Uwaga: plakietka musi zawierać tekst lub obraz.

Dowolny tekst

Zalecany rozmiar tekstu: maksymalnie 15 znaków

Plakietka – obraz Opcjonalny

Mały obraz

Specjalne traktowanie pod kątem wygody użytkownika, np. plakietka na miniaturze obrazu lub filmu.

Uwaga: plakietka musi zawierać tekst lub obraz.

Wskazówki znajdziesz w specyfikacji obrazu.
Cena – CurrentPrice Wymagane warunkowo

Aktualna cena biletu lub karnetu na wydarzenie.

Należy podać, jeśli podano przekreśloną cenę.

Dowolny tekst
Price - StrikethroughPrice Opcjonalny Pierwotna cena biletu lub karnetu na wydarzenie. Dowolny tekst
Objaśnienie ceny Opcjonalny Objaśnienie ceny, aby wyróżnić promocję, wydarzenie lub rabat dla uczestników programu, jeśli są dostępne.

Dowolny tekst

Zalecane rozmiary tekstu: poniżej 45 znaków (tekst, który jest za długi, może zawierać wielokropek)

Kategorie treści Opcjonalny Opisz kategorię treści w encji.

Lista kwalifikujących się typów wyliczeniowych

  • TYPE_MOVIES_AND_TV_SHOWS (przykład: kino)
  • TYPE_DIGITAL_GAMES (przykład: e-sport)
  • TYPE_MUSIC (przykład: koncert)
  • TYPE_TRAVEL_AND_LOCAL (przykład: wycieczka, festiwal)
  • TYPE_HEALTH_AND_FITENESS (np. zajęcia z jogi)
  • TYPE_EDUCATION (przykład: zajęcia)
  • TYPE_SPORTS (przykład: mecz piłki nożnej)
  • TYPE_DATING (przykład: meetup)

Wskazówki znajdziesz w sekcji dotyczącej kategorii treści.

DisplayTimeWindow (opcjonalnie) – ustaw przedział czasu, w którym treści mają być wyświetlane na danej platformie.
Sygnatura czasowa rozpoczęcia Opcjonalny

Sygnatura czasowa epoki, po której treści powinny być wyświetlane na danej platformie.

Jeśli nie jest ustawiona, treści mogą być wyświetlane na danej platformie.

Sygnatura czasowa epoki w milisekundach
Sygnatura czasowa zakończenia Opcjonalny

Sygnatura czasowa epoki, po której treści nie są już wyświetlane na danej platformie.

Jeśli nie jest ustawiona, treści mogą być wyświetlane na danej platformie.

Sygnatura czasowa epoki w milisekundach

LodgingEntity

Atrybut Wymaganie Opis Format
Identyfikator URI działania Wymagany

Precyzyjny link do elementu w aplikacji dostawcy.

Uwaga: do atrybucji możesz używać precyzyjnych linków. Zapoznaj się z odpowiedziami na najczęstsze pytania.

Uri
Tytuł Wymagany Tytuł elementu.

Ciąg znaków

Zalecana długość tekstu: maks. 50 znaków

Obrazy plakatu Wymagany

Jeśli podasz kilka obrazów, wyświetlimy tylko 1 z nich. Zalecany format obrazu to 16:9.

Uwaga: jeśli podano plakietkę, upewnij się, że u góry i u dołu obrazu jest bezpieczny obszar o szerokości 24 dp.

Wskazówki znajdziesz w specyfikacji obrazu.
Lokalizacja – kraj Wymagany Kraj, w którym znajduje się miejsce zakwaterowania.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Lokalizacja – miasto Wymagany Miasto, w którym znajduje się miejsce zakwaterowania.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Lokalizacja – wyświetlany adres Wymagany Adres, który będzie wyświetlany użytkownikowi. W większości przypadków zalecamy podanie nazwy miasta i ewentualnie stanu lub kraju. Adres lub dzielnicę podawaj tylko wtedy, gdy użytkownik znajduje się w pobliżu danej lokalizacji, zna ją lub nazwa miasta jest zawarta w tytule klastra. Jeśli podajesz adres, powinien on być zwięzły i zawierać skróty, jeśli to możliwe (np. „ul.” zamiast „ulica”).

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Lokalizacja – adres Opcjonalny Adres (jeśli dotyczy) miejsca zakwaterowania.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Lokalizacja – stan Opcjonalny Województwo lub region (w stosownych przypadkach), w którym znajduje się miejsce zakwaterowania.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Lokalizacja – kod pocztowy Opcjonalny Kod pocztowy (jeśli dotyczy) miejsca zakwaterowania.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Lokalizacja – dzielnica Opcjonalny Dzielnica (jeśli dotyczy), w której znajduje się kwatera.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Plakietki Opcjonalny

Każda plakietka to dowolny tekst (maks. 15 znaków) lub mały obraz.

Plakietka – tekst Opcjonalny

Tytuł plakietki

Uwaga: plakietka musi zawierać tekst lub obraz.

Dowolny tekst

Zalecany rozmiar tekstu: maksymalnie 15 znaków

Plakietka – obraz Opcjonalny

Mały obraz

Specjalne traktowanie pod kątem wygody użytkownika, np. plakietka na miniaturze obrazu lub filmu.

Uwaga: plakietka musi zawierać tekst lub obraz.

Wskazówki znajdziesz w specyfikacji obrazu.
Opis Opcjonalny

Pojedynczy akapit tekstu opisujący encję.

Uwaga: użytkownikowi wyświetli się opis lub lista podtytułów, ale nie oba te elementy.

Dowolny tekst

Zalecana długość tekstu: 180 znaków

Lista napisów Opcjonalny

Maksymalnie 3 podtytuły, każdy w jednym wierszu tekstu.

Uwaga: użytkownikowi wyświetli się opis lub lista podtytułów, ale nie oba te elementy.

Dowolny tekst

Zalecany rozmiar tekstu dla każdego podtytułu: maks. 50 znaków

AvailabilityTimeWindow - Localized Start Time - Timestamp Opcjonalny Sygnatura czasowa epoki, kiedy miejsce zakwaterowania ma być otwarte/dostępne. Joda-Time Instant
AvailabilityTimeWindow - Localized Start Time - Timezone Opcjonalny Strefa czasowa, w której miejsce zakwaterowania ma być otwarte/dostępne.

Joda-Time DateTimeZone

Wskazówki znajdziesz w specyfikacji stref czasowych.

AvailabilityTimeWindow - Localized End Time - Timestamp Opcjonalny Sygnatura czasowa epoki, do której miejsce zakwaterowania ma być otwarte/dostępne. Joda-Time Instant
AvailabilityTimeWindow - Localized End Time - Timezone Opcjonalny Strefa czasowa, w której miejsce zakwaterowania ma być otwarte/dostępne.

Joda-Time DateTimeZone

Wskazówki znajdziesz w specyfikacji stref czasowych.

Ocena – wartość maksymalna Opcjonalny

Maksymalna wartość skali ocen.

Musisz podać tę wartość, jeśli podajesz też bieżącą wartość oceny.

Liczba >= 0,0
Ocena – bieżąca wartość Opcjonalny

Bieżąca wartość skali ocen.

Należy podać, jeśli podano też maksymalną wartość oceny.

Liczba >= 0,0
Ocena – liczba Opcjonalny

Liczba ocen miejsca zakwaterowania.

Uwaga: wypełnij to pole, jeśli aplikacja ma kontrolować sposób wyświetlania tego elementu użytkownikom. Podaj krótki ciąg znaków, który może być wyświetlany użytkownikowi. Jeśli np. liczba wynosi 1 000 000, rozważ użycie skrótu, np. 1 mln, aby nie została obcięta w przypadku mniejszych rozmiarów wyświetlanych elementów.

Ciąg znaków
Ocena – liczba ocen Opcjonalny

Liczba ocen miejsca zakwaterowania.

Uwaga: podaj to pole, jeśli nie chcesz samodzielnie obsługiwać logiki skrótu wyświetlania. Jeśli podane są zarówno liczba, jak i wartość liczby, użytkownikom wyświetlimy liczbę.

Długi
Cena – CurrentPrice Wymagane warunkowo

Aktualna cena noclegu.

Należy podać, jeśli podano przekreśloną cenę.

Dowolny tekst
Price - StrikethroughPrice Opcjonalny Pierwotna cena miejsca zakwaterowania, która jest przekreślona w interfejsie. Dowolny tekst
Objaśnienie ceny Opcjonalny Objaśnienie ceny, aby wyróżnić promocję, wydarzenie lub rabat dla uczestników programu, jeśli są dostępne.

Dowolny tekst

Zalecane rozmiary tekstu: poniżej 45 znaków (tekst, który jest za długi, może zawierać wielokropek)

DisplayTimeWindow (opcjonalnie) – ustaw przedział czasu, w którym treści mają być wyświetlane na danej platformie.
Sygnatura czasowa rozpoczęcia Opcjonalny

Sygnatura czasowa epoki, po której treści powinny być wyświetlane na danej platformie.

Jeśli nie jest ustawiona, treści mogą być wyświetlane na danej platformie.

Sygnatura czasowa epoki w milisekundach
Sygnatura czasowa zakończenia Opcjonalny

Sygnatura czasowa epoki, po której treści nie są już wyświetlane na danej platformie.

Jeśli nie jest ustawiona, treści mogą być wyświetlane na danej platformie.

Sygnatura czasowa epoki w milisekundach

StoreEntity

Obiekt StoreEntity reprezentuje pojedynczy sklep, który partnerzy deweloperzy chcą opublikować, np. popularną restaurację lub lokal gastronomiczny, które są istotne dla podróżujących.

Atrybut Wymaganie Opis Format
Obrazy plakatu Wymagany Musisz podać co najmniej 1 obraz. Wskazówki znajdziesz w specyfikacji obrazu.
Identyfikator URI działania Wymagany

Precyzyjny link do elementu w aplikacji dostawcy.

Uwaga: do atrybucji możesz używać precyzyjnych linków. Zapoznaj się z odpowiedziami na najczęstsze pytania.

Uri
Tytuł Opcjonalny Nazwa sklepu.

Dowolny tekst

Zalecane rozmiary tekstu: poniżej 45 znaków (tekst, który jest za długi, może zawierać wielokropek).

Lokalizacja Opcjonalny Lokalizacja sklepu.

Dowolny tekst

Zalecane rozmiary tekstu: poniżej 45 znaków (tekst, który jest za długi, może zawierać wielokropek)

Objaśnienie Opcjonalny Objaśnienie dotyczące promocji, wydarzenia lub aktualizacji w sklepie, jeśli jest dostępne.

Dowolny tekst

Zalecane rozmiary tekstu: poniżej 45 znaków (tekst, który jest za długi, może zawierać wielokropek)

Callout fine print Opcjonalny Tekst objaśnienia zapisany drobnym drukiem.

Dowolny tekst

Zalecane rozmiary tekstu: poniżej 45 znaków (tekst, który jest za długi, może zawierać wielokropek)

Opis Opcjonalny Opis sklepu.

Dowolny tekst

Zalecana długość tekstu: mniej niż 90 znaków (za długi tekst może być wyświetlany z wielokropkiem)

Kategoria Opcjonalny

Kategoria sklepu, w kontekście lokali gastronomicznych może to być kuchnia, np. „francuska”, „nowoamerykańska”, „ramen”, „ekskluzywna”.

Dowolny tekst

Zalecane rozmiary tekstu: poniżej 45 znaków (tekst, który jest za długi, może zawierać wielokropek)

Ocena – wartość maksymalna Opcjonalny

Maksymalna wartość skali ocen.

Musisz podać tę wartość, jeśli podajesz też bieżącą wartość oceny.

Liczba >= 0,0
Ocena – bieżąca wartość Opcjonalny

Bieżąca wartość skali ocen.

Należy podać, jeśli podano też maksymalną wartość oceny.

Liczba >= 0,0
Ocena – liczba Opcjonalny

Liczba ocen miejsca zakwaterowania.

Uwaga: wypełnij to pole, jeśli aplikacja ma kontrolować sposób wyświetlania tego elementu użytkownikom. Podaj krótki ciąg znaków, który może być wyświetlany użytkownikowi. Jeśli np. liczba wynosi 1 000 000, rozważ użycie skrótu, np. 1 mln, aby nie została obcięta w przypadku mniejszych rozmiarów wyświetlanych elementów.

Ciąg znaków
Ocena – liczba ocen Opcjonalny

Liczba ocen miejsca zakwaterowania.

Uwaga: podaj to pole, jeśli nie chcesz samodzielnie obsługiwać logiki skrótu wyświetlania. Jeśli podane są zarówno liczba, jak i wartość liczby, użytkownikom wyświetlimy liczbę.

Długi
DisplayTimeWindow (opcjonalnie) – ustaw przedział czasu, w którym treści mają być wyświetlane na danej platformie.
Sygnatura czasowa rozpoczęcia Opcjonalny

Sygnatura czasowa epoki, po której treści powinny być wyświetlane na danej platformie.

Jeśli nie jest ustawiona, treści mogą być wyświetlane na danej platformie.

Sygnatura czasowa epoki w milisekundach
Sygnatura czasowa zakończenia Opcjonalny

Sygnatura czasowa epoki, po której treści nie są już wyświetlane na danej platformie.

Jeśli nie jest ustawiona, treści mogą być wyświetlane na danej platformie.

Sygnatura czasowa epoki w milisekundach

PointOfInterestEntity

Atrybut Wymaganie Opis Format
Identyfikator URI działania Wymagany

Precyzyjny link do elementu w aplikacji dostawcy.

Uwaga: do atrybucji możesz używać precyzyjnych linków. Zapoznaj się z odpowiedziami na najczęstsze pytania.

Uri
Tytuł Wymagany Tytuł elementu.

Ciąg znaków

Zalecana długość tekstu: maks. 50 znaków

Obrazy plakatu Wymagane warunkowo

Jeśli podasz kilka obrazów, wyświetlimy tylko 1 z nich. Zalecany format obrazu to 16:9.

Uwaga: obraz jest wymagany, jeśli encja jest częścią klastra rekomendacji. Jeśli podano plakietkę, upewnij się, że bezpieczny obszar wynosi 24 dp zarówno u góry, jak i u dołu obrazu.

Wskazówki znajdziesz w specyfikacji obrazu.
Czas ostatniego zaangażowania Wymagane warunkowo

Sygnatura czasowa epoki, kiedy użytkownik ostatnio wszedł w interakcję z tym elementem.

Uwaga: to pole jest wymagane, jeśli encja jest częścią klastra kontynuacji wyszukiwania.

Joda-Time Instant
Lokalizacja – kraj Wymagane warunkowo

Kraj, w którym znajduje się ciekawe miejsce.

Uwaga: to pole jest wymagane, jeśli encja jest częścią klastra rekomendacji.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Lokalizacja – miasto Wymagane warunkowo

Miasto, w którym znajduje się ciekawe miejsce.

Uwaga: to pole jest wymagane, jeśli encja jest częścią klastra rekomendacji.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Lokalizacja – wyświetlany adres Wymagane warunkowo

Adres, który będzie wyświetlany użytkownikowi. Podaj zwięzły adres, używając skrótów, gdzie to możliwe (np. „ul.” zamiast „ulica”). Ten ciąg znaków może zostać obcięty w zależności od urządzenia i ustawień użytkownika. Podaj nazwę miasta, aby ułatwić identyfikację.

Uwaga: to pole jest wymagane, jeśli encja jest częścią klastra rekomendacji.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 35 znaków

Lokalizacja – adres Opcjonalny Adres (jeśli dotyczy) ciekawego miejsca.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Lokalizacja – stan Opcjonalny Stan lub prowincja (w odpowiednich przypadkach), w której znajduje się dany punkt orientacyjny.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Lokalizacja – kod pocztowy Opcjonalny Kod pocztowy (jeśli dotyczy) ciekawego miejsca.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Lokalizacja – dzielnica Opcjonalny Okolica (jeśli dotyczy) ciekawego miejsca.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

AvailabilityTimeWindow - Localized Start Time - Timestamp Opcjonalny Sygnatura czasowa epoki, kiedy dany punkt zainteresowania powinien być otwarty lub dostępny. Joda-Time Instant
AvailabilityTimeWindow - Localized Start Time - Timezone Opcjonalny Strefa czasowa, w której dany punkt zainteresowania powinien być otwarty lub dostępny.

Joda-Time DateTimeZone

Wskazówki znajdziesz w specyfikacji stref czasowych.

AvailabilityTimeWindow - Localized End Time - Timestamp Opcjonalny Sygnatura czasowa epoki, do której dany punkt zainteresowania powinien być otwarty lub dostępny. Joda-Time Instant
AvailabilityTimeWindow - Localized End Time - Timezone Opcjonalny Strefa czasowa, w której dany punkt zainteresowania powinien być otwarty lub dostępny.

Joda-Time DateTimeZone

Wskazówki znajdziesz w specyfikacji stref czasowych.

Plakietki Opcjonalny

Każda plakietka to dowolny tekst (maks. 15 znaków) lub mały obraz.

Plakietka – tekst Opcjonalny

Tytuł plakietki

Uwaga: plakietka musi zawierać tekst lub obraz.

Dowolny tekst

Zalecany rozmiar tekstu: maksymalnie 15 znaków

Plakietka – obraz Opcjonalny

Mały obraz

Specjalne traktowanie pod kątem wygody użytkownika, np. plakietka na miniaturze obrazu lub filmu.

Uwaga: plakietka musi zawierać tekst lub obraz.

Wskazówki znajdziesz w specyfikacji obrazu.
Opis Opcjonalny

Pojedynczy akapit tekstu opisujący encję.

Uwaga: użytkownikowi wyświetli się opis lub lista podtytułów, ale nie oba te elementy.

Dowolny tekst

Zalecana długość tekstu: 180 znaków

Lista napisów Opcjonalny

Maksymalnie 3 podtytuły, każdy w jednym wierszu tekstu.

Uwaga: użytkownikowi wyświetli się opis lub lista podtytułów, ale nie oba te elementy.

Dowolny tekst

Zalecany rozmiar tekstu dla każdego podtytułu: maks. 50 znaków

Ocena – wartość maksymalna Opcjonalny

Maksymalna wartość skali ocen.

Musisz podać tę wartość, jeśli podajesz też bieżącą wartość oceny.

Liczba >= 0,0
Ocena – bieżąca wartość Opcjonalny

Bieżąca wartość skali ocen.

Należy podać, jeśli podano też maksymalną wartość oceny.

Liczba >= 0,0
Ocena – liczba Opcjonalny

Liczba ocen ciekawego miejsca.

Uwaga: wypełnij to pole, jeśli aplikacja ma kontrolować sposób wyświetlania tego elementu użytkownikom. Podaj krótki ciąg znaków, który może być wyświetlany użytkownikowi. Jeśli np. liczba wynosi 1 000 000, rozważ użycie skrótu, np. 1 mln, aby nie została obcięta w przypadku mniejszych rozmiarów wyświetlanych elementów.

Ciąg znaków
Ocena – liczba ocen Opcjonalny

Liczba ocen ciekawego miejsca.

Uwaga: podaj to pole, jeśli nie chcesz samodzielnie obsługiwać logiki skrótu wyświetlania. Jeśli podane są zarówno liczba, jak i wartość liczby, użytkownikom wyświetlimy liczbę.

Długi
Cena – CurrentPrice Wymagane warunkowo

Aktualna cena biletów lub karnetów do ciekawego miejsca.

Należy podać, jeśli podano przekreśloną cenę.

Dowolny tekst
Price - StrikethroughPrice Opcjonalny Pierwotna cena biletów lub karnetów do ciekawego miejsca. Dowolny tekst
Objaśnienie ceny Opcjonalny Objaśnienie ceny, aby wyróżnić promocję, wydarzenie lub rabat dla uczestników programu, jeśli są dostępne.

Dowolny tekst

Zalecane rozmiary tekstu: poniżej 45 znaków (tekst, który jest za długi, może zawierać wielokropek)

Kategorie treści Opcjonalny Opisz kategorię treści w encji.

Lista kwalifikujących się typów wyliczeniowych

  • TYPE_TRAVEL_AND_LOCAL
  • TYPE_MOVIES_AND_TV_SHOWS (przykład: kino)
  • TYPE_MEDICAL (przykład: szpital)
  • TYPE_EDUCATION (np. szkoła)
  • TYPE_SPORTS (np. stadion)

Wskazówki znajdziesz w sekcji dotyczącej kategorii treści.

DisplayTimeWindow (opcjonalnie) – ustaw przedział czasu, w którym treści mają być wyświetlane na danej platformie.
Sygnatura czasowa rozpoczęcia Opcjonalny

Sygnatura czasowa epoki, po której treści powinny być wyświetlane na danej platformie.

Jeśli nie jest ustawiona, treści mogą być wyświetlane na danej platformie.

Sygnatura czasowa epoki w milisekundach
Sygnatura czasowa zakończenia Opcjonalny

Sygnatura czasowa epoki, po której treści nie są już wyświetlane na danej platformie.

Jeśli nie jest ustawiona, treści mogą być wyświetlane na danej platformie.

Sygnatura czasowa epoki w milisekundach

RestaurantReservationEntity

Atrybut Wymaganie Opis Format
Identyfikator URI działania Wymagany

Precyzyjny link do elementu w aplikacji dostawcy.

Uwaga: do atrybucji możesz używać precyzyjnych linków. Zapoznaj się z odpowiedziami na najczęstsze pytania.

Uri
Tytuł Wymagany Tytuł elementu.

Ciąg znaków

Zalecana długość tekstu: maks. 50 znaków

Zlokalizowany czas rozpoczęcia rezerwacji – sygnatura czasowa Wymagany Sygnatura czasowa epoki, kiedy rezerwacja ma się rozpocząć. Joda-Time Instant
Zlokalizowany czas rozpoczęcia rezerwacji – strefa czasowa Wymagany Strefa czasowa, w której ma się rozpocząć rezerwacja.

Joda-Time DateTimeZone

Wskazówki znajdziesz w specyfikacji stref czasowych.

Lokalizacja – kraj Wymagany Kraj, w którym znajduje się restauracja.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Lokalizacja – miasto Wymagany Miasto, w którym znajduje się restauracja.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Lokalizacja – wyświetlany adres Wymagany Adres restauracji, który będzie wyświetlany użytkownikowi.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Lokalizacja – adres Opcjonalny Adres restauracji (jeśli dotyczy).

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Lokalizacja – stan Opcjonalny Stan lub prowincja (jeśli dotyczy), w której znajduje się restauracja.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Lokalizacja – kod pocztowy Opcjonalny Kod pocztowy restauracji (jeśli dotyczy).

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Lokalizacja – dzielnica Opcjonalny Dzielnica (jeśli dotyczy), w której znajduje się restauracja.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Obrazy plakatu Opcjonalny Jeśli podasz kilka obrazów, wyświetlimy tylko 1 z nich. Zalecany format obrazu to 16:9. Wskazówki znajdziesz w specyfikacji obrazu.
Opis Opcjonalny

Pojedynczy akapit tekstu opisujący encję.

Uwaga: użytkownikowi wyświetli się opis lub lista podtytułów, ale nie oba te elementy.

Dowolny tekst

Zalecana długość tekstu: 180 znaków

Lista napisów Opcjonalny

Maksymalnie 3 podtytuły, każdy w jednym wierszu tekstu.

Uwaga: użytkownikowi wyświetli się opis lub lista podtytułów, ale nie oba te elementy.

Dowolny tekst

Zalecany rozmiar tekstu dla każdego podtytułu: maks. 50 znaków

Wielkość tabeli Opcjonalny Liczba osób w grupie rezerwacji Liczba całkowita > 0
DisplayTimeWindow (opcjonalnie) – ustaw przedział czasu, w którym treści mają być wyświetlane na danej platformie.
Sygnatura czasowa rozpoczęcia Opcjonalny

Sygnatura czasowa epoki, po której treści powinny być wyświetlane na danej platformie.

Jeśli nie jest ustawiona, treści mogą być wyświetlane na danej platformie.

Sygnatura czasowa epoki w milisekundach
Sygnatura czasowa zakończenia Opcjonalny

Sygnatura czasowa epoki, po której treści nie są już wyświetlane na danej platformie.

Jeśli nie jest ustawiona, treści mogą być wyświetlane na danej platformie.

Sygnatura czasowa epoki w milisekundach

EventReservationEntity

Atrybut Wymaganie Opis Format
Identyfikator URI działania Wymagany

Precyzyjny link do elementu w aplikacji dostawcy.

Uwaga: do atrybucji możesz używać precyzyjnych linków. Zapoznaj się z odpowiedziami na najczęstsze pytania.

Uri
Tytuł Wymagany Tytuł elementu.

Ciąg znaków

Zalecana długość tekstu: maks. 50 znaków

Zlokalizowany czas rozpoczęcia – sygnatura czasowa Wymagany

Sygnatura czasowa epoki, kiedy wydarzenie ma się rozpocząć.

Joda-Time Instant
Zlokalizowany czas rozpoczęcia – strefa czasowa Wymagany

Strefa czasowa, w której ma się rozpocząć wydarzenie.

Joda-Time DateTimeZone

Wskazówki znajdziesz w specyfikacji stref czasowych.

Tryb zdarzenia Wymagany

Pole wskazujące, czy wydarzenie będzie miało charakter wirtualny, stacjonarny czy mieszany.

Lista wartości: VIRTUAL, IN_PERSON lub HYBRID
Lokalizacja – kraj Wymagane warunkowo

Kraj, w którym odbywa się wydarzenie.

Uwaga: jest to wymagane w przypadku wydarzeń, które są IN_PERSON lub HYBRID.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Lokalizacja – miasto Wymagane warunkowo

Miasto, w którym odbywa się wydarzenie.

Uwaga: jest to wymagane w przypadku wydarzeń, które są IN_PERSON lub HYBRID.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Lokalizacja – wyświetlany adres Wymagane warunkowo

Adres lub nazwa miejsca, w którym odbędzie się wydarzenie, które powinno być wyświetlane użytkownikowi.

Uwaga: jest to wymagane w przypadku wydarzeń, które są IN_PERSON lub HYBRID.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Lokalizacja – adres Opcjonalny Adres (jeśli dotyczy) miejsca, w którym odbywa się wydarzenie.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Lokalizacja – stan Opcjonalny Stan lub prowincja (jeśli dotyczy), w której odbywa się wydarzenie.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Lokalizacja – kod pocztowy Opcjonalny Kod pocztowy (w stosownych przypadkach) lokalizacji, w której odbywa się wydarzenie.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Lokalizacja – dzielnica Opcjonalny Dzielnica (jeśli dotyczy), w której odbywa się wydarzenie.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Obrazy plakatu Opcjonalny

Jeśli podasz kilka obrazów, wyświetlimy tylko 1 z nich. Zalecany format obrazu to 16:9.

Uwaga: zdecydowanie zalecamy dodanie obrazu. Jeśli podano plakietkę, upewnij się, że u góry i u dołu obrazu jest bezpieczny obszar o wielkości 24 dp.

Wskazówki znajdziesz w specyfikacji obrazu.
Zlokalizowany czas zakończenia – sygnatura czasowa Opcjonalny

Sygnatura czasowa epoki, kiedy wydarzenie ma się zakończyć.

Joda-Time Instant
Zlokalizowany czas zakończenia – strefa czasowa Opcjonalny

Strefa czasowa, w której wydarzenie ma się zakończyć.

Joda-Time DateTimeZone

Wskazówki znajdziesz w specyfikacji stref czasowych.

Dostawca usług – nazwa Opcjonalny

Nazwa dostawcy usług.

Uwaga: w przypadku dostawcy usług wymagany jest tekst lub obraz.

Dowolny tekst. Na przykład nazwa organizatora wydarzenia lub trasy koncertowej.
Dostawca usług – obraz Opcjonalny

Logo lub obraz usługodawcy.

Uwaga: w przypadku dostawcy usług wymagany jest tekst lub obraz.

Wskazówki znajdziesz w specyfikacji obrazu.
Opis Opcjonalny

Pojedynczy akapit tekstu opisujący encję.

Uwaga: użytkownikowi wyświetli się opis lub lista podtytułów, ale nie oba te elementy.

Dowolny tekst

Zalecana długość tekstu: 180 znaków

Lista napisów Opcjonalny

Maksymalnie 3 podtytuły, każdy w jednym wierszu tekstu.

Uwaga: użytkownikowi wyświetli się opis lub lista podtytułów, ale nie oba te elementy.

Dowolny tekst

Zalecany rozmiar tekstu dla każdego podtytułu: maks. 50 znaków

Plakietki Opcjonalny

Każda plakietka to dowolny tekst (maks. 15 znaków) lub mały obraz.

Plakietka – tekst Opcjonalny

Tytuł plakietki

Uwaga: plakietka musi zawierać tekst lub obraz.

Dowolny tekst

Zalecany rozmiar tekstu: maksymalnie 15 znaków

Plakietka – obraz Opcjonalny

Mały obraz

Specjalne traktowanie pod kątem wygody użytkownika, np. plakietka na miniaturze obrazu lub filmu.

Uwaga: plakietka musi zawierać tekst lub obraz.

Wskazówki znajdziesz w specyfikacji obrazu.
Identyfikator rezerwacji Opcjonalny Identyfikator rezerwacji wydarzenia. Dowolny tekst
Cena – CurrentPrice Wymagane warunkowo

Aktualna cena biletu lub karnetu na wydarzenie.

Należy podać, jeśli podano przekreśloną cenę.

Dowolny tekst
Price - StrikethroughPrice Opcjonalny Pierwotna cena biletu lub karnetu na wydarzenie. Dowolny tekst
Objaśnienie ceny Opcjonalny Objaśnienie ceny, aby wyróżnić promocję, wydarzenie lub rabat dla uczestników programu, jeśli są dostępne.

Dowolny tekst

Zalecane rozmiary tekstu: poniżej 45 znaków (tekst, który jest za długi, może zawierać wielokropek)

Ocena – wartość maksymalna Opcjonalny

Maksymalna wartość skali ocen.

Musisz podać tę wartość, jeśli podajesz też bieżącą wartość oceny.

Liczba >= 0,0
Ocena – bieżąca wartość Opcjonalny

Bieżąca wartość skali ocen.

Należy podać, jeśli podano też maksymalną wartość oceny.

Liczba >= 0,0
Ocena – liczba Opcjonalny

Liczba ocen zdarzenia.

Uwaga: wypełnij to pole, jeśli aplikacja ma kontrolować sposób wyświetlania tego elementu użytkownikom. Podaj krótki ciąg znaków, który może być wyświetlany użytkownikowi. Jeśli np. liczba wynosi 1 000 000, rozważ użycie skrótu, np. 1 mln, aby nie została obcięta w przypadku mniejszych rozmiarów wyświetlanych elementów.

Ciąg znaków
Ocena – liczba ocen Opcjonalny

Liczba ocen zdarzenia.

Uwaga: podaj to pole, jeśli nie chcesz samodzielnie obsługiwać logiki skrótu wyświetlania. Jeśli podane są zarówno liczba, jak i wartość liczby, użytkownikom wyświetlimy liczbę.

Długi
Kategorie treści Opcjonalny Opisz kategorię treści w encji.

Lista kwalifikujących się typów wyliczeniowych

  • TYPE_MOVIES_AND_TV_SHOWS (przykład: kino)
  • TYPE_DIGITAL_GAMES (przykład: e-sport)
  • TYPE_MUSIC (przykład: koncert)
  • TYPE_TRAVEL_AND_LOCAL (przykład: wycieczka, festiwal)
  • TYPE_HEALTH_AND_FITENESS (np. zajęcia z jogi)
  • TYPE_EDUCATION (przykład: zajęcia)
  • TYPE_SPORTS (przykład: mecz piłki nożnej)
  • TYPE_DATING (przykład: meetup)

Wskazówki znajdziesz w sekcji dotyczącej kategorii treści.

DisplayTimeWindow (opcjonalnie) – ustaw przedział czasu, w którym treści mają być wyświetlane na danej platformie.
Sygnatura czasowa rozpoczęcia Opcjonalny

Sygnatura czasowa epoki, po której treści powinny być wyświetlane na danej platformie.

Jeśli nie jest ustawiona, treści mogą być wyświetlane na danej platformie.

Sygnatura czasowa epoki w milisekundach
Sygnatura czasowa zakończenia Opcjonalny

Sygnatura czasowa epoki, po której treści nie są już wyświetlane na danej platformie.

Jeśli nie jest ustawiona, treści mogą być wyświetlane na danej platformie.

Sygnatura czasowa epoki w milisekundach

LodgingReservationEntity

Atrybut Wymaganie Opis Format
Identyfikator URI działania Wymagany

Precyzyjny link do elementu w aplikacji dostawcy.

Uwaga: do atrybucji możesz używać precyzyjnych linków. Zapoznaj się z odpowiedziami na najczęstsze pytania.

Uri
Tytuł Wymagany Tytuł elementu.

Dowolny tekst. Na przykład „Twój pobyt od 12 grudnia”.

Zalecana długość tekstu: maks. 50 znaków

Zlokalizowana godzina zameldowania – sygnatura czasowa Wymagany Sygnatura czasowa epoki, która reprezentuje godzinę zameldowania w ramach rezerwacji. Joda-Time Instant
Zlokalizowana godzina zameldowania – strefa czasowa Wymagany Strefa czasowa, w której obowiązuje godzina zameldowania dla rezerwacji.

Joda-Time DateTimeZone

Wskazówki znajdziesz w specyfikacji stref czasowych.

Zlokalizowana godzina wymeldowania – sygnatura czasowa Wymagany Sygnatura czasowa epoki, która reprezentuje godzinę wymeldowania w rezerwacji. Joda-Time Instant
Zlokalizowana godzina wymeldowania – strefa czasowa Wymagany Strefa czasowa, w której obowiązuje godzina wymeldowania dla rezerwacji.

Joda-Time DateTimeZone

Wskazówki znajdziesz w specyfikacji stref czasowych.

Lokalizacja – kraj Wymagany Kraj, w którym znajduje się miejsce zakwaterowania.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Lokalizacja – miasto Wymagany Miasto, w którym znajduje się miejsce zakwaterowania.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Lokalizacja – wyświetlany adres Wymagany Adres, który będzie wyświetlany użytkownikowi. Podaj zwięzły adres, używając skrótów, gdzie to możliwe (np. „ul.” zamiast „ulica”). Ten ciąg znaków może zostać obcięty w zależności od urządzenia i ustawień użytkownika. Uwzględnij nazwę miasta, aby ułatwić identyfikację.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 35 znaków

Lokalizacja – adres Opcjonalny Adres (jeśli dotyczy) miejsca zakwaterowania.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Lokalizacja – stan Opcjonalny Województwo lub region (w stosownych przypadkach), w którym znajduje się miejsce zakwaterowania.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Lokalizacja – kod pocztowy Opcjonalny Kod pocztowy (jeśli dotyczy) miejsca zakwaterowania.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Lokalizacja – dzielnica Opcjonalny Dzielnica (jeśli dotyczy), w której znajduje się kwatera.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Obrazy plakatu Opcjonalny

Jeśli podasz kilka obrazów, wyświetlimy tylko 1 z nich. Zalecany format obrazu to 16:9.

Uwaga: jeśli podano plakietkę, upewnij się, że u góry i u dołu obrazu jest bezpieczny obszar o szerokości 24 dp.

Wskazówki znajdziesz w specyfikacji obrazu.
Opis Opcjonalny

Pojedynczy akapit tekstu opisujący encję.

Uwaga: użytkownikowi wyświetli się opis lub lista podtytułów, ale nie oba te elementy.

Dowolny tekst

Zalecana długość tekstu: 180 znaków

Lista napisów Opcjonalny

Maksymalnie 3 podtytuły, każdy w jednym wierszu tekstu.

Uwaga: użytkownikowi wyświetli się opis lub lista podtytułów, ale nie oba te elementy.

Dowolny tekst

Zalecany rozmiar tekstu dla każdego podtytułu: maks. 50 znaków

Identyfikator rezerwacji Opcjonalny Identyfikator rezerwacji noclegu. Dowolny tekst
Ocena – wartość maksymalna Opcjonalny

Maksymalna wartość skali ocen.

Musisz podać tę wartość, jeśli podajesz też bieżącą wartość oceny.

Liczba >= 0,0
Ocena – bieżąca wartość Opcjonalny

Bieżąca wartość skali ocen.

Należy podać, jeśli podano też maksymalną wartość oceny.

Liczba >= 0,0
Ocena – liczba Opcjonalny

Liczba ocen miejsca zakwaterowania.

Uwaga: wypełnij to pole, jeśli aplikacja ma kontrolować sposób wyświetlania tego elementu użytkownikom. Podaj krótki ciąg znaków, który może być wyświetlany użytkownikowi. Jeśli np. liczba wynosi 1 000 000, rozważ użycie skrótu, np. 1 mln, aby nie została obcięta w przypadku mniejszych rozmiarów wyświetlanych elementów.

Ciąg znaków
Ocena – liczba ocen Opcjonalny

Liczba ocen miejsca zakwaterowania.

Uwaga: podaj to pole, jeśli nie chcesz samodzielnie obsługiwać logiki skrótu wyświetlania. Jeśli podane są zarówno liczba, jak i wartość liczby, użytkownikom wyświetlimy liczbę.

Długi
Cena – CurrentPrice Wymagane warunkowo

Aktualna cena noclegu.

Należy podać, jeśli podano przekreśloną cenę.

Dowolny tekst
Price - StrikethroughPrice Opcjonalny Pierwotna cena miejsca zakwaterowania, która jest przekreślona w interfejsie. Dowolny tekst
Objaśnienie ceny Opcjonalny Objaśnienie ceny, aby wyróżnić promocję, wydarzenie lub rabat dla uczestników programu, jeśli są dostępne.

Dowolny tekst

Zalecane rozmiary tekstu: poniżej 45 znaków (tekst, który jest za długi, może zawierać wielokropek)

DisplayTimeWindow (opcjonalnie) – ustaw przedział czasu, w którym treści mają być wyświetlane na danej platformie.
Sygnatura czasowa rozpoczęcia Opcjonalny

Sygnatura czasowa epoki, po której treści powinny być wyświetlane na danej platformie.

Jeśli nie jest ustawiona, treści mogą być wyświetlane na danej platformie.

Sygnatura czasowa epoki w milisekundach
Sygnatura czasowa zakończenia Opcjonalny

Sygnatura czasowa epoki, po której treści nie są już wyświetlane na danej platformie.

Jeśli nie jest ustawiona, treści mogą być wyświetlane na danej platformie.

Sygnatura czasowa epoki w milisekundach

TransportationReservationEntity

Atrybut Wymaganie Opis Format
Identyfikator URI działania Wymagany

Precyzyjny link do elementu w aplikacji dostawcy.

Uwaga: do atrybucji możesz używać precyzyjnych linków. Zapoznaj się z odpowiedziami na najczęstsze pytania.

Uri
Tytuł Wymagany Tytuł elementu.

Dowolny tekst. Na przykład „SFO do SAN”

Zalecana długość tekstu: maks. 50 znaków

Typ transportu Wymagany Środek/typ transportu w rezerwacji. Enum: FLIGHT, TRAIN, BUS lub FERRY
Zlokalizowany czas wylotu – sygnatura czasowa Wymagany Sygnatura czasowa epoki, która reprezentuje czas odjazdu. Joda-Time Instant
Zlokalizowany czas wylotu – strefa czasowa Wymagany Strefa czasowa godziny odjazdu.

Joda-Time DateTimeZone

Wskazówki znajdziesz w specyfikacji stref czasowych.

Zlokalizowana godzina przyjazdu – sygnatura czasowa Wymagany Sygnatura czasowa epoki, która reprezentuje czas przybycia. Joda-Time Instant
Zlokalizowana godzina przylotu – strefa czasowa Wymagany Strefa czasowa godziny przyjazdu.

Joda-Time DateTimeZone

Wskazówki znajdziesz w specyfikacji stref czasowych.

Numer transportu Wymagany Numer lotu, autobusu, pociągu, promu lub rejsu. Dowolny tekst
Zlokalizowany czas wejścia na pokład – sygnatura czasowa Wymagany Sygnatura czasowa epoki, która reprezentuje czas wejścia na pokład w przypadku rezerwacji (jeśli dotyczy) Joda-Time Instant
Zlokalizowany czas wejścia na pokład – strefa czasowa Wymagany Strefa czasowa godziny wejścia na pokład w przypadku rezerwacji (jeśli dotyczy)

Joda-Time DateTimeZone

Wskazówki znajdziesz w specyfikacji stref czasowych.

Lokalizacja wyjazdu – kraj Opcjonalny Kraj wyjazdu.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Lokalizacja miejsca wylotu – miasto Opcjonalny Miasto wylotu.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Departure Location - Display Address Opcjonalny Miejsce wylotu, które będzie wyświetlane użytkownikowi.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Miejsce wyjazdu – ulica i numer Opcjonalny Adres (jeśli dotyczy) miejsca wyjazdu.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Lokalizacja miejsca wyjazdu/wylotu – stan Opcjonalny Województwo lub region (jeśli dotyczy) miejsca wylotu.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Miejsce wylotu – kod pocztowy Opcjonalny Kod pocztowy (jeśli dotyczy) miejsca wylotu.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Miejsce wylotu – dzielnica Opcjonalny Dzielnica (jeśli dotyczy) miejsca wylotu.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Lokalizacja przylotu – kraj Opcjonalny Kraj docelowy.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Lokalizacja przylotu – miasto Opcjonalny Miasto przylotu.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Miejsce przyjazdu – wyświetlany adres Opcjonalny Miejsce przybycia, które będzie wyświetlane użytkownikowi.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Lokalizacja miejsca docelowego – ulica i numer Opcjonalny Adres (jeśli dotyczy) miejsca przyjazdu.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Lokalizacja przylotu – stan Opcjonalny Województwo lub region (jeśli dotyczy) lokalizacji docelowej.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Lokalizacja docelowa – kod pocztowy Opcjonalny Kod pocztowy (w odpowiednich przypadkach) miejsca dostawy.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Miejsce docelowe – dzielnica Opcjonalny Dzielnica (jeśli dotyczy) miejsca przyjazdu.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Dostawca usług – nazwa Opcjonalny

Nazwa dostawcy usług.

Uwaga: w przypadku dostawcy usług wymagany jest tekst lub obraz.

Dowolny tekst. Na przykład nazwa linii lotniczych
Dostawca usług – obraz Opcjonalny

Logo lub obraz usługodawcy.

Uwaga: w przypadku dostawcy usług wymagany jest tekst lub obraz.

Wskazówki znajdziesz w specyfikacji obrazu.
Obrazy plakatu Opcjonalny

Jeśli podasz kilka obrazów, wyświetlimy tylko 1 z nich. Zalecany format obrazu to 16:9.

Wskazówki znajdziesz w specyfikacji obrazu.
Opis Opcjonalny

Pojedynczy akapit tekstu opisujący encję.

Uwaga: użytkownikowi wyświetli się opis lub lista podtytułów, ale nie oba te elementy.

Dowolny tekst

Zalecana długość tekstu: 180 znaków

Lista napisów Opcjonalny

Maksymalnie 3 podtytuły, każdy w jednym wierszu tekstu.

Uwaga: użytkownikowi wyświetli się opis lub lista podtytułów, ale nie oba te elementy.

Dowolny tekst

Zalecany rozmiar tekstu dla każdego podtytułu: maks. 50 znaków

Identyfikator rezerwacji Opcjonalny Identyfikator rezerwacji transportu. Dowolny tekst
Cena – CurrentPrice Wymagane warunkowo

Aktualna cena rezerwacji.

Należy podać, jeśli podano przekreśloną cenę.

Dowolny tekst
Price - StrikethroughPrice Opcjonalny Pierwotna cena rezerwacji, która jest przekreślona w interfejsie. Dowolny tekst
Objaśnienie ceny Opcjonalny Objaśnienie ceny, aby wyróżnić promocję, wydarzenie lub rabat dla uczestników programu, jeśli są dostępne.

Dowolny tekst

Zalecane rozmiary tekstu: poniżej 45 znaków (tekst, który jest za długi, może zawierać wielokropek)

DisplayTimeWindow (opcjonalnie) – ustaw przedział czasu, w którym treści mają być wyświetlane na danej platformie.
Sygnatura czasowa rozpoczęcia Opcjonalny

Sygnatura czasowa epoki, po której treści powinny być wyświetlane na danej platformie.

Jeśli nie jest ustawiona, treści mogą być wyświetlane na danej platformie.

Sygnatura czasowa epoki w milisekundach
Sygnatura czasowa zakończenia Opcjonalny

Sygnatura czasowa epoki, po której treści nie są już wyświetlane na danej platformie.

Jeśli nie jest ustawiona, treści mogą być wyświetlane na danej platformie.

Sygnatura czasowa epoki w milisekundach

VehicleRentalReservationEntity

Atrybut Wymaganie Opis Format
Identyfikator URI działania Wymagany

Precyzyjny link do elementu w aplikacji dostawcy.

Uwaga: do atrybucji możesz używać precyzyjnych linków. Zapoznaj się z odpowiedziami na najczęstsze pytania.

Uri
Tytuł Wymagany Tytuł elementu.

Dowolny tekst. Na przykład „Avis Union Square SF”.

Zalecana długość tekstu: maks. 50 znaków

Zlokalizowany czas odbioru – sygnatura czasowa Wymagany Sygnatura czasowa epoki, która reprezentuje godzinę odbioru w rezerwacji. Joda-Time Instant
Zlokalizowany czas odbioru – strefa czasowa Wymagany Strefa czasowa godziny odbioru w rezerwacji.

Joda-Time DateTimeZone

Wskazówki znajdziesz w specyfikacji stref czasowych.

Zlokalizowany czas zwrotu – sygnatura czasowa Opcjonalny Sygnatura czasowa epoki, która reprezentuje godzinę wymeldowania w rezerwacji. Joda-Time Instant
Zlokalizowany czas powrotu – strefa czasowa Opcjonalny Strefa czasowa godziny wymeldowania w rezerwacji.

Joda-Time DateTimeZone

Wskazówki znajdziesz w specyfikacji stref czasowych.

Adres odbioru – kraj Opcjonalny Kraj, w którym znajduje się miejsce odbioru.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Adres odbioru – miasto Opcjonalny Miasto, w którym znajduje się miejsce odbioru.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Adres odbioru – wyświetlany adres Opcjonalny Lokalizacja odbioru, która będzie wyświetlana użytkownikowi.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Adres odbioru – ulica i numer Opcjonalny Adres (jeśli dotyczy) miejsca odbioru.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Adres odbioru – stan Opcjonalny Województwo lub region (jeśli dotyczy), w którym znajduje się miejsce odbioru.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Adres odbioru – kod pocztowy Opcjonalny Kod pocztowy (jeśli dotyczy) miejsca odbioru.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Adres odbioru – dzielnica Opcjonalny Okolica (jeśli dotyczy) miejsca odbioru.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Adres zwrotny – kraj Opcjonalny Kraj lokalizacji zwrotu.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Adres zwrotny – miasto Opcjonalny Miasto, w którym znajduje się lokalizacja zwrotu.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Adres zwrotny – wyświetlany adres Opcjonalny Lokalizacja zwrotu, która będzie wyświetlana użytkownikowi.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Adres zwrotny – ulica i numer Opcjonalny Adres (jeśli dotyczy) lokalizacji zwrotu.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Adres zwrotny – stan Opcjonalny Województwo lub region (jeśli dotyczy) lokalizacji zwrotu.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Adres zwrotny – kod pocztowy Opcjonalny Kod pocztowy (jeśli dotyczy) lokalizacji zwrotu.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Adres zwrotny – dzielnica Opcjonalny Dzielnica (jeśli dotyczy) lokalizacji zwrotu.

Dowolny tekst

Zalecany rozmiar tekstu: maks. ok. 20 znaków

Dostawca usług – nazwa Opcjonalny

Nazwa dostawcy usług.

Uwaga: w przypadku dostawcy usług wymagany jest tekst lub obraz.

Dowolny tekst. Na przykład „Avis Car Rental”.
Dostawca usług – obraz Opcjonalny

Logo lub obraz usługodawcy.

Uwaga: w przypadku dostawcy usług wymagany jest tekst lub obraz.

Wskazówki znajdziesz w specyfikacji obrazu.
Obrazy plakatu Opcjonalny

Jeśli podasz kilka obrazów, wyświetlimy tylko 1 z nich. Zalecany format obrazu to 16:9.

Wskazówki znajdziesz w specyfikacji obrazu.
Opis Opcjonalny

Pojedynczy akapit tekstu opisujący encję.

Uwaga: użytkownikowi wyświetli się opis lub lista podtytułów, ale nie oba te elementy.

Dowolny tekst

Zalecana długość tekstu: 180 znaków

Lista napisów Opcjonalny

Maksymalnie 3 podtytuły, każdy w jednym wierszu tekstu.

Uwaga: użytkownikowi wyświetli się opis lub lista podtytułów, ale nie oba te elementy.

Dowolny tekst

Zalecany rozmiar tekstu dla każdego podtytułu: maks. 50 znaków

Identyfikator potwierdzenia Opcjonalny Identyfikator potwierdzenia rezerwacji wynajmu pojazdu. Dowolny tekst
Cena – CurrentPrice Wymagane warunkowo

Aktualna cena rezerwacji.

Należy podać, jeśli podano przekreśloną cenę.

Dowolny tekst
Price - StrikethroughPrice Opcjonalny Pierwotna cena rezerwacji, która jest przekreślona w interfejsie. Dowolny tekst
Objaśnienie ceny Opcjonalny Objaśnienie ceny, aby wyróżnić promocję, wydarzenie lub rabat dla uczestników programu, jeśli są dostępne.

Dowolny tekst

Zalecane rozmiary tekstu: poniżej 45 znaków (tekst, który jest za długi, może zawierać wielokropek)

DisplayTimeWindow (opcjonalnie) – ustaw przedział czasu, w którym treści mają być wyświetlane na danej platformie.
Sygnatura czasowa rozpoczęcia Opcjonalny

Sygnatura czasowa epoki, po której treści powinny być wyświetlane na danej platformie.

Jeśli nie jest ustawiona, treści mogą być wyświetlane na danej platformie.

Sygnatura czasowa epoki w milisekundach
Sygnatura czasowa zakończenia Opcjonalny

Sygnatura czasowa epoki, po której treści nie są już wyświetlane na danej platformie.

Jeśli nie jest ustawiona, treści mogą być wyświetlane na danej platformie.

Sygnatura czasowa epoki w milisekundach

Specyfikacja obrazu

W tabeli poniżej znajdziesz wymagane specyfikacje komponentów z obrazem:

Format obrazu Obsługiwane klastry Minimalny rozmiar w pikselach Zalecany rozmiar w pikselach
Orientacja pozioma (16:9, 1,91 x 1) Polecane, rezerwacja, kontynuuj wyszukiwanie i rekomendacja (preferowany format 16:9) 640 x 360 (16:9) / 600 x 314 (1,91:1) 1264 x 712 (16:9) / 1200 x 628 (1,91:1)
Kwadrat (1 x 1) Wszystkie klastry (preferowane w przypadku: StoreEntity; wymagane w przypadku obrazów dostawcy usług i plakietek) 300 x 300 1200 x 1200
Orientacja pionowa (4:5) Rekomendacja 480 x 600 960 x 1200

Obrazy muszą być hostowane w publicznych sieciach CDN, aby Google miało do nich dostęp.

Formaty plików

PNG, JPG, statyczny GIF, WebP

Maksymalny rozmiar pliku

5120 KB

Dodatkowe zalecenia

  • Bezpieczny obszar obrazu: ważne treści umieść w środkowych 80% obrazu.
  • Użyj przezroczystego tła, aby obraz był prawidłowo wyświetlany w ustawieniach ciemnego i jasnego motywu.

Specyfikacje strefy czasowej

Preferuj identyfikator (np. „Ameryka/Los_Angeles”) zamiast przesunięcia (np. „-07:00”).

Przykładowe użycie: DateTimeZone.forID("America/Los_Angeles")

Kategoria treści

Kategoria treści umożliwia aplikacjom publikowanie treści należących do wielu kategorii. Dzięki temu treści są mapowane na niektóre ze wstępnie zdefiniowanych kategorii, czyli:

  • TYPE_EDUCATION
  • TYPE_SPORTS
  • TYPE_MOVIES_AND_TV_SHOWS
  • TYPE_BOOKS
  • TYPE_AUDIOBOOKS
  • TYPE_MUSIC
  • TYPE_DIGITAL_GAMES
  • TYPE_TRAVEL_AND_LOCAL
  • TYPE_HOME_AND_AUTO
  • TYPE_BUSINESS
  • TYPE_NEWS
  • TYPE_FOOD_AND_DRINK
  • TYPE_SHOPPING
  • TYPE_HEALTH_AND_FITENESS
  • TYPE_MEDICAL
  • TYPE_PARENTING
  • TYPE_DATING

Obrazy muszą być hostowane w publicznych sieciach CDN, aby Google miało do nich dostęp.

Wskazówki dotyczące korzystania z kategorii treści

  1. Niektóre encje, takie jak ArticleEntity i GenericFeaturedEntity, mogą używać dowolnych kategorii treści. W przypadku innych encji, takich jak EventEntity, EventReservationEntity, PointOfInterestEntity, kwalifikuje się tylko podzbiór tych kategorii. Przed wypełnieniem listy sprawdź listę kategorii odpowiednich dla danego typu elementu.
  2. W przypadku niektórych kategorii treści używaj konkretnego typu elementu zamiast kombinacji elementów ogólnych i kategorii treści:

  3. Pole ContentCategory jest opcjonalne i należy je pozostawić puste, jeśli treść nie należy do żadnej z wymienionych wcześniej kategorii.

  4. Jeśli podajesz kilka kategorii treści, podaj je w kolejności trafności, przy czym najbardziej trafna kategoria treści powinna być umieszczona na początku listy.

Krok 2. Podaj dane klastra

Zalecamy, aby zadanie publikowania treści było wykonywane w tle (np. za pomocą WorkManagera) i było zaplanowane regularnie lub na podstawie zdarzenia (np. za każdym razem, gdy użytkownik otwiera aplikację lub gdy właśnie dodał coś do koszyka).

AppEngageTravelClient odpowiada za klastry publikujące.

Do publikowania klastrów w kliencie służą te interfejsy API:

  • isServiceAvailable
  • publishRecommendationClusters
  • publishFeaturedCluster
  • publishReservationCluster
  • publishContinueSearchCluster
  • publishUserAccountManagementRequest
  • updatePublishStatus
  • deleteRecommendationsClusters
  • deleteFeaturedCluster
  • deleteReservationCluster
  • deleteContinueSearchCluster
  • deleteUserManagementCluster
  • deleteClusters

isServiceAvailable

Ten interfejs API służy do sprawdzania, czy usługa jest dostępna do integracji i czy treści mogą być wyświetlane na urządzeniu.

Możesz sprawdzić dostępność usługi dla każdego typu klastra, który chcesz opublikować. Interfejs API isServiceAvailable akceptuje obiekt żądania ServiceAvailabilityRequest, który zawiera typy klastrów, dla których należy sprawdzić dostępność usługi. Wartości typu wyliczeniowego ClusterType wymagane w przypadku ServiceAvailabilityRequest znajdziesz w tabeli poniżej.

Typ klastra Stała typu klastra Wartość w formie liczby całkowitej
Nieznany TYPE_UNKNOWN 0
Klaster rekomendacji TYPE_RECOMMENDATION 1
Polecany klaster TYPE_FEATURED 2
Klaster kontynuacji TYPE_CONTINUATION 3
Klaster zarządzania użytkownikami TYPE_ENGAGEMENT 8
Klaster subskrypcji TYPE_SUBSCRIPTION 12
Kontynuuj wyszukiwanie klastra TYPE_CONTINUE_SEARCH 13
Klaster rezerwacji TYPE_RESERVATION 14

Kotlin

val request = ServiceAvailabilityRequest.Builder()
    .addIntendedClusterType(ClusterType.TYPE_CONTINUATION)
    .addIntendedClusterType(ClusterType.TYPE_RECOMMENDATION)
    .build()

client.isServiceAvailable(request).addOnCompleteListener { task ->
    if (task.isSuccessful) {
        val availabilityMap = task.result
        if (availabilityMap[ClusterType.TYPE_CONTINUATION] == true) {
            // Proceed with publishing continuation content
        }
        if (availabilityMap[ClusterType.TYPE_RECOMMENDATION] == true) {
            // Proceed with publishing recommendation content
        }
    } else {
        // The IPC call itself fails, proceed with error handling logic here,
        // such as retry.
    }
}

Java

ServiceAvailabilityRequest request =
    new ServiceAvailabilityRequest.Builder()
        .addIntendedClusterType(ClusterType.TYPE_CONTINUATION)
        .addIntendedClusterType(ClusterType.TYPE_RECOMMENDATION)
        .build();

client.isServiceAvailable(request).addOnCompleteListener(task -> {
    if (task.isSuccessful()) {
        Map<Integer, Boolean> availabilityMap = task.getResult();
        if (Boolean.TRUE.equals(availabilityMap.get(ClusterType.TYPE_CONTINUATION))) {
            // Proceed with publishing continuation content
        }
        if (Boolean.TRUE.equals(availabilityMap.get(ClusterType.TYPE_RECOMMENDATION))) {
            // Proceed with publishing recommendation content
        }
    } else {
        // The IPC call itself fails, proceed with error handling logic here,
        // such as retry.
    }
});
Funkcja warunkowej dostępności usługi

Niektóre zintegrowane aplikacje wymagają specjalnej konfiguracji, która okresowo włącza i wyłącza usługę Engage, aby obniżyć koszty reklamy. Jednak ta strategia przerywanego przetwarzania treści negatywnie wpływa na wrażenia użytkowników: nieaktualne treści nie będą prezentowane, a niektóre platformy nie będą obsługiwane.

Od wersji 1.6.0 pakiet Engage SDK umożliwia sprawdzanie dostępności określonych typów klastrów. Jeśli Twoja aplikacja korzysta z przetwarzania przerywanego:

  • Klastry kontynuacji (takie jak Rezerwacja i Kontynuuj wyszukiwanie) pozostają domyślnie włączone na wszystkich obsługiwanych urządzeniach.
  • Inne typy klastrów (np. rekomendacje) są włączane i wyłączane okresowo.

Jeśli ta domyślna konfiguracja nie odpowiada Twoim potrzebom, skontaktuj się z nami pod adresem engage-developers@google.com.

Wersje pakietu SDK starsze niż 1.6.0 (wycofane)

Kotlin

client.isServiceAvailable.addOnCompleteListener { task ->
    if (task.isSuccessful) {
        // Handle IPC call success
        if(task.result) {
          // Service is available on the device, proceed with content publish
          // calls.
        } else {
          // Service is not available, no further action is needed.
        }
    } else {
      // The IPC call itself fails, proceed with error handling logic here,
      // such as retry.
    }
}

Java

client.isServiceAvailable().addOnCompleteListener(task - > {
    if (task.isSuccessful()) {
        // Handle success
        if(task.getResult()) {
          // Service is available on the device, proceed with content publish
          // calls.
        } else {
          // Service is not available, no further action is needed.
        }
    } else {
      // The IPC call itself fails, proceed with error handling logic here,
      // such as retry.
    }
});

publishRecommendationClusters

Ten interfejs API służy do publikowania listy obiektów RecommendationCluster.

Kotlin

client.publishRecommendationClusters(
      PublishRecommendationClustersRequest.Builder()
        .addRecommendationCluster(
          RecommendationCluster.Builder()
            .addEntity(entity1)
            .addEntity(entity2)
            .setTitle("Top Picks For You")
            .build()
        )
        .build()
    )

Java

client.publishRecommendationClusters(
            new PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    new RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("Top Picks For You")
                        .build())
                .build());

Gdy usługa otrzyma żądanie, w ramach jednej transakcji zostaną wykonane te działania:

  • Dotychczasowe dane RecommendationCluster od partnera dewelopera zostaną usunięte.
  • Dane z żądania są analizowane i zapisywane w zaktualizowanym klastrze rekomendacji.

W przypadku błędu całe żądanie jest odrzucane, a dotychczasowy stan jest zachowywany.

publishFeaturedCluster

Ten interfejs API służy do publikowania listy obiektów FeaturedCluster.

Kotlin

client.publishFeaturedCluster(
    PublishFeaturedClusterRequest.Builder()
      .setFeaturedCluster(
        FeaturedCluster.Builder()
          .addEntity(entity1)
          .addEntity(entity2)
          .build())
      .build())

Java

client.publishFeaturedCluster(
            new PublishFeaturedClusterRequest.Builder()
                .setFeaturedCluster(
                    new FeaturedCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .build())
                .build());

Gdy usługa otrzyma żądanie, w ramach jednej transakcji zostaną wykonane te działania:

  • Dotychczasowe dane FeaturedCluster od partnera dewelopera zostaną usunięte.
  • Dane z żądania są analizowane i zapisywane w zaktualizowanym klastrze polecanych.

W przypadku błędu całe żądanie jest odrzucane i zachowywany jest dotychczasowy stan.

publishReservationCluster

Ten interfejs API służy do publikowania obiektu ReservationCluster.

Kotlin

client.publishReservationCluster(
    PublishReservationClusterRequest.Builder()
      .setReservationCluster(
        ReservationCluster.Builder()
          .addLodgingReservationEntity(lodgingReservationEntity)
          .addVehicleRentalReservationEntity(vehicleRentalReservationEntity)
          .addTransportationReservationEntity(transportationReservationEntity)
          .addEventReservationEntity(eventReservationEntity)
          .addRestaurantReservationEntity(restaurantReservationEntity)
          .build())
      .build())

Java

client.publishReservationCluster(
            new PublishReservationClusterRequest.Builder()
                .setReservationCluster(
                    new ReservationCluster.Builder()
                        .addLodgingReservationEntity(lodgingReservationEntity)
                        .addVehicleRentalReservationEntity(vehicleRentalReservationEntity)
                        .addTransportationReservationEntity(transportationReservationEntity)
                        .addEventReservationEntity(eventReservationEntity)
                        .addRestaurantReservationEntity(restaurantReservationEntity)
                        .build())
                .build());

Gdy usługa otrzyma żądanie, w ramach jednej transakcji zostaną wykonane te działania:

  • Dotychczasowe dane ReservationCluster od partnera dewelopera zostaną usunięte.
  • Dane z żądania są analizowane i zapisywane w zaktualizowanym klastrze rezerwacji.

W przypadku błędu całe żądanie jest odrzucane i zachowywany jest dotychczasowy stan.

publishContinueSearchCluster

Ten interfejs API służy do publikowania listy obiektów ContinueSearchCluster.

Kotlin

client.publishContinueSearchCluster(
    PublishContinueSearchClusterRequest.Builder()
      .setContinueSearchCluster(
        ContinueSearchCluster.Builder()
          .addPointOfInterestEntity(entity1)
          .addPointOfInterestEntity(entity2)
          .build())
      .build())

Java

client.publishContinueSearchCluster(
            new PublishContinueSearchClusterRequest.Builder()
                .setContinueSearchCluster(
                    new ContinueSearchCluster.Builder()
                        .addPointOfInterestEntity(entity1)
                        .addPointOfInterestEntity(entity2)
                        .build())
                .build());

Gdy usługa otrzyma żądanie, w ramach jednej transakcji zostaną wykonane te działania:

  • Dotychczasowe dane ContinueSearchCluster od partnera dewelopera zostaną usunięte.
  • Dane z żądania są analizowane i przechowywane w zaktualizowanym klastrze kontynuacji wyszukiwania.

W przypadku błędu całe żądanie jest odrzucane, a dotychczasowy stan jest zachowywany.

publishUserAccountManagementRequest

Ten interfejs API służy do publikowania karty logowania . Działanie logowania kieruje użytkowników na stronę logowania aplikacji, dzięki czemu aplikacja może publikować treści (lub udostępniać bardziej spersonalizowane treści).

Karta logowania zawiera te metadane:

Atrybut Wymaganie Opis
Identyfikator URI działania Wymagane Precyzyjny link do działania (np. przekierowuje na stronę logowania w aplikacji)
Obraz Opcjonalny – jeśli nie zostanie podany, należy podać tytuł

Obraz wyświetlany na karcie

obrazy o formacie obrazu 16:9 i rozdzielczości 1264 x 712;

Tytuł Opcjonalny – jeśli nie zostanie podany, należy podać obraz Tytuł na karcie
Tekst z opcją działania Opcjonalny Tekst wyświetlany w wezwaniu do działania (np. Zaloguj się)
Podtytuł Opcjonalny Opcjonalny podtytuł na karcie

Kotlin

var SIGN_IN_CARD_ENTITY =
      SignInCardEntity.Builder()
          .addPosterImage(
              Image.Builder()
                  .setImageUri(Uri.parse("http://www.x.com/image.png"))
                  .setImageHeightInPixel(500)
                  .setImageWidthInPixel(500)
                  .build())
          .setActionText("Sign In")
          .setActionUri(Uri.parse("http://xx.com/signin"))
          .build()

client.publishUserAccountManagementRequest(
            PublishUserAccountManagementRequest.Builder()
                .setSignInCardEntity(SIGN_IN_CARD_ENTITY)
                .build());

Java

SignInCardEntity SIGN_IN_CARD_ENTITY =
      new SignInCardEntity.Builder()
          .addPosterImage(
              new Image.Builder()
                  .setImageUri(Uri.parse("http://www.x.com/image.png"))
                  .setImageHeightInPixel(500)
                  .setImageWidthInPixel(500)
                  .build())
          .setActionText("Sign In")
          .setActionUri(Uri.parse("http://xx.com/signin"))
          .build();

client.publishUserAccountManagementRequest(
            new PublishUserAccountManagementRequest.Builder()
                .setSignInCardEntity(SIGN_IN_CARD_ENTITY)
                .build());

Gdy usługa otrzyma żądanie, w ramach jednej transakcji zostaną wykonane te działania:

  • Istniejące dane UserAccountManagementCluster od partnera dewelopera zostaną usunięte.
  • Dane z żądania są analizowane i przechowywane w zaktualizowanym klastrze UserAccountManagementCluster.

W przypadku błędu całe żądanie jest odrzucane i zachowywany jest dotychczasowy stan.

updatePublishStatus

Jeśli z jakiegoś powodu biznesowego żaden z klastrów nie zostanie opublikowany, zdecydowanie zalecamy zaktualizowanie stanu publikacji za pomocą interfejsu API updatePublishStatus. To ważne, ponieważ :

  • Podawanie stanu we wszystkich scenariuszach, nawet gdy treść jest opublikowana (STATUS == PUBLISHED), ma kluczowe znaczenie dla wypełniania paneli, które używają tego stanu do przekazywania informacji o stanie i innych danych dotyczących integracji.
  • Jeśli nie opublikowano żadnych treści, ale stan integracji nie jest uszkodzony (STATUS == NOT_PUBLISHED), Google może uniknąć wywoływania alertów w panelach stanu aplikacji. Potwierdza, że treści nie są publikowane z powodu oczekiwanej sytuacji z punktu widzenia dostawcy.
  • Pomaga deweloperom uzyskać informacje o tym, kiedy dane są publikowane, a kiedy nie.
  • Google może używać kodów stanu, aby zachęcić użytkownika do wykonania określonych działań w aplikacji, dzięki czemu będzie on mógł zobaczyć jej zawartość lub rozwiązać problem.

Lista odpowiednich kodów stanu publikacji :

// Content is published
AppEngagePublishStatusCode.PUBLISHED,

// Content is not published as user is not signed in
AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN,

// Content is not published as user is not subscribed
AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SUBSCRIPTION,

// Content is not published as user location is ineligible
AppEngagePublishStatusCode.NOT_PUBLISHED_INELIGIBLE_LOCATION,

// Content is not published as there is no eligible content
AppEngagePublishStatusCode.NOT_PUBLISHED_NO_ELIGIBLE_CONTENT,

// Content is not published as the feature is disabled by the client
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_FEATURE_DISABLED_BY_CLIENT,

// Content is not published as the feature due to a client error
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_CLIENT_ERROR,

// Content is not published as the feature due to a service error
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_SERVICE_ERROR,

// Content is not published due to some other reason
// Reach out to engage-developers@ before using this enum.
AppEngagePublishStatusCode.NOT_PUBLISHED_OTHER

Jeśli treści nie są publikowane, ponieważ użytkownik nie jest zalogowany, Google zaleca opublikowanie karty logowania. Jeśli z jakiegoś powodu dostawcy nie mogą opublikować karty logowania, zalecamy wywołanie interfejsu API updatePublishStatus z kodem stanu NOT_PUBLISHED_REQUIRES_SIGN_IN.

Kotlin

client.updatePublishStatus(
   PublishStatusRequest.Builder()
     .setStatusCode(AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN)
     .build())

Java

client.updatePublishStatus(
    new PublishStatusRequest.Builder()
        .setStatusCode(AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN)
        .build());

deleteRecommendationsClusters

Ten interfejs API służy do usuwania zawartości klastrów rekomendacji.

Kotlin

client.deleteRecommendationsClusters()

Java

client.deleteRecommendationsClusters();

Gdy usługa otrzyma żądanie, usunie istniejące dane z klastrów rekomendacji. W przypadku błędu całe żądanie jest odrzucane i zachowywany jest dotychczasowy stan.

deleteFeaturedCluster

Ten interfejs API służy do usuwania zawartości klastra polecanych.

Kotlin

client.deleteFeaturedCluster()

Java

client.deleteFeaturedCluster();

Gdy usługa otrzyma żądanie, usunie istniejące dane z polecanego klastra. W przypadku błędu całe żądanie jest odrzucane i zachowywany jest dotychczasowy stan.

deleteReservationCluster

Ten interfejs API służy do usuwania zawartości klastra rezerwacji.

Kotlin

client.deleteReservationCluster()

Java

client.deleteReservationCluster();

Gdy usługa otrzyma żądanie, usunie istniejące dane z klastra rezerwacji. W przypadku błędu całe żądanie jest odrzucane i zachowywany jest dotychczasowy stan.

deleteUserManagementCluster

Ten interfejs API służy do usuwania zawartości klastra UserAccountManagement.

Kotlin

client.deleteUserManagementCluster()

Java

client.deleteUserManagementCluster();

Gdy usługa otrzyma żądanie, usunie istniejące dane z klastra UserAccountManagement. W przypadku błędu całe żądanie jest odrzucane i zachowywany jest dotychczasowy stan.

deleteContinueSearchCluster

Ten interfejs API służy do usuwania zawartości klastra kontynuacji wyszukiwania.

Kotlin

client.deleteContinueSearchCluster()

Java

client.deleteContinueSearchCluster();

Gdy usługa otrzyma żądanie, usunie istniejące dane z klastra wyszukiwania kontynuacji. W przypadku błędu całe żądanie jest odrzucane, a dotychczasowy stan zostaje zachowany.

deleteClusters

Ten interfejs API służy do usuwania zawartości danego typu klastra.

Kotlin

client.deleteClusters(
    DeleteClustersRequest.Builder()
      .addClusterType(ClusterType.TYPE_RESERVATION)
      .addClusterType(ClusterType.TYPE_FEATURED)
      .addClusterType(ClusterType.TYPE_RECOMMENDATION)
      .addClusterType(ClusterType.TYPE_CONTINUE_SEARCH)
      .build())

Java

client.deleteClusters(
            new DeleteClustersRequest.Builder()
                .addClusterType(ClusterType.TYPE_RESERVATION)
                .addClusterType(ClusterType.TYPE_FEATURED)
                .addClusterType(ClusterType.TYPE_RECOMMENDATION)
                .addClusterType(ClusterType.TYPE_CONTINUE_SEARCH)
                .build());

Gdy usługa otrzyma żądanie, usunie istniejące dane ze wszystkich klastrów pasujących do określonych typów klastrów. Klienci mogą przekazywać jeden lub wiele typów klastrów. W przypadku błędu całe żądanie jest odrzucane i zachowywany jest dotychczasowy stan.

Obsługa błędów

Zdecydowanie zalecamy nasłuchiwanie wyniku zadania z interfejsów API publikowania, aby można było podjąć działania następcze w celu odzyskania i ponownego przesłania zadania, które zakończyło się powodzeniem.

Kotlin

client.publishRecommendationClusters(
        PublishRecommendationClustersRequest.Builder()
          .addRecommendationCluster(..)
          .build())
      .addOnCompleteListener { task ->
        if (task.isSuccessful) {
          // do something
        } else {
          val exception = task.exception
          if (exception is AppEngageException) {
            @AppEngageErrorCode val errorCode = exception.errorCode
            if (errorCode == AppEngageErrorCode.SERVICE_NOT_FOUND) {
              // do something
            }
          }
        }
      }

Java

client.publishRecommendationClusters(
              new PublishRecommendationClustersRequest.Builder()
                  .addRecommendationCluster(...)
                  .build())
          .addOnCompleteListener(
              task -> {
                if (task.isSuccessful()) {
                  // do something
                } else {
                  Exception exception = task.getException();
                  if (exception instanceof AppEngageException) {
                    @AppEngageErrorCode
                    int errorCode = ((AppEngageException) exception).getErrorCode();
                    if (errorCode == AppEngageErrorCode.SERVICE_NOT_FOUND) {
                      // do something
                    }
                  }
                }
              });

Błąd jest zwracany jako AppEngageException z przyczyną podaną jako kod błędu.

Kod błędu Nazwa błędu Uwaga
1 SERVICE_NOT_FOUND Usługa jest niedostępna na danym urządzeniu.
2 SERVICE_NOT_AVAILABLE Usługa jest dostępna na danym urządzeniu, ale nie jest dostępna w momencie wywołania (np. jest wyraźnie wyłączona).
3 SERVICE_CALL_EXECUTION_FAILURE Nie udało się wykonać zadania z powodu problemów z wątkami. W takim przypadku można spróbować ponownie.
4 SERVICE_CALL_PERMISSION_DENIED Wywołujący nie ma uprawnień do wywołania usługi.
5 SERVICE_CALL_INVALID_ARGUMENT Żądanie zawiera nieprawidłowe dane (np. więcej klastrów niż dozwolona liczba).
6 SERVICE_CALL_INTERNAL Wystąpił błąd po stronie usługi.
7 SERVICE_CALL_RESOURCE_EXHAUSTED Wywołanie usługi jest wykonywane zbyt często.

Krok 3. Obsługa intencji transmisji

Oprócz wywoływania interfejsu API do publikowania treści za pomocą zadania musisz też skonfigurować BroadcastReceiver, aby otrzymywać żądania publikowania treści.

Intencje rozgłaszania służą głównie do ponownej aktywacji aplikacji i wymuszania synchronizacji danych. Intencje rozgłaszania nie są przeznaczone do częstego wysyłania. Jest wywoływana tylko wtedy, gdy usługa Engage określi, że treści mogą być nieaktualne (np. mają tydzień). Dzięki temu użytkownik może mieć pewność, że będzie miał dostęp do aktualnych treści, nawet jeśli aplikacja nie była uruchamiana przez dłuższy czas.

BroadcastReceiver musi być skonfigurowany na 2 sposoby:

  • Dynamicznie zarejestruj instancję klasy BroadcastReceiver za pomocą Context.registerReceiver(). Umożliwia to komunikację z aplikacjami, które nadal działają w pamięci.

Kotlin

class AppEngageBroadcastReceiver : BroadcastReceiver(){
  // Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION broadcast
  // is received
  // Trigger featured cluster publish when PUBLISH_FEATURED broadcast is received
  // Trigger continue search cluster publish when PUBLISH_CONTINUE_SEARCH
  // broadcast is received
  // Trigger reservation cluster publish when PUBLISH_RESERVATION broadcast is
  // received
}

fun registerBroadcastReceivers(context: Context){
  var  context = context
  context = context.applicationContext

// Register Recommendation Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_RECOMMENDATION),
                           com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                           /*scheduler=*/null)

// Register Featured Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_FEATURED),
                           com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                           /*scheduler=*/null)

// Register Continue Search Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(com.google.android.engage.travel.service.Intents.ACTION_PUBLISH_CONTINUE_SEARCH),
                           com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                           /*scheduler=*/null)

// Register Reservation Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(com.google.android.engage.travel.service.Intents.ACTION_PUBLISH_RESERVATION),
                           com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                           /*scheduler=*/null)
}

Java

class AppEngageBroadcastReceiver extends BroadcastReceiver {
// Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION broadcast
// is received

// Trigger featured cluster publish when PUBLISH_FEATURED broadcast is received

// Trigger continue search cluster publish when PUBLISH_CONTINUE_SEARCH
// broadcast is received

// Trigger reservation cluster publish when PUBLISH_RESERVATION broadcast is
// received
}

public static void registerBroadcastReceivers(Context context) {

context = context.getApplicationContext();

// Register Recommendation Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
                         new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_RECOMMENDATION),
                         com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                         /*scheduler=*/null);

// Register Featured Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
                         new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_FEATURED),
                         com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                         /*scheduler=*/null);

// Register Continue Search Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
                         new IntentFilter(com.google.android.engage.travel.service.Intents.ACTION_PUBLISH_CONTINUE_SEARCH),
                         com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                         /*scheduler=*/null);

// Register Reservation Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
                         new IntentFilter(com.google.android.engage.travel.service.Intents.ACTION_PUBLISH_RESERVATION),
                         com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                         /*scheduler=*/null);

}
  • Zadeklaruj statycznie implementację za pomocą tagu <receiver> w pliku AndroidManifest.xml. Dzięki temu aplikacja może odbierać intencje transmisji, gdy nie jest uruchomiona, a także publikować treści.

<application>
   <receiver
      android:name=".AppEngageBroadcastReceiver"
      android:permission="com.google.android.engage.REQUEST_ENGAGE_DATA"
      android:exported="true"
      android:enabled="true">
      <intent-filter>
         <action android:name="com.google.android.engage.action.PUBLISH_RECOMMENDATION" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.PUBLISH_FEATURED" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.travel.PUBLISH_CONTINUE_SEARCH" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.travel.PUBLISH_RESERVATION" />
      </intent-filter>
   </receiver>
</application>

Usługa wysyła te intencje:

  • com.google.android.engage.action.PUBLISH_RECOMMENDATION Zalecamy rozpoczęcie połączenia publishRecommendationClusters po otrzymaniu tej intencji.
  • com.google.android.engage.action.PUBLISH_FEATURED Po otrzymaniu tej intencji zalecamy rozpoczęcie połączenia publishFeaturedCluster.
  • com.google.android.engage.action.travel.PUBLISH_CONTINUE_SEARCH Po otrzymaniu tej intencji zalecamy rozpoczęcie połączenia publishContinueSearchCluster.
  • com.google.android.engage.action.travel.PUBLISH_RESERVATION Po otrzymaniu tej intencji zalecamy rozpoczęcie połączenia publishReservationCluster.

Przepływ pracy integracji

Szczegółowy przewodnik dotyczący weryfikacji integracji po jej zakończeniu znajdziesz w artykule Przepływ pracy integracji dla deweloperów Engage.

Najczęstsze pytania

Odpowiedzi na najczęstsze pytania znajdziesz w artykule Najczęstsze pytania dotyczące pakietu Engage SDK.

Kontakt

Jeśli podczas procesu integracji pojawią się pytania, skontaktuj się z engage-developers@google.com.

Dalsze kroki

Po zakończeniu integracji wykonaj te czynności:

  • Wyślij e-maila na adres engage-developers@google.com i załącz zintegrowany plik APK, który jest gotowy do przetestowania przez Google.
  • Google przeprowadza weryfikację i sprawdza wewnętrznie, czy integracja działa zgodnie z oczekiwaniami. Jeśli konieczne będą zmiany, Google skontaktuje się z Tobą i poda niezbędne informacje.
  • Gdy testy zostaną zakończone i nie będą potrzebne żadne zmiany, Google skontaktuje się z Tobą, aby poinformować, że możesz zacząć publikować zaktualizowany i zintegrowany pakiet APK w Sklepie Play.
  • Gdy Google potwierdzi, że zaktualizowany pakiet APK został opublikowany w Sklepie Play, klastry Rekomendacja, Polecane, Rezerwacja i Kontynuuj wyszukiwanie mogą zostać opublikowane i widoczne dla użytkowników.