Engage SDK Social: instrukcje integracji technicznej firm zewnętrznych

Google tworzy platformę na urządzeniu, która porządkuje aplikacje użytkowników według branż i zapewnia nowe, immersyjne środowisko do przeglądania i odkrywania treści z aplikacji. Tryb pełnoekranowy daje partnerom deweloperom możliwość zaprezentowania swoich najlepszych treści w ramach dedykowanego kanału poza aplikacją.

Ten dokument zawiera instrukcje dla deweloperów, jak integrować swoje treści społecznościowe za pomocą pakietu Engage SDK, aby wypełniać ten nowy obszar.

Szczegóły integracji

W następnej sekcji znajdziesz szczegóły integracji.

Terminologia

Rekomendacje to grupy spersonalizowanych sugestii od poszczególnych partnerów deweloperów.

Rekomendacje mają następującą strukturę:

Klaster rekomendacji: widok interfejsu użytkownika zawierający grupę rekomendacji od tego samego partnera programistów.

Każdy klaster rekomendacji składa się z jednego z tych 2 typów elementów :

• PortraitMediaEntity
• SocialPostEntity

Element PortraitMediaEntity musi zawierać 1 obraz w orientacji pionowej dla posta. Metadane dotyczące profilu i interakcji są opcjonalne.

• Post

  • obraz w orientacji pionowej i sygnatura czasu,
  • Obraz w formacie pionowym + treść tekstowa i sygnatura czasowa

• Profil

  • Awatar, imię i nazwisko lub nick, dodatkowe zdjęcie

• Interakcje

  • Tylko liczba i etykieta lub
  • Liczba i elementy wizualne (ikona)

SocialPostEntity zawiera metadane związane z profilem, postem i interakcją.

• Profil

  • Awatar, imię i nazwisko lub nick, dodatkowy tekst, dodatkowe zdjęcie

• Post

  • Tekst i sygnatura czasowa lub
  • Rich media (obraz lub URL reklamy multimedialnej) i sygnatura czasowa lub
  • tekst i multimedia (obraz lub URL sformatowany) oraz sygnatura czasowa lub
  • Podgląd filmu (miniatura i czas trwania) oraz sygnatura czasowa

• Interakcje

  • Zliczaj i tylko etykietuj lub
  • Liczba i elementy wizualne (ikona)

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 z ograniczeniami.

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 5	Co najmniej 5 (PortraitMediaEntity lub SocialPostEntity)	Maksymalnie 25 (PortraitMediaEntity lub SocialPostEntity)

Krok 1. Podaj dane o podmiocie

Pakiet SDK definiuje różne elementy, które reprezentują poszczególne typy elementów. W przypadku kategorii „Społecznościowe” pakiet SDK obsługuje te elementy:

1. PortraitMediaEntity
2. SocialPostEntity

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

PortraitMediaEntity

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
Metadane związane z postem (wymagane)
Zdjęcie(a)	Wymagane	Obrazy powinny mieć format pionowy. Gdy przesłanych jest kilka obrazów, interfejs może wyświetlić tylko 1 obraz. Interfejs może jednak wizualnie wskazywać, że w aplikacji jest więcej zdjęć. Jeśli post jest filmem, dostawca powinien dostarczyć miniaturę filmu, która będzie wyświetlana jako obraz.	Więcej informacji znajdziesz w specyfikacji zdjęć.
Zawartość tekstowa	Opcjonalnie	Główny tekst posta, aktualizacji itp.	Ciąg (zalecane maksymalnie 140 znaków)
Sygnatura czasowa	Opcjonalnie	Czas opublikowania posta.	Sygnatura czasowa od początku epoki w milisekundach
zawiera treści wideo,	Opcjonalnie	Czy post jest filmem?	wartość logiczna
Czas trwania wideo	Opcjonalnie	Czas trwania filmu w milisekundach.	Długie
Metadane związane z profilem (opcjonalnie)
Nazwa	Wymagane	Nazwa profilu, identyfikator lub ksywka, np. „Jan Kowalski”, „@TeamPixel”	Ciąg (zalecana maksymalna liczba znaków: 25)
Awatar	Wymagane	Zdjęcie profilowe lub awatar użytkownika. Obraz kwadratowy 1:1	Wskazówki znajdziesz w specyfikacjach obrazów.
Dodatkowe zdjęcie	Opcjonalnie	Plakietka na profilu, np. plakietka zweryfikowanego kanału Obraz kwadratowy w formacie 1:1	Więcej informacji znajdziesz w specyfikacji zdjęć.
Metadane związane z interakcjami (opcjonalnie)
Liczba	Opcjonalnie	Wskazuje liczbę interakcji, np. „3,7 mln”. Uwaga: jeśli podasz zarówno wartość Liczba, jak i wartość Liczba, zostanie użyta liczba.	Ciąg znaków Zalecany rozmiar tekstu: maksymalnie 20 znaków dla liczby i etykiety łącznie
Wartość zliczania	Opcjonalnie	Liczba interakcji jako wartość. Uwaga: jeśli aplikacja nie obsługuje logiki, według której duża liczba powinna być optymalizowana pod kątem różnych rozmiarów wyświetlacza, podaj Wartość liczby zamiast Liczba. Jeśli podasz zarówno wartość Liczba, jak i Wartość liczby, zostanie użyta wartość Liczba.	Długie
Wytwórnia	Opcjonalnie	Wskaż, do czego służy etykieta interakcji. Na przykład „Polubione”.	Ciąg znaków Zalecany rozmiar tekstu: maks. 20 znaków w przypadku liczby + etykiety łącznie
Treści wizualne	Opcjonalnie	Wskazać, do czego służy interakcja. Na przykład: obraz przedstawiający ikonę polubienia lub emotikon. Możesz przesłać więcej niż 1 obraz, ale nie wszystkie mogą być wyświetlane w różnych formatach. Uwaga: obraz musi być kwadratowy (1:1).	Więcej informacji znajdziesz w specyfikacji zdjęć.
DisplayTimeWindow (opcjonalnie) – ustaw przedział czasu, w którym treści mają być wyświetlane na urządzeniu
Sygnatura czasowa rozpoczęcia	Opcjonalnie	sygnatura czasowa epoki, po której treści powinny być wyświetlane na danej platformie; Jeśli zasada nie jest skonfigurowana, treści mogą być wyświetlane na platformie.	Sygnatura czasowa od początku epoki w milisekundach
Sygnatura czasowa zakończenia	Opcjonalnie	Znak czasu epoki, po którym treści nie są już wyświetlane na powierzchni. Jeśli zasada nie jest skonfigurowana, treści mogą być wyświetlane na platformie.	Sygnatura czasowa epoki w milisekundach

