Entrar

Bem-vindos ao nosso Centro de Suporte

Obtenha ajuda com integração e campanhas ativas.

Bem-vindos ao nosso Centro de Suporte. Obtenha ajuda com integração e campanhas ativas.

Como posso chamar as informações de relatório com a Criteo API?

É possível chamar um relatório através da Criteo API com as seguintes consultas: 
  1. clientLogin
  2. scheduleReportJob
  3. getJobStatus
  4. getReportDownloadUrl

 

Lista de chamadas e respostas da API

 
1. clientLogin
Retorna um token de autorização que deve ser usado em todas as chamadas subsequentes.

Parâmetros:
Campo tipo Descrição
Nome de usuário xsd:string Nome de usuário do anunciante.
senha xsd:string Senha do anunciante.
origem xsd:string String curta que identifica seu aplicativo para fins de login. Essa string deve assumir o formato: "nomeEmpresa-nomeAplicativo-IDversão".

Resposta:
Campo tipo Descrição
clientLoginResult xsd:string clientLoginResult é o token de autenticação (authToken) que deve ser usado em todas as outras chamadas. Ele é válido por 48 horas.
 
2. getAccount
Retorna informações básicas da conta.

Parâmetros:
N/A

Resposta:
Campo tipo Descrição
Nome do anunciante xsd:string Nome desta conta.
email xsd:string Email do contato principal do anunciante.
moeda xsd:string A moeda da conta. Enumeração.
Fuso horário xsd:string O fuso horário da conta. Enumeração.
país xsd:string O país da conta. Enumeração.
 
3. getBudgets
Retorna a lista de orçamentos que atendem aos critérios do seletor.

Parâmetros:
Campo tipo Descrição
budgetSelector BudgetIDs[] Uma lista de IDs de orçamentos a serem recuperadas. Quando vazia, todos os orçamentos são recuperados.

Resposta:
Campo tipo Descrição
getBudgetsResult Budget[] Uma lista de objetos de orçamento.
 
4. getCampaigns
Retorna a lista de campanhas que atendem aos critérios do seletor.

Parâmetros:
Campo tipo Descrição
campaignSelector CampaignSelector BudgetID,CampaignID,CampaignStatus e BiddingStartegy podem ser usados para recuperar campanhas.

Resposta:
Campo tipo Descrição
getCampaignsResult Campaign[] Uma lista de objetos de campanhas.
 
5. getCategories
Retorna a lista de categorias que atendem aos critérios do seletor.

Parâmetros:
Campo tipo Descrição
categorySelector CategorySelector CategoryID e Selected podem ser usados para recuperar categorias.

Resposta:
Campo tipo Descrição
getCategoriesResult Category[] Uma lista de objetos de categorias.
 
6. mutateCategories
Atualiza categorias.

Parâmetros:
Campo tipo Descrição
mutateCategories CategoryMutates[] Uma lista de operações de mutação. Somente operações SET são válidas.

Resposta:
Campo tipo Descrição
jobResponse categoryMutateJobResponse[] Uma lista de categoryJobResponseObjects. Cada operação possui o próprio jobID, o qual pode ser verificado com getJobStatus.
 
7. mutateCampaigns
Atualiza campanhas.

Parâmetros:
Campo tipo Descrição
mutateCampaigns CampaignMutates[] Uma lista de operações de mutação. Somente operações SET são válidas.


Resposta:
Campo tipo Descrição
jobResponse campaignMutateJobResponse[] Uma lista de campaignJobResponseObjects. Cada operação possui o próprio jobID, o qual pode ser verificado com getJobStatus.


8. scheduleReportJob
Agenda um trabalho de relatório para execução.

Parâmetros:
Campo tipo Descrição
reportJob ReportJob Um objeto reportJob é passado e descreve o Relatório solicitado.

Resposta:
Campo tipo Descrição
jobID xsd:int A ID do trabalho solicitado. Pode ser usada em getJobStatus e getReportDownloadURL.
jobStatus xsd:string O status da solicitação. Se reportJob foi aceito, retorna ‘Pendente’.
reportJob ReportJob A solicitação reportJob inicial.


9. getJobStatus
Recupera o status de um trabalho com base na ID.

Parâmetros:
Campo tipo Descrição
jobID xsd:int O parâmetro jobID para o qual o status é recuperado.

Resposta:
Campo tipo Descrição
getJobStatusResult xsd:String O status do trabalho solicitado. Enumeração.


