Verwenden Sie die JSON-Abfrageergebnisse von Amazon Pinpoint Analytics - Amazon Pinpoint
JSON-StrukturJSON-Objekte und -Felder

Hinweis zum Ende des Supports: Am 30. Oktober 2026 AWS wird der Support für Amazon Pinpoint eingestellt. Nach dem 30. Oktober 2026 können Sie nicht mehr auf die Amazon Pinpoint-Konsole oder die Amazon Pinpoint Pinpoint-Ressourcen (Endpunkte, Segmente, Kampagnen, Journeys und Analysen) zugreifen. Weitere Informationen finden Sie unter Ende des Supports von Amazon Pinpoint. Hinweis: APIs In Bezug auf SMS sind Sprach-, Handy-Push-, OTP- und Telefonnummernvalidierung von dieser Änderung nicht betroffen und werden von AWS End User Messaging unterstützt.

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Verwenden Sie die JSON-Abfrageergebnisse von Amazon Pinpoint Analytics

Wenn Sie Amazon Pinpoint Analytics verwenden, APIs um Analysedaten abzufragen, gibt Amazon Pinpoint die Ergebnisse in einer JSON-Antwort zurück. Bei Anwendungsmetriken, Kampagnenmetriken und Journey-Engagement-Metriken entsprechen die Daten in der Antwort einem Standard JSON-Schema für das Reporting von Amazon-Pinpoint-Analysedaten.

Das bedeutet, dass Sie mit der Programmiersprache oder dem Tool Ihrer Wahl eine benutzerdefinierte Lösung implementieren können, die die Daten für eine oder mehrere dieser Metriken abfragt, die Ergebnisse jeder Abfrage erfasst und die Ergebnisse dann in eine Tabelle, ein Objekt oder einen anderen Speicherort schreibt. Sie können dann mit den Abfrageergebnissen an diesem Speicherort arbeiten, indem Sie einen anderen Service oder eine andere Anwendung verwenden.

Beispielsweise ist Folgendes möglich:

  • Ein benutzerdefiniertes Dashboard erstellen, das regelmäßig eine Reihe von Metriken abfragt und die Ergebnisse mithilfe des bevorzugten Datenvisualisierungsrahmens anzeigt.

  • Erstellen Sie einen Bericht, der die Interaktionsraten verfolgt, indem Sie die entsprechenden Metriken abfragen und die Ergebnisse in einem Diagramm oder einem anderen Berichtstyp anzeigen, den Sie entwerfen.

  • Analysedaten analysieren und in ein bestimmtes Speicherformat schreiben und anschließend die Ergebnisse in eine Langzeitspeicherlösung portieren.

Beachten Sie, dass Amazon Pinpoint Analytics APIs nicht dafür konzipiert ist, persistente Objekte zu erstellen oder zu speichern, die Sie anschließend in einem Amazon Pinpoint Pinpoint-Projekt oder Ihrem Amazon Pinpoint Pinpoint-Konto lesen oder verwenden können. Stattdessen APIs sollen sie Ihnen helfen, Analysedaten abzurufen und diese Daten zur weiteren Analyse, Speicherung oder Berichterstattung an andere Dienste und Anwendungen zu übertragen. Sie tun dies zum Teil, indem sie dieselbe JSON-Antwortstruktur und dasselbe Schema für alle Analysedaten verwenden, die Sie programmgesteuert nach Anwendungsmetriken, Kampagnenmetriken und Journey-Engagement-Metriken abfragen können.

In diesem Thema werden die Struktur, die Objekte und die Felder in einer JSON-Antwort auf eine Anfrage nach einer Anwendungsmetrik, einer Kampagnenmetrik oder einer Journey-Engagement-Metrik erläutert. Informationen zu den Feldern in einer JSON-Antwort auf eine Abfrage für eine Journey-Ausführungs- oder Journey-Aktivitätsausführungsmetrik finden Sie unter Standardkennzahlen, die für Projekte, Kampagnen und Journeys von Amazon Pinpoint gelten.

JSON-Struktur

