Introdução

Você pode executar qualquer um dos seus relatórios da Rakuten Advertising, tanto padrão quanto personalizados, via a API de Relatórios. Isso permite que você execute relatórios sem fazer login na sua conta.

Instruções

Siga estas etapas para obter a URL da API para seus relatórios:

1. Acesse a Interface para Relatórios.
2. Selecione um relatório padrão no menu suspenso Escolher Relatórios ou crie o seu próprio.
3. Defina um intervalo de datas para o seu relatório.
4. Se desejar personalizar ainda mais o relatório, aplique filtros ou adicione ou remova colunas de métricas e pontos de dados, em seguida, clique em Salvar Relatório.
5. Clique na seta ao lado de Visualizar Relatório e selecione Obter API:

   

6. Um pop-up de Obter URL da API aparece. Ele exibe uma URL que inclui seu token da web. Copie a URL da API e salve-a em um local seguro.

Aplicação

Você pode colar a URL da API 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. Arquivos CSV podem ser abertos no Excel.

URL da API

Você pode modificar os parâmetros da API existentes que está usando atualmente ou criar novas URLs de API de relatórios sem retornar à Interface para Relatórios. Este é um exemplo de URL da 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

Você pode editar as partes mostradas em verde. Clique no + ao lado de cada nome de parâmetro para mais informações:

Intervalos de Datas Predefinidos

Você pode usar datas de início e término exatas e intervalos de datas predefinidos na URL da API. Usar intervalos de datas predefinidos evita que você tenha que calcular as datas específicas para suas chamadas de API. Quando você seleciona um intervalo de datas predefinido no menu suspenso na interface para relatórios, a URL da API usa esse valor predefinido da seguinte forma:

Quando você compara seu relatório com outro período, pode usar esses valores para o previous_date_range:

Se você selecionar um intervalo de datas personalizado usando o seletor de datas na interface para relatórios, a URL da API mostrará as datas específicas. Por exemplo, se você selecionar 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, a URL incluirá:

/filters?start_date=20XX-04-22&end_date=20XX-05-05

O deslocamento do fuso horário selecionado será aplicado ao seu relatório. Datas e Horários refletirão apenas o fuso horário para as colunas de data da transação, hora da transação, Data do processo e hora do processo.

O deslocamento do fuso horário será aplicado a relatórios que não incluem essas colunas, como o Relatório de Vendas e Atividades. 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 hora da transação convertidas.

No entanto, 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 de Correspondência da Signature
• Hora de Correspondência da Signature
• Data de Criação da Transação
• Hora de Criação da Transação

Parâmetro de Formato de Data

Este parâmetro é opcional e possui valores padrão. Você pode inserir os valores do parâmetro date_format na URL da API Get. Você pode usar valores codificados ou não codificados.

Limite da API

Você pode executar apenas uma chamada de API de relatório por vez. Se você enviar mais de uma solicitação simultaneamente, receberá um erro nas solicitações extras e em todas as solicitações subsequentes até que uma ou mais de suas solicitações existentes sejam concluídas. O erro é uma resposta HTTP 429 com a mensagem Você excedeu seus limites de solicitação para esta sessão, por favor, tente novamente mais tarde.

Se você usar scripts para executar chamadas de API, certifique-se de que seu script não tente executar várias chamadas simultaneamente. Por exemplo, evite usar loops encadeados que façam chamadas ilimitadas. Se precisar fazer muitas chamadas, adicione uma pausa ou um limite no seu código entre as solicitações.

Erros da API

Você pode receber um código de erro ou mensagem ao executar seus relatórios via API. Veja exemplos de possíveis erros de API e instruções sobre como resolvê-los. Para assistência adicional com erros de API, entre em contato com o Suporte ao Cliente.