10. getReportDownloadUrl
Retorna uma URL da qual o relatório com a ID de trabalho especificada pode ser baixado. Após invocar esse método, o chamador pode executar um GET HTTP normal na URL retornada para recuperar o relatório. Os relatórios são criados no formato XML.

Parâmetros:
Campo tipo Descrição
jobID xsd:int jobID para o qual a URL de download é recuperada.

Resposta:
Campo tipo Descrição
jobURL xsd:String URL completa de onde o relatório pode ser baixado.


11. getStatisticsLastUpdate
Retorna uma lista de objetos StatUpdate para indicar os “livros fechados” para o Tipo de estatística relacionado (no momento, ClicksAndImpressions e Sales).

Parâmetros:
Nenhum.

Resposta:
Campo tipo Descrição
getStatisticsLastUpdateResult StatUpdate[] Uma lista de StatUpdateObjects. Um StatUpdate contém um tipo e uma data.

 

Descrições dos objetos

 
Tipo Campaign
Campo tipo Descrição
campaignID xsd:int ID da campanha.
campaignName xsd:string Nome da campanha.
campaignBid BidInformation BidInformation da campanha.
budgetID xsd:decimal ID do orçamento usado pela campanha.
remainingDays xsd:int Número de dias em que a campanha pode ser veiculada com o orçamento existente. Esse valor é estimado com base na tendência de gastos atual.
Status xsd:string Status da campanha:
  • RUNNING: a campanha está ativa.
  • NOT_RUNNING: a campanha está inativa.
  • DEAD: a campanha está arquivada (somente leitura).
categoryBids CategoryBid[] Lista de tipos BidInformation vinculados a uma categoria.


Tipo Category
Campo tipo Descrição
categoryID xsd:int ID da categoria.
categoryName xsd:string Nome da categoria (recuperado do feed do catálogo).
avgPrice xsd:double Preço médio dos produtos desta categoria.
numberOfProducts xsd:int O número de produtos com tag desta categoria.
selected xsd:boolean True se a categoria está selecionada (selecionada significa disponível para bids e relatórios).


Tipo Budget
Campo tipo Descrição
budgetID xsd:int ID do orçamento.
budgetName xsd:string Nome do orçamento.
totalAmount xsd:int Valor total adicionado a este orçamento.
remainingBudget xsd:decimal Valor disponível.
remainingBudgetUpdated xsd:dateTime A hora em que remainingBudget foi calculado.


Tipo BidInformation
Campo tipo Descrição
biddingStrategy xsd:string Estratégia do bid:
  • CPC: custo por clique.
  • CPA: custo por ação.
  • CPM: custo por mil impressões.
Observação: só há suporte para CPC.
cpcBid xsd:double Valor do custo por clique.
cpaBid CPABid CPABid contém postClick, postView, comissão e percentual. (Ainda não há suporte.)


Tipo CategoryBid
Campo tipo Descrição
campaignCategoryUID xsd:int UID global que identifica a categoria de uma campanha específica.
campaignID xsd:int ID da campanha para a qual este bid de categoria é feito.
categoryID xsd:int ID da categoria para a qual este bid é feito.
selected xsd:boolean True se a categoria está selecionada (selecionada significa disponível para bids e relatórios).
bidInformation BidInformation BidInformation do bid da categoria.


Tipo ReportJob
Campo tipo Descrição
reportSelector CategoryIDs
CampaignIDs
Lista de IDs de categorias ou campanhas para os quais o relatório deve recuperar dados.
reportType xsd:string Tipo do relatório a ser executado:
  • Campanha
  • Categoria
aggregationType xsd:string Tipo de agregação para o relatório:
  • Por hora
  • Diário
startDate xsd:string Data de início do relatório (AAAA-MM-DD).
endDate xsd:string Data de término do relatório (AAAA-MM-DD).
selectedColumns ReportColumn[] Lista de colunas solicitadas no relatório:
  • cliques
  • impressões
  • ctr
  • cpcrev
  • ecpm
  • custo
  • vendas
  • convRate
  • orderValue
  • salesPostView
  • convRatePostView
  • orderValuePostView
  • Custo de venda
  • impressionWin
  • costPerOrder
isResultGzipped xsd:boolean Quando True, o relatório precisa ser compactado.

 

Esse artigo foi útil?
Usuários que acharam isso útil: 0 de 1
Powered by Zendesk