Um Ihnen bei der Analyse und Verwendung von Abfrageergebnissen zu helfen, verwendet Amazon Pinpoint Analytics APIs dieselbe JSON-Antwortstruktur für alle Amazon Pinpoint Pinpoint-Analysedaten, die Sie programmgesteuert nach Anwendungsmetriken, Kampagnenmetriken und Kennzahlen zur Kundenbindung abfragen können. Jede JSON-Antwort gibt die Werte zur Definition der Abfrage an, wie beispielsweise die Projekt-ID (ApplicationId), an. Die Antwort beinhaltet ein (nur ein einziges) KpiResult-Objekt. Das KpiResult-Objekt enthält die Gesamtergebnismenge für eine Abfrage.

Jedes KpiResult-Objekt enthält ein Rows-Objekt. Dies ist ein Array von Objekten, die die Abfrageergebnisse und relevante Metadaten zu den Werten in diesen Ergebnissen enthalten. Struktur und Inhalt eines Rows-Objekts weisen folgende allgemeine Merkmale auf:

  • Jede Zeile mit Abfrageergebnissen ist ein separates JSON-Objekt mit dem Namen Values im Rows-Objekt. Wenn eine Abfrage beispielsweise drei Werte zurückgibt, enthält das Rows-Objekt drei Values-Objekte. Jedes Values-Objekt enthält ein individuelles Ergebnis für die Abfrage.

  • Jede Spalte mit Abfrageergebnissen ist eine Eigenschaft des Values-Objekts, auf das sie angewendet wird. Der Name der Spalte wird im Key-Feld des Values-Objekts gespeichert.

  • Für gruppierte Abfrageergebnisse verfügt jedes Values-Objekt über ein zugeordnetes GroupedBys-Objekt. Das GroupedBys-Objekt gibt an, in welchem Feld die Ergebnisse gruppiert wurden. Es liefert auch den Gruppierungswert für das zugehörige Values-Objekt.

  • Wenn die Abfrageergebnisse für eine Metrik null sind, ist das Rows-Objekt leer.

Neben diesen allgemeinen Merkmalen variieren Struktur und Inhalt des Rows-Objekts je nach Metrik. Dies liegt daran, dass zwei Arten von Metriken von Amazon Pinpoint unterstützt werden:einwertige Metriken und mehrwertige Metriken.

Eine Einzelwertmetrik liefert nur einen kumulativen Wert. Ein Beispiel ist der Prozentsatz der Nachrichten, die von allen Läufen einer Kampagne an die Empfänger zugestellt wurden. Eine Mehrwertmetrik liefert mehr als einen Wert und gruppiert diese Werte nach einem relevanten Feld. Ein Beispiel ist der Prozentsatz der Nachrichten, die für jeden Lauf einer Kampagne an die Empfänger zugestellt wurden, gruppiert nach Kampagnenlauf.

Sie können schnell feststellen, ob es sich bei einer Metrik um eine einwertige oder eine mehrwertige Metrik handelt, indem Sie Bezug auf den Namen der Metrik nehmen. Wenn grouped-by im Namen nicht enthalten ist, handelt es sich um eine einwertige Metrik. Falls doch, handelt es sich um eine mehrwertige Metrik. Eine vollständige Liste der Metriken, die Sie programmgesteuert abfragen können, finden Sie unter Standardkennzahlen, die für Projekte, Kampagnen und Journeys von Amazon Pinpoint gelten.

Einzelwert-Metriken

Bei einer einwertigen Metrik enthält das Rows-Objekt ein Values-Objekt, das:

  • Den Anzeigenamen der Metrik angibt, die abgefragt wurde.

  • Den Wert für die abgefragte Metrik angibt.

  • Den Datentyp des zurückgegebenen Wertes angibt.

Die folgende JSON-Antwort enthält beispielsweise die Abfrageergebnisse für eine Einzelwertmetrik. Diese Metrik gibt die Anzahl der eindeutigen Endpunkte an, an die Nachrichten von allen Kampagnen, die mit einem Projekt verbunden sind, vom 1. August 2019 bis zum 31. August 2019 gesendet wurden:

{
    "ApplicationDateRangeKpiResponse":{
        "ApplicationId":"1234567890123456789012345example",
        "EndTime":"2019-08-31T23:59:59Z",
        "KpiName":"unique-deliveries",
        "KpiResult":{
            "Rows":[
                {
                    "Values":[
                        {
                            "Key":"UniqueDeliveries",
                            "Type":"Double",
                            "Value":"1368.0"
                        }
                    ]
                }
            ]
        },
        "StartTime":"2019-08-01T00:00:00Z"
    }
}

