La API de informes de Prime Video Slate permite a los desarrolladores crear clientes para recuperar información relacionada con los informes, como los tipos de informes disponibles y la URL de descarga de esos informes. En este tema se proporciona información sobre el uso de las API.
Autenticación
Las API de informes de Slate utilizan el Inicio de sesión con Amazon para autenticar las solicitudes. Para obtener más información sobre cómo configurar el Inicio de sesión con Amazon, consulta la documentación de esta función.
Las solicitudes deben incluir un token de autenticación de Inicio de sesión con Amazon válido en el encabezado de autorización de la solicitud. Por ejemplo: curl -H "Authorization: Bearer Atza|auth_token"
https://videocentral.amazon.com/apis/v1/accounts
https://videocentral.amazon.com/apis/v1/accounts
Si el encabezado de la solicitud no incluye el token o si el token está caducado, las API devolverán una excepción no autorizada.
Paginación
Todas las respuestas de la API de Slate están organizadas en páginas. Los parámetros de paginación se especifican mediante los parámetros de las solicitudes.
limit |
10 |
El número de documentos devueltos en una sola página (el tamaño de la página). |
offset |
0 |
El número de páginas que se van a omitir (el número de página). |
Todas las respuestas paginadas contienen los siguientes campos.
total |
El recuento total de documentos en todas las páginas. |
next |
La dirección URL de la página siguiente. El valor será nulo si es la última página. |
Cuentas
Este recurso devuelve la lista de cuentas de Slate a las que el usuario puede acceder. Se puede acceder al conjunto de cuentas en Slate a través de la lista de cuentas de la esquina superior derecha de la ventana.
Se puede acceder al recurso a través de https://videocentral.amazon.com/apis/v1/accounts. El siguiente código es un ejemplo de respuesta:
{
"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"
}
]
}
Grupos de informes
Este recurso muestra los grupos de informes como Canales y Compra o alquiler a los que el usuario puede acceder. Los grupos están disponibles en Slate en la pestaña Informes.
Se puede acceder al recurso a través de https://videocentral.amazon.com/apis/v1/accounts/{account_id}. El siguiente código es un ejemplo de respuesta:{
"next": null,
"total": 1,
"data": [
{
"id": "channels",
"name": "Channels"
}
]
}
Canales y producciones
Este recurso muestra la lista de canales o producciones disponibles para esta cuenta, según el grupo de informes facilitado. Se puede acceder a la lista de canales o producciones en Slate desde el menú desplegable Canales de la pestaña Informes.
Se puede acceder al recurso a través de https://videocentral.amazon.com/apis/v1/accounts/{account_id}/{reports_group_id}. El siguiente código es un ejemplo de respuesta:{
"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"
}
]
}
Tipos de informes
Este recurso devuelve la lista de tipos de informes disponibles para un canal o una producción determinados. Los tipos de informes están disponibles en la pestaña Informes de Slate.
Se puede acceder al recurso a través de https://videocentral.amazon.com/apis/v1/accounts/{account_id}/{reports_group_id}/{channel/studio_id}/reportTypes. El siguiente código es un ejemplo de respuesta:{
"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"
}
]
}
Informes
Este recurso devuelve la lista de informes disponibles para un tipo de informe determinado. Los informes están disponibles en la lista desplegable de informes correspondiente al tipo de informe.
Se puede acceder al recurso a través de https://videocentral.amazon.com/apis/v1/accounts/{account_id}/{reports_group_id}/{channel/studio_id}/reportTypes/{report_type_id}/reports. El siguiente código es un ejemplo de respuesta:{
"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"
}
]
}
Además, el recurso acepta parámetros que permiten a los usuarios buscar y filtrar los informes para buscar un intervalo de datos específico. En la siguiente tabla se resaltan los parámetros de solicitud admitidos.
reportDateBeginGte |
Devuelve únicamente los informes con una fecha de inicio igual o posterior a la fecha determinada. |
reportDateBeginLt |
Devuelve únicamente los informes con una fecha de inicio anterior a la fecha indicada. |
modifiedDateGte |
Devuelve únicamente los informes que se generaron en la fecha indicada o después. Este parámetro se puede utilizar para detectar informes que se han vuelto a generar en caso de problemas de calidad de los datos. |