SocialPostEntity

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
Metadane dotyczące postu (wymagane) Wymagane jest co najmniej jedno z tych pól: TextContent, Image lub WebContent
Zdjęcie(a)	Opcjonalnie	Obrazy powinny mieć format pionowy. Gdy przesłanych jest kilka obrazów, interfejs może wyświetlić tylko 1 obraz. Interfejs może jednak wizualnie wskazywać, że w aplikacji jest więcej zdjęć. Jeśli post jest filmem, dostawca powinien dostarczyć miniaturę filmu, która będzie wyświetlana jako obraz.	Więcej informacji znajdziesz w specyfikacji zdjęć.
Zawartość tekstowa	Opcjonalnie	Główny tekst posta, aktualizacji itp.	Ciąg (zalecane maksymalnie 140 znaków)
Treść wideo (opcjonalnie)
Czas działania	Wymagane	Czas trwania filmu w milisekundach.	Długie
Obraz	Wymagane	Podgląd obrazu treści wideo.	Wskazówki znajdziesz w specyfikacjach obrazów.
Podgląd linku (opcjonalny)
Podgląd linku – tytuł	Wymagane	Tekst określający tytuł treści strony internetowej	Ciąg znaków
Podgląd linku – nazwa hosta	Wymagane	Tekst wskazujący właściciela strony internetowej, np. „INSIDER”	Ciąg znaków
Podgląd linku – obraz	Opcjonalnie	Baner powitalny dla treści internetowych	Więcej informacji znajdziesz w specyfikacji zdjęć.
Sygnatura czasowa	Opcjonalnie	Czas opublikowania posta.	Sygnatura czasowa od początku epoki w milisekundach
Metadane związane z profilem (opcjonalnie)
Nazwa	Wymagane	Nazwa profilu lub identyfikator albo nick, na przykład „Jan Kowalski”, „@TeamPixel”.	Ciąg znaków(zalecane maks. 25 znaków)
Dodatkowy tekst	Opcjonalnie	Może być używany jako identyfikator profilu, nick lub dodatkowe metadane. Na przykład „@Jan-Nowak”, „5 mln obserwujących”, „Możesz polubić”, „Na czasie”, „5 nowych postów”.	Ciąg znaków (maksymalnie 40 znaków)
Awatar	Wymagane	Zdjęcie profilowe lub awatar użytkownika. Obraz kwadratowy w formacie 1:1	Więcej informacji znajdziesz w specyfikacji zdjęć.
Dodatkowy obraz	Opcjonalnie	Plakietka profilu, np. plakietka zweryfikowanego kanału Obraz kwadratowy 1:1	Wskazówki znajdziesz w specyfikacjach obrazów.
Metadane dotyczące interakcji (opcjonalnie)
Liczba	Wymagane	Wskazuje liczbę interakcji, np. „3,7 mln”.	Ciąg (zalecane maksymalnie 20 znaków w przypadku łącznej liczby i etykiety)
Wytwórnia	Opcjonalnie Jeśli nie podano tej wartości, należy podać wartość Visual.	Wskazać, do czego służy interakcja. Na przykład „Lubię to”.	Ciąg (zalecane maksymalnie 20 znaków w przypadku łącznej liczby i etykiety)
Treści wizualne	Opcjonalnie Jeśli nie podano tej wartości, musisz podać Label.	Wskaż, do czego służy dana interakcja. Na przykład: obraz przedstawiający ikonę polubienia lub emotikon. Możesz przesłać więcej niż 1 obraz, ale nie wszystkie mogą być wyświetlane w różnych formatach. Obraz kwadratowy w formacie 1:1	Więcej informacji znajdziesz w specyfikacji zdjęć.
DisplayTimeWindow (opcjonalnie) – ustaw przedział czasu, w którym treści mają być wyświetlane na urządzeniu
Sygnatura czasowa rozpoczęcia	Opcjonalnie	sygnatura czasowa epoki, po której treści powinny być wyświetlane na danej platformie; Jeśli zasada nie jest skonfigurowana, treści mogą być wyświetlane na platformie.	Sygnatura czasowa od początku epoki w milisekundach
Sygnatura czasowa zakończenia	Opcjonalnie	Znak czasu epoki, po którym treści nie są już wyświetlane na powierzchni. Jeśli zasada nie jest skonfigurowana, treści mogą być wyświetlane na platformie.	Sygnatura czasowa od początku epoki w milisekundach

