Iniciar sesión

Bienvenido al Centro de soporte técnico

Obtenga ayuda con la integración y las campañas en vivo.

Bienvenido al Centro de soporte técnico. Obtenga ayuda con la integración y las campañas en vivo.

Detalles de la API de marketing

A la API de Criteo se puede acceder utilizando esta url: https://api.criteo.com/marketing

Endpoints

Authentication

tipo

Endpoint

Objetivo

Parámetros

Observaciones

POST

/oauth2/token

Recupera el token que te permitirá realizar una solicitud a la API

  • client_id (obligatorio)
  • client_secret (obligatorio)
  • grant_type (obligatorio)

El token será válido durante 300s

 

Gestión de anunciantes

tipo

Endpoint

Objetivo

Parámetros

GET

/portfolio

Recupera tu(s) advertiser_Id(s)

Ninguno.

GET

/advertiser/{advertiser_Id}/campaigns

Recupera tus campañas y categorías para un anunciante concreto

advertiser_Id (obligatorio): string

GET

/advertiser/{advertiser_Id}/categories

Recupera tus campañas y categorías para un anunciante concreto

Filtrar por estado de categorías

advertiser_Id (obligatorio): int

enabledOnly: bool

GET

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

Recupera categorías específicas para un anunciante concreto

advertiser_Id (obligatorio)

categoryHashCode (obligatorio)

 


Gestión de campañas

tipo

Endpoint

Objetivo

Parámetros

GET

/campaigns/

Recupera campañas para tu portfolio

advertiser_Ids: string

campaignIds: string

campaignstatus: string

bidtype: string

GET

/campaigns/{campaignId}

Recupera tu campaña y categorías para un anunciante concreto

campaignId (mandatory): int

GET

/campaigns/{campaignId}/categories

Recupera tu campaña y categorías para un anunciante concreto

Filtrar por estado de categorías

campaignId (mandatory): int

enabledOnly: string

GET

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

Recupera categorías de campaña específicas de tu portfolio

campaignId (mandatory): int

categoryHashCodes (mandatory): int

GET

/campaigns/bids

Recupera tus pujas para tu portfolio

advertiser_Ids: string

campaignIds: string

categoryHashCodes:string

bidType: string

campaignStatus: string

pendingChanges: bool

PUT

/campaigns/bids

Fija nuevos valores de puja para tu campaña o categorías de campaña

bidChanges (mandatoy): string

 

Generación de informes sobre campañas

tipo

Endpoint

Objetivo

Parámetros

Observaciones

POST

/statistics

Recuperar informes de performance de la publicidad

statsQuery (obligatorio)

La información detallada sobre este endpoint se proporcionan en la sección de documentación pertinente

 

Gestión de presupuesto

tipo

Endpoint

Objetivo

Parámetros

GET

/budgets

Recupera presupuestos para tu portfolio

advertiser_Ids: string

budgetIds: string

onlyActiveCampaigns:bool

 

Gestión de categorías

tipo

Endpoint

Objetivo

Parámetros

GET

/categories

Recupera categorías para tu portfolio

campaign_Ids: : string

advertiser_Ids: string

categoryHashCodes: string

enabledOnly: bool

PUT

/categories

Categorías activadas o desactivadas

categoriesPerCatalog (obligatorio)

 

Gestión de audiencias

tipo

Endpoint

Objetivo

Parámetros

Observaciones

GET

/audiences

Recupera la lista de audiencias

advertiser_Id : int

Sin id de anunciante especificado, se devolverá el portfolio del usuario

POST

 /audiences/userlist/ 

Crear un audiencia

advertiser_Id : int

name: string

description:string

El id audiencia es el siguiente id (incrementado cada vez que se crea una audiencia)

PUT

/audiences/{audienceId} 

Cambiar los metadatos de una audiencia

name: string

description: string

 

PATCH

/audiences/userlist/{audienceId}

Añadir/ eliminar usuarios de una audiencia

operation: string (ADD  or REMOVE) 

schema: string (email or madid)

identifiers: list of string

Limitado a 50.000 identificadores por solicitud.

los identificadores pueden ser:

emails: Texto normal, MD5 o SHA256 de MD5

MADID: IDFA o AAID

Nota: la API no acepta IDs de cookies de DMPs

BORRAR 

/audiences/userlist/{audienceId}/users

Eliminar todos los usuarios de una audiencia

   

BORRAR 

/audiences/{audienceId}

Borrar una audiencia

   

 

Parámetros

Parámetro

Utilizado para...

Detalles

client_id

Recuperación de token

Tu e-mail (mismo login que para Criteo Management Center)

client_secret

Recuperación de token

Tu contraseña (mismo login que para Criteo Management Center)

grant_type

Recuperación de token

Siempre igual a "client_credentials"

advertiser_Id

Recuperación de datos específicos de anunciantes

