Introdução
Você pode executar qualquer um dos seus relatórios da Rakuten Advertising, tanto padrão, quanto personalizados, por meio da API de relatórios. Isso permite que execute relatórios sem fazer login na sua conta.
Instruções
Siga estas etapas para obter o URL da API para seus relatórios:
- Acesse a interface para relatórios.
- Selecione um relatório padrão no menu suspenso Escolher relatórios ou crie o seu.
- Selecione os parâmetros do intervalo de datas.
- Se desejar, personalize o relatório aplicando filtros, adicionando ou removendo colunas de métricas e pontos de dados e clique em Salvar relatório.
- Clique na seta ao lado de Ver relatório e selecione Adquirir API:
- Uma janela pop-up com o URL Adquira API aparecerá. Ela exibe um URL que inclui seu token da web. Copie o URL de API e salve-o em um local seguro.
Cuidado
O URL de API apresenta um token que permite acessar os dados do relatório sem fazer login na sua conta. Então ele deve ficar protegido da mesma maneira que você protege seu nome de usuário e senha. Consulte a seção URL de API abaixo para obter mais informações sobre o parâmetro do token.
Aplicação
O URL de API pode ser colado em qualquer navegador, a qualquer momento, para gerar seu relatório sem precisar acessar a interface para relatórios. O arquivo CSV com os dados do seu relatório será baixado para o seu computador. Os arquivos CSV podem ser abertos no Excel.
URL DA API
Você pode modificar os parâmetros existentes de API que está usando atualmente ou criar novos URLs de relatórios API sem retornar ao interface para relatórios. Este é um exemplo de URL de API:
https://ran-reporting.rakutenmarketing.com/en/reports/revenue-report-by-day/filters?start_date=20XX-10-25&end_date=20XX-10-26&include_summary=Y&network=1&previous-start-date=20XX-09-25&; previous-end-date=20XX-09-26&tz=GMT&date_type=process&date_format=m-d-yy&token=xxxxxxx
Tudo em verde acima pode ser editado. Clique no + ao lado do nome de cada parâmetro para obter mais informações:
Descrição: a data de início do primeiro intervalo de datas dos dados do relatório. Formatado como AAAA-MM-DD.
Descrição: a data de término do primeiro intervalo de datas da data do relatório. Formatado como AAAA-MM-DD.
Descrição: defina como Y se quiser o resumo do relatório de seis linhas na parte superior do arquivo que baixar. Defina como "N" se não quiser. O padrão é Y.
Descrição: use esse filtro para exibir dados de uma rede de cada vez, para que várias moedas não apareçam no mesmo relatório.
- US=1
- UK=3
- CA=5
- BR=8
- AU=41
- FR=7
- DE=9
- JP=11
Descrição: a data de início do segundo intervalo dos dados do relatório. Formatado como AAAA-MM-DD.
Descrição: a data de término do segundo intervalo de datas dos dados do relatório. Formatado como AAAA-MM-DD.
Descrição: esse é o fuso horário que o relatório usa. GMT é o fuso horário padrão. Os usuários podem alterar o fuso horário ao selecionar datas e vê-lo refletido no API.
Descrição: o tipo de data. Use processo para a data do processo e transação para a data da transação.
Descrição: esse é um parâmetro opcional com valores padrão. Use um dos campos abaixo para formatar as datas no relatório. Se não for especificado, definiremos os valores padrão para todas as redes como m/d/aa para redes não japonesas e aaaa/mm/dd para a rede do Japão. Os valores permitidos nesse parâmetro são:
- m/d/AA
- AAAA/mm/dd
- mm/dd/AA
- dd/mm/AA
- dd/mm/AAAA
- m-d-aa
- AAAA-mm-dd
- mm-dd-AA
- dd-mm-AA
- dd-mm-AAAA
Descrição: esse token garante a segurança dos seus dados. Ele é derivado do seu token de segurança. Mantenha o token seguro. Não modifique esse valor. Se quiser atualizar seu token, pode fazer isso no Painel do Afiliado.
Intervalos de datas predefinidos
Oferecemos suporte para intervalos de datas predefinidos e exatos, conforme especificado nos valores start_date e end_date
Isso reduz a necessidade de lógica adicional para gerar as datas das APIs. A Interface de relatórios definirá que o URL de API use o intervalo de datas predefinido ao escolher um no menu suspenso de intervalo de datas.
| Intervalo de datas predefinido | Valores do período atual para o parâmetro date_range |
|---|---|
| Ontem | ontem |
| Últimos 7 Dias | últimos 7 dias |
| Este mês | este mês |
| Mês passado | mês passado |
| Este trimestre | este trimestre |
| Último trimestre | último trimestre |
| Este ano | este ano |
| Ano passado | ano passado |
Ao comparar com outro período, esses são os valores de previous_date_range:
| Intervalo de Datas | Valores do intervalo de datas |
|---|---|
| Semana passada | semana passada |
| Mês passado | mês passado |
| Trimestre passado | trimestre passado |
| Ano passado | ano-passado |
A interface gerará um URL de API com datas específicas se escolher Intervalo de datas personalizado no seletor de datas. Por exemplo, se um intervalo de datas personalizado com 22 de abril de 20XX como data de início e 5 de maio de 20XX como data de término for selecionado, o URL da API terá a seguinte aparência:
/filters?start_date=20XX-04-22&end_date=20XX-05-05
A diferença de fuso horário selecionada será aplicada ao seu relatório. As datas e horas refletirão o fuso horário somente para as colunas Data da transação, Hora da transação, Data do processo e Hora do processo.
Um relatório sem essas colunas, como o Relatório de vendas e atividades, terá o deslocamento de fuso horário aplicado. Os relatórios que incluem essas colunas, como o Relatório de itens individuais, também terão o deslocamento do fuso horário aplicado, conforme visto na data e horário da transação.
Entretanto, a conversão de fuso horário não é feita para as seguintes colunas de Data e Hora:
- Data de consumo da reserva
- Data do clique
- Data de envio do pedido
- Data da correspondência da Signature
- Horário da correspondência da Signature
- Transação criada na data
- Transação criada no horário
Parâmetro de formato de data
Esse é um parâmetro opcional com valores padrão. Você pode inserir os valores do parâmetro date_format codificados ou não codificados no "Obter o URL de API".
Atenção
Dependendo das configurações de localidade, o Excel ou outros aplicativos de arquivo poderão não suportar ou substituir nosso parâmetro de formato de data em determinados formatos de data. Talvez você tenha que ajustar seus aplicativos para suportar nosso parâmetro de formato de data.
Limite de API
As solicitações que usam as APIs de relatórios são limitadas a uma chamada simultânea por vez. Se recebermos mais de uma solicitação em execução ao mesmo tempo, você receberá um erro em todas as outras solicitações até que uma ou mais das solicitações existentes sejam concluídas. O erro será uma resposta HTTP 429 com a mensagem "Você excedeu seus limites de solicitação para esta sessão, por favor, tente novamente mais tarde".
Veja mais exemplos de possíveis erros de API.
Se estiver usando chamadas com roteiro, certifique-se de que não esteja fazendo mais de uma chamada simultânea, como em um loop encadeado. Se estiver executando chamadas de API ilimitadas, coloque uma pausa ou um limite nas chamadas em seu código.
Comentários
Por favor, entre para comentar.