Amazon Pinpoint Pinpoint-Daten für eine Kampagne abfragen

Um die Daten für eine Kampagne abzufragen, verwenden Sie die Kampagnenmetriken-API und geben Werte für die folgenden erforderlichen Parameter an:

• application-id: Die Projekt-ID, bei der es sich um den eindeutigen Bezeichner für das Projekt handelt, das der Kampagne zugeordnet ist. In Amazon Pinpoint haben die Begriffe Projekt und Anwendung dieselbe Bedeutung.

• campaign-id: Der eindeutige Bezeichner für die Kampagne.

• kpi-name: Der Name der abzufragenden Metrik. Dieser Wert beschreibt die zugeordnete Metrik und besteht aus zwei oder mehr Begriffen, die aus alphanumerischen Kleinbuchstaben bestehen, die durch einen Bindestrich getrennt sind. Eine vollständige Liste der unterstützten Metriken und den kpi-name-Wert für die einzelnen Metriken finden Sie unter Standardkennzahlen für Projekte, Kampagnen und Journeys.

Sie können auch einen Filter anwenden, der die Daten für einen bestimmten Zeitraum abfragt. Wenn Sie keinen Datumsbereich angeben, werden die Daten für die letzten 31 Kalendertage von Amazon Pinpoint zurückgegeben. Um die Daten nach verschiedenen Datumsangaben zu filtern, verwenden Sie die unterstützten Datumsbereichsparameter, um das erste und letzte Datum und die Uhrzeit des Datumsbereichs anzugeben. Die Werte sollten im erweiterten ISO 8601-Format vorliegen und die koordinierte Weltzeit (UTC) verwenden, z. B. 2019-07-19T20:00:00Z für 20.00 Uhr UTC am 19. Juli 2019. Datumsbereiche werden inklusiv angegeben und dürfen maximal 31 Kalendertage umfassen. Darüber hinaus müssen das erste Datum und die erste Uhrzeit früher als 90 Tage ab dem aktuellen Tag liegen.

Die folgenden Beispiele zeigen, wie Analysedaten für eine Kampagne mithilfe der Amazon Pinpoint REST-API AWS CLI, der und der AWS SDK für Java abgefragt werden. Sie können jedes unterstützte AWS SDK verwenden, um Analysedaten für eine Kampagne abzufragen. Die AWS CLI Beispiele sind für Microsoft Windows formatiert. Ersetzen Sie für Unix, Linux und macOS das Zeilenfortsetzungszeichen (^) durch einen umgekehrten Schrägstrich (\).

REST API

Um Analysedaten für eine Kampagne mithilfe der Amazon-Pinpoint-REST-API abzufragen, senden Sie eine HTTP(S)-GET-Anforderung an den Kampagnenmetriken-URI. Geben Sie im URI die entsprechenden Werte für die erforderlichen Pfadparameter an:

https://endpoint/v1/apps/application-id/campaigns/campaign-id/kpis/daterange/kpi-name

Wobei gilt:

• endpointist der Amazon Pinpoint-Endpunkt für die AWS Region, in der das mit der Kampagne verknüpfte Projekt gehostet wird.

• application-id ist der eindeutige Bezeichner für das Projekt, das der Kampagne zugeordnet ist.

• campaign-id ist der eindeutige Bezeichner für die Kampagne.

• kpi-nameist der kpi-name Wert für die abzufragende Metrik.

Alle Parameter sollten URL-codiert sein.

Wenn Sie einen Filter anwenden möchten, der die Daten für einen bestimmten Datumsbereich abfragt, hängen Sie die start-time- und end-time-Abfrageparameter und -werte an den URI an. Mithilfe dieser Parameter können Sie das erste und letzte Datum und die Uhrzeit im erweiterten ISO 8601-Format eines Inklusivdatumsbereichs angeben, für den die Daten abgerufen werden sollen. Verwenden Sie ein kaufmännisches Und-Zeichen (&), um die Parameter zu trennen.

Die folgende Anforderung ruft beispielsweise die Anzahl der eindeutigen Endpunkte ab, an die Nachrichten von allen Ausführungen einer Kampagne vom 19. Juli 2019 bis zum 26. Juli 2019 übermittelt wurden:

