As APIs de relatórios do Prime Video Slate permitem que os desenvolvedores criem clientes para recuperar informações relacionadas a relatórios, como os tipos de relatórios disponíveis e o URL de download desses relatórios. Este tópico fornece informações sobre como usar essas APIs.
Autenticação
As APIs de relatórios do Slate utilizam o Login com a Amazon (LWA) para autenticar solicitações. Para obter mais informações sobre como configurar o LWA, consulte a documentação do LWA.
As solicitações devem incluir um token de autenticação LWA válido no cabeçalho de autorização da solicitação. Por exemplo: curl -H "Authorization: Bearer Atza|auth_token"
https://videocentral.amazon.com/apis/v1/accounts
https://videocentral.amazon.com/apis/v1/accounts
se o cabeçalho da solicitação não inclui o token ou se o token expirou, as APIs retornarão uma exceção não autorizada.
Paginação
Todas as respostas da API Slate são paginadas. Os parâmetros de paginação são especificados por meio de parâmetros de solicitações.
descrição |
10 |
O número de documentos devolvidos em uma única página (o tamanho de página). |
deslocamento |
0 |
O número de páginas a pular (o número de página). |
Todas as respostas paginadas contêm os seguintes campos.
total |
A contagem total de documentos em todas as páginas. |
próximo |
O URL para a próxima página. Nulo se for a última página. |
Contas
Esse recurso retorna a lista de contas do Slate que o usuário pode acessar. O conjunto de contas pode ser acessado no Slate por meio da lista de contas no canto superior direito da janela.
O recurso está acessível em https://videocentral.amazon.com/apis/v1/accounts. O código a seguir é um exemplo de resposta:
{
"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 relatórios
Esse recurso retorna os grupos de relatórios como Canais e Comprar ou Alugar que o usuário pode acessar. Os grupos estão disponíveis no Slate na guia Relatórios.
O recurso pode ser acessado por meio de https://videocentral.amazon.com/apis/v1/accounts/{account_id}. O código a seguir é um exemplo de resposta:{
"next": null,
"total": 1,
"data": [
{
"id": "channels",
"name": "Channels"
}
]
}
Canais e estúdios
Este recurso retorna a lista de canais ou estúdios disponíveis para a conta, dependendo do grupo de relatórios fornecido. A lista de canais ou estúdios pode ser acessada no Slate por meio do menu suspenso Canais na guia Relatórios.
O recurso pode ser acessado por meio de https://videocentral.amazon.com/apis/v1/accounts/{account_id}/{reports_group_id}. O código a seguir é um exemplo de resposta:{
"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 relatório
Este recurso retorna a lista de tipos de relatório disponíveis para um determinado canal ou estúdio. Os tipos de relatório estão disponíveis na guia Relatórios no Slate.
O recurso está acessível em https://videocentral.amazon.com/apis/v1/accounts/{account_id}/{reports_group_id}/{channel/studio_id}/reportTypes. O código a seguir é um exemplo de resposta:{
"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"
}
]
}
Relatórios
Este recurso retorna a lista de relatórios disponíveis para um determinado tipo de relatório. Os relatórios estão disponíveis na lista suspensa de relatórios correspondente ao tipo de relatório.
O recurso pode ser acessado em https://videocentral.amazon.com/apis/v1/accounts/{account_id}/{reports_group_id}/{channel/studio_id}/reportTypes/{report_type_id}/reports. O código a seguir é um exemplo de resposta:{
"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"
}
]
}
Além disso, o recurso aceita parâmetros que permitem aos usuários pesquisar e filtrar relatórios para um intervalo de dados específico. A tabela a seguir ressalta os parâmetros de solicitação compatíveis.
reportDateBeginGte |
Retorna apenas relatórios que foram gerados em ou após a data especificada. |
reportDateBeginLt |
Retorna apenas relatórios com data de início antes da data especificada. |
modifiedDateGte |
Devolve apenas relatórios que foram gerados em ou após a data especificada. Este parâmetro pode ser usado para detectar relatórios regerados em caso de problemas de qualidade de dados. |