In diesem Beispiel zeigt die Antwort, dass alle Kampagnen des Projekts vom 1. August 2019 bis 31. August 2019 Nachrichten an 1.368 eindeutige Endpunkte lieferten, wobei folgendes gilt:

  • Key ist der Anzeigename der Metrik, deren Wert im Value-Feld (UniqueDeliveries) angegeben ist.

  • Type ist der Datentyp des im Value-Feld (Double) angegebenen Wertes.

  • Value ist der tatsächliche Wert für die Metrik, die abgefragt wurde, einschließlich aller angewendeten Filter (1368.0).

Wenn die Abfrageergebnisse für eine einwertige Metrik Null sind (nicht größer oder gleich Null), ist das Rows-Objekt leer. Amazon Pinpoint gibt einen Nullwert für eine Metrik zurück, wenn keine Daten für die Metrik zurückgegeben werden können. Zum Beispiel:

{
    "ApplicationDateRangeKpiResponse":{
        "ApplicationId":"2345678901234567890123456example",
        "EndTime":"2019-08-31T23:59:59Z",
        "KpiName":"unique-deliveries",
        "KpiResult":{
            "Rows":[

            ]
        },
        "StartTime":"2019-08-01T00:00:00Z"
    }
}

Mehrwertige Metriken

Struktur und Inhalt des Rows-Objekts für eine mehrwertige Metrik sind meist identisch mit einer einwertigen Metrik. Das Rows-Objekt für eine Mehrwertmetrik enthält auch ein Values-Objekt. Das Values-Objekt gibt den Anzeigenamen der abgefragten Metrik an, liefert den Wert für diese Metrik und identifiziert den Datentyp dieses Wertes.

Das Rows-Objekt für eine mehrwertige Metrik enthält jedoch auch ein oder mehrere GroupedBy-Objekte. Es gibt ein GroupedBy-Objekt für jedes Values-Objekt in den Abfrageergebnissen. Das GroupedBy-Objekt gibt an, in welchem Feld die Daten in den Ergebnissen gruppiert wurden und den Datentyp dieses Feldes. Es zeigt auch den Gruppierungswert für dieses Feld an (für das zugehörige Values-Objekt).

Die folgende JSON-Antwort enthält beispielsweise die Abfrageergebnisse für eine mehrwertige Metrik, die die Anzahl der eindeutigen Endpunkte angibt, an die Nachrichten gesendet wurden, für jede Kampagne, die einem Projekt zugeordnet ist, vom 1. August 2019 bis zum 31. August 2019 :

{
    "ApplicationDateRangeKpiResponse":{
        "ApplicationId":"1234567890123456789012345example",
        "EndTime":"2019-08-31T23:59:59Z",
        "KpiName":"unique-deliveries-grouped-by-campaign",
        "KpiResult":{
            "Rows":[
                {
                    "GroupedBys":[
                        {
                            "Key":"CampaignId",
                            "Type":"String",
                            "Value":"80b8efd84042ff8d9c96ce2f8example"
                        }
                    ],
                    "Values":[
                        {
                            "Key":"UniqueDeliveries",
                            "Type":"Double",
                            "Value":"123.0"
                        }
                    ]
                },
                {
                    "GroupedBys":[
                        {
                            "Key":"CampaignId",
                            "Type":"String",
                            "Value":"810c7aab86d42fb2b56c8c966example"
                        }
                    ],
                    "Values":[
                        {
                            "Key":"UniqueDeliveries",
                            "Type":"Double",
                            "Value":"456.0"
                        }
                    ]
                },
                {
                    "GroupedBys":[
                        {
                            "Key":"CampaignId",
                            "Type":"String",
                            "Value":"42d8c7eb0990a57ba1d5476a3example"
                        }
                    ],
                    "Values":[
                        {
                            "Key":"UniqueDeliveries",
                            "Type":"Double",
                            "Value":"789.0"
                        }
                    ]
                }
            ]
        },
        "StartTime":"2019-08-01T00:00:00Z"
    }
}

