Engage-SDK lesen: Anleitung zur technischen Integration von Drittanbietern

client.publishRecommendationClusters(
            PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("Reconnect with yourself")
                        .build())
                .build())

client.publishRecommendationClusters(
            new PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    new RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("Reconnect with yourself")
                        .build())
                .build());

Wenn der Dienst die Anfrage erhält, werden innerhalb einer Transaktion die folgenden Aktionen ausgeführt:

• Vorhandene RecommendationCluster-Daten des Entwicklerpartners werden entfernt.
• Daten aus der Anfrage werden geparst und im aktualisierten Empfehlungscluster gespeichert.

Tritt ein Fehler auf, wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.

publishFeaturedCluster

Mit dieser API wird eine Liste von FeaturedCluster-Objekten veröffentlicht.

client.publishFeaturedCluster(
            PublishFeaturedClusterRequest.Builder()
                .setFeaturedCluster(
                    FeaturedCluster.Builder()
                        ...
                        .build())
                .build())

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

Wenn der Dienst die Anfrage empfängt, finden innerhalb einer Transaktion die folgenden Aktionen statt:

• Vorhandene FeaturedCluster-Daten des Entwicklerpartners werden entfernt.
• Die Daten aus der Anfrage werden analysiert und im aktualisierten „Empfohlen“-Cluster gespeichert.

Tritt ein Fehler auf, wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.

publishContinuationCluster

Mit dieser API wird ein ContinuationCluster-Objekt veröffentlicht.

client.publishContinuationCluster(
            PublishContinuationClusterRequest.Builder()
                .setContinuationCluster(
                    ContinuationCluster.Builder()
                        .addEntity(book_entity1)
                        .addEntity(book_entity2)
                        .build())
                .build())

client.publishContinuationCluster(
            PublishContinuationClusterRequest.Builder()
                .setContinuationCluster(
                    ContinuationCluster.Builder()
                        .addEntity(book_entity1)
                        .addEntity(book_entity2)
                        .build())
                .build())

Wenn der Dienst die Anfrage erhält, werden innerhalb einer Transaktion die folgenden Aktionen ausgeführt:

• Vorhandene ContinuationCluster-Daten des Entwicklerpartners werden entfernt.
• Die Daten aus der Anfrage werden analysiert und im aktualisierten Fortsetzungscluster gespeichert.

Bei einem Fehler wird die gesamte Anfrage abgelehnt und der aktuelle Status bleibt erhalten.

publishUserAccountManagementRequest

Dieses API wird verwendet, um eine Anmeldekarte zu veröffentlichen . Die Anmeldeaktion leitet Nutzer zur Anmeldeseite der App weiter, damit die App Inhalte veröffentlichen oder personalisiertere Inhalte bereitstellen kann.

Die folgenden Metadaten sind Teil der Anmeldekarte:

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());

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());

Wenn der Dienst die Anfrage empfängt, finden innerhalb einer Transaktion die folgenden Aktionen statt:

• Vorhandene UserAccountManagementCluster-Daten des Entwicklerpartners werden entfernt.
• Die Daten aus der Anfrage werden analysiert und im aktualisierten Cluster „UserAccountManagementCluster“ gespeichert.

Bei einem Fehler wird die gesamte Anfrage abgelehnt und der aktuelle Status bleibt erhalten.

updatePublishStatus

Wenn aus internen geschäftlichen Gründen keiner der Cluster veröffentlicht wird, empfehlen wir dringend, den Veröffentlichungsstatus mit der updatePublishStatus API zu aktualisieren. Das ist wichtig, weil:

• Die Angabe des Status in allen Szenarien, selbst wenn der Inhalt veröffentlicht wurde (STATUS == VERÖFFENTLICHT), ist wichtig, um Dashboards mit diesem expliziten Status zu füllen, um den Zustand und andere Messwerte deiner Integration zu vermitteln.
• Wenn keine Inhalte veröffentlicht werden, der Integrationsstatus aber nicht fehlerhaft ist (STATUS == NOT_PUBLISHED), kann Google Warnungen in den Dashboards zur App-Integrität vermeiden. Hiermit wird bestätigt, dass Inhalte aufgrund einer erwarteten Situation aus Sicht des Anbieters nicht veröffentlicht werden.
• Sie hilft Entwicklern, Aufschluss darüber zu geben, wann die Daten veröffentlicht werden und wann nicht.
• Google kann die Statuscodes verwenden, um Nutzer zu bestimmten Aktionen in der App zu bewegen, damit sie den App-Inhalt sehen oder überwinden können.

Folgende Veröffentlichungsstatuscodes sind zulässig:

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

Wenn die Inhalte nicht veröffentlicht werden, weil ein Nutzer nicht angemeldet ist, empfiehlt Google, die Anmeldekarte zu veröffentlichen. Wenn Anbieter die Anmeldekarte aus irgendeinem Grund nicht veröffentlichen können, empfehlen wir, die API updatePublishStatus mit dem Statuscode NOT_PUBLISHED_REQUIRES_SIGN_IN aufzurufen.

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

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

deleteRecommendationClusters

Mit dieser API können Sie den Inhalt von Empfehlungsclustern löschen.

client.deleteRecommendationClusters()

client.deleteRecommendationClusters();

Wenn der Dienst die Anfrage erhält, werden die vorhandenen Daten aus den Empfehlungsclustern entfernt. Bei einem Fehler wird die gesamte Anfrage abgelehnt und der aktuelle Status beibehalten.

deleteFeaturedCluster