Specyfikacja obrazu

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.

Krok 2. Podaj dane klastra

Zaleca się, aby zadanie publikowania treści było wykonywane w tle (np. przy użyciu narzędzia WorkManager) i zaplanowane w regularnych odstępach czasu lub w określonych zdarzeniach (na przykład za każdym razem, gdy użytkownik otworzy aplikację lub gdy użytkownik właśnie zaczął korzystać z nowego konta).

Za publikowanie klastrów społecznościowych odpowiada AppEngageSocialClient.

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

• isServiceAvailable
• publishRecommendationClusters
• publishUserAccountManagementRequest
• updatePublishStatus
• deleteRecommendationsClusters
• 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.
    }
});

Uwaga: zdecydowanie zalecamy okresowe wykonywanie zadań w celu sprawdzania, czy usługa stanie się dostępna w późniejszym czasie. Dostępność usługi może się zmieniać w zależności od aktualizacji wersji Androida, aktualizacji aplikacji, instalacji i odinstalowania. Dzięki okresowym sprawdzaniu zadań w określonym odstępie czasu dane mogą być publikowane, gdy usługa stanie się dostępna.

publishRecommendationClusters

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

Obiekt RecommendationCluster może mieć te atrybuty:

Atrybut	Wymaganie	Opis
Lista obiektów SocialPostEntity lub PortraitMediaEntity	Wymagany	Lista elementów, które składają się na rekomendacje w tym klastrze rekomendacji. Encje w jednym klastrze muszą być tego samego typu.
Tytuł	Wymagany	Tytuł klastra rekomendacji (np. Najnowsze od znajomych). Zalecany rozmiar tekstu: poniżej 25 znaków (zbyt długi tekst może zawierać wielokropki)
Podtytuł	Opcjonalnie	Podtytuł klastra rekomendacji.
Identyfikator URI działania	Opcjonalnie	Precyzyjny link do strony w aplikacji partnera, na której użytkownicy mogą zobaczyć pełną listę rekomendacji. Uwaga: na potrzeby atrybucji możesz używać precyzyjnych linków. Zapoznaj się z odpowiedziami na najczęstsze pytania

Ważne: interfejsy API publikowania to interfejsy API do wprowadzania zmian i zastępowania treści. Nie wywołuj i publikuj interfejsów API w celu zastąpienia treści, ponieważ interfejsy API publikowania robią to samodzielnie.

Ważne: w przypadku aplikacji społecznościowych koniecznie jest aktualizowanie rekomendacji po każdym użyciu aplikacji. Użytkownicy aplikacji społecznościowych są bardziej zainteresowani najnowszymi rekomendacjami i najchętniej widzieliby posty maksymalnie raz.

Kotlin

client.publishRecommendationClusters(
            PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("Latest from your friends")
                        .build())
                .build())

Java

client.publishRecommendationClusters(
            new PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    new RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("Latest from your friends")
                        .build())
                .build());

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

• Wszystkie istniejące dane klastra rekomendacji zostaną usunięte.
• Dane z żądania są analizowane i przechowywane w nowych klastrach rekomendacji.

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. Logowanie kieruje użytkowników na stronę logowania w aplikacji, na której aplikacja może publikować treści (lub udostępniać treści bardziej spersonalizowane).

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 działania	Opcjonalnie	Tekst widoczny w wezwaniu do działania (np. „Zaloguj się”)
Podtytuł	Opcjonalnie	Opcjonalny tytuł na karcie

