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.

¿Cómo consulto la información de reportes con la API de Criteo?

Para consultar un informe utilizando la API de Crieto, puedes recurrir a las siguientes consultas: 
  1. clientLogin
  2. scheduleReportJob
  3. getJobStatus
  4. getReportDownloadUrl

 

Lista de llamadas y respuestas de la API

 
1. clientLogin
Proporciona un authToken, que se utilizará en todas las llamadas posteriores.

Parámetros:
Campo tipo Descripción
Nombre de usuario xsd:string Nombre de usuario del anunciante
contraseña xsd:string Contraseña del anunciante
fuente xsd:string String (cadena de carácteres) corta que identifica tu aplicación con fines de registro. Esta string debe tener la forma: "companyName-applicationName-versionID".

Respuesta:
Campo tipo Descripción
clientLoginResult xsd:string clientLoginResult es el token de autenticación (authToken), que se utilizará en todas las demás llamadas. Es válido por 48 horas.
 
2. getAccount
Devuelve la información básica de la cuenta.

Parámetros:
N/A

Respuesta:
Campo tipo Descripción
Nombre del anunciante xsd:string Nombre de esta cuenta
email xsd:string Email de contacto del anunciante
moneda xsd:string Moneda de esta cuenta. Enumeración
Zona horaria xsd:string Zona horaria de esta cuenta. Enumeración
país xsd:string País de esta cuenta. Enumeración
 
3. getBudgets
Proporciona la lista de presupuestos que cumplen los criterios de selección.

Parámetros:
Campo tipo Descripción
budgetSelector BudgetIDs[] Una lista de IDs de presupuestos para recuperar. Si está vacía, se han recuperado todos los presupuestos.

Respuesta:
Campo tipo Descripción
getBudgetsResult Presupuesto[] Proporciona una lista de objetos del presupuesto
 
4. getCampaigns
Devuelve la lista de campañas que cumplen los criterios de selección.

Parámetros:
Campo tipo Descripción
campaignSelector CampaignSelector BudgetID, CampaignID, CampaignStatus y BiddingStartegy se pueden utilizar para recuperar campañas.

Respuesta:
Campo tipo Descripción
getCampaignsResult Campaign[] Proporciona una lista de objetos de campaña
 
5. getCategories
Devuelve la lista de categorías que cumple los criterios del selector.

Parámetros:
Campo tipo Descripción
categorySelector CategorySelector CategoryID y Selected se pueden usar para recuperar categorías.

Respuesta:
Campo tipo Descripción
getCategoriesResult Category[] Proporciona una lista de objetos de categoría
 
6. mutateCategories
Actualiza las categorías.

Parámetros:
Campo tipo Descripción
mutateCategories CategoryMutates[] Lista de operaciones de mutación. Solo se admiten las operaciones SET.

Respuesta:
Campo tipo Descripción
jobResponse categoryMutateJobResponse[] Una lista de categoryJobResponseObjects. Cada operación tiene su identificador de trabajo, que puede comprobarse con getJobStatus.
 
7. mutateCampaigns
Actualiza las campañas.

Parámetros:
Campo tipo Descripción
mutateCampaigns CampaignMutates[] Lista de operaciones de mutación. Solo se admiten las operaciones SET.


Respuesta:
Campo tipo Descripción
jobResponse campaignMutateJobResponse[] Lista de campaignJobResponseObjects. Cada operación tiene su propio jobID, que puede comprobarse con getJobStatus.


8. scheduleReportJob
Programa un trabajo de informe para su ejecución.

Parámetros:
Campo tipo Descripción
reportJob ReportJob Se pasa un objeto reportJob, que escribe el informe solicitado.

Respuesta:
Campo tipo Descripción
jobID xsd:int Identificador del trabajo solicitado. Se puede utilizar en getJobStatus y getReportDownloadURL.
jobStatus xsd:string Estado de la solicitud. Si se aceptó el reportJob, regresa a "Pendiente".
reportJob ReportJob La solicitud inicial de reportJob


9. getJobStatus
Recupera un estado de trabajo basado en su ID.

Parámetros:
Campo tipo Descripción
jobID xsd:int Se recuperó el estado de jobID.

Respuesta:
Campo tipo Descripción
getJobStatusResult xsd:String Estado del trabajo solicitado. Enumeración