Mit dieser API können Sie den Inhalt des „Empfohlen“-Clusters löschen.

client.deleteFeaturedCluster()

client.deleteFeaturedCluster();

Wenn der Dienst die Anfrage empfängt, werden die vorhandenen Daten aus dem hervorgehobenen Cluster entfernt. Bei einem Fehler wird die gesamte Anfrage abgelehnt und der aktuelle Status beibehalten.

deleteContinuationCluster

Mit dieser API können Sie den Inhalt eines Fortsetzungsclusters löschen.

client.deleteContinuationCluster()

client.deleteContinuationCluster();

Wenn der Dienst die Anfrage erhält, entfernt er die vorhandenen Daten aus dem Fortsetzungscluster. Tritt ein Fehler auf, wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.

deleteUserManagementCluster

Mit dieser API können Sie den Inhalt des Clusters „UserAccountManagement“ löschen.

client.deleteUserManagementCluster()

client.deleteUserManagementCluster();

Wenn der Dienst die Anfrage erhält, entfernt er die vorhandenen Daten aus dem Cluster „UserAccountManagement“. Bei einem Fehler wird die gesamte Anfrage abgelehnt und der aktuelle Status bleibt erhalten.

deleteClusters

Mit dieser API können Sie den Inhalt eines bestimmten Clustertyps löschen.

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

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

Wenn der Dienst die Anfrage empfängt, werden die vorhandenen Daten aus allen Clustern entfernt, die den angegebenen Clustertypen entsprechen. Clients können einen oder mehrere Clustertypen übergeben. Bei einem Fehler wird die gesamte Anfrage abgelehnt und der vorhandene Status bleibt erhalten.

Fehlerbehandlung

Es wird dringend empfohlen, das Aufgabenergebnis aus den Veröffentlichungs-APIs abzuhören, damit eine Folgeaktion ausgeführt werden kann, um eine erfolgreiche Aufgabe wiederherzustellen und noch einmal einzureichen.

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
                    }
                  }
                }
              });

Der Fehler wird als AppEngageException zurückgegeben, wobei die Ursache als Fehlercode angegeben wird.

Schritt 3: Broadcast-Intents verarbeiten

Zusätzlich zu API-Aufrufen für die Veröffentlichung von Inhalten über einen Job muss auch eine BroadcastReceiver eingerichtet werden, um die Anfrage für die Veröffentlichung von Inhalten zu erhalten.

Broadcast-Intents dienen hauptsächlich zur Reaktivierung von Apps und zum Erzwingen der Datensynchronisierung. Broadcast-Intents sind nicht für häufiges Senden vorgesehen. Sie wird nur ausgelöst, wenn der Engage-Dienst feststellt, dass die Inhalte möglicherweise veraltet sind (z. B. eine Woche alt). So ist die Wahrscheinlichkeit höher, dass Nutzer aktuelle Inhalte sehen, auch wenn die Anwendung seit einiger Zeit nicht ausgeführt wurde.

Das BroadcastReceiver muss auf eine der folgenden beiden Arten eingerichtet werden:

• Registrieren Sie eine Instanz der Klasse BroadcastReceiver dynamisch mit Context.registerReceiver(). Dies ermöglicht die Kommunikation von Anwendungen, die sich noch im Arbeitsspeicher befinden.

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));

}

• Deklarieren Sie eine Implementierung statisch mit dem <receiver>-Tag in Ihrer AndroidManifest.xml-Datei. So kann die Anwendung Broadcast-Intents empfangen, wenn sie nicht ausgeführt wird, und die Inhalte veröffentlichen.

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

Der Dienst sendet die folgenden Intents:

• com.google.android.engage.action.PUBLISH_RECOMMENDATION Wir empfehlen, bei Erhalt dieser Absicht einen publishRecommendationClusters-Aufruf zu starten.
• com.google.android.engage.action.PUBLISH_FEATURED Wir empfehlen, bei Erhalt dieser Absicht einen publishFeaturedCluster-Anruf zu starten.
• Rufen Sie „com.google.android.engage.action.PUBLISH_CONTINUATIONIt is recommended to start apublishContinuationCluster` auf, wenn Sie diese Absicht erhalten.

Integrationsablauf

Eine detaillierte Anleitung zum Überprüfen Ihrer Integration nach Abschluss finden Sie unter Integrationsablauf für Entwickler.

Häufig gestellte Fragen

Häufig gestellte Fragen zum Engage SDK

Kontakt

Wenn Sie während der Integration Fragen haben, wenden Sie sich an engage-developers@google.com. Unser Team wird sich so schnell wie möglich bei Ihnen melden.

Nächste Schritte

Nach Abschluss dieser Integration sind folgende Schritte erforderlich:

• Sende eine E-Mail an Engage-developers@google.com und hänge dein integriertes APK an, das von Google getestet werden kann.
• Google führt eine interne Überprüfung durch, um sicherzustellen, dass die Integration wie erwartet funktioniert. Falls Änderungen erforderlich sind, wird Google Sie mit allen erforderlichen Details kontaktieren.
• Wenn die Tests abgeschlossen sind und keine Änderungen erforderlich sind, werden Sie von Google benachrichtigt, dass Sie das aktualisierte und integrierte APK im Play Store veröffentlichen können.
• Nachdem Google bestätigt hat, dass Ihr aktualisiertes APK im Play Store veröffentlicht wurde, werden Ihre Cluster Empfehlung, Empfohlen und Fortsetzung veröffentlicht und sind für Nutzer sichtbar.