Documentação do Mercado Livre
Confira todas as informações necessárias sobre as APIs Mercado Livre.
Documentação do
Última atualização em 21/10/2024
Display Ads
Tipos e objetivos de campanha
| Tipo de campanha | Objetivo | Métricas chave |
|---|---|---|
| Programmatic | Awareness: aumenta a exposição de uma marca ou produto entre os usuários de seu interesse. | Alcance y frecuencia: permitem medir quantos usuários você alcançou com seus anúncios e quantas vezes eles os viram em um determinado período. *Com vídeo criativo disponível. |
| Programmatic | Consideration: aumenta as visitas e ações do usuário em uma marca ou produto. | Clicks and VPP: permitem medir quantas vezes seus anúncios foram clicados e quantas visitas eles geraram na página do produto. |
| Programmatic | Conversion: aumenta as vendas dos produtos da sua marca com publicidade. | Ingresos y ventas: permitem quantificar as vendas geradas depois que os usuários visualizam ou clicam em seus anúncios. |
| Guaranteed | São criadas e gerenciadas pela equipe de operações do Mercado Livre. | Permite planejar e comprar um determinado número de impressões com um CPM fixo. |
Fluxo técnico recomendado
- Anunciantes (advertiser id) de display
- Campanhas de anunciantes
- Métricas de uma campanha
- Consultar line items
- Métricas de line items
- Consultar criativos
- Métricas de criativos
Painel de campanha en Mercado Ads
Consultar anunciante
Os anunciantes (advertiser_id) são aqueles que têm um pressuposto para a criação e distribuição de anúncios publicitários, com o objetivo de promover seus produtos ou serviços. Consulte a listagem de anunciantes que têm acesso a um usuário, dependendo do tipo de produto que você deseja (Brand Ads ou Display).
Parâmetros obrigatórios
product_id: tipo de produto. Valores disponíveis: PADS (Product Ads), DISPLAY, BADS (Brand Ads).
Parâmetros opcionais
sort_by: classifica por atributo (advertiser_id, site_id). Por padrão é advertiser_id.
sort_order: ordem (asc, desc). Por padrão é desc.
Chamada:
curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' -H 'Content-Type: application/json' -H 'Api-Version: 1'
https://api.mercadolibre.com/advertising/advertisers?product_id=$PRODUCT_IDExemplo:
curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' -H 'Content-Type: application/json' -H 'Api-Version: 1'
https://api.mercadolibre.com/advertising/advertisers?product_id=DISPLAYResposta:
{
"advertisers": [
{
"advertiser_id": 000,
"site_id": "MLB",
"advertiser_name": "Advertiser AAA",
"account_name": "MLB - XZY"
},
{
"advertiser_id": 111,
"site_id": "MLM",
"advertiser_name": "Advertiser BBB",
"account_name": "MLM - XYZ"
},
{
"advertiser_id": 222,
"site_id": "MLA",
"advertiser_name": "Advertiser CCC",
"account_name": "MLA - XYZ"
},
{
"advertiser_id": 333,
"site_id": "MLC",
"advertiser_name": "Advertiser DDD",
"account_name": "MLC - XYZ"
}
]
}Campos de resposta
advertiser_id: identificador do anunciante. Você o usará para o restante das solicitações.
site_id: identificador do país. Consulte a nomenclatura dos sites do Mercado Livre e suas respectivas moedas.
advertiser_name: nome do anunciante.
account_name: nome da conta.
Consultar campanhas de um anunciante
Parâmetros opcionais
sort_by: classifica por atributo (id, name, start_date, end_date). O padrão é id.
sort_order: pedido (asc, desc). O padrão é desc.
Chamada:
curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' -H "Content-Type: application/json" -H "Api-Version: 1"
https://api.mercadolibre.com/advertising/advertisers/$ADVERTISER_ID/display/campaignsExemplo:
curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' -H "Content-Type: application/json" -H "Api-Version: 1"
https://api.mercadolibre.com/advertising/advertisers/61/display/campaigns?sort_by=start_date&sort_order=descResposta:
{
"results": [
{
"id": 80,
"name": "CONVERSION_ENERO2022_MLA",
"start_date": "2022-01-12T17:00:00",
"end_date": "2022-01-31T23:59:00",
"advertiser_id": 61,
"type": "GUARANTEED",
"status": "paused",
"site_id": "MLA"
}
]
}Campos da resposta
id: id da campanha. Use o id para consultar as métricas da campanha.
name: nome da campanha.
start_date: data de início da campanha.
end_date: data de término da campanha.
advertiser_id: id do anunciante.
type: tipo da campanha: Programmatic ou Guaranteed.
status: estado da campanha.
site_id: país.
strategy: objetivo da campanha. Em breve.
Métricas de campanha
Os resultados deste endpoint serão as métricas por dia e um resumo do período da campanha. Você pode consultar até 90 dias atrás, considerando 1º de setembro de 2022 como data inicial.
Parâmetros obrigatórios
date_from: data desde a consulta no formato YYYY-MM-DD.
date_to: data até consulta no formato YYYY-MM-DD.
Parâmetros opcionais
sort_by: classifica por atributo (id, name, start_date, end_date). O padrão é id.
sort_order: pedido (asc, desc). O padrão é desc.
Chamada:
curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' -H "Content-Type: application/json" -H "Api-Version: 1"
https://api.mercadolibre.com/advertising/advertisers/$ADVERTISER_ID/display/campaigns/$CAMPAIGN_ID/metrics?date_from=YYYY-MM-DD&date_to=YYYY-MM-DDExemplo:
curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' -H "Content-Type: application/json" -H "Api-Version: 1"
https://api.mercadolibre.com/advertising/advertisers/61/display/campaigns/80/metrics?date_from=2024-04-01&date_to=2024-04-15Resposta:
{
"metrics": [
{
"date": "2024-02-01",
"site_id": "MLM",
"currency": "MXN",
"prints": 17961,
"clicks": 186,
"active_views": 0,
"completed_views": 0,
"reach": 10079,
"ctr": 0.01,
"consumed_budget": 57449.13,
"cpm": 3198.55,
"cpc": 308.87,
"average_frequency": 1148.98,
"event_time": {
"cpa_order": 1083.95,
"cpa_ppv": 135.81,
"roas": 10.03,
"units_quantity": 75,
"direct_amount": 576150,
"direct_item_quantity": 53,
"attribution_ppv": 423,
"attribution_add_to_cart": 26,
"attribution_bookmark": 33,
"attribution_checkout": 24,
"attribution_leads": 0,
"cpl": 0.0
},
"touch_point": {
"cpa_order": 1148.98,
"cpa_ppv": 125.16,
"roas": 12.36,
"units_quantity": 70,
"direct_amount": 710324,
"direct_item_quantity": 50,
"attribution_ppv": 459,
"attribution_add_to_cart": 26,
"attribution_bookmark": 35,
"attribution_checkout": 28,
"attribution_leads": 0,
"cpl": 0.0
}
}
],
"summary": {
"site_id": "MLM",
"currency": "MXN",
"prints": 170462,
"clicks": 2033,
"active_views": 0,
"completed_views": 0,
"reach": 48957,
"ctr": 0.01,
"consumed_budget": 605406.93,
"cpm": 3551.57,
"cpc": 297.79,
"average_frequency": 1509.74,
"event_time": {
"cpa_order": 1513.52,
"cpa_ppv": 128.59,
"roas": 9.48,
"units_quantity": 586,
"direct_amount": 5741691,
"direct_item_quantity": 400,
"attribution_ppv": 4708,
"attribution_add_to_cart": 263,
"attribution_bookmark": 375,
"attribution_checkout": 219,
"attribution_leads": 0,
"cpl": 0.0
},
"touch_point": {
"cpa_order": 1509.74,
"cpa_ppv": 125.66,
"roas": 9.49,
"units_quantity": 586,
"direct_amount": 5746421,
"direct_item_quantity": 401,
"attribution_ppv": 4818,
"attribution_add_to_cart": 270,
"attribution_bookmark": 352,
"attribution_checkout": 225,
"attribution_leads": 0,
"cpl": 0.0
}
}
}
Line items de campanha
O line item define os parâmetros de compra do anúncio patrocinado: o perfil do usuário que você quer alcançar, a localização geográfica, o dispositivo por onde a pessoa navega, entre outros. Cada line item está associado a uma única campanha e consome o orçamento dela.
Parâmetros opcionais
sort_by: valores possíveis: id, name, start_date, end_date.
sort_order: valores possíveis: asc, desc.
Chamada:
curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' -H "Content-Type: application/json" -H "Api-Version: 1"
https://api.mercadolibre.com/advertising/advertisers/$ADVERTISER_ID/display/campaigns/$CAMPAIGN_ID/line_items?sort_by=start_date&sort_order=ascExemplo:
curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' -H "Content-Type: application/json" -H "Api-Version: 1"
https://api.mercadolibre.com/advertising/advertisers/123456/display/campaigns/987654/line_items?sort_by=start_date&sort_order=ascResposta:
{
"results": [
{
"line_item_id": 1,
"name": "Name_Line_Item_Test",
"start_date": "2022-01-12T17:00:00",
"end_date": "2022-01-31T23:59:00",
"campaing_id": 987654,
"type": "Social",
"status": "paused"
}
]
}Campos de resposta
line_item_id: id de line item.
name: nome de line item.
start_date: data de início de line item.
end_date: data final de line item.
type: tipo de line item. Eles variam de acordo com o criativo atribuído.
- Display: banner nativo com imagem e texto. Apto para distintos espaços de publicidade do Mercado Livre e Mercado Pago.
- Social: video en formato vertical con banner inferior. Disponible para los espacios de Clips de Mercado Libre.
- Video: vídeo no formato horizontal. Disponível para plataformas de streaming integradas ao Mercado Ads.
status: estado de line item.
Métricas de line items
Os resultados deste endpoint serão as métricas por dia e um resumo do período da campanha. Você pode consultar até 90 dias atrás, considerando 1º de setembro de 2022 como data inicial.
Parâmetros obrigatórios
dimension: tipo de métrica: line_items.
date_from: data desde a consulta no formato YYYY-MM-DD.
date_to: data até consulta no formato YYYY-MM-DD.
Parâmetros opcionais
campaign_id: ID de campanha.
ids: listagem de ids de dimension ao consultar, separados por vírgula.
Chamada:
curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' -H "Content-Type: application/json" -H "Api-Version: 1"
https://api.mercadolibre.com/advertising/advertisers/$ADVERTISER_ID/display/metrics?dimension=line_items&date_from=YYYY-MM-DD&date_to=YYYY-MM-DD&campaign_id=$CAMPAIGN_IDExemplo:
curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' -H "Content-Type: application/json" -H "Api-Version: 1"
https://api.mercadolibre.com/advertising/advertisers/0000/display/metrics?dimension=line_items&date_from=2024-09-19&date_to=2024-09-19&campaign_id=1111Resposta:
[
{
"campaign_id": 1111,
"line_item_id": 010101,
"metrics": [
{
"date": "2024-09-19",
"site_id": "MLM",
"currency": "MXN",
"prints": 2460,
"clicks": 20,
"active_views": 388,
"completed_views": 55,
"reach": 2091,
"ctr": 0.01,
"consumed_budget": 423.01,
"cpm": 171.96,
"cpc": 21.15,
"average_frequency": 0.0,
"event_time": {
"cpa_order": 0.0,
"cpa_ppv": 28.2,
"roas": 0.0,
"units_quantity": 0,
"direct_amount": 0.0,
"direct_item_quantity": 0,
"attribution_ppv": 15,
"attribution_add_to_cart": 0,
"attribution_bookmark": 9,
"attribution_checkout": 0,
"attribution_leads": 0,
"cpl": 0.0
},
"touch_point": {
"cpa_order": 0.0,
"cpa_ppv": 17.63,
"roas": 0.0,
"units_quantity": 0,
"direct_amount": 0.0,
"direct_item_quantity": 0,
"attribution_ppv": 24,
"attribution_add_to_cart": 2,
"attribution_bookmark": 9,
"attribution_checkout": 0,
"attribution_leads": 0,
"cpl": 0.0
}
},
{
"date": "2024-09-20",
"site_id": "MLM",
"currency": "MXN",
"prints": 2907,
"clicks": 23,
"active_views": 511,
"completed_views": 73,
"reach": 2475,
"ctr": 0.01,
"consumed_budget": 494.54,
"cpm": 170.12,
"cpc": 21.5,
"average_frequency": 0.0,
"event_time": {
"cpa_order": 0.0,
"cpa_ppv": 26.03,
"roas": 0.0,
"units_quantity": 0,
"direct_amount": 0.0,
"direct_item_quantity": 0,
"attribution_ppv": 19,
"attribution_add_to_cart": 1,
"attribution_bookmark": 4,
"attribution_checkout": 0,
"attribution_leads": 0,
"cpl": 0.0
},
"touch_point": {
"cpa_order": 0.0,
"cpa_ppv": 24.73,
"roas": 0.0,
"units_quantity": 0,
"direct_amount": 0.0,
"direct_item_quantity": 0,
"attribution_ppv": 20,
"attribution_add_to_cart": 1,
"attribution_bookmark": 6,
"attribution_checkout": 0,
"attribution_leads": 0,
"cpl": 0.0
}
}
],
"summary": {
"site_id": "MLM",
"currency": "MXN",
"prints": 5367,
"clicks": 43,
"active_views": 899,
"completed_views": 128,
"reach": 4477,
"ctr": 0.01,
"consumed_budget": 917.55,
"cpm": 170.96,
"cpc": 21.34,
"average_frequency": 0.0,
"event_time": {
"cpa_order": 0.0,
"cpa_ppv": 26.99,
"roas": 0.0,
"units_quantity": 0,
"direct_amount": 0.0,
"direct_item_quantity": 0,
"attribution_ppv": 34,
"attribution_add_to_cart": 1,
"attribution_bookmark": 13,
"attribution_checkout": 0,
"attribution_leads": 0,
"cpl": 0.0
},
"touch_point": {
"cpa_order": 0.0,
"cpa_ppv": 20.85,
"roas": 0.0,
"units_quantity": 0,
"direct_amount": 0.0,
"direct_item_quantity": 0,
"attribution_ppv": 44,
"attribution_add_to_cart": 3,
"attribution_bookmark": 15,
"attribution_checkout": 0,
"attribution_leads": 0,
"cpl": 0.0
}
}
}
]Criativos de line item
Parâmetros opcionais
sort_by: valores posibles: id, name.
sort_order: valores posibles: asc, desc.
Chamada:
curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' -H "Content-Type: application/json" -H "Api-Version: 1"
https://api.mercadolibre.com/advertising/advertisers/$ADVERTISER_ID/display/campaigns/$CAMPAIGN_ID/line_items/$LINE_ITEM_ID/creatives?sort_by=start_date&sort_order=ascExemplo:
curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' -H "Content-Type: application/json" -H "Api-Version: 1"
https://api.mercadolibre.com/advertising/advertisers/$ADVERTISER_ID/display/campaigns/999999/line_items/0000001/creatives?sort_by=start_date&sort_order=ascResposta:
{
"results": [
{
"creative_id": 123456,
"name": "Name_Creative_Test",
"status": "active",
"line_item_id": 0000001,
"campaign_id": 999999
}
]
}Campos de resposta
creative_id: id del criativo.
name: nombre del criativo.
status: estado del criativo. Puede ser: active.
line_item_id: id del line item.
campaign_id: id da campanha.
Métricas de criativos
Os resultados deste endpoint serão as métricas por dia e um resumo do período do line item. Você pode consultar até 90 dias atrás, considerando 1º de setembro de 2022 como data inicial.
Parâmetros obrigatórios
dimension: tipo de métrica: creatives.
date_from: data desde a consulta no formato YYYY-MM-DD.
date_to: data até consulta no formato YYYY-MM-DD.
Parâmetros opcionais
ids: listagem de ids de dimension ao consultar, separados por vírgula.
line_item_id: ID de line item.
Chamada:
curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' -H "Content-Type: application/json" -H "Api-Version: 1"
https://api.mercadolibre.com/advertising/advertisers/$ADVERTISER_ID/display/metrics?dimension=creatives&date_from=YYYY-MM-DD&date_to=YYYY-MM-DD&line_item_id=$LINE_ITEM_IDExemplo:
curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' -H "Content-Type: application/json" -H "Api-Version: 1"
https://api.mercadolibre.com/advertising/advertisers/0000/display/metrics?dimension=creatives&date_from=2024-09-19&date_to=2024-09-20&line_item_id=4321Resposta:
[
{
"campaign_id": 1111,
"line_item_id": 4321,
"creative_id": 3333,
"metrics": [
{
"date": "2024-09-19",
"site_id": "MLM",
"currency": "MXN",
"prints": 579,
"clicks": 3,
"active_views": 104,
"completed_views": 20,
"reach": 527,
"ctr": 0.01,
"consumed_budget": 99.52,
"cpm": 171.89,
"cpc": 33.17,
"average_frequency": 0.0,
"event_time": {
"cpa_order": 0.0,
"cpa_ppv": 0.0,
"roas": 0.0,
"units_quantity": 0,
"direct_amount": 0.0,
"direct_item_quantity": 0,
"attribution_ppv": 0,
"attribution_add_to_cart": 0,
"attribution_bookmark": 0,
"attribution_checkout": 0,
"attribution_leads": 0,
"cpl": 0.0
},
"touch_point": {
"cpa_order": 0.0,
"cpa_ppv": 33.17,
"roas": 0.0,
"units_quantity": 0,
"direct_amount": 0.0,
"direct_item_quantity": 0,
"attribution_ppv": 3,
"attribution_add_to_cart": 0,
"attribution_bookmark": 0,
"attribution_checkout": 0,
"attribution_leads": 0,
"cpl": 0.0
}
},
{
"date": "2024-09-20",
"site_id": "MLM",
"currency": "MXN",
"prints": 569,
"clicks": 0,
"active_views": 90,
"completed_views": 18,
"reach": 517,
"ctr": 0.0,
"consumed_budget": 96.42,
"cpm": 169.46,
"cpc": 0.0,
"average_frequency": 0.0,
"event_time": {
"cpa_order": 0.0,
"cpa_ppv": 0.0,
"roas": 0.0,
"units_quantity": 0,
"direct_amount": 0.0,
"direct_item_quantity": 0,
"attribution_ppv": 0,
"attribution_add_to_cart": 0,
"attribution_bookmark": 0,
"attribution_checkout": 0,
"attribution_leads": 0,
"cpl": 0.0
},
"touch_point": {
"cpa_order": 0.0,
"cpa_ppv": 96.42,
"roas": 0.0,
"units_quantity": 0,
"direct_amount": 0.0,
"direct_item_quantity": 0,
"attribution_ppv": 1,
"attribution_add_to_cart": 0,
"attribution_bookmark": 0,
"attribution_checkout": 0,
"attribution_leads": 0,
"cpl": 0.0
}
}
],
"summary": {
"site_id": "MLM",
"currency": "MXN",
"prints": 1148,
"clicks": 3,
"active_views": 194,
"completed_views": 38,
"reach": 1037,
"ctr": 0.0,
"consumed_budget": 195.94,
"cpm": 170.68,
"cpc": 65.31,
"average_frequency": 0.0,
"event_time": {
"cpa_order": 0.0,
"cpa_ppv": 0.0,
"roas": 0.0,
"units_quantity": 0,
"direct_amount": 0.0,
"direct_item_quantity": 0,
"attribution_ppv": 0,
"attribution_add_to_cart": 0,
"attribution_bookmark": 0,
"attribution_checkout": 0,
"attribution_leads": 0,
"cpl": 0.0
},
"touch_point": {
"cpa_order": 0.0,
"cpa_ppv": 48.99,
"roas": 0.0,
"units_quantity": 0,
"direct_amount": 0.0,
"direct_item_quantity": 0,
"attribution_ppv": 4,
"attribution_add_to_cart": 0,
"attribution_bookmark": 0,
"attribution_checkout": 0,
"attribution_leads": 0,
"cpl": 0.0
}
}
},
{
"campaign_id": 1111,
"line_item_id": 4321,
"creative_id": 3333,
"metrics": [
{
"date": "2024-09-19",
"site_id": "MLM",
"currency": "MXN",
"prints": 550,
"clicks": 3,
"active_views": 70,
"completed_views": 7,
"reach": 503,
"ctr": 0.01,
"consumed_budget": 94.6,
"cpm": 172.01,
"cpc": 31.53,
"average_frequency": 0.0,
"event_time": {
"cpa_order": 0.0,
"cpa_ppv": 94.6,
"roas": 0.0,
"units_quantity": 0,
"direct_amount": 0.0,
"direct_item_quantity": 0,
"attribution_ppv": 1,
"attribution_add_to_cart": 0,
"attribution_bookmark": 6,
"attribution_checkout": 0,
"attribution_leads": 0,
"cpl": 0.0
},
"touch_point": {
"cpa_order": 0.0,
"cpa_ppv": 94.6,
"roas": 0.0,
"units_quantity": 0,
"direct_amount": 0.0,
"direct_item_quantity": 0,
"attribution_ppv": 1,
"attribution_add_to_cart": 0,
"attribution_bookmark": 6,
"attribution_checkout": 0,
"attribution_leads": 0,
"cpl": 0.0
}
},
{
"date": "2024-09-20",
"site_id": "MLM",
"currency": "MXN",
"prints": 544,
"clicks": 6,
"active_views": 92,
"completed_views": 8,
"reach": 495,
"ctr": 0.01,
"consumed_budget": 92.72,
"cpm": 170.44,
"cpc": 15.45,
"average_frequency": 0.0,
"event_time": {
"cpa_order": 0.0,
"cpa_ppv": 15.45,
"roas": 0.0,
"units_quantity": 0,
"direct_amount": 0.0,
"direct_item_quantity": 0,
"attribution_ppv": 6,
"attribution_add_to_cart": 0,
"attribution_bookmark": 0,
"attribution_checkout": 0,
"attribution_leads": 0,
"cpl": 0.0
},
"touch_point": {
"cpa_order": 0.0,
"cpa_ppv": 13.25,
"roas": 0.0,
"units_quantity": 0,
"direct_amount": 0.0,
"direct_item_quantity": 0,
"attribution_ppv": 7,
"attribution_add_to_cart": 0,
"attribution_bookmark": 1,
"attribution_checkout": 0,
"attribution_leads": 0,
"cpl": 0.0
}
}
],
"summary": {
"site_id": "MLM",
"currency": "MXN",
"prints": 1094,
"clicks": 9,
"active_views": 162,
"completed_views": 15,
"reach": 991,
"ctr": 0.01,
"consumed_budget": 187.32,
"cpm": 171.23,
"cpc": 20.81,
"average_frequency": 0.0,
"event_time": {
"cpa_order": 0.0,
"cpa_ppv": 26.76,
"roas": 0.0,
"units_quantity": 0,
"direct_amount": 0.0,
"direct_item_quantity": 0,
"attribution_ppv": 7,
"attribution_add_to_cart": 0,
"attribution_bookmark": 6,
"attribution_checkout": 0,
"attribution_leads": 0,
"cpl": 0.0
},
"touch_point": {
"cpa_order": 0.0,
"cpa_ppv": 23.42,
"roas": 0.0,
"units_quantity": 0,
"direct_amount": 0.0,
"direct_item_quantity": 0,
"attribution_ppv": 8,
"attribution_add_to_cart": 0,
"attribution_bookmark": 7,
"attribution_checkout": 0,
"attribution_leads": 0,
"cpl": 0.0
}
}
},
{
"campaign_id": 4321,
"line_item_id": 3333,
"creative_id": 4444,
"metrics": [
{
"date": "2024-09-19",
"site_id": "MLM",
"currency": "MXN",
"prints": 582,
"clicks": 9,
"active_views": 97,
"completed_views": 13,
"reach": 545,
"ctr": 0.02,
"consumed_budget": 100.34,
"cpm": 172.4,
"cpc": 11.15,
"average_frequency": 0.0,
"event_time": {
"cpa_order": 0.0,
"cpa_ppv": 7.72,
"roas": 0.0,
"units_quantity": 0,
"direct_amount": 0.0,
"direct_item_quantity": 0,
"attribution_ppv": 13,
"attribution_add_to_cart": 0,
"attribution_bookmark": 0,
"attribution_checkout": 0,
"attribution_leads": 0,
"cpl": 0.0
},
"touch_point": {
"cpa_order": 0.0,
"cpa_ppv": 5.9,
"roas": 0.0,
"units_quantity": 0,
"direct_amount": 0.0,
"direct_item_quantity": 0,
"attribution_ppv": 17,
"attribution_add_to_cart": 0,
"attribution_bookmark": 0,
"attribution_checkout": 0,
"attribution_leads": 0,
"cpl": 0.0
}
},
{
"date": "2024-09-20",
"site_id": "MLM",
"currency": "MXN",
"prints": 651,
"clicks": 8,
"active_views": 117,
"completed_views": 17,
"reach": 590,
"ctr": 0.01,
"consumed_budget": 111.42,
"cpm": 171.15,
"cpc": 13.93,
"average_frequency": 0.0,
"event_time": {
"cpa_order": 0.0,
"cpa_ppv": 22.28,
"roas": 0.0,
"units_quantity": 0,
"direct_amount": 0.0,
"direct_item_quantity": 0,
"attribution_ppv": 5,
"attribution_add_to_cart": 0,
"attribution_bookmark": 1,
"attribution_checkout": 0,
"attribution_leads": 0,
"cpl": 0.0
},
"touch_point": {
"cpa_order": 0.0,
"cpa_ppv": 27.85,
"roas": 0.0,
"units_quantity": 0,
"direct_amount": 0.0,
"direct_item_quantity": 0,
"attribution_ppv": 4,
"attribution_add_to_cart": 0,
"attribution_bookmark": 2,
"attribution_checkout": 0,
"attribution_leads": 0,
"cpl": 0.0
}
}
],
"summary": {
"site_id": "MLM",
"currency": "MXN",
"prints": 1233,
"clicks": 17,
"active_views": 214,
"completed_views": 30,
"reach": 1128,
"ctr": 0.01,
"consumed_budget": 211.75,
"cpm": 171.74,
"cpc": 12.46,
"average_frequency": 0.0,
"event_time": {
"cpa_order": 0.0,
"cpa_ppv": 11.76,
"roas": 0.0,
"units_quantity": 0,
"direct_amount": 0.0,
"direct_item_quantity": 0,
"attribution_ppv": 18,
"attribution_add_to_cart": 0,
"attribution_bookmark": 1,
"attribution_checkout": 0,
"attribution_leads": 0,
"cpl": 0.0
},
"touch_point": {
"cpa_order": 0.0,
"cpa_ppv": 10.08,
"roas": 0.0,
"units_quantity": 0,
"direct_amount": 0.0,
"direct_item_quantity": 0,
"attribution_ppv": 21,
"attribution_add_to_cart": 0,
"attribution_bookmark": 2,
"attribution_checkout": 0,
"attribution_leads": 0,
"cpl": 0.0
}
}
},
{
"campaign_id": 2222,
"line_item_id": 3333,
"creative_id": 4444,
"metrics": [
{
"date": "2024-09-19",
"site_id": "MLM",
"currency": "MXN",
"prints": 350,
"clicks": 4,
"active_views": 54,
"completed_views": 6,
"reach": 298,
"ctr": 0.01,
"consumed_budget": 59.75,
"cpm": 170.72,
"cpc": 14.94,
"average_frequency": 0.0,
"event_time": {
"cpa_order": 0.0,
"cpa_ppv": 0.0,
"roas": 0.0,
"units_quantity": 0,
"direct_amount": 0.0,
"direct_item_quantity": 0,
"attribution_ppv": 0,
"attribution_add_to_cart": 0,
"attribution_bookmark": 3,
"attribution_checkout": 0,
"attribution_leads": 0,
"cpl": 0.0
},
"touch_point": {
"cpa_order": 0.0,
"cpa_ppv": 59.75,
"roas": 0.0,
"units_quantity": 0,
"direct_amount": 0.0,
"direct_item_quantity": 0,
"attribution_ppv": 1,
"attribution_add_to_cart": 2,
"attribution_bookmark": 3,
"attribution_checkout": 0,
"attribution_leads": 0,
"cpl": 0.0
}
},
{
"date": "2024-09-20",
"site_id": "MLM",
"currency": "MXN",
"prints": 613,
"clicks": 5,
"active_views": 128,
"completed_views": 16,
"reach": 529,
"ctr": 0.01,
"consumed_budget": 103.73,
"cpm": 169.22,
"cpc": 20.75,
"average_frequency": 0.0,
"event_time": {
"cpa_order": 0.0,
"cpa_ppv": 51.86,
"roas": 0.0,
"units_quantity": 0,
"direct_amount": 0.0,
"direct_item_quantity": 0,
"attribution_ppv": 2,
"attribution_add_to_cart": 1,
"attribution_bookmark": 3,
"attribution_checkout": 0,
"attribution_leads": 0,
"cpl": 0.0
},
"touch_point": {
"cpa_order": 0.0,
"cpa_ppv": 51.86,
"roas": 0.0,
"units_quantity": 0,
"direct_amount": 0.0,
"direct_item_quantity": 0,
"attribution_ppv": 2,
"attribution_add_to_cart": 1,
"attribution_bookmark": 3,
"attribution_checkout": 0,
"attribution_leads": 0,
"cpl": 0.0
}
}
],
"summary": {
"site_id": "MLM",
"currency": "MXN",
"prints": 963,
"clicks": 9,
"active_views": 182,
"completed_views": 22,
"reach": 825,
"ctr": 0.01,
"consumed_budget": 163.48,
"cpm": 169.76,
"cpc": 18.16,
"average_frequency": 0.0,
"event_time": {
"cpa_order": 0.0,
"cpa_ppv": 81.74,
"roas": 0.0,
"units_quantity": 0,
"direct_amount": 0.0,
"direct_item_quantity": 0,
"attribution_ppv": 2,
"attribution_add_to_cart": 1,
"attribution_bookmark": 6,
"attribution_checkout": 0,
"attribution_leads": 0,
"cpl": 0.0
},
"touch_point": {
"cpa_order": 0.0,
"cpa_ppv": 54.49,
"roas": 0.0,
"units_quantity": 0,
"direct_amount": 0.0,
"direct_item_quantity": 0,
"attribution_ppv": 3,
"attribution_add_to_cart": 3,
"attribution_bookmark": 6,
"attribution_checkout": 0,
"attribution_leads": 0,
"cpl": 0.0
}
}
},
{
"campaign_id": 2222,
"line_item_id": 3333,
"creative_id": 4444,
"metrics": [
{
"date": "2024-09-19",
"site_id": "MLM",
"currency": "MXN",
"prints": 399,
"clicks": 1,
"active_views": 63,
"completed_views": 9,
"reach": 347,
"ctr": 0.0,
"consumed_budget": 68.8,
"cpm": 172.43,
"cpc": 68.8,
"average_frequency": 0.0,
"event_time": {
"cpa_order": 0.0,
"cpa_ppv": 68.8,
"roas": 0.0,
"units_quantity": 0,
"direct_amount": 0.0,
"direct_item_quantity": 0,
"attribution_ppv": 1,
"attribution_add_to_cart": 0,
"attribution_bookmark": 0,
"attribution_checkout": 0,
"attribution_leads": 0,
"cpl": 0.0
},
"touch_point": {
"cpa_order": 0.0,
"cpa_ppv": 34.4,
"roas": 0.0,
"units_quantity": 0,
"direct_amount": 0.0,
"direct_item_quantity": 0,
"attribution_ppv": 2,
"attribution_add_to_cart": 0,
"attribution_bookmark": 0,
"attribution_checkout": 0,
"attribution_leads": 0,
"cpl": 0.0
}
},
{
"date": "2024-09-20",
"site_id": "MLM",
"currency": "MXN",
"prints": 530,
"clicks": 4,
"active_views": 84,
"completed_views": 14,
"reach": 484,
"ctr": 0.01,
"consumed_budget": 90.25,
"cpm": 170.29,
"cpc": 22.56,
"average_frequency": 0.0,
"event_time": {
"cpa_order": 0.0,
"cpa_ppv": 15.04,
"roas": 0.0,
"units_quantity": 0,
"direct_amount": 0.0,
"direct_item_quantity": 0,
"attribution_ppv": 6,
"attribution_add_to_cart": 0,
"attribution_bookmark": 0,
"attribution_checkout": 0,
"attribution_leads": 0,
"cpl": 0.0
},
"touch_point": {
"cpa_order": 0.0,
"cpa_ppv": 15.04,
"roas": 0.0,
"units_quantity": 0,
"direct_amount": 0.0,
"direct_item_quantity": 0,
"attribution_ppv": 6,
"attribution_add_to_cart": 0,
"attribution_bookmark": 0,
"attribution_checkout": 0,
"attribution_leads": 0,
"cpl": 0.0
}
}
],
"summary": {
"site_id": "MLM",
"currency": "MXN",
"prints": 929,
"clicks": 5,
"active_views": 147,
"completed_views": 23,
"reach": 825,
"ctr": 0.01,
"consumed_budget": 159.05,
"cpm": 171.21,
"cpc": 31.81,
"average_frequency": 0.0,
"event_time": {
"cpa_order": 0.0,
"cpa_ppv": 22.72,
"roas": 0.0,
"units_quantity": 0,
"direct_amount": 0.0,
"direct_item_quantity": 0,
"attribution_ppv": 7,
"attribution_add_to_cart": 0,
"attribution_bookmark": 0,
"attribution_checkout": 0,
"attribution_leads": 0,
"cpl": 0.0
},
"touch_point": {
"cpa_order": 0.0,
"cpa_ppv": 19.88,
"roas": 0.0,
"units_quantity": 0,
"direct_amount": 0.0,
"direct_item_quantity": 0,
"attribution_ppv": 8,
"attribution_add_to_cart": 0,
"attribution_bookmark": 0,
"attribution_checkout": 0,
"attribution_leads": 0,
"cpl": 0.0
}
}
}
]Glossário
date: data.
site_id: identificador do país. Consulte a nomenclatura dos sites do Mercado Livre e suas respectivas moedas.
currency: identificador de moedas.
prints: Impressões: número de vezes que seus anúncios foram exibidos.
clicks: vezes que os usuários clicaram em seus anúncios.
active_views (vistas activas): quantidade de vezes que os usuários viram os primeiros 6 segundos do seu anúncio de Social e Vídeo.
completed_views (vistas completas): quantidade de vezes que os usuários viram seu anúncio completo de Social e Vídeo.
reach: Escopo: número de usuários únicos para os quais seus anúncios foram exibidos.
ctr: Click-Through Rate: taxa de cliques obtidos sobre o total de impressões.
consumed_budget: Investimento: valor efetivamente gasto para exibir seus anúncios.
cpm: custo médio pago por mil impressões de anúncios.
cpc: Custo por clique. É o custo médio pago por cada clique que os anúncios receberam.
average_frequency: Frequência média. Número médio de vezes que seus anúncios foram exibidos ao mesmo usuário.
As métricas de atribuição têm duas formas de serem apresentadas:
Métricas atribuídas por data de ação (event_time): as métricas serão mostradas associadas à data exata em que a ação foi realizada (Ex: Vendas).
Métricas atribuídas por data de visualização (touchpoint): as métricas serão exibidas associadas à data do clique ou impressão visível a que foram atribuídas.
- cpa_order: (vendas): custo médio de investimento para cada venda obtida.
- cpa_ppv: custo médio de investimento para cada visualização de página de produto obtida.
- roas: retorno do dinheiro obtido no investimento.
- units_quantity: unidades de seus produtos que foram vendidas entre todas as compras atribuídas aos seus anúncios.
- direct_amount (lucros): valor total das vendas atribuídas aos seus anúncios.
- direct_item_quantity: vezes que os usuários fizeram uma compra depois de visualizar ou clicar em seus anúncios.
- attribution_ppv (visualizações da página do produto): vezes que as pessoas visitaram a página do seu produto depois de visualizar ou clicar em seus anúncios.
- attribution_add_to_cart: vezes que os usuários adicionaram seus produtos promovidos ao carrinho de compras depois de visualizar ou clicar em seus anúncios.
- attribution_bookmark: vezes que os usuários adicionaram seus produtos promovidos aos favoritos depois de visualizar ou clicar em seus anúncios.
- attribution_checkout: vezes que os usuários iniciaram um processo de compra de seus produtos promovidos após visualizar ou clicar em seus anúncios.
- attribution_leads: contatos gerados por clientes em potencial depois que eles visualizaram ou clicaram em seus anúncios.
- cpl: custo médio de cada lead com base no investimento.
Erros
| Erro | Status | Mensagem |
|---|---|---|
| bad_request | 400 | The parameter {paramKey} is required. |
| not_found | 404 | No campaigns found for advertiser id {advertiser_id} Campaign not found for sent campaign_id. |
| not_found | 404 | No line items found for campaign_id {campaign_id} |
| not_found | 404 | No campaigns found for advertiser id {advertiser_id} Campaign not found for sent campaign_id. |