Le API di report di Prime Video Slate consentono agli sviluppatori di creare client per recuperare informazioni relative ai report, ad esempio i tipi di report disponibili e l’URL del download di tali report. In questo argomento vengono fornite informazioni sull’utilizzo di tali API.
Autenticazione
Per autenticare le richieste, le API di report di Slate utilizzano Login con Amazon (LWA). Per maggiori informazioni su come configurare LWA, consulta la documentazione LWA.
Le richieste devono includere un token di autenticazione LWA valido nell’intestazione di autorizzazione della richiesta. Ad esempio: curl -H "Authorization: Bearer Atza|auth_token"
https://videocentral.amazon.com/apis/v1/accounts
https://videocentral.amazon.com/apis/v1/accounts
L’intestazione della richiesta non include il token o se il token è scaduto, le API restituiranno un’eccezione non autorizzato.
Impaginazione
Tutte le risposte dell’API Slate sono impaginate. I parametri di impaginazione vengono specificati tramite i parametri delle richieste.
limit |
10 |
Numero di documenti restituiti in una singola pagina. (la dimensione della pagina). |
offset |
0 |
Il numero di pagine da ignorare. (il numero di pagina). |
Tutte le risposte impaginate contengono i seguenti campi:.
total |
Il conteggio totale dei documenti in tutte le pagine. |
next |
L’URL della pagina successiva. Null se è l’ultima pagina. |
Account
Questa risorsa restituisce l’elenco degli account Slate a cui l’utente può accedere. Il set di account è accessibile in Slate tramite l’elenco degli account nell’angolo in alto a destra della finestra.
La risorsa è accessibile tramite https://videocentral.amazon.com/apis/v1/accounts. Il codice seguente è un esempio di risposta:
{
"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"
}
]
}
Gruppi report
Questa risorsa restituisce i gruppi di report come Canali e Acquista o noleggia a cui l’utente può accedere.. I gruppi sono disponibili in Slate nella scheda Report.
La risorsa è accessibile tramite https://videocentral.amazon.com/apis/v1/accounts/{account_id}. Il codice seguente è un esempio di risposta:{
"next": null,
"total": 1,
"data": [
{
"id": "channels",
"name": "Channels"
}
]
}
Canali e studi
Questa risorsa restituisce l’elenco dei canali o degli studi disponibili per l’account a seconda del gruppo di report specificato. L’elenco dei canali o degli studi è accessibile in Slate tramite il menu a discesa Canali nella scheda Report.
La risorsa è accessibile tramite https://videocentral.amazon.com/apis/v1/accounts/{account_id}/{reports_group_id}. Il codice seguente è un esempio di risposta:{
"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"
}
]
}
Tipi di report
Questa risorsa restituisce l’elenco dei tipi di report disponibili per un determinato canale o studio. I tipi di report sono disponibili nella scheda Report in Slate.
La risorsa è accessibile tramite https://videocentral.amazon.com/apis/v1/accounts/{account_id}/{reports_group_id}/{channel/studio_id}/reportTypes. Il codice seguente è un esempio di risposta:{
"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"
}
]
}
Report
Questa risorsa restituisce l’elenco dei report disponibili per un determinato tipo di report. I report sono disponibili nell’elenco a discesa dei report corrispondente al tipo di report.
La risorsa è accessibile tramite https://videocentral.amazon.com/apis/v1/accounts/{account_id}/{reports_group_id}/{channel/studio_id}/reportTypes/{report_type_id}/reports. Il codice seguente è un esempio di risposta:{
"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"
}
]
}
Inoltre, la risorsa accetta parametri che consentono agli utenti di cercare e filtrare i report in base a un intervallo di dati specifico. La tabella seguente illustra i parametri di richiesta supportati:
reportDateBeginGte |
Restituisce solo i report con data di inizio uguale o successiva alla data specificata. |
reportDateBeginLt |
Restituisce solo i report con una data di inizio precedente alla data specificata. |
modifiedDateGte |
Restituisce solo i report generati a partire dalla data specificata. Questo parametro può essere utilizzato per individuare i report rigenerati in caso di problemi di qualità dei dati. |