Ważne: interfejsy API publikowania to interfejsy API do wprowadzania zmian i zastępowania treści. Nie wywołuj i publikuj interfejsów API w celu zastąpienia treści, ponieważ interfejsy API publikowania robią to samodzielnie.

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 klastrów nie został opublikowany, zdecydowanie zalecamy zaktualizowanie stanu publikowania przy użyciu interfejsu API updatePublishStatus. 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 wyświetlania stanu i innych danych 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 oczekiwanej sytuacji 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 ją pokonać.

Lista kodów stanu publikacji, które kwalifikują się do opublikowania:

// 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.

Ważne: interfejsy API do usuwania treści należy wywoływać tylko wtedy, gdy nie ma treści do opublikowania. Nie wywołuj kolejno interfejsów API do usuwania i publikowania, aby zastąpić treści, ponieważ interfejsy API do publikowania wykonują to automatycznie. Zanim użyjesz interfejsów API do usuwania, skontaktuj się z działem engage-developers@.

Kotlin

client.deleteRecommendationClusters()

Java

client.deleteRecommendationClusters();

Po otrzymaniu żądania usługa usuwa istniejące dane z klastrów rekomendacji. W przypadku błędu cała prośba zostaje odrzucona, a obecny stan jest zachowany.

deleteUserManagementCluster

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

Ważne: interfejsy Delete API powinny być wywoływane tylko wtedy, gdy nie ma żadnej treści do opublikowania. Nie wywołuj kolejno interfejsów API do usuwania i publikowania, aby zastąpić treści, ponieważ interfejsy API do publikowania wykonują to automatycznie. Zanim użyjesz interfejsów API do usuwania, skontaktuj się z działem engage-developers@.

Kotlin

client.deleteUserManagementCluster()

Java

client.deleteUserManagementCluster();

Po otrzymaniu żądania usługa usuwa istniejące dane z klastra zarządzania kontami użytkowników. W przypadku błędu całe żądanie zostaje odrzucone, a obecny stan zostaje zachowany.

deleteClusters

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

Ważne: interfejsy API do usuwania treści należy wywoływać tylko wtedy, gdy nie ma treści do opublikowania. Nie wywołuj kolejno interfejsów API do usuwania i publikowania, aby zastąpić treści, ponieważ interfejsy API do publikowania wykonują to automatycznie. Zanim użyjesz interfejsów API do usuwania, skontaktuj się z działem engage-developers@.

Kotlin

client.deleteClusters(
    DeleteClustersRequest.Builder()
      .addClusterType(ClusterType.TYPE_RECOMMENDATION)
      ...
      .build())

Java

client.deleteClusters(
            new DeleteClustersRequest.Builder()
                .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 móc podjąć dalsze działania w celu odzyskania i ponowniego przesłania zadania, które zostało wykonane prawidłowo.

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żna spróbować jeszcze raz.
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	Dzwonienie do zespołu pomocy 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 strumieniowego służą głównie do ponownego aktywowania aplikacji i wymuszania synchronizacji danych. Intencje dotyczące transmisji nie są przeznaczone do wysyłania bardzo 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ą funkcji Context.registerReceiver(). Umożliwia to komunikację z aplikacji, które są nadal aktywne w pamięci.

class AppEngageBroadcastReceiver extends BroadcastReceiver {
// Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION 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));

}

• Zadeklaruj statycznie implementację za pomocą tagu <receiver> w pliku AndroidManifest.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>
   </receiver>
</application>

Usługa wyśle te intencje:

• com.google.android.engage.action.PUBLISH_RECOMMENDATION Gdy otrzymasz tę intencję, zalecamy rozpoczęcie rozmowy publishRecommendationClusters.

Proces integracji

Szczegółowy przewodnik dotyczący weryfikacji integracji po jej zakończeniu znajdziesz w artykule Przepływ pracy w procesie integracji dla programistów Google dla Agencji.

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 [e-mail]. Nasz zespół odpowie tak szybko, jak to będzie możliwe.

Dalsze kroki

Po zakończeniu tej integracji wykonaj te czynności:

• Wyślij e-maila na adres [e-mail] i załącz zintegrowany plik APK, który jest gotowy do testowania przez Google.
• Google przeprowadza weryfikację i weryfikuje wewnętrznie, aby upewnić się, że integracja działa 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 pliku APK w Sklepie Play.
• Gdy Google potwierdzi, że zaktualizowany plik APK został opublikowany w Sklepie Play, Twoje rekomendacje zostaną opublikowane i staną się widoczne dla użytkowników.