Recuperado del endpoint del /portfolio

Recuperado del endpoint /advertisers

Recuperado del endpoint /audience

Recuperado de /audiences/userlist/ 

advertiser_Ids

Recuperación de datos específicos de anunciantes

Recuperado del endpoint /budget

Recuperado del endpoint /campaigns

Recuperado del endpoint /campaigns/ bids

Recuperado del endpoint /categories

Recuperado del endpoint /statistics

Puedes solicitar múltiples advertiser_Ids separándolos por comas, p.ej. 1,2,3

enabledOnly

Filtrar lista de categorías

Recuperado de endpoints /categories

Recuperado de endpoint /advertiser/{advertiser_id}/categories

Recuperado de endpoint /campaigns/{campaignid}/categories

activado

actualizar estado de categoría

Recuperado de endpoints /categories

categoryHashCode

Recuperación de datos de categorías específicas

Actualizar estado de categorías específias

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

categoryHashCodes

Recuperación de datos de categorías específicas

Actualización de valor de puja de categorías de campañas específicas

Recuperado del endpoint /categories

Recuperado del endpoint /campaigns/ bids

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

Puedes solicitar múltiples categoryhashcodes separándolos por comas, p.ej. 1,2,3

budgetIds

Recuperación de datos de prespuestos específicos

Recuperado del endpoint /budgets

onlyactiveCampaigns

Filtrar campañas por estados

Recuperado del endpoint /budgets

campaignID

Recuperación de datos de campañas específicos

Actualización de valor de puja de campañas específicas

Recuperado de endpoint /campaigns/{campaignid}

Recuperado de endpoint /campaigns/{campaignid}/categories

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

Recuperado del endpoint /campaigns/ bids

campaignIds

Recuperación de datos de campañas específicos

Recuperado del endpoint /campaigns

Recuperado del endpoint /campaigns/ bids

Recuperado del endpoint /categories

Puedes solicitar múltiples campaignids separándolos por comas, p.ej. 1,2,3

bidType

Filtrar por tipos de puja

Recuperado del endpoint /campaigns

Recuperado del endpoint /campaigns/bids

bidValue

Actualización de valor de puja de categorías de campañas específicas

Recuperado del endpoint /campaigns/bids

campaignStatus

Filtrar por estado de campaña

Recuperado del endpoint /campaigns

Recuperado del endpoint /campaigns/ bids

pendingChanges

Filtrar campaña con cambios pendientes o ya realizados

Recuperado del endpoint /campaigns/ bids

catalogId

Actualizar estado de categoría

Recuperado de endpoints /categories

audienceId

Actualizar audiencia específica

Recuperado de /audiences 

name

Actualizar nombre de audiencia

Recuperado de endpoint /audiences/userlist/

Recuperado de endpoint /audiences/{audience_id}

description

Actualizar descripción de audiencia

Recuperado de endpoint /audiences/userlist/

Recuperado de endpoint /audiences/{audience_id}

operación

Acción sobre una audiencia

Recuperado de endpoint /audiences/userlist/{audience_id}

El valor debe ser del siguiente: ADD / REMOVE

schema

Datos de tipo de audiencia

Recuperado de endpoint /audiences/userlist/{audience_id}

identificadores

Lista de identificadores de usuario

Recuperado de endpoint /audiences/{audience_id}

reportType

Exportación de informes de estadísticas

Recuperado de /statistics

El valor debe ser uno de los siguientes: Performance de campaña / Informe de DPA de Facebook / Informe de ID de transacción

ignoreXDevice

Exportación de informes de estadísticas

Recuperado de /statistics

startDate

Exportación de informes de estadísticas

Recuperado de /statistics

endDate

Exportación de informes de estadísticas

Recuperado de /statistics

dimensiones

Exportación de informes de estadísticas

Recuperado de /statistics

Máx. 3 dimensiones

métricas

Exportación de informes de estadísticas

Recuperado de /statistics

Las métricas deben tomarse de MC UI

formato

Exportación de informes de estadísticas

Recuperado de /statistics

El valor debe ser uno de los siguientes: XML, JSON, CSV, EXCEL, HTML

moneda

Exportación de informes de estadísticas

Recuperado de /statistics

El valor debe tener código de moneda ISO

Zona horaria

Exportación de informes de estadísticas

Recuperado de /statistics

El valor debe ser del siguiente: GMT / PST / JST 


Códigos de respuesta

Código de respuesta

Razón

200

OK

400

Solicitud errónea, sintaxis no válida

401

Fallo de autentificación

403

Acceso prohibido

429

Se ha alcanzado el límite máximo, no se permiten más de 200 solicitudes por minuto, por cliente

500

Error desconocido

¿Fue útil este artículo?
Usuarios a los que les pareció útil: 0 de 0
Tecnología de Zendesk