https://pinpoint.us-east-1.amazonaws.com/v1/apps/1234567890123456789012345example/campaigns/80b8efd84042ff8d9c96ce2f8example/kpis/daterange/unique-deliveries?start-time=2019-07-19T00:00:00Z&end-time=2019-07-26T23:59:59Z

Wobei gilt:

• pinpoint.us-east-1.amazonaws.com ist der Amazon-Pinpoint-Endpunkt für die AWS -Region, die das Projekt hostet.

• 1234567890123456789012345example ist der eindeutige Bezeichner für das Projekt, das der Kampagne zugeordnet ist.

• 80b8efd84042ff8d9c96ce2f8example ist der eindeutige Bezeichner für die Kampagne.

• unique-deliveries ist der kpi-name-Wert für die Endpunktzustellungen-Kampagnenmetrik, d. h. die Metrik, die die Anzahl der eindeutigen Endpunkte angibt, an die Nachrichten von allen Ausführungen einer Kampagne übermittelt wurden.

• 2019-07-19T00:00:00Z ist das erste Datum und die Uhrzeit, für die Daten abgerufen werden sollen, als Teil eines einschließenden Datumsbereichs.

• 2019-07-26T23:59:59Z ist das letzte Datum und die Uhrzeit, für die Daten abgerufen werden sollen, als Teil eines einschließenden Datumsbereichs.

AWS CLI

Um Analysedaten für eine Kampagne mithilfe von abzufragen AWS CLI, verwenden Sie den get-campaign-date-range-kpi Befehl und geben Sie die entsprechenden Werte für die erforderlichen Parameter an:

C:\> aws pinpoint get-campaign-date-range-kpi ^
    --application-id application-id ^
    --campaign-id campaign-id ^
    --kpi-name kpi-name

Wobei gilt:

• application-id ist der eindeutige Bezeichner für das Projekt, das der Kampagne zugeordnet ist.

• campaign-id ist der eindeutige Bezeichner für die Kampagne.

• kpi-nameist der kpi-name Wert für die abzufragende Metrik.

Um einen Filter anzuwenden, der die Daten für einen bestimmten Zeitraum abfragt, fügen Sie der Abfrage die start-time- und end-time-Parameter und -Werte hinzu. Mithilfe dieser Parameter können Sie das erste und letzte Datum und die Uhrzeit im erweiterten ISO 8601-Format eines Inklusivdatumsbereichs angeben, für den die Daten abgerufen werden sollen. Die folgende Anforderung ruft beispielsweise die Anzahl der eindeutigen Endpunkte ab, an die Nachrichten von allen Ausführungen einer Kampagne vom 19. Juli 2019 bis zum 26. Juli 2019 übermittelt wurden:

C:\> aws pinpoint get-campaign-date-range-kpi ^
    --application-id 1234567890123456789012345example ^
    --campaign-id 80b8efd84042ff8d9c96ce2f8example ^
    --kpi-name unique-deliveries ^
    --start-time 2019-07-19T00:00:00Z ^
    --end-time 2019-07-26T23:59:59Z

Wobei gilt:

• 1234567890123456789012345example ist der eindeutige Bezeichner für das Projekt, das der Kampagne zugeordnet ist.

• 80b8efd84042ff8d9c96ce2f8example ist der eindeutige Bezeichner für die Kampagne.

• unique-deliveries ist der kpi-name-Wert für die Endpunktzustellungen-Kampagnenmetrik, d. h. die Metrik, die die Anzahl der eindeutigen Endpunkte angibt, an die Nachrichten von allen Ausführungen einer Kampagne übermittelt wurden.

• 2019-07-19T00:00:00Z ist das erste Datum und die Uhrzeit, für die Daten abgerufen werden sollen, als Teil eines einschließenden Datumsbereichs.

• 2019-07-26T23:59:59Z ist das letzte Datum und die Uhrzeit, für die Daten abgerufen werden sollen, als Teil eines einschließenden Datumsbereichs.

SDK for Java

Verwenden Sie die GetCampaignDateRangeKpiRequest Methode der Campaign Metrics API AWS SDK für Java, um Analysedaten für eine Kampagne mithilfe von abzufragen. Geben Sie die entsprechenden Werte für die erforderlichen Parameter an:

