Mit Prime Video Slate-Berichterstellungs-APIs können Entwickler Clients erstellen, um Informationen für die Berichterstellung wie verfügbare Berichtstypen und die Download-URL für diese Berichte abzurufen. Dieser Thema enthält Informationen zur Verwendung dieser APIs.
Authentifizierung
Slate-Berichterstellungs-APIs nutzen Login mit Amazon (LWA), um Anfragen zu authentifizieren. Weitere Informationen zum Einrichten von LWA findest du in der LWA-Dokumentation.
Anforderungen müssen ein gültiges LWA-Authentifizierungstoken im Autorisierungs-Header der Anfragen enthalten. Zum Beispiel: curl -H "Authorization: Bearer Atza|auth_token"
https://videocentral.amazon.com/apis/v1/accounts
https://videocentral.amazon.com/apis/v1/accounts
Wenn der Anfrage-Header nicht das Token enthält oder das Token abgelaufen ist, geben die APIs eine nicht autorisierte Ausnahme zurück.
Paginierung
Alle Antworten der Slate-API sind paginiert. Paginierungs-Parameter werden durch Anfrage-Parameter angegeben.
limit |
10 |
Die Anzahl der Dokumente, die auf einer einzelnen Seite zurückgegeben werden (die Seitengröße). |
offset |
0 |
Die Anzahl der zu überspringenden Seiten (die Seitenzahl). |
Alle paginierten Antworten enthalten die folgenden Felder.
total |
Die Gesamtzahl der Dokumente auf allen Seiten. |
next |
Die URL zur nächsten Seite. Null, wenn es die letzte Seite ist. |
Konten
Diese Ressource gibt die Liste der Slate-Konten zurück, auf die der Benutzer zugreifen kann. Auf diesen Satz von Konten kannst du in Video Central über die Kontenliste oben rechts im Fenster zugreifen.
Auf die Ressource kann über https://videocentral.amazon.com/apis/v1/accounts zugegriffen werden. Der folgende Code ist ein Beispiel für eine Antwort:
{
"total":3,
"next":"https://videocentral.amazon.com/apis/v1/accounts?offset=2&limit=2",
"data":[
{
"id":"123",
"name":"Account 1"
},
{
"id":"321",
"name":"Account 2"
}
]
}
Berichtsgruppen
Diese Ressource gibt die Gruppen von Berichten wie Channels und Leihen oder Kaufen zurück, auf die der Benutzer zugreifen kann. Die Gruppen sind in Slate auf der Registerkarte Berichterstellung verfügbar.
Auf die Ressource kann über https://videocentral.amazon.com/apis/v1/accounts/{account_id} zugegriffen werden. Der folgende Code ist ein Beispiel für eine Antwort:{
"next": null,
"total": 1,
"data": [
{
"id": "channels",
"name": "Channels"
}
]
}
Channels und Studios
Diese Ressource gibt je nach angegebener Berichtsgruppe die Liste der für dieses Konto verfügbaren Channels oder Studios zurück. Auf die Liste der Channels oder Studios in Slate kann über das Dropdown-Menü Channels auf der Registerkarte Berichterstellung zugegriffen werden.
Auf die Ressource kann über https://videocentral.amazon.com/apis/v1/accounts/{account_id}/{reports_group_id} zugegriffen werden. Der folgende Code ist ein Beispiel für eine Antwort:{
"next":"https://videocentral.amazon.com/apis/v1/accounts/123/channelsPremium?limit=2&offset=2",
"total":3,
"data":[
{
"id":"5fb81476-88ca-370e-b158-7e3d04e0a75e",
"name":"Channel 1",
"territory":"US"
},
{
"id":"756d9819-74ef-32e1-9c65-b2665b7ac867",
"name":"Channel 2",
"territory":"US"
}
]
}
Berichtstypen
Diese Ressource gibt die Liste der Berichtstypen zurück, die für einen bestimmten Channel oder ein bestimmtes Studio verfügbar sind. Die Berichtstypen sind auf der Registerkarte Berichterstellung in Slate verfügbar.
Auf die Ressource kann über https://videocentral.amazon.com/apis/v1/accounts/{account_id}/{reports_group_id}/{channel/studio_id}/reportTypes zugegriffen werden. Der folgende Code ist ein Beispiel für eine Antwort:{
"next":"https://videocentral.amazon.com/apis/v1/accounts/123/channelsPremium/5fb81476-88ca-370e-b158-7e3d04e0a75e/reportTypes?limit=2&offset=2",
"total":10,
"data":[
{
"name":"Content Usage",
"cadence":"Weekly",
"id":"amzn1.vcpa.arcs.insight.8ff7afff-2099-47fd-a58c-fc8de96ffff"
},
{
"name":"Content Usage",
"cadence":"Monthly",
"reportTypeId":"amzn1.vcpa.arcs.insight.3d1a7d87-a21a-444b-b887-49db54c5ffff"
}
]
}
Berichte
Diese Ressource gibt die Liste der Berichte zurück, die für einen bestimmten Berichtstyp verfügbar sind. Die Berichte sind in der Dropdown-Liste für Berichte verfügbar, die dem Berichtstyp entspricht.
Auf die Ressource kann über https://videocentral.amazon.com/apis/v1/accounts/{account_id}/{reports_group_id}/{channel/studio_id}/reportTypes/{report_type_id}/reports zugegriffen werden. Der folgende Code ist ein Beispiel für eine Antwort:{
"total":2,
"next":"https://videocentral.amazon.com/apis/v1/accounts/123/channelsPremium/123/reportType/123?offset=2&limit=2",
"data":[
{
"numRows":20,
"downloadUrl":"https://packaged-report-v2-prod.s3.us-east-1.amazonaws.com/...",
"reportDateBegin":"2019-01-01",
"reportDateEnd":"2019-01-07",
"modifiedDate":"2020-09-02T21:09:16.045Z",
"name": "Sales",
"cadence": "Daily"
},
{
"numRows":20,
"downloadUrl":"https://packaged-report-v2-prod.s3.us-east-1.amazonaws.com/",
"reportDateBegin":"2019-01-07",
"reportDateEnd":"2019-01-14",
"modifiedDate":"2020-09-02T21:09:16.045Z",
"name": "Sales",
"cadence": "Daily"
}
]
}
Die Ressource ermöglicht es zudem Benutzern, mithilfe von Parametern Berichte für einen bestimmten Datenbereich zu suchen und zu filtern. In der folgenden Tabelle werden die unterstützten Anfrageparameter beschrieben.
reportDateBeginGte |
Gibt nur Berichte mit einem Anfangsdatum am oder nach dem angegebenen Datum zurück. |
reportDateBeginLt |
Gibt nur Berichte mit einem Anfangsdatum vor dem angegebenen Datum zurück. |
modifiedDateGte |
Gibt nur Berichte zurück, die nach dem angegebenen Datum generiert wurden. Dieser Parameter kann verwendet werden, um im Falle von Mängeln hinsichtlich der Datenqualität erneut generierte Berichte zu erkennen. |
