Google tworzy interfejs na urządzeniu, który porządkuje aplikacje użytkowników według branży i umożliwia nowe wciągające wrażenia podczas przeglądania i odtwarzania spersonalizowanych treści w aplikacji. Dzięki temu partnerzy deweloperzy mogą prezentować swoje najlepsze treści w ramach dedykowanego kanału poza aplikacją.
Ten dokument zawiera instrukcje dla partnerów deweloperów dotyczące integracji nowych treści, takich jak rezerwacje, wydarzenia, obiekty noclegowe, miejsca warte odwiedzenia, osoby i inne treści, które nie pasują do żadnej z tych kategorii, za pomocą pakietu SDK Engage w celu wypełniania nowej powierzchni.
Szczegóły integracji
Terminologia
Ta integracja obejmuje 3 typy klastrów: Recommendation (Rekomendacje), Featured (Polecane) i Continuation (Kontynuacja).
Rekomendacje to grupy zawierające spersonalizowane sugestie od poszczególnych partnerów deweloperów. Jest to widok interfejsu, który zawiera grupę rekomendacji od tego samego partnera deweloperskiego.
ArticleEntity: obiekt ArticleEntity, który reprezentuje tekstową rekomendację treści, która jest istotna dla więcej niż jednej kategorii treści. Element ArticleEntity umożliwia deweloperom udostępnianie różnych treści tekstowych i obrazowych z większą ilością metadanych, aby przekazywać użytkownikom więcej informacji niż w przypadku elementu GenericFeaturedEntity. Przykład: treści marketingowe, fragment wiadomości
Ilustracja 1. Interfejs pokazujący pojedynczą entość ArticleEntity w klastrze rekomendacji. EventEntity: obiekt EventEntity reprezentuje zdarzenie, które ma nastąpić w przyszłości. Czas rozpoczęcia wydarzenia to kluczowa informacja, którą należy przekazać użytkownikom.
Rysunek 2.: interfejs pokazujący pojedynczy obiekt EventEntity w klastrze rekomendacji. LodgingEntity: obiekt zakwaterowania, np. hotel, apartament, dom wakacyjny na krótki lub długi okres wynajmu.
Rysunek 3. Interfejs pokazujący pojedynczą instancję obiektu LodgingEntity w klastrze rekomendacji. StoreEntity: StoreEntity reprezentuje sklep, restaurację, kawiarnię itp. Podkreśla treści, w których lokal gastronomiczny lub sklep jest kluczowym elementem informacji, który należy przekazać użytkownikom.
Rysunek 4. Interfejs pokazujący pojedynczą instancję typu StoreEntity w klastrze rekomendacji. PointOfInterestEntity: obiekt PointOfInterestEntity reprezentuje miejsce, które może zainteresować użytkowników, np. stację benzynową, miejsce wydarzenia, park rozrywki, muzeum, atrakcję turystyczną, szlak turystyczny itp. Podkreśla treści, w których przypadku lokalizacja jest istotną informacją, którą należy przekazać użytkownikom. Nie powinien on dotyczyć obiektu noclegowego, sklepu ani lokalu gastronomicznego.
Rysunek 5. Interfejs pokazujący pojedynczy obiekt PointOfInterestEntity w klastrze rekomendacji. PersonEntity: obiekt PersonEntity reprezentuje osobę. Rekomendacje mogą na przykład wyróżniać osobę w kategoriach takich jak zdrowie i fitness, sport, randki itp.
Rysunek 5.: interfejs z jednym obiektem PersonEntity w klastrze rekomendacji.
Klaster Kontynuacja zawiera treści, z których użytkownicy korzystali ostatnio, pochodzące od wielu partnerów deweloperów w jednym układzie interfejsu. Każdy partner deweloper może nadawać maksymalnie 10 elementów w klastrze Kontynuacji.
Treści kontynuacji mogą mieć taką strukturę:
ArticleEntity: obiekt ArticleEntity, który reprezentuje tekstową rekomendację treści, która jest istotna dla więcej niż jednej kategorii treści. Ten element może służyć do reprezentowania niedokończonych artykułów informacyjnych lub innych treści, które użytkownik chce kontynuować od miejsca, w którym je przerwał. Przykład: treści marketingowe, fragment wiadomości
Rysunek 6. Interfejs pokazujący pojedynczy element ArticleEntity w klastrze Continuation. RestaurantReservationEntity: obiekt RestaurantReservationEntity reprezentuje rezerwację w restauracji lub kawiarni i pomaga użytkownikom śledzić nadchodzące lub trwające rezerwacje w restauracji.
Rysunek 7. Interfejs pokazujący pojedynczy obiekt RestaurantReservationEntity w klastrze Continuation. EventReservationEntity: obiekt EventReservationEntity reprezentuje rezerwację wydarzenia i pomaga użytkownikom śledzić nadchodzące lub trwające rezerwacje wydarzeń. Te wydarzenia mogą obejmować m.in.:
- wydarzenia sportowe, takie jak rezerwacja na mecz piłki nożnej;
- wydarzenia związane z grami, np. rezerwacje na mecze e-sportowe;
- wydarzenia rozrywkowe, takie jak rezerwacja biletów do kina, koncert, teatr, spotkanie z autorem książki.
- rezerwacje dotyczące podróży lub miejsc, takich jak wycieczki z przewodnikiem czy bilety do muzeum;
- Rezerwacje na spotkania towarzyskie, seminaria i konferencje
- Rezerwacje na zajęcia edukacyjne / szkoleniowe
Rysunek 8. Interfejs pokazujący pojedynczy obiekt EventReservationEntity w klastrze kontynuacji. LodgingReservationEntity: obiekt zakwaterowania LodgingEntityReservation reprezentuje rezerwację miejsca zakwaterowania i pomaga użytkownikom śledzić nadchodzące lub trwające rezerwacje hoteli lub kwater wakacyjnych.
Rysunek 9. Interfejs użytkownika pokazujący pojedynczy obiekt typu LodgingReservationEntity w klastrze kontynuacji. TransportationReservationEntity: TransportationReservationEntity reprezentuje rezerwację transportu w dowolnym trybie i pomaga użytkownikom śledzić rezerwacje dotyczące nadchodzących lub trwających lotów, przepraw, pociągów, autobusów, przejazdów taksówką lub rejsów.
Rysunek 10. Interfejs użytkownika pokazujący pojedynczy obiekt TransportationReservationEntity w klastrze Continuation. VehicleRentalReservationEntity: VehicleRentalReservationEntity reprezentuje rezerwację wynajmu pojazdu i pomaga użytkownikom śledzić nadchodzące lub bieżące rezerwacje wynajmu pojazdów.
Rysunek 11. Interfejs pokazujący pojedynczy obiekt VehicleRentalReservationEntity w klastrze Continuation.
Grupa Polecane to widok interfejsu, który prezentuje wybrany element
GenericFeaturedEntity
od wielu partnerów deweloperów w jednym układzie interfejsu. Jest jeden wyróżniony klaster, który jest wyświetlany u góry interfejsu użytkownika, w priorytetowym miejscu nad wszystkimi klastrami rekomendacji. Każdy partner deweloper może wyświetlać w sekcji Polecane pojedynczy element danego typu, a w każdym z tych klastrów może być wiele elementów (potencjalnie różnych typów) od wielu deweloperów aplikacji.GenericFeaturedEntity: GenericFeaturedEntity różni się od elementu rekomendacji tym, że element polecany powinien być używany w przypadku pojedynczego najlepszego materiału od dewelopera i powinien reprezentować najważniejszy materiał, który będzie interesujący i trafny dla użytkowników.
Rysunek 12. Interfejs użytkownika z jedną kartą typu hero GenericFeaturedEntity w grupie Featured
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.5.2'
}
Podsumowanie
Projekt jest oparty na implementacji usługi powiązanej.
Dane, które klient może publikować, podlegają następującym ograniczeniom 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 ,
PointOfInterestEntity lub PersonEntity ) |
Klaster kontynuacji | Maksymalnie 1 | Co najmniej 1 | Maksymalnie 20 (ArticleEntity , EventReservationEntity , LodgingReservationEntity , TransportationReservationEntity lub VehicleRentalReservationEntity ) |
Polecany klaster | Maksymalnie 1 | Co najmniej 1 | Maksymalnie 20 (GenericFeaturedEntity ) |
Krok 1. Podaj dane o podmiocie
Pakiet SDK definiuje różne elementy reprezentujące poszczególne typy elementów. W kategorii „Inne” obsługujemy te typy jednostek:
GenericFeaturedEntity
ArticleEntity
EventEntity
LodgingEntity
StoreEntity
PointOfInterestEntity
PersonEntity
RestaurantReservationEntity
EventReservationEntity
LodgingReservationEntity
TransportationReservationEntity
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 |
Identyfikator 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 dodasz plakietkę, pamiętaj o pozostawieniu 24 dps wolnego miejsca u góry i u dołu obrazu. |
Więcej informacji znajdziesz w specyfikacji zdjęć. |
Tytuł | Opcjonalny | Tytuł elementu. | Tekst otwarty Zalecany rozmiar tekstu: 50 znaków |
Opis | Opcjonalny | Jeden akapit tekstu opisujący daną encję. Uwaga: użytkownik zobaczy albo opis, albo listę napisów, ale nie oba naraz. |
Tekst otwarty Zalecany rozmiar tekstu: 180 znaków |
Lista napisów | Opcjonalny | Maksymalnie 3 napisy, z których każdy stanowi pojedynczy wiersz tekstu. Uwaga: użytkownik zobaczy albo opis, albo listę napisów, ale nie oba naraz. |
Tekst otwarty Zalecane rozmiary tekstu dla każdego z podtytułów: maks. 50 znaków |
Odznaki | Opcjonalny | Każda plakietka może zawierać dowolny tekst (maksymalnie 15 znaków) lub mały obraz. specjalne wrażenia użytkownika na obrazie lub filmie, np. w postaci plakietki nałożonej na obraz
|
|
Odznaka – tekst | Opcjonalny | Tytuł plakietki Uwaga: na plakietce musi znajdować się tekst lub obraz. |
Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 15 znaków |
Odznaka – obraz | Opcjonalny | Mały obraz specjalne wrażenia użytkownika, na przykład w postaci plakietki nałożonej na obrazie lub miniaturze filmu; Uwaga: na plakietce musi znajdować się tekst lub obraz. |
Więcej informacji znajdziesz w specyfikacji zdjęć. |
Kategorie treści | Opcjonalny | Opisz kategorię treści w podmiocie. | Lista wartości w polu enum Wskazówki znajdziesz w sekcji Kategoria treści. |
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 |
Identyfikator URI |
Tytuł | Wymagany | Tytuł elementu. | Tekst otwarty Zalecany rozmiar 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 w ramach projektu znajduje się plakietka, należy zapewnić bezpieczną odległość 24 dps u góry i dołu obrazu. |
Więcej informacji znajdziesz w specyfikacji zdjęć. |
Źródło – tytuł | Opcjonalny | imię i nazwisko autora, organizacji lub reportera; | Tekst otwarty Zalecany rozmiar tekstu: mniej niż 25 znaków |
Źródło – obraz | Opcjonalny | obraz źródła, np. autora, organizacji, reportera; | Więcej informacji znajdziesz w specyfikacji zdjęć. |
Opis | Opcjonalny | Jeden akapit tekstu opisujący daną encję. Uwaga: użytkownik zobaczy albo opis, albo listę napisów, ale nie oba naraz. |
Tekst otwarty Zalecany rozmiar tekstu: 180 znaków |
Lista napisów | Opcjonalny | Maksymalnie 3 napisy, z których każdy stanowi pojedynczy wiersz tekstu. Uwaga: użytkownik zobaczy albo opis, albo listę napisów, ale nie oba naraz. |
Tekst otwarty Zalecane rozmiary tekstu dla każdego z podtytułów: maks. 50 znaków |
Odznaki | Opcjonalny | Każda plakietka może zawierać dowolny tekst (maksymalnie 15 znaków) lub mały obraz. Specjalne wrażenia użytkownika na obrazie lub filmie, na przykład w postaci plakietki nałożonej na obraz
|
|
Odznaka – tekst | Opcjonalny | Tytuł plakietki Uwaga: na plakietce musi znajdować się tekst lub obraz. |
Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 15 znaków |
Odznaka – obraz | Opcjonalny | Mały obraz specjalne wrażenia użytkownika, na przykład w postaci plakietki nałożonej na obrazie lub miniaturze filmu; Uwaga: na plakietce musi znajdować się tekst lub obraz. |
Więcej informacji znajdziesz w specyfikacji zdjęć. |
Czas publikacji treści | Opcjonalny | To sygnatura czasowa ery w milisekundach, w których treści zostały opublikowane lub zaktualizowane w aplikacji. | Sygnatura czasowa od początku epoki w milisekundach |
Ostatni czas zaangażowania | Wymagane warunkowo | Sygnatura czasowa w epoce (w milisekundach) ostatniej interakcji użytkownika z tym elementem. Uwaga: to pole jest wymagane, jeśli ten element należy do klastra kontynuacji. |
Sygnatura czasowa od początku epoki w milisekundach |
Procent postępu | Wymagane warunkowo | Odsetek pełnych treści wykorzystanych przez użytkownika do tej pory. Uwaga: to pole jest wymagane, jeśli ten element należy do klastra kontynuacji. |
Wartość typu int z zakresu 0–100. |
Kategorie treści | Opcjonalny | Opisz kategorię treści w podmiocie. | Lista wartości w polu enum Wskazówki znajdziesz w sekcji Kategoria treści. |
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 |
Identyfikator URI |
Tytuł | Wymagany | Tytuł elementu. | Ciąg znaków Zalecany rozmiar tekstu: maks. 50 znaków |
Czas rozpoczęcia | Wymagany |
Sygnatura czasowa ery, w której ma się rozpocząć zdarzenie. Uwaga: wartość ta jest podawana w milisekundach. |
Sygnatura czasowa od początku epoki w milisekundach |
Tryb zdarzenia | Wymagany | Pole, w którym wskazujesz, czy wydarzenie będzie wirtualne, stacjonarne czy obie te formy. |
Typ enumeracji: 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 w ramach projektu znajduje się plakietka, należy zapewnić bezpieczną odległość 24 dps u góry i dołu obrazu. |
Więcej informacji znajdziesz w specyfikacji zdjęć. |
Lokalizacja – kraj | Wymagane warunkowo | Kraj, w którym odbywa się wydarzenie. Uwaga: ta opcja jest wymagana w przypadku zdarzeń o typie IN_PERSON lub HYBRID. |
Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Lokalizacja – miasto | Wymagane warunkowo | Miasto, w którym odbywa się wydarzenie. Uwaga: ta opcja jest wymagana w przypadku zdarzeń o typie IN_PERSON lub HYBRID. |
Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 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: ta opcja jest wymagana w przypadku zdarzeń o typie IN_PERSON lub HYBRID. |
Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Lokalizacja – adres | Opcjonalny | Adres (w odpowiednich przypadkach) miejsca, w którym odbywa się wydarzenie. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Lokalizacja – stan | Opcjonalny | Stan lub prowincja (jeśli ma zastosowanie), w których odbywa się wydarzenie. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Lokalizacja – kod pocztowy | Opcjonalny | Kod pocztowy (jeśli występuje) miejsca, w którym odbywa się wydarzenie. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Lokalizacja – okolica | Opcjonalny | Dzielnica (jeśli dotyczy), w której odbywa się wydarzenie. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Czas zakończenia | Opcjonalny |
Znak czasu epoki, w którym ma się zakończyć zdarzenie. Uwaga: wartość ta jest podawana w milisekundach. |
Sygnatura czasowa od początku epoki w milisekundach |
Opis | Opcjonalny | Jeden akapit tekstu opisujący daną encję. Uwaga: użytkownik zobaczy albo opis, albo listę napisów, ale nie oba naraz. |
Tekst otwarty Zalecany rozmiar tekstu: 180 znaków |
Lista napisów | Opcjonalny | Maksymalnie 3 napisy, z których każdy stanowi pojedynczy wiersz tekstu. Uwaga: użytkownik zobaczy albo opis, albo listę napisów, ale nie oba naraz. |
Tekst otwarty Zalecane rozmiary tekstu dla każdego z podtytułów: maks. 50 znaków |
Odznaki | Opcjonalny |
Każda plakietka może zawierać dowolny tekst (maksymalnie 15 znaków) lub mały obraz. |
|
Odznaka – tekst | Opcjonalny | Tytuł plakietki Uwaga: na plakietce musi znajdować się tekst lub obraz. |
Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 15 znaków |
Odznaka – obraz | Opcjonalny | Mały obraz specjalne wrażenia użytkownika, na przykład w postaci plakietki nałożonej na obrazie lub miniaturze filmu; Uwaga: na plakietce musi znajdować się tekst lub obraz. |
Więcej informacji znajdziesz w specyfikacji zdjęć. |
Cena – CurrentPrice | Wymagane warunkowo |
Aktualna cena biletu na wydarzenie. Musi być podana, jeśli podano cenę przekreśloną. |
Tekst otwarty |
Cena – przekreślona cena | Opcjonalny | Pierwotna cena biletu/karnetu na wydarzenie. | Tekst otwarty |
Objaśnienie dotyczące ceny | Opcjonalny | Podkreślenie ceny, aby poinformować o promocji, wydarzeniu lub rabacie dla członków (jeśli są dostępne). | Tekst otwarty Zalecane rozmiary tekstu: poniżej 45 znaków (w przypadku zbyt długiego tekstu mogą być wyświetlane wielokropki) |
Kategorie treści | Opcjonalny | Opisz kategorię treści w podmiocie. | Lista typów wyliczeniowych spełniających wymagania
Wskazówki znajdziesz w sekcji Kategoria treści. |
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 |
Identyfikator URI |
Tytuł | Wymagany | Tytuł elementu. | Ciąg znaków Zalecany rozmiar 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 w plakietce jest umieszczony obraz, należy pozostawić bezpieczną odległość 24 dps u góry i u dołu obrazu. |
Więcej informacji znajdziesz w specyfikacji zdjęć. |
Lokalizacja – kraj | Wymagany | Kraj, w którym odbywa się zakwaterowanie. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Lokalizacja – miasto | Wymagany | Miasto, w którym znajduje się obiekt zakwaterowania. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Lokalizacja – wyświetlany adres | Wymagany | Adres obiektu zakwaterowania, który będzie wyświetlany użytkownikowi. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Lokalizacja – adres | Opcjonalny | Adres (jeśli dotyczy) obiektu noclegowego. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Lokalizacja – stan | Opcjonalny | Stan lub prowincja (jeśli ma zastosowanie), w których znajduje się obiekt zakwaterowania. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Lokalizacja – kod pocztowy | Opcjonalny | Kod pocztowy (jeśli dotyczy) miejsca zakwaterowania. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Lokalizacja – okolica | Opcjonalny | Okolica (jeśli dotyczy) zakwaterowania. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Odznaki | Opcjonalny |
Każda plakietka może zawierać dowolny tekst (maksymalnie 15 znaków) lub mały obraz. |
|
Odznaka – tekst | Opcjonalny | Tytuł plakietki Uwaga: na plakietce musi znajdować się tekst lub obraz. |
Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 15 znaków |
Odznaka – obraz | Opcjonalny | Mały obraz specjalne wrażenia użytkownika, na przykład w postaci plakietki nałożonej na obrazie lub miniaturze filmu; Uwaga: na plakietce musi znajdować się tekst lub obraz. |
Więcej informacji znajdziesz w specyfikacji zdjęć. |
Opis | Opcjonalny | Jeden akapit tekstu opisujący daną encję. Uwaga: użytkownik zobaczy albo opis, albo listę napisów, ale nie oba naraz. |
Tekst otwarty Zalecany rozmiar tekstu: 180 znaków |
Lista napisów | Opcjonalny | Maksymalnie 3 napisy, z których każdy stanowi pojedynczy wiersz tekstu. Uwaga: użytkownik zobaczy albo opis, albo listę napisów, ale nie oba naraz. |
Tekst otwarty Zalecane rozmiary tekstu dla każdego z podtytułów: maks. 50 znaków |
AvailabilityTimeWindow – Start Time | Opcjonalny | Znak czasowy epoki w milisekundach, kiedy obiekt zakwaterowania ma być otwarty/dostępny. | Sygnatura czasowa od początku epoki w milisekundach |
AvailabilityTimeWindow – End Time | Opcjonalny | Znak czasowy epoki w milisekundach, do którego wniosek powinien być otwarty/dostępny. | Sygnatura czasowa od początku epoki w milisekundach |
Ocena – wartość maksymalna | Opcjonalny | Maksymalna wartość skali oceny. Musi być podana, jeśli podana jest też aktualna wartość oceny. |
Liczba >= 0,0 |
Rating - Current value | Opcjonalny | Bieżąca wartość skali ocen. Musi być podana, jeśli podana jest też maksymalna wartość oceny. |
Liczba >= 0,0 |
Rating - Count (Liczba ocen) | Opcjonalny | Liczba ocen obiektu zakwaterunkowego. Uwaga: wypełnij to pole, jeśli Twoja aplikacja kontroluje sposób wyświetlania liczby użytkownikom. Użyj zwięzłego ciągu znaków. Jeśli np. liczba wynosi 1 000 000, rozważ użycie skrótu, takiego jak 1 mln, aby liczba nie została obcięta w mniejszych rozmiarach wyświetlacza. |
Ciąg znaków |
Rating - Count Value | Opcjonalny | Liczba ocen obiektu zakwaterunkowego. Uwaga: wypełnij to pole, jeśli nie obsługujesz samodzielnie logiki wyświetlania skrótu. Jeśli występują zarówno parametry Liczba, jak i Wartość liczby, użytkownikom wyświetlana jest liczba. |
Długie |
Cena – CurrentPrice | Wymagane warunkowo | bieżąca cena zakwaterowania; Musi być podana, jeśli podano cenę z przekreśleniem. |
Tekst otwarty |
Cena – przekreślona cena | Opcjonalny | Pierwotna cena zakwaterowania, która jest przekreślona w interfejsie. | Tekst otwarty |
Objaśnienie dotyczące ceny | Opcjonalny | Podkreślenie ceny, aby poinformować o promocji, wydarzeniu lub rabacie dla członków (jeśli są dostępne). | Tekst otwarty Zalecane rozmiary tekstu: poniżej 45 znaków (w przypadku zbyt długiego tekstu mogą być wyświetlane wielokropki) |
StoreEntity
Obiekt StoreEntity
reprezentuje pojedynczy sklep, który partnerzy deweloperzy chcą opublikować, np. restaurację lub sklep spożywczy.
Atrybut | Wymaganie | Opis | Format |
---|---|---|---|
obrazy plakatu, | Wymagany | Musisz podać co najmniej 1 obraz. | Więcej informacji znajdziesz w specyfikacji zdjęć. |
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 |
Identyfikator URI |
Tytuł | Opcjonalny | Nazwa sklepu. | Tekst otwarty Zalecane rozmiary tekstu: poniżej 45 znaków (tekst, który jest za długi, może zawierać wielokropki) |
Lokalizacja | Opcjonalny | Lokalizacja sklepu. | Tekst otwarty Zalecane rozmiary tekstu: poniżej 45 znaków (tekst, który jest za długi, może zawierać wielokropki) |
Objaśnienie | Opcjonalny | Ramka z informacją o promocji, wydarzeniu lub aktualizacji sklepu (jeśli jest dostępna). | Tekst otwarty Zalecane rozmiary tekstu: poniżej 45 znaków (tekst, który jest za długi, może zawierać wielokropki) |
Drobny druk | Opcjonalny | Drobny druk objaśnienia. | Tekst otwarty Zalecane rozmiary tekstu: poniżej 45 znaków (tekst, który jest za długi, może zawierać wielokropki) |
Opis | Opcjonalny | Opis sklepu. | Tekst otwarty Zalecana długość tekstu: mniej niż 90 znaków (za długi tekst może być wyświetlany z wielokropem) |
Ocena – wartość maksymalna | Opcjonalny | Maksymalna wartość skali oceny. Musi być podana, jeśli podana jest też aktualna wartość oceny. |
Liczba >= 0,0 |
Rating - Current value | Opcjonalny | Bieżąca wartość skali ocen. Musi być podana, jeśli podana jest też maksymalna wartość oceny. |
Liczba >= 0,0 |
Rating - Count (Liczba ocen) | Opcjonalny | Liczba ocen obiektu zakwaterunkowego. 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 ona obcięta w mniejszych rozmiarach wyświetlacza. |
Ciąg znaków |
Rating - Count Value | Opcjonalny | Liczba ocen obiektu zakwaterunkowego. Uwaga: wypełnij to pole, jeśli nie chcesz samodzielnie obsługiwać logiki wyświetlania skrótów. Jeśli występują zarówno właściwości Liczba, jak i Wartość liczby, użytkownikom wyświetlana jest liczba. |
Długie |
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 |
Identyfikator URI |
Tytuł | Wymagany | Tytuł elementu. | Ciąg znaków Zalecany rozmiar 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: zdecydowanie zalecamy dodanie obrazu. Jeśli w ramach projektu znajduje się plakietka, należy zapewnić bezpieczną odległość 24 dps u góry i dołu obrazu. |
Więcej informacji znajdziesz w specyfikacji zdjęć. |
Lokalizacja – kraj | Wymagany | Kraj, w którym znajduje się punkt zainteresowania. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Lokalizacja – miasto | Wymagany | Miasto, w którym znajduje się ciekawe miejsce. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Lokalizacja – wyświetlany adres | Wymagany | Adres punktu zainteresowania, który będzie wyświetlany użytkownikowi. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Lokalizacja – adres | Opcjonalny | Adres (jeśli dotyczy) ciekawego miejsca. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Lokalizacja – stan | Opcjonalny | Stan lub prowincja (jeśli ma zastosowanie), w których znajduje się punkt zainteresowania. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Lokalizacja – kod pocztowy | Opcjonalny | Kod pocztowy (jeśli występuje) ciekawego miejsca. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Lokalizacja – okolica | Opcjonalny | Okolica (jeśli występuje) ciekawego miejsca. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
AvailabilityTimeWindow – Start Time | Opcjonalny | Sygnatura czasowa w epoce w milisekundach, kiedy punkt zainteresowania ma być otwarty/dostępny. | Sygnatura czasowa od początku epoki w milisekundach |
AvailabilityTimeWindow – End Time | Opcjonalny | Sygnatura czasowa epoki w milisekundach, do której punkt zainteresowania ma być otwarty/dostępny. | Sygnatura czasowa od początku epoki w milisekundach |
Odznaki | Opcjonalny |
Każda plakietka może zawierać dowolny tekst (maksymalnie 15 znaków) lub mały obraz. |
|
Odznaka – tekst | Opcjonalny | Tytuł plakietki Uwaga: na plakietce musi znajdować się tekst lub obraz. |
Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 15 znaków |
Odznaka – obraz | Opcjonalny | Mały obraz specjalne wrażenia użytkownika, na przykład w postaci plakietki nałożonej na obrazie lub miniaturze filmu; Uwaga: na plakietce musi znajdować się tekst lub obraz. |
Więcej informacji znajdziesz w specyfikacji zdjęć. |
Opis | Opcjonalny | Jeden akapit tekstu opisujący daną encję. Uwaga: użytkownik zobaczy albo opis, albo listę napisów, ale nie oba naraz. |
Tekst otwarty Zalecany rozmiar tekstu: 180 znaków |
Lista napisów | Opcjonalny | Maksymalnie 3 napisy, z których każdy stanowi pojedynczy wiersz tekstu. Uwaga: użytkownik zobaczy albo opis, albo listę napisów, ale nie oba naraz. |
Tekst otwarty Zalecane rozmiary tekstu dla każdego z podtytułów: maks. 50 znaków |
Ocena – wartość maksymalna | Opcjonalny | Maksymalna wartość skali oceny. Musi być podana, jeśli podana jest też aktualna wartość oceny. |
Liczba >= 0,0 |
Rating - Current value | Opcjonalny | Bieżąca wartość skali ocen. Musi być podana, jeśli podana jest też maksymalna wartość oceny. |
Liczba >= 0,0 |
Rating - Count (Liczba ocen) | Opcjonalny | Liczba ocen ciekawego miejsca. Uwaga: wypełnij to pole, jeśli Twoja aplikacja kontroluje sposób wyświetlania liczby użytkownikom. Użyj zwięzłego ciągu znaków. Jeśli np. liczba wynosi 1 000 000, rozważ użycie skrótu, takiego jak 1 mln, aby liczba nie została obcięta w mniejszych rozmiarach wyświetlacza. |
Ciąg znaków |
Rating - Count Value | Opcjonalny | Liczba ocen ciekawego miejsca. Uwaga: wypełnij to pole, jeśli nie obsługujesz samodzielnie logiki skrótu wyświetlania. Jeśli występują zarówno parametry Liczba, jak i Wartość liczby, użytkownikom wyświetlana jest liczba |
Długie |
Cena – CurrentPrice | Wymagane warunkowo |
Aktualna cena biletów lub kart wstępu do atrakcji. Musi być podana, jeśli podano cenę przekreśloną. |
Tekst otwarty |
Cena – przekreślona cena | Opcjonalny | Pierwotna cena biletów/kart wstępu do atrakcji. | Tekst otwarty |
Objaśnienie dotyczące ceny | Opcjonalny | Podkreślenie ceny, aby poinformować o promocji, wydarzeniu lub rabacie dla członków (jeśli są dostępne). |
Tekst otwarty Zalecane rozmiary tekstu: poniżej 45 znaków (zbyt długi tekst może zawierać wielokropki) |
Kategorie treści | Opcjonalny | Opisz kategorię treści w podmiocie. | Lista typów wyliczeniowych spełniających wymagania
Wskazówki znajdziesz w sekcji Kategoria treści. |
PersonEntity
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 |
Identyfikator URI |
Profil – nazwa | Wymagany | Nazwa profilu, identyfikator lub nick, np. „Jan Kowalski”, „@TeamPixel” itp. | Ciąg znaków Zalecany rozmiar tekstu: maks. 50 znaków |
Profil – awatar | Wymagany |
Zdjęcie profilowe lub awatar użytkownika. Uwaga: musi to być kwadratowy obraz o proporcjach 1:1. |
Więcej informacji znajdziesz w specyfikacji zdjęć. |
Profil – dodatkowy tekst | Opcjonalny | dowolny tekst, np. nazwa profilu; | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 15 znaków |
Profil – dodatkowe zdjęcie | Opcjonalny | mały obraz, np. odznaka weryfikacyjna; | Więcej informacji znajdziesz w specyfikacji zdjęć. |
Obraz w nagłówku | 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 w ramach projektu znajduje się plakietka, należy zapewnić bezpieczną odległość 24 dps u góry i dołu obrazu. |
Więcej informacji znajdziesz w specyfikacji zdjęć. |
Popularność – liczba | Opcjonalny |
Wskazuje liczbę obserwujących lub wartość popularności, np. „3,7 mln”. Uwaga: jeśli podasz zarówno wartość Liczba, jak i Wartość liczby, zostanie użyta wartość Liczba. |
Ciąg znaków Zalecane rozmiary tekstu: maksymalnie 20 znaków dla liczby i etykiety łącznie |
Popularność – liczba wystąpień | Opcjonalny | Liczba obserwatorów lub wartość popularności. Uwaga: podaj wartość liczby, jeśli aplikacja nie ma obsługiwać logiki optymalizacji dużych liczb pod kątem różnych rozmiarów wyświetlacza. Jeśli podasz zarówno wartość Liczba, jak i Wartość liczby, zostanie użyta liczba. |
Długie |
Popularność – etykieta | Opcjonalny | Wskazać, czym jest etykieta popularności. Na przykład „Lubię to”. | Ciąg znaków Zalecany rozmiar tekstu: maksymalnie 20 znaków dla liczby i etykiety łącznie |
Popularność – wizualizacja | Opcjonalny |
Wskazać, do czego służy interakcja. Na przykład: obraz przedstawiający ikonę polubienia lub emotikony. Możesz przesłać więcej niż 1 obraz, ale nie wszystkie mogą być wyświetlane w wszystkich formatach. Uwaga: musi to być kwadratowy obraz o proporcjach 1:1. |
Więcej informacji znajdziesz w specyfikacji zdjęć. |
Ocena – wartość maksymalna | Wymagane | Maksymalna wartość skali oceny. Musi być podana, jeśli podana jest też aktualna wartość oceny. |
Liczba >= 0,0 |
Rating - Current value | Wymagane | Bieżąca wartość skali ocen. Musi być podana, jeśli podana jest też maksymalna wartość oceny. |
Liczba >= 0,0 |
Rating - Count (Liczba ocen) | Opcjonalny | Liczba ocen danej encji. Uwaga: wypełnij to pole, jeśli aplikacja ma kontrolować sposób wyświetlania tego elementu użytkownikom. Podaj zwięzły 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 ona obcięta w mniejszych rozmiarach wyświetlacza. |
Ciąg znaków |
Rating - Count Value | Opcjonalny | Liczba ocen danej encji. Uwaga: wypełnij to pole, jeśli nie chcesz samodzielnie obsługiwać logiki wyświetlania skrótów. Jeśli występują zarówno właściwości Liczba, jak i Wartość liczby, użytkownikom wyświetlana jest liczba. |
Długie |
Lokalizacja – kraj | Opcjonalny | Kraj, w którym znajduje się dana osoba lub w którym pełni służbę. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Lokalizacja – miasto | Opcjonalny | Miasto, w którym znajduje się dana osoba lub w którym pracuje. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Lokalizacja – wyświetlany adres | Opcjonalny | Użytkownik zobaczy adres, pod którym znajduje się dana osoba lub do którego jest kierowana. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Lokalizacja – adres | Opcjonalny | Adres (w stosownych przypadkach) ulicy, na której znajduje się osoba, która obsługuje klienta. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Lokalizacja – stan | Opcjonalny | Stan (jeśli dotyczy), w którym znajduje się dana osoba lub w którym pełni służbę. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Lokalizacja – kod pocztowy | Opcjonalny | Kod pocztowy (jeśli dotyczy) miejsca, w którym znajduje się lub pracuje dana osoba. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Lokalizacja – okolica | Opcjonalny | Dzielnica (jeśli dotyczy), w której znajduje się lub w której służy. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Odznaki | Opcjonalny |
Każda plakietka może zawierać dowolny tekst (maksymalnie 15 znaków) lub mały obraz. |
|
Odznaka – tekst | Opcjonalny | Tytuł plakietki Uwaga: na plakietce musi znajdować się tekst lub obraz. |
Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 15 znaków |
Odznaka – obraz | Opcjonalny | Mały obraz specjalne wrażenia użytkownika, na przykład w postaci plakietki nałożonej na obrazie lub miniaturze filmu; Uwaga: na plakietce musi znajdować się tekst lub obraz. |
Więcej informacji znajdziesz w specyfikacji zdjęć. |
Opis | Opcjonalny | Jeden akapit tekstu opisujący daną encję. Uwaga: użytkownik zobaczy albo opis, albo listę napisów, ale nie oba naraz. |
Tekst otwarty Zalecany rozmiar tekstu: 180 znaków |
Lista napisów | Opcjonalny | Maksymalnie 3 napisy, z których każdy stanowi pojedynczy wiersz tekstu. Uwaga: użytkownik zobaczy albo opis, albo listę napisów, ale nie oba naraz. |
Tekst otwarty Zalecane rozmiary tekstu dla każdego z podtytułów: maks. 50 znaków |
Kategorie treści | Opcjonalny | Opisz kategorię treści w podmiocie. | Lista typów wyliczeniowych spełniających wymagania
Wskazówki znajdziesz w sekcji Kategoria treści. |
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 |
Identyfikator URI |
Tytuł | Wymagany | Tytuł elementu. | Ciąg znaków Zalecany rozmiar tekstu: maks. 50 znaków |
Czas rozpoczęcia rezerwacji | Wymagany | Sygnatura czasowa epoki w milisekundach, w której ma się rozpocząć rezerwacja. | Sygnatura czasowa od początku epoki w milisekundach |
Lokalizacja – kraj | Wymagany | Kraj, w którym znajduje się restauracja. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Lokalizacja – miasto | Wymagany | Miasto, w którym znajduje się restauracja. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Lokalizacja – wyświetlany adres | Wymagany | Adres restauracji, który będzie wyświetlany użytkownikowi. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Lokalizacja – adres | Opcjonalny | Ulica i numer domu (jeśli dotyczy) restauracji. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Lokalizacja – stan | Opcjonalny | Województwo (jeśli występuje), w którym znajduje się restauracja. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Lokalizacja – kod pocztowy | Opcjonalny | Kod pocztowy (jeśli dotyczy) restauracji. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Lokalizacja – okolica | Opcjonalny | Okolica (jeśli dotyczy) restauracji. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
obrazy plakatu, | Opcjonalny | Jeśli podasz kilka obrazów, wyświetlimy tylko 1 z nich. Zalecany format obrazu to 16:9 | Więcej informacji znajdziesz w specyfikacji zdjęć. |
Opis | Opcjonalny | Jeden akapit tekstu opisujący daną encję. Uwaga: użytkownik zobaczy albo opis, albo listę napisów, ale nie oba naraz. |
Tekst otwarty Zalecany rozmiar tekstu: 180 znaków |
Lista napisów | Opcjonalny | Maksymalnie 3 napisy, z których każdy stanowi pojedynczy wiersz tekstu. Uwaga: użytkownik zobaczy albo opis, albo listę napisów, ale nie oba naraz. |
Tekst otwarty Zalecane rozmiary tekstu dla każdego z podtytułów: maks. 50 znaków |
Wielkość tabeli | Opcjonalny | Liczba osób w grupie rezerwacji | Liczba całkowita > 0 |
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 |
Identyfikator URI |
Tytuł | Wymagany | Tytuł elementu. | Ciąg znaków Zalecany rozmiar tekstu: maks. 50 znaków |
Czas rozpoczęcia | Wymagany |
Sygnatura czasowa ery, w której ma się rozpocząć zdarzenie. Uwaga: wartość ta jest podawana w milisekundach. |
Sygnatura czasowa od początku epoki w milisekundach |
Tryb zdarzenia | Wymagany | Pole, w którym wskazujesz, czy wydarzenie będzie wirtualne, stacjonarne czy obie te formy. |
Typ enumeracji: VIRTUAL, IN_PERSON lub HYBRID |
Lokalizacja – kraj | Wymagane warunkowo | Kraj, w którym odbywa się wydarzenie. Uwaga: ta opcja jest wymagana w przypadku zdarzeń o typie IN_PERSON lub HYBRID. |
Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Lokalizacja – miasto | Wymagane warunkowo | Miasto, w którym odbywa się wydarzenie. Uwaga: ta opcja jest wymagana w przypadku zdarzeń o typie IN_PERSON lub HYBRID. |
Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 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: ta opcja jest wymagana w przypadku zdarzeń o typie IN_PERSON lub HYBRID. |
Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Lokalizacja – adres | Opcjonalny | Adres (w odpowiednich przypadkach) miejsca, w którym odbywa się wydarzenie. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Lokalizacja – stan | Opcjonalny | Stan lub prowincja (jeśli ma zastosowanie), w których odbywa się wydarzenie. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Lokalizacja – kod pocztowy | Opcjonalny | Kod pocztowy (jeśli występuje) miejsca, w którym odbywa się wydarzenie. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Lokalizacja – okolica | Opcjonalny | Dzielnica (jeśli dotyczy), w której odbywa się wydarzenie. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 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 w ramach projektu znajduje się plakietka, należy zapewnić bezpieczną odległość 24 dps u góry i dołu obrazu. |
Więcej informacji znajdziesz w specyfikacji zdjęć. |
Czas zakończenia | Opcjonalny |
Znak czasu epoki, w którym ma się zakończyć zdarzenie. Uwaga: wartość ta jest podawana w milisekundach. |
Sygnatura czasowa od początku epoki w milisekundach |
Dostawca usług – nazwa | Opcjonalny |
Nazwa dostawcy usługi. Uwaga: dostawca usługi musi podać tekst lub obraz. |
tekst swobodny, Na przykład nazwa organizatora wydarzenia lub nazwa wycieczki |
Dostawca usług – obraz | Opcjonalny |
Logo lub obraz dostawcy usługi. Uwaga: dostawca usługi musi podać tekst lub obraz. |
Więcej informacji znajdziesz w specyfikacji zdjęć. |
Opis | Opcjonalny | Jeden akapit tekstu opisujący daną encję. Uwaga: użytkownik zobaczy albo opis, albo listę napisów, ale nie oba naraz. |
Tekst otwarty Zalecany rozmiar tekstu: 180 znaków |
Lista napisów | Opcjonalny | Maksymalnie 3 napisy, z których każdy stanowi pojedynczy wiersz tekstu. Uwaga: użytkownik zobaczy albo opis, albo listę napisów, ale nie oba naraz. |
Tekst otwarty Zalecane rozmiary tekstu dla każdego z podtytułów: maks. 50 znaków |
Odznaki | Opcjonalny |
Każda plakietka może zawierać dowolny tekst (maksymalnie 15 znaków) lub mały obraz. |
|
Odznaka – tekst | Opcjonalny | Tytuł plakietki Uwaga: na plakietce musi znajdować się tekst lub obraz. |
Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 15 znaków |
Odznaka – obraz | Opcjonalny | Mały obraz specjalne wrażenia użytkownika, na przykład w postaci plakietki nałożonej na obrazie lub miniaturze filmu; Uwaga: na plakietce musi znajdować się tekst lub obraz. |
Więcej informacji znajdziesz w specyfikacji zdjęć. |
Identyfikator rezerwacji | Opcjonalny | Identyfikator rezerwacji wydarzenia. | Tekst otwarty |
Cena – CurrentPrice | Wymagane warunkowo |
Aktualna cena biletu na wydarzenie. Musi być podana, jeśli podano cenę przekreśloną. |
Tekst otwarty |
Cena – przekreślona cena | Opcjonalny | Pierwotna cena biletu/karnetu na wydarzenie. | Tekst otwarty |
Objaśnienie dotyczące ceny | Opcjonalny | Podkreślenie ceny, aby poinformować o promocji, wydarzeniu lub rabacie dla członków (jeśli są dostępne). | Tekst otwarty Zalecane rozmiary tekstu: poniżej 45 znaków (w przypadku zbyt długiego tekstu mogą być wyświetlane wielokropki) |
Ocena – wartość maksymalna | Opcjonalny | Maksymalna wartość skali oceny. Musi być podana, jeśli podana jest też aktualna wartość oceny. |
Liczba >= 0,0 |
Rating - Current value | Opcjonalny | Bieżąca wartość skali ocen. Musi być podana, jeśli podana jest też maksymalna wartość oceny. |
Liczba >= 0,0 |
Rating - Count (Liczba ocen) | Opcjonalny | Liczba ocen zdarzenia. Uwaga: wypełnij to pole, jeśli aplikacja ma kontrolować sposób wyświetlania tego elementu użytkownikom. Podaj zwięzły 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 ona obcięta w mniejszych rozmiarach wyświetlacza. |
Ciąg znaków |
Rating - Count Value | Opcjonalny | Liczba ocen zdarzenia. Uwaga: wypełnij to pole, jeśli nie chcesz samodzielnie obsługiwać logiki wyświetlania skrótów. Jeśli występują zarówno właściwości Liczba, jak i Wartość liczby, użytkownikom wyświetlana jest liczba. |
Długie |
Kategorie treści | Opcjonalny | Opisz kategorię treści w podmiocie. | Lista typów wyliczeniowych spełniających wymagania
Wskazówki znajdziesz w sekcji Kategoria treści. |
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 |
Identyfikator URI |
Tytuł | Wymagany | Tytuł elementu. | tekst swobodny, Na przykład „Twój pobyt od 12 grudnia” Zalecany rozmiar tekstu: maks. 50 znaków |
Godzina zameldowania | Wymagany | Sygnatura czasowa epoki w milisekundach, która reprezentuje czas zameldowania w rezerwacji. | Sygnatura czasowa od początku epoki w milisekundach |
Godzina wymeldowania | Wymagany | Sygnatura czasowa epoki w milisekundach, która reprezentuje czas wymeldowania z rezerwacji. | Sygnatura czasowa od początku epoki w milisekundach |
Lokalizacja – kraj | Wymagany | Kraj, w którym znajduje się obiekt zakwaterowania. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Lokalizacja – miasto | Wymagany | Miasto, w którym znajduje się obiekt zakwaterowania. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Lokalizacja – wyświetlany adres | Wymagany | Adres obiektu zakwaterowania, który będzie wyświetlany użytkownikowi. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Lokalizacja – adres | Opcjonalny | Adres (jeśli dotyczy) obiektu noclegowego. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Lokalizacja – stan | Opcjonalny | Stan lub prowincja (jeśli ma zastosowanie), w których znajduje się obiekt zakwaterowania. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Lokalizacja – kod pocztowy | Opcjonalny | Kod pocztowy (jeśli dotyczy) miejsca zakwaterowania. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Lokalizacja – okolica | Opcjonalny | Okolica (jeśli dotyczy) zakwaterowania. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 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 dodasz plakietkę, pamiętaj, aby zachować bezpieczny obszar o szerokości 24 dps u góry i u dołu obrazu. |
Więcej informacji znajdziesz w specyfikacji zdjęć. |
Opis | Opcjonalny | Jeden akapit tekstu opisujący daną encję. Uwaga: użytkownik zobaczy albo opis, albo listę napisów, ale nie oba naraz. |
Tekst otwarty Zalecany rozmiar tekstu: 180 znaków |
Lista napisów | Opcjonalny | Maksymalnie 3 napisy, z których każdy stanowi pojedynczy wiersz tekstu. Uwaga: użytkownik zobaczy albo opis, albo listę napisów, ale nie oba naraz. |
Tekst otwarty Zalecane rozmiary tekstu dla każdego z podtytułów: maks. 50 znaków |
Identyfikator rezerwacji | Opcjonalny | Identyfikator rezerwacji zakwaterowania. | Tekst otwarty |
Ocena – wartość maksymalna | Opcjonalny | Maksymalna wartość skali oceny. Musi być podana, jeśli podana jest też aktualna wartość oceny. |
Liczba >= 0,0 |
Rating - Current value | Opcjonalny | Bieżąca wartość skali ocen. Musi być podana, jeśli podana jest też maksymalna wartość oceny. |
Liczba >= 0,0 |
Rating - Count (Liczba ocen) | Opcjonalny | Liczba ocen obiektu zakwaterunkowego. 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 ona obcięta w mniejszych rozmiarach wyświetlacza. |
Ciąg znaków |
Rating - Count Value | Opcjonalny | Liczba ocen obiektu zakwaterunkowego. Uwaga: wypełnij to pole, jeśli nie chcesz samodzielnie obsługiwać logiki wyświetlania skrótów. Jeśli występują zarówno właściwości Liczba, jak i Wartość liczby, użytkownikom wyświetlana jest liczba. |
Długie |
Cena – CurrentPrice | Wymagane warunkowo | bieżąca cena zakwaterowania; Musi być podana, jeśli podano cenę z przekreśleniem. |
Tekst otwarty |
Cena – przekreślona cena | Opcjonalny | Pierwotna cena zakwaterowania, która jest przekreślona w interfejsie. | Tekst otwarty |
Objaśnienie dotyczące ceny | Opcjonalny | Podkreślenie ceny, aby poinformować o promocji, wydarzeniu lub rabacie dla członków (jeśli są dostępne). | Tekst otwarty Zalecane rozmiary tekstu: poniżej 45 znaków (w przypadku zbyt długiego tekstu mogą być wyświetlane wielokropki) |
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 |
Identyfikator URI |
Tytuł | Wymagany | Tytuł elementu. | tekst swobodny, np. „SFO to SAN”. Zalecany rozmiar tekstu: maks. 50 znaków |
Typ transportu | Wymagany | Środek lub typ transportu dla rezerwacji. | Enum: FLIGHT, TRAIN, BUS lub FERRY |
Godzina wylotu | Wymagany | Sygnatura czasowa w milisekundach od początku epoki, która reprezentuje czas wyjazdu. | Sygnatura czasowa od początku epoki w milisekundach |
Godzina przyjazdu | Wymagany | Sygnatura czasowa w milisekundach od początku epoki, która reprezentuje czas przybycia. | Sygnatura czasowa od początku epoki w milisekundach |
Miejsce wylotu – kraj | Opcjonalny | Kraj wyjazdu. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Miejsce wylotu – miasto | Opcjonalny | Miasto wyjazdu. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Miejsce wyjazdu – adres wyświetlania | Opcjonalny | Miejsce wylotu, które będzie wyświetlane użytkownikowi. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Miejsce wylotu – adres | Opcjonalny | Adres miejsca wylotu (jeśli dotyczy). | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Miejsce wylotu – stan | Opcjonalny | Województwo (jeśli występuje) miejsca wylotu. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Miejsce wylotu – kod pocztowy | Opcjonalny | Kod pocztowy (jeśli dotyczy) miejsca wylotu. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Miejsce wylotu – dzielnica | Opcjonalny | Okolica (jeśli dotyczy) miejsca wylotu. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Miejsce docelowe – kraj | Opcjonalny | Kraj docelowy. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Miejsce przylotu – miasto | Opcjonalny | Miasto docelowe. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Miejsce docelowe – adres wyświetlany | Opcjonalny | Miejsce docelowe, które będzie wyświetlane użytkownikowi. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Miejsce przyjazdu – adres | Opcjonalny | Adres (jeśli dotyczy) miejsca docelowego. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Miejsce docelowe – stan | Opcjonalny | Stan lub prowincja (jeśli ma zastosowanie) miejsca przylotu. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Miejsce docelowe – kod pocztowy | Opcjonalny | Kod pocztowy (jeśli dotyczy) miejsca docelowego. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Miejsce docelowe – dzielnica | Opcjonalny | Okolica (jeśli dotyczy) miejsca docelowego. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Dostawca usług – nazwa | Opcjonalny |
Nazwa dostawcy usługi. Uwaga: dostawca usługi musi podać tekst lub obraz. |
tekst swobodny, Na przykład nazwa linii lotniczej |
Dostawca usług – obraz | Opcjonalny |
Logo lub obraz dostawcy usługi. Uwaga: dostawca usługi musi podać tekst lub obraz. |
Więcej informacji znajdziesz w specyfikacji zdjęć. |
obrazy plakatu, | Opcjonalny |
Jeśli podasz kilka obrazów, wyświetlimy tylko 1 z nich. Zalecany format obrazu to 16:9 |
Więcej informacji znajdziesz w specyfikacji zdjęć. |
Opis | Opcjonalny | Jeden akapit tekstu opisujący daną encję. Uwaga: użytkownik zobaczy albo opis, albo listę napisów, ale nie oba naraz. |
Tekst otwarty Zalecany rozmiar tekstu: 180 znaków |
Lista napisów | Opcjonalny | Maksymalnie 3 napisy, z których każdy stanowi pojedynczy wiersz tekstu. Uwaga: użytkownik zobaczy albo opis, albo listę napisów, ale nie oba naraz. |
Tekst otwarty Zalecane rozmiary tekstu dla każdego z podtytułów: maks. 50 znaków |
Identyfikator rezerwacji | Opcjonalny | Identyfikator rezerwacji transportu. | Tekst otwarty |
Cena – CurrentPrice | Wymagane warunkowo | Obecna cena rezerwacji. Musi być podana, jeśli podano cenę z przekreśleniem. |
Tekst otwarty |
Cena – przekreślona cena | Opcjonalny | Pierwotna cena rezerwacji, która jest przekreślona w interfejsie użytkownika. | Tekst otwarty |
Objaśnienie dotyczące ceny | Opcjonalny | Podkreślenie ceny, aby poinformować o promocji, wydarzeniu lub rabacie dla członków (jeśli są dostępne). | Tekst otwarty Zalecane rozmiary tekstu: poniżej 45 znaków (w przypadku zbyt długiego tekstu mogą być wyświetlane wielokropki) |
Numer transportowy | Wymagane | Numer lotu, numer autobusu, numer pociągu lub numer promu/statku wycieczkowego. | Tekst otwarty |
Wejście na pokład | Wymagane | sygnatura czasowa epoki, która reprezentuje czas wsiadania (jeśli dotyczy); | Sygnatura czasowa od początku 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 |
Identyfikator URI |
Tytuł | Wymagany | Tytuł elementu. | tekst swobodny, Przykład: „Avis Union Square SF”. Zalecany rozmiar tekstu: maks. 50 znaków |
Czas odbioru | Wymagany | Sygnatura czasowa epoki, która reprezentuje czas odbioru w rezerwacji. | Sygnatura czasowa od początku epoki w milisekundach |
Czas powrotu | Opcjonalny | Sygnatura czasowa epoki, która reprezentuje czas wymeldowania z rezerwacji. | Sygnatura czasowa od początku epoki w milisekundach |
Adres odbioru – kraj | Opcjonalny | Kraj miejsca odbioru. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Adres odbioru – miasto | Opcjonalny | Miasto, w którym znajduje się miejsce odbioru. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Adres odbioru – wyświetlany adres | Opcjonalny | Miejsce odbioru, które będzie wyświetlane użytkownikowi. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Adres odbioru – adres ulicy | Opcjonalny | Adres (jeśli dotyczy) miejsca odbioru. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Adres odbioru – stan | Opcjonalny | Województwo (jeśli występuje) miejsca odbioru. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Adres odbioru – kod pocztowy | Opcjonalny | Kod pocztowy (jeśli dotyczy) miejsca odbioru. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Adres odbioru – dzielnica | Opcjonalny | Okolica (jeśli dotyczy) miejsca odbioru. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Adres zwrotny – kraj | Opcjonalny | Kraj, w którym znajduje się miejsce zwrotu. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Adres zwrotny – miasto | Opcjonalny | Miasto, w którym znajduje się miejsce zwrotu. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Adres zwrotny – adres wyświetlany | Opcjonalny | Miejsce docelowego zwrotu, które będzie wyświetlane użytkownikowi. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Adres zwrotny – adres ulicy | Opcjonalny | Adres (jeśli dotyczy) miejsca zwrotu. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Adres zwrotny – stan | Opcjonalny | Stan lub prowincja (jeśli ma zastosowanie) miejsca zwrotu. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Adres zwrotny – kod pocztowy | Opcjonalny | Kod pocztowy (jeśli dotyczy) miejsca zwrotu. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Adres zwrotny – dzielnica | Opcjonalny | Okolica (jeśli dotyczy) miejsca zwrotu. | Tekst otwarty Zalecany rozmiar tekstu: maksymalnie 20 znaków |
Dostawca usług – nazwa | Opcjonalny |
Nazwa dostawcy usługi. Uwaga: dostawca usługi musi podać tekst lub obraz. |
tekst swobodny, Przykład: „Wypożyczalnia samochodów Avis” |
Dostawca usług – obraz | Opcjonalny |
Logo lub obraz dostawcy usługi. Uwaga: dostawca usługi musi podać tekst lub obraz. |
Więcej informacji znajdziesz w specyfikacji zdjęć. |
obrazy plakatu, | Opcjonalny |
Jeśli podasz kilka obrazów, wyświetlimy tylko 1 z nich. Zalecany format obrazu to 16:9 |
Więcej informacji znajdziesz w specyfikacji zdjęć. |
Opis | Opcjonalny | Jeden akapit tekstu opisujący daną encję. Uwaga: użytkownik zobaczy albo opis, albo listę napisów, ale nie oba naraz. |
Tekst otwarty Zalecany rozmiar tekstu: 180 znaków |
Lista napisów | Opcjonalny | Maksymalnie 3 napisy, z których każdy stanowi pojedynczy wiersz tekstu. Uwaga: użytkownik zobaczy albo opis, albo listę napisów, ale nie oba naraz. |
Tekst otwarty Zalecane rozmiary tekstu dla każdego z podtytułów: maks. 50 znaków |
Identyfikator potwierdzenia | Opcjonalny | Identyfikator potwierdzenia rezerwacji wynajmu pojazdu. | Tekst otwarty |
Cena – CurrentPrice | Wymagane warunkowo | Obecna cena rezerwacji. Musi być podana, jeśli podano cenę z przekreśleniem. |
Tekst otwarty |
Cena – przekreślona cena | Opcjonalny | Pierwotna cena rezerwacji, która jest przekreślona w interfejsie użytkownika. | Tekst otwarty |
Objaśnienie dotyczące ceny | Opcjonalny | Podkreślenie ceny, aby poinformować o promocji, wydarzeniu lub rabacie dla członków (jeśli są dostępne). | Tekst otwarty Zalecane rozmiary tekstu: poniżej 45 znaków (w przypadku zbyt długiego tekstu mogą być wyświetlane wielokropki) |
Specyfikacja obrazu
Wymagania dotyczące komponentów z obrazem:
Format obrazu | Minimalna liczba pikseli | Zalecany rozmiar w pikselach |
---|---|---|
Kwadrat (1 x 1) Preferowany |
300 x 300 | 1200 x 1200 |
Orientacja pozioma (1,91 x 1) | 600 x 314 | 1200 x 628 |
Orientacja pionowa (4 x 5) | 480 x 600 | 960 x 1200 |
Obrazy muszą być hostowane w publicznych sieciach CDN, aby Google mogło do nich uzyskać dostęp.
Formaty plików
PNG, JPG, statyczny GIF, WebP
Maksymalny rozmiar pliku
5120 KB
Dodatkowe rekomendacje
- 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 motywu ciemnego i jasnego.
Kategoria treści
Kategoria treści umożliwia aplikacjom publikowanie treści należących do wielu kategorii. Dzięki temu treści są przypisywane do niektórych z wstępnie zdefiniowanych kategorii, takich jak:
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 mogło do nich uzyskać dostęp.
Wskazówki dotyczące korzystania z kategorii treści
- Niektóre typy jednostek, np. ArticleEntity i GenericFeaturedEntity, mogą być używane w dowolnej kategorii treści. W przypadku innych elementów, takich jak EventEntity, EventReservationEntity czy PointOfInterestEntity, kwalifikuje się tylko podzbiór tych kategorii. Przed wypełnieniem listy sprawdź listę kategorii dostępnych dla danego typu elementu.
W przypadku niektórych kategorii treści użyj konkretnego typu elementu zamiast kombinacji elementów typu Element ogólny i ContentCategory:
- TYPE_MOVIES_AND_TV_SHOWS – przed użyciem elementów ogólnych zapoznaj się z elementami z przewodnika po integracji z Watch.
- TYPE_BOOKS – przed użyciem ogólnych jednostek sprawdź jednostkę EbookEntity.
- TYPE_AUDIOBOOKS – przed użyciem elementów ogólnych sprawdź element AudiobookEntity.
- TYPE_SHOPPING – przed użyciem elementów ogólnych zapoznaj się z elementem ShoppingEntity.
- TYPE_FOOD_AND_DRINK – przed użyciem typów ogólnych zapoznaj się z elementami z przewodnika po integracji z jedzeniem.
Pole ContentCategory jest opcjonalne i powinno być puste, jeśli treści nie należą do żadnej z wymienionych wcześniej kategorii.
Jeśli podajesz kilka kategorii treści, podaj je w kolejności od najbardziej do najmniej trafnych. Najtrafniejszą kategorię treści umieść 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 zaplanowane regularnie lub w zależności od zdarzenia (np. za każdym razem, gdy użytkownik otworzy aplikację lub doda coś do koszyka).
AppEngagePublishClient
odpowiada za publikowanie klastrów.
Do publikowania klastrów w kliencie służą te interfejsy API:
isServiceAvailable
publishRecommendationClusters
publishFeaturedCluster
publishContinuationCluster
publishUserAccountManagementRequest
updatePublishStatus
deleteRecommendationsClusters
deleteFeaturedCluster
deleteContinuationCluster
deleteUserManagementCluster
deleteClusters
isServiceAvailable
Ten interfejs API służy do sprawdzania, czy usługa jest dostępna do integracji i czy można wyświetlić treści na urządzeniu.
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 wykona te działania:
- Istniejące dane
RecommendationCluster
od partnera dewelopera zostaną usunięte. - Dane z zapytania są analizowane i przechowywane w zaktualizowanym klastrze rekomendacji.
W przypadku błędu cała prośba jest odrzucana, a obecny stan jest zachowany.
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 PublishFeaturedClustersRequest.Builder() .addFeaturedCluster( new FeaturedCluster.Builder() .addEntity(entity1) .addEntity(entity2) .build()) .build());
Gdy usługa otrzyma żądanie, w ramach jednej transakcji wykona te działania:
- Istniejące dane
FeaturedCluster
od partnera dewelopera zostaną usunięte. - Dane z zapytania są analizowane i przechowywane w zaktualizowanym zbiorze polecanych.
W przypadku błędu cała prośba jest odrzucana, a obecny stan jest zachowany.
publishContinuationCluster
Ten interfejs API służy do publikowania obiektu ContinuationCluster
.
Kotlin
client.publishContinuationCluster( PublishContinuationClusterRequest.Builder() .setContinuationCluster( ContinuationCluster.Builder() .addEntity(entity1) .addEntity(entity2) .build()) .build())
Java
client.publishContinuationCluster( new PublishContinuationClusterRequest.Builder() .setContinuationCluster( new ContinuationCluster.Builder() .addEntity(entity1) .addEntity(entity2) .build()) .build());
Gdy usługa otrzyma żądanie, w ramach jednej transakcji wykona te działania:
- Istniejące dane
ContinuationCluster
od partnera dewelopera zostaną usunięte. - Dane z zapytania są analizowane i przechowywane w zaktualizowanym klastrze kontynuacji.
W przypadku błędu cała prośba jest odrzucana, a obecny stan jest zachowany.
publishUserAccountManagementRequest
Ten interfejs API służy do publikowania karty logowania . Działanie logowania kieruje użytkowników na stronę logowania w aplikacji, aby aplikacja mogła publikować treści (lub udostępniać bardziej spersonalizowane treści).
Te metadane są częścią karty logowania:
Atrybut | Wymaganie | Opis |
---|---|---|
Identyfikator URI działania | Wymagane | Precyzyjny link do aplikacji Action (np. przekierowuje na stronę logowania do aplikacji) |
Obraz | Opcjonalnie – jeśli nie zostanie podany, należy podać tytuł. |
Obraz na karcie obrazy w formacie 16 x 9 o rozdzielczości 1264 x 712; |
Tytuł | Opcjonalnie – jeśli nie zostanie podany, należy podać obraz | Tytuł na karcie |
Tekst wezwania do działania | Opcjonalny | Tekst wezwania do działania (np. Zaloguj się) |
Podtytuł | Opcjonalny | Opcjonalny napis 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 wykona te działania:
- Dotychczasowe dane
UserAccountManagementCluster
od partnera dewelopera zostaną usunięte. - Dane z żądania są analizowane i przechowywane w zaktualizowanym klastrze UserAccountManagementCluster.
W przypadku błędu cała prośba jest odrzucana, a obecny stan jest zachowany.
updatePublishStatus
Jeśli z jakiegokolwiek wewnętrznego powodu biznesowego żaden z tych klastrów nie został opublikowany, zdecydowanie zalecamy zaktualizowanie stanu publikacji za pomocą interfejsu updatePublishStatus API. Jest to ważne, ponieważ :
- Podanie stanu we wszystkich scenariuszach, nawet gdy treści są opublikowane (STATUS = PUBLISHED), jest kluczowe dla wypełniania paneli, które używają tego stanu do przekazywania informacji o stanie i innych danych dotyczących integracji.
- Jeśli nie ma opublikowanych treści, ale integracja nie jest uszkodzona (STATUS = NOT_PUBLISHED), Google może nie uruchamiać alertów na panelach danych dotyczących zdrowia w aplikacji. Potwierdza, że treści nie są publikowane z powodu oczekiwanego stanu z punktu widzenia dostawcy.
- Pomaga deweloperom udostępniać 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 którym będzie on mógł zobaczyć jej zawartość lub je pokonać.
Lista kodów stanu publikacji, które kwalifikują się do wyświetlania :
// 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 jakiegokolwiek 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());
deleteRecommendationClusters
Ten interfejs API służy do usuwania treści z grup rekomendacji.
Kotlin
client.deleteRecommendationClusters()
Java
client.deleteRecommendationClusters();
Gdy usługa otrzyma prośbę, usunie istniejące dane z klastrów rekomendacji. W przypadku błędu cała prośba jest odrzucana, a istniejący stan jest zachowany.
deleteFeaturedCluster
Ten interfejs API służy do usuwania treści z wyróżnionego klastra.
Kotlin
client.deleteFeaturedCluster()
Java
client.deleteFeaturedCluster();
Gdy usługa otrzyma żądanie, usunie istniejące dane z wyróżnionego klastra. W przypadku błędu cała prośba jest odrzucana, a istniejący stan jest zachowany.
deleteContinuationCluster
To interfejs API służy do usuwania treści z kontynuacji klastra.
Kotlin
client.deleteContinuationCluster()
Java
client.deleteContinuationCluster();
Gdy usługa otrzyma żądanie, usunie istniejące dane z Klastra Kontynuacji. W przypadku błędu cała prośba jest odrzucana, a istniejący stan jest zachowany.
deleteUserManagementCluster
Ten interfejs API służy do usuwania treści z klastra UserAccountManagement.
Kotlin
client.deleteUserManagementCluster()
Java
client.deleteUserManagementCluster();
Gdy usługa otrzyma żądanie, usuwa istniejące dane z klastra UserAccountManagement. W przypadku błędu cała prośba jest odrzucana, a obecny stan jest zachowany.
deleteClusters
Ten interfejs API służy do usuwania treści danego typu klastra.
Kotlin
client.deleteClusters( DeleteClustersRequest.Builder() .addClusterType(ClusterType.TYPE_CONTINUATION) .addClusterType(ClusterType.TYPE_FEATURED) .addClusterType(ClusterType.TYPE_RECOMMENDATION) .build())
Java
client.deleteClusters( new DeleteClustersRequest.Builder() .addClusterType(ClusterType.TYPE_CONTINUATION) .addClusterType(ClusterType.TYPE_FEATURED) .addClusterType(ClusterType.TYPE_RECOMMENDATION) .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ła prośba jest odrzucana, a istniejący stan jest zachowany.
Obsługa błędów
Zdecydowanie zalecamy odsłuchanie wyniku zadania z interfejsów API do publikowania, aby można było podjąć dalsze działania w celu odzyskania i ponowniego przesłania zadania, które zostało wykonane prawidłowo.
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
, a jego przyczyna jest podana w postaci kodu 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 połączenia (na przykład 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żesz spróbować ponownie. |
4 |
SERVICE_CALL_PERMISSION_DENIED |
Rozmówca nie ma uprawnień do zgłoszenia. |
5 |
SERVICE_CALL_INVALID_ARGUMENT |
Żądanie zawiera nieprawidłowe dane (np. więcej niż dozwoloną liczbę klastrów). |
6 |
SERVICE_CALL_INTERNAL |
Po stronie usługi wystąpił błąd. |
7 |
SERVICE_CALL_RESOURCE_EXHAUSTED |
wywołanie usługi jest wykonywane zbyt często. |
Krok 3. Obsługa intencji przesyłania
Oprócz wywoływania interfejsu Content API za pomocą zadania musisz też skonfigurować BroadcastReceiver
, aby odbierać prośby o publikowanie treści.
Intencje przesyłania są przeznaczone głównie do ponownej aktywacji aplikacji i wymuszania synchronizacji danych. Intencje dotyczące transmisji nie są przeznaczone do wysyłania zbyt często. Jest ona wywoływana tylko wtedy, gdy usługa Engage stwierdzi, że treści mogą być nieaktualne (np. mają tydzień). Dzięki temu użytkownik ma pewność, że będzie mieć dostęp do aktualnych treści, nawet jeśli aplikacja nie była uruchamiana przez długi czas.
Element BroadcastReceiver
musi być skonfigurowany w jednym z tych 2 sposobów:
- Dynamicznie zarejestruj instancję klasy
BroadcastReceiver
za pomocą funkcjiContext.registerReceiver()
. Umożliwia to komunikację z aplikacji, które są nadal aktywne 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 continuation cluster publish when PUBLISH_CONTINUATION broadcast is // received } fun registerBroadcastReceivers(context: Context){ var context = context context = context.applicationContext // Register Recommendation Cluster Publish Intent context.registerReceiver(AppEngageBroadcastReceiver(), IntentFilter(Intents.ACTION_PUBLISH_RECOMMENDATION)) // Register Featured Cluster Publish Intent context.registerReceiver(AppEngageBroadcastReceiver(), IntentFilter(Intents.ACTION_PUBLISH_FEATURED)) // Register Continuation Cluster Publish Intent context.registerReceiver(AppEngageBroadcastReceiver(), IntentFilter(Intents.ACTION_PUBLISH_CONTINUATION)) }
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 continuation cluster publish when PUBLISH_CONTINUATION 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)); // Register Featured Cluster Publish Intent context.registerReceiver(new AppEngageBroadcastReceiver(), new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_FEATURED)); // Register Continuation Cluster Publish Intent context.registerReceiver(new AppEngageBroadcastReceiver(), new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_CONTINUATION)); }
- Zadeklaruj statycznie implementację za pomocą tagu
<receiver>
w plikuAndroidManifest.xml
. Dzięki temu aplikacja może odbierać intencje przesyłania, gdy nie jest uruchomiona, a także publikować treści.
<application>
<receiver
android:name=".AppEngageBroadcastReceiver"
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.PUBLISH_CONTINUATION" />
</intent-filter>
</receiver>
</application>
Usługa wysyła te intencje:
com.google.android.engage.action.PUBLISH_RECOMMENDATION
Gdy otrzymasz ten zamiar, zalecamy rozpoczęcie rozmowypublishRecommendationClusters
.com.google.android.engage.action.PUBLISH_FEATURED
Gdy otrzymasz ten zamiar, zalecamy rozpoczęciepublishFeaturedCluster
połączenia.com.google.android.engage.action.PUBLISH_CONTINUATION
Gdy otrzymasz ten zamiar, zalecamy rozpoczęciepublishContinuationCluster
połączenia.
Proces integracji
Szczegółowy przewodnik po weryfikacji integracji po jej zakończeniu znajdziesz w artykule Proces integracji z Engage dla deweloperów.
Najczęstsze pytania
Najczęstsze pytania dotyczące Engage SDK znajdziesz w artykule Najczęstsze pytania dotyczące Engage SDK.
Kontakt
Jeśli masz pytania dotyczące procesu integracji, wyślij e-maila na adres engage-developers@google.com.
Dalsze kroki
Po zakończeniu tej integracji wykonaj te czynności:
- Wyślij e-maila na adres engage-developers@google.com i załącz zintegrowany pakiet APK, który jest gotowy do przetestowania przez Google.
- Google przeprowadza weryfikację i sprawdza integrację wewnętrznie, aby upewnić się, że działa ona zgodnie z oczekiwaniami. Jeśli będą potrzebne zmiany, Google skontaktuje się z Tobą, podając niezbędne informacje.
- Gdy testy zostaną zakończone i nie trzeba będzie wprowadzać żadnych zmian, skontaktujemy się z Tobą, aby poinformować, że możesz rozpocząć publikowanie zaktualizowanego i zintegrowanego pakietu APK w Sklepie Play.
- Gdy Google potwierdzi, że zaktualizowany plik APK został opublikowany w Sklepie Play, Twoje grupy rekomendacji, polecanych i kontynuacji mogą zostać opublikowane i staną się widoczne dla użytkowników.