10. getReportDownloadUrl
Devuelve una URL desde la que se puede descargar el informe con el identificador de trabajo dado. Después de invocar este método, la persona que llama puede hacer un HTTP GET normal en la URL devuelta para recuperar el informe. Los informes están en formato XML.

Parámetros:
Campo tipo Descripción
jobID xsd:int Se recuperó la URL de descarga del jobID.

Respuesta:
Campo tipo Descripción
jobURL xsd:String URL completa que permite la descarga del informe.


11. getStatisticsLastUpdate
Proporciona una lista de objetos StatUpdate para indicar la última actualización para el tipo de estadísticas relacionado (ClicksAndImpressions, Sales for now).

Parámetros:
Ninguno.

Respuesta:
Campo tipo Descripción
getStatisticsLastUpdateResult StatUpdate[] Lista de StatUpdateObjects. Un StatUpdate contiene un tipo y una fecha.

 

Descripciones de los objetos

 
Tipos de campañas
Campo tipo Descripción
campaignID xsd:int Identificador de la campaña
campaignName xsd:string Nombre de la campaña
campaignBid BidInformation Información de la puja de la campaña
budgetID xsd:decimal Identificador del presupuesto que utiliza la campaña.
remainingDays xsd:int Cantidad de días en los que esta campaña se puede ejecutar con el presupuesto existente. Este valor se estima en función de la tendencia de gasto actual.
Estado xsd:string Estado de la campaña:
  • RUNNING: la campaña está activa actualmente
  • NOT_RUNNING: la campaña está inactiva
  • DEAD: la campaña está archivada (solo lectura)
categoryBids CategoryBid[] Lista de información de puja adjunta a una categoría.


Tipo de categoría
Campo tipo Descripción
categoryID xsd:int Identificador de la categoría
categoryName xsd:string Nombre de la categoría (recuperado del feed).
avgPrice xsd:double Precio medio de los productos de esta categoría.
numberOfProducts xsd:int Número de productos etiquetados con esta categoría.
seleccionado xsd:boolean Es verdadero si la categoría está seleccionada (seleccionada significa disponible para pujas e informes).


Tipo de presupuesto
Campo tipo Descripción
budgetID xsd:int Identificador o ID del presupuesto.
budgetName xsd:string Nombre del presupuesto.
totalAmount xsd:int Importe total añadido a este presupuesto.
remainingBudget xsd:decimal Cantidad disponible.
remainingBudgetUpdated xsd:dateTime Tiempo en el que se calculó el remainingBudget.


Tipo de BidInformation
Campo tipo Descripción
biddingStrategy xsd:string Estrategia de la puja:
  • Cpc: coste por clic
  • CPA: coste por adquisición
  • CPM: coste por mil impresiones
Nota: Únicamente se admite Cpc.
cpcBid xsd:double Valor del coste por clic.
cpaBid CPABid CPABid contiene post-clic, post-vista, comisión y porcentaje. (Aún no se admite).


Tipo de CategoryBid
Campo tipo Descripción
campaignCategoryUID xsd:int UID global que identifica la categoría para una campaña específica.
campaignID xsd:int Identificador de la campaña en la que se realiza esta puja de categoría.
categoryID xsd:int Identificador de la categoría en la que se realiza esta puja.
seleccionado xsd:boolean Es verdadero si la categoría está seleccionada (seleccionada significa disponible para pujas e informes).
bidInformation BidInformation BidInformation para la puja de categoría.


Tipo de ReportJob
Campo tipo Descripción
reportSelector CategoryIDs
CampaignIDs
Lista de IDs de categoría o IDs de campaña sobre los que el informe debe recuperar datos.
reportType xsd:string Tipo de informe a ejecutar:
  • Campaña
  • Categoría
aggregationType xsd:string Tipo de agregación para el informe:
  • Por hora
  • Diariamente
startDate xsd:string Fecha de inicio del informe (AAAA-MM-DD).
endDate xsd:string Fecha fin del informe (AAAA-MM-DD).
selectedColumns ReportColumn[] Lista de columnas solicitadas en el informe:
  • clics
  • impresiones
  • ctr
  • revcpc
  • ecpm
  • coste
  • Ventas
  • convRate
  • orderValue
  • salesPostView
  • convRatePostView
  • orderValuePostView
  • costOfSale
  • impressionWin
  • costPerOrder
isResultGzipped xsd:boolean Es cierto que se necesita comprimir el informe.

 

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