In diesem Beispiel zeigt die Antwort an, dass drei der Kampagnen des Projekts vom 1. August 2019 bis zum 31. August 2019 Nachrichten an eindeutige Endpunkte übermittelt haben. Für jede dieser Kampagnen lautet die Aufschlüsselung der Zustellanzahl:

  • Kampagne 80b8efd84042ff8d9c96ce2f8example hat Nachrichten an 123 eindeutige Endpunkte übermittelt.

  • Kampagne 810c7aab86d42fb2b56c8c966example hat Nachrichten an 456 eindeutige Endpunkte übermittelt.

  • Kampagne 42d8c7eb0990a57ba1d5476a3example hat Nachrichten an 789 eindeutige Endpunkte übermittelt.

Wobei dies die allgemeine Struktur der Objekte und Felder ist:

  • GroupedBys.Key: Der Name der Eigenschaft oder des Feldes, in dem der im GroupedBys.Value-Feld (CampaignId) angegebene Gruppierungswert gespeichert wird.

  • GroupedBys.Type: Der Datentyp des im GroupedBys.Value-Feld (String) angegebenen Wertes.

  • GroupedBys.Value: Der tatsächliche Wert für das Feld, das zur Gruppierung der Daten verwendet wurde, wie im GroupedBys.Key-Feld angegeben (Kampagnen-ID).

  • Values.Key: Der Anzeigename der Metrik, deren Wert im Values.Value-Feld (UniqueDeliveries) angegeben ist.

  • Values.Type: Der Datentyp des im Values.Value-Feld (Double) angegebenen Wertes.

  • Values.Value: Der tatsächliche Wert für die abgefragte Metrik, einschließlich aller angewendeten Filter.

Wenn die Abfrageergebnisse für eine mehrwertige Metrik für ein bestimmtes Projekt, eine Kampagne oder eine andere Ressource null (nicht größer als oder gleich Null) sind, werden von Amazon Pinpoint keine Objekte oder Felder für die Ressource zurückgegeben. Wenn die Abfrageergebnisse für eine mehrwertige Metrik für alle Ressourcen null sind, wird ein leeres Rows-Objekt von Amazon Pinpoint zurückgegeben.

JSON-Objekte und -Felder

Zusätzlich zur Angabe der Werte, die eine Abfrage definiert haben, wie z. B. die Projekt-ID (ApplicationId), beinhaltet jede JSON-Antwort auf eine Abfrage für eine Anwendungsmetrik, einer Kampagnenmetrik oder einer Journey-Engagement-Metrik ein KpiResult-Objekt. Dieses Objekt enthält die Gesamtergebnismenge für eine Abfrage, die Sie analysieren können, um Analysedaten an einen anderen Service oder eine andere Anwendung zu senden. Jedes KpiResult-Objekt enthält einige oder alle der folgenden Standardobjekte und -felder, abhängig von der Metrik.

Objekt oder Feld Beschreibung
Rows Ein Array von Objekten, das die Ergebnismenge für eine Abfrage enthält.
Rows.GroupedBys Bei einer mehrwertigen Metrik ein Array von Feldern, das das Feld und die Werte definiert, die zum Gruppieren von Daten in Abfrageergebnissen verwendet wurden.
Rows.GroupedBys.Key Bei einer mehrwertigen Metrik der Name der Eigenschaft oder des Feldes, in dem der im GroupedBys.Value-Feld angegebene Wert gespeichert wird.
Rows.GroupedBys.Type Bei einer mehrwertigen Metrik der Datentyp des im GroupedBys.Value-Feld angegebenen Wertes.
Rows.GroupedBys.Value Bei einer mehrwertigen Metrik der tatsächliche Wert für das Feld, das zum Gruppieren von Daten in Abfrageergebnissen verwendet wurde. Dieser Wert korreliert mit einem zugeordneten Values-Objekt.
Rows.Values Ein Array von Feldern, das Abfrageergebnisse enthält.
Rows.Values.Key Der Anzeigename der Metrik, die abgefragt wurde. Der Wert der Metrik wird im Feld Values.Value angegeben.
Rows.Values.Type Der Datentyp des im Values.Value-Feld angegebenen Wertes.
Rows.Values.Value Der tatsächliche Wert für die abgefragte Metrik, einschließlich aller angewendeten Filter.

Informationen zu den Feldern in einer JSON-Antwort auf eine Abfrage für eine Journey-Ausführungs- oder Journey-Aktivitätsausführungsmetrik finden Sie unter Standardkennzahlen, die für Projekte, Kampagnen und Journeys von Amazon Pinpoint gelten.