Entrar

Bem-vindo ao nosso Centro de Suporte

Obtenha ajuda com integração e campanhas ativas.

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

Detalhes da Criteo Marketing API

A Criteo API pode ser acessanda usando esta URL: https://api.criteo.com/marketing

Endpoints

Autenticação

tipo

Endpoint

Objetivo

Parâmetros

Comentários

POST

/oauth2/token

Recuperar o token que permitirá enviar a solicitação à API

  • client_id (obrigatório)
  • client_secret (obrigatório)
  • grant_type (obrigatório)

O token será válido por 300s

 

Gestão de anunciantes

tipo

Endpoint

Objetivo

Parâmetros

GET

/portfolio

Recuperar seu(s) advertiser_Id(s)

Nenhum

GET

/advertiser/{advertiser_Id}/campaigns

Recuperar suas campanhas e categorias para determinado anunciante

advertiser_Id (obrigatório): string

GET

/advertiser/{advertiser_Id}/categories

Recuperar suas campanhas e categorias para determinado anunciante

Filtrar por status da categoria

advertiser_Id (obrigatório): int

enabledOnly: bool

GET

/advertiser/{advertiser_Id}/categories/{categoryHashCode}

Recuperar categorias específicas para determinando anunciante

advertiser_Id (obrigatório)

categoryHashCode (obrigatório)

 


Gestão de campanhas

tipo

Endpoint

Objetivo

Parâmetros

GET

/campaigns/

Recuperar campanhas do seu portfólio

advertiser_Ids: string

campaignIds: string

campaignstatus: string

bidtype: string

GET

/campaigns/{campaignId}

Recuperar sua campanha e categorias de determinada campanha

campaignId (obrigatório): int

GET

/campaigns/{campaignId}/categories

Recuperar sua campanha e categorias de determinada campanha

Filtrar por status da categoria

campaignId (obrigatório): int

enabledOnly: string

GET

/campaigns/{campaignId}/categories/{categoryHashCode}

Recuperar categorias de campanhas específicas do seu portfólio

campaignId (obrigatório): int

categoryHashCodes (obrigatório): int

GET

/campaigns/bids

Recuperar bids do seu portfólio

advertiser_Ids: string

campaignIds: string

categoryHashCodes:string

bidType: string

campaignStatus: string

pendingChanges: bool

PUT

/campaigns/bids

Definir novos valores de bid para sua campanha ou para categorias da campanha

bidChanges (obrigatório): string

 

Relatório da campanha

tipo

Endpoint

Objetivo

Parâmetros

Comentários

POST

/statistics

Recuperar relatórios de performance de anúncios

statsQuery (obrigatório)

Detalhes sobre este endpoint estão na seção de documentação específica.

 

Gerenciamento de budget

tipo

Endpoint

Objetivo

Parâmetros

GET

/budgets

Recuperar budgets do seu portfólio

advertiser_Ids: string

budgetIds: string

onlyActiveCampaigns:bool

 

Gestão de categorias

tipo

Endpoint

Objetivo

Parâmetros

GET

/categories

Recuperar categorias do seu portfólio

campaign_Ids: : string

advertiser_Ids: string

categoryHashCodes: string

enabledOnly: bool

PUT

/categories

Categorias habilitadas ou desabilitadas

categoriesPerCatalog (obrigatório)

 

Gestão de audiência

tipo

Endpoint

Objetivo

Parâmetros

Comentários

GET

/audiences

Buscar na lista de audiências

advertiser_Id : int

Sem o id do anunciante especificado, o portfólio do usuário será retornado

POST

 /audiences/userlist/ 

Criar uma audiência

advertiser_Id : int

name: string

description:string

O id de audiência é o próximo id (incrementado toda vez que uma audiência é criada)

PUT

/audiences/{audienceId} 

Alterar metadados de audiência

name: string

description: string

 

PATCH

/audiences/userlist/{audienceId}

Adicionar/Remover usuários de audiência

operation: string (ADD ou REMOVE) 

esquema: string (email ou madid)

identifiers: lista de strings

Limitado a 50.000 identificadores por solicitação.

Os identificadores podem ser

emails: texto sem formatação, MD5 ou SHA256 de MD5

MADID: IDFA ou AAID

Nota: A API não aceita ids de cookies de DMPs.

DELETE 

/audiences/userlist/{audienceId}/users

Remover todos os usuários de uma audiência

   

DELETE 

/audiences/{audienceId}

Excluir uma audiência

   

 

Parâmetros

Parâmetro

Usado para...

Detalhes

client_id

Recuperação de token

Seu email (mesmo login para o Criteo Management Center)

client_secret

Recuperação de token

Sua senha (mesmo login para o Criteo Management Center)

grant_type

Recuperação de token

É sempre igual a "client_credentials"

advertiser_Id

Recuperação de dados de anunciante específico

Recuperado do endpoint /portfolio

Recuperado do endpoint /advertisers

