Les API Slate dédiées aux rapports permettent aux développeurs de créer des clients afin de récupérer certaines informations. Celles-ci incluent, entre autres, les types de rapports disponibles et l’URL de téléchargement de ces derniers. Cet article indique comment employer ces API.
Authentification
Les API Slate s’appuient sur la fonctionnalité « Login With Amazon » (LWA) pour authentifier les requêtes. Pour plus d’informations sur la configuration du LWA, consultez la documentation LWA.
L’en-tête d’autorisation des requêtes doit inclure un jeton d’authentification LWA valide. Par exemple : curl -H "Authorization: Bearer Atza|auth_token"
https://videocentral.amazon.com/apis/v1/accounts
https://videocentral.amazon.com/apis/v1/accounts
Si l’en-tête de requête n’inclut pas le jeton, ou si le jeton est arrivé à expiration, une exception non autorisée sera générée par les API.
Pagination
Toutes les réponses de l’API Slate sont paginées. Les paramètres de pagination sont définis à l’aide des paramètres de requête.
limit |
10 |
Nombre de documents renvoyés sur une seule page (format de la page). |
offset |
0 |
Nombre de pages à ignorer (le nombre de pages). |
Toutes les réponses paginées comportent les champs suivants.
total |
Nombre total de documents dans toutes les pages. |
next |
URL de la page suivante. Null se rapporte à la dernière page. |
Comptes
Cette ressource permet d’obtenir la liste des comptes Slate auxquels l’utilisateur peut accéder. Les comptes sont accessibles dans Slate via la liste située dans la partie supérieure droite de la fenêtre..
La ressource est accessible via https://videocentral.amazon.com/apis/v1/accounts. Le code ci-dessous est un exemple de réponse :
{
"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"
}
]
}
Groupes de rapports
Cette ressource permet d’obtenir les groupes de rapports auxquels l’utilisateur peut accéder, tels que Chaînes ou Locations ou Achats. Les groupes sont disponibles dans Slate sous l’onglet Rapports.
La ressource est accessible via https://videocentral.amazon.com/apis/v1/accounts/{account_id}. Le code ci-dessous est un exemple de réponse :{
"next": null,
"total": 1,
"data": [
{
"id": "channels",
"name": "Channels"
}
]
}
Chaînes et studios
Cette ressource permet d’obtenir la liste des chaînes ou studios disponibles pour ce compte en fonction du groupe de rapports donné. La liste des chaînes ou des studios est accessible dans Slate via la liste déroulante Chaînes sous l’onglet Rapports.
La ressource est accessible via https://videocentral.amazon.com/apis/v1/accounts/{account_id}/{reports_group_id}. Le code ci-dessous est un exemple de réponse :{
"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"
}
]
}
Types de rapport
Cette ressource permet d’obtenir la liste des types de rapport disponibles pour une chaîne ou un studio donné(e). Les types de rapports sont disponibles dans l’onglet Rapports de Slate.
La ressource est accessible via https://videocentral.amazon.com/apis/v1/accounts/{account_id}/{reports_group_id}/{channel/studio_id}/reportTypes. Le code ci-dessous est un exemple de réponse :{
"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"
}
]
}
Rapports
Cette ressource permet d’obtenir la liste des rapports disponibles pour un type de rapport donné. Les rapports sont disponibles dans la liste déroulante des rapports correspondant au type de rapport.
La ressource est accessible via https://videocentral.amazon.com/apis/v1/accounts/{account_id}/{reports_group_id}/{channel/studio_id}/reportTypes/{report_type_id}/reports. Le code ci-dessous est un exemple de réponse :{
"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"
}
]
}
De plus, la ressource accepte des paramètres qui permettent aux utilisateurs de rechercher et de filtrer des rapports pour une plage de données spécifique. Le tableau suivant fait état des paramètres de requête pris en charge :.
ReportDateBegingTE |
Renvoie uniquement les rapports dont la date de début est ultérieure à la date concernée. |
ReportDateBeginLT |
Renvoie uniquement les rapports dont la date de début est antérieure à la date concernée. |
ModifiedDateGTE |
Permet d’obtenir uniquement les rapports qui ont été générés à la date concernée ou après celle-ci. Ce paramètre peut être utilisé pour détecter les rapports régénérés en cas de problèmes affectant la qualité des données. |