GetCampaignDateRangeKpiRequest request = new GetCampaignDateRangeKpiRequest()
        .withApplicationId("applicationId")
        .withCampaignId("campaignId")
        .withKpiName("kpiName")

Wobei gilt:

• applicationId ist der eindeutige Bezeichner für das Projekt, das der Kampagne zugeordnet ist.

• campaignId ist der eindeutige Bezeichner für die Kampagne.

• kpiNameist der kpi-name Wert für die abzufragende Metrik.

Um einen Filter anzuwenden, der die Daten für einen bestimmten Datumsbereich abfragt, schließen Sie die startTime- und endTime-Parameter und -Werte in die Abfrage ein. Mithilfe dieser Parameter können Sie das erste und letzte Datum und die Uhrzeit im erweiterten ISO 8601-Format eines Inklusivdatumsbereichs angeben, für den die Daten abgerufen werden sollen. Die folgende Anforderung ruft beispielsweise die Anzahl der eindeutigen Endpunkte ab, an die Nachrichten von allen Ausführungen einer Kampagne vom 19. Juli 2019 bis zum 26. Juli 2019 übermittelt wurden:

GetCampaignDateRangeKpiRequest request = new GetCampaignDateRangeKpiRequest()
        .withApplicationId("1234567890123456789012345example")
        .withCampaignId("80b8efd84042ff8d9c96ce2f8example")
        .withKpiName("unique-deliveries")
        .withStartTime(Date.from(Instant.parse("2019-07-19T00:00:00Z")))
        .withEndTime(Date.from(Instant.parse("2019-07-26T23:59:59Z")));

Wobei gilt:

• 1234567890123456789012345example ist der eindeutige Bezeichner für das Projekt, das der Kampagne zugeordnet ist.

• 80b8efd84042ff8d9c96ce2f8example ist der eindeutige Bezeichner für die Kampagne.

• unique-deliveries ist der kpi-name-Wert für die Endpunktzustellungen-Kampagnenmetrik, d. h. die Metrik, die die Anzahl der eindeutigen Endpunkte angibt, an die Nachrichten von allen Ausführungen einer Kampagne übermittelt wurden.

• 2019-07-19T00:00:00Z ist das erste Datum und die Uhrzeit, für die Daten abgerufen werden sollen, als Teil eines einschließenden Datumsbereichs.

• 2019-07-26T23:59:59Z ist das letzte Datum und die Uhrzeit, für die Daten abgerufen werden sollen, als Teil eines einschließenden Datumsbereichs.

Nachdem Sie Ihre Abfrage gesendet haben, gibt Amazon Pinpoint die Abfrageergebnisse in einer JSON-Antwort zurück. Die Struktur der Ergebnisse hängt von der Metrik ab, die Sie abgefragt haben. Einige Metriken geben nur einen Wert zurück. Beispielsweise gibt die Kampagnenmetrik Endpunkt-Zustellungen (unique-deliveries), die in den vorherigen Beispielen verwendet wurde, einen Wert zurück – die Anzahl der eindeutigen Endpunkte, an die Nachrichten gesendet wurden, für jede Kampagnenausführung. In diesem Fall lautet die JSON-Antwort wie folgt:

{
    "CampaignDateRangeKpiResponse":{
        "ApplicationId":"1234567890123456789012345example",
        "CampaignId":"80b8efd84042ff8d9c96ce2f8example",
        "EndTime":"2019-07-26T23:59:59Z",
        "KpiName":"unique-deliveries",
        "KpiResult":{
            "Rows":[
                {
                    "Values":[
                        {
                            "Key":"UniqueDeliveries",
                            "Type":"Double",
                            "Value":"123.0"
                        }
                    ]
                }
            ]
        },
        "StartTime":"2019-07-19T00:00:00Z"
    }
}  

Andere Metriken geben mehrere Werte zurück und gruppieren die Werte nach einem relevanten Feld. Wenn eine Metrik mehrere Werte zurückgibt, enthält die JSON-Antwort ein Feld, das angibt, welches Feld zum Gruppieren der Daten verwendet wurde.

Weitere Informationen zur Struktur von Abfrageergebnissen finden Sie unter Verwenden Sie JSON-Abfrageergebnisse.