Recuperado do endpoint /audience

Recuperado de /audiences/userlist/ 

advertiser_Ids

Recuperação de dados de anunciantes específicos

Recuperado do endpoint /budget

Recuperado do endpoint /campaigns

Recuperado do endpoint /campaigns/bids

Recuperado do endpoint /categories

Recuperado do endpoint /statistics

Você pode solicitar vários advertiser_ids separando-os por vírgulas, por exemplo, 1,2,3

enabledOnly

Filtrar a lista de categorias

Recuperado do endpoint /categories

Recuperado do endpoint /advertiser/{advertiser_id}/categories

Recuperado do endpoint campaigns/{campaignid}/categories

enabled

atualizar o status da categoria

Recuperado do endpoint /categories

categoryHashCode

Recuperação de dados de categoria específica

Atualização de status de categoria específica

Recuperado do endpoint /advertiser/{advertiser_id}/categories/{categoriesHashCode}

categoryHashCodes

Recuperação de dados de categorias específicas

Atualização de valor de bid de categorias de campanha específica

Recuperado do endpoint /categories

Recuperado do endpoint /campaigns/bids

Recuperado do endpoint /campaigns/{campaignid}//categories/{categoriesHashCode}

Você pode solicitar vários categoryhashcodes separando-os por vírgulas, por exemplo, 1,2,3

budgetIds

Recuperação de dados de budget específico

Recuperado do endpoint /budgets

onlyactiveCampaigns

Filtrar campanhas por status

Recuperado do endpoint /budgets

campaignID

Recuperação de dados de campanha específica

Atualização de valor de bid de campanha específica

Recuperado do endpoint /campaigns/{campaignid}

Recuperado do endpoint campaigns/{campaignid}/categories

Recuperado do endpoint /campaigns/{campaignid}/categories/{categoriesHashCode}

Recuperado do endpoint /campaigns/bids

campaignIds

Recuperação de dados de campanhas específicas

Recuperado do endpoint /campaigns

Recuperado do endpoint /campaigns/bids

Recuperado do endpoint /categories

Você pode solicitar vários campaignids separando-os por vírgulas, por exemplo, 1,2,3

bidType

Filtrar por tipos de bid

Recuperado do endpoint /campaigns

Recuperado do endpoint /campaigns/bids

bidValue

Atualização de valor de bid de categorias de campanha específica

Recuperado do endpoint /campaigns/bids

campaignStatus

Filtrar por status da campanha

Recuperado do endpoint /campaigns

Recuperado do endpoint /campaigns/bids

pendingChanges

Filtrar campanha com alterações pendentes ou implementadas

Recuperado do endpoint /campaigns/bids

catalogId

Atualizar o status da categoria

Recuperado do endpoint /categories

audienceId

Atualizar uma audiência específica

Recuperado de /audiences/ 

Nome

Atualizar o nome da audiência

Recuperado do endpoint /audiences/userlist/ 

Recuperado do endpoint /audiences/{audience_id} 

Descrição

Atualizar a descrição da audiência

Recuperado do endpoint /audiences/userlist/ 

Recuperado do endpoint /audiences/{audience_id} 

operation

Ação em relação a uma audiência

Recuperado do endpoint /audiences/userlist/{audience_id} 

O valor deve ser o seguinte: ADD / REMOVE

schema

Tipo de dados de audiência

Recuperado do endpoint /audiences/userlist/{audience_id} 

identifiers

Lista de identificadores de usuários

Recuperado do endpoint /audiences/{audience_id} 

reportType

Exportação de relatório de estatísticas

Recuperado de /statistics

O valor deve ser o seguinte: Performance da campanha / Relatório sobre Facebook DPA / Relatório de IDs de Transação

ignoreXDevice

Exportação de relatório de estatísticas

Recuperado de /statistics

startDate

Exportação de relatório de estatísticas

Recuperado de /statistics

endDate

Exportação de relatório de estatísticas

Recuperado de /statistics

dimensions

Exportação de relatório de estatísticas

Recuperado de /statistics

Máximo de 3 dimensões

metrics

Exportação de relatório de estatísticas

Recuperado de /statistics

As métricas devem ser selecionadas na IU do Criteo Management Center

format

Exportação de relatório de estatísticas

Recuperado de /statistics

O valor deve ser o seguinte: XML, JSON, CSV, EXCEL, HTML

moeda

Exportação de relatório de estatísticas

Recuperado de /statistics

O valor deve ser um código de moeda ISO

Fuso horário

Exportação de relatório de estatísticas

Recuperado de /statistics

O valor deve ser o seguinte: GMT / PST / JST 


Códigos de resposta

Código de resposta

Motivo

200

Bem-sucedido

400

Solicitação inválida, sintaxe inválida

401

Falha na autenticação

403

Acesso proibido

429

Limite de taxa alcançado, não mais do que 200 solicitações por minuto, por cliente

500

Erro desconhecido

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