> For the complete documentation index, see [llms.txt](https://help.citrusad.com/retail-media-interface/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.citrusad.com/retail-media-interface/partner/pt-br/partner-api-overview/epsilon-retail-media-partner-apis-overview-1.md).

# Visão geral das APIs de parceiros da Epsilon Retail Media

Boas-vindas à Epsilon Retail Media API do parceiro. Este guia ajuda você a se integrar com nossa plataforma de publicidade para gerenciar suas campanhas, carteiras, equipes e usuários de forma programática. Você também pode acompanhar o desempenho e expandir seus negócios de maneira eficaz.

## O que é uma API?

Uma API significa Interface de Programação de Aplicações. Uma API atua como um intermediário que permite que dois componentes de software se comuniquem usando um conjunto de funções e procedimentos. As APIs são comumente usadas para obter ou enviar dados, acessando recursos e serviços de outras aplicações.

## O que é a API do parceiro?

Nossa API do parceiro oferece acesso programático a quase tudo o que você pode fazer na Epsilon interface do usuário das plataformas de gestão de campanhas No site. Isso significa que, em vez de clicar manualmente no aplicativo, seus sistemas ou desenvolvedores podem se conectar diretamente à nossa plataforma e automatizar, personalizar ou integrar seus recursos às suas próprias ferramentas ou fluxos de trabalho.

A API do parceiro é utilizada por muitos varejistas e parceiros, incluindo agregadores como Pacvue, Skai e Commerce IQ.

## Visão geral da API

A Epsilon Retail Media API do parceiro permite o gerenciamento programático de mídia de varejo [Campanhas](/retail-media-interface/partner/pt-br/campaign-management-api/productcampaign-1/createproductcampaign.md), [Equipe](/retail-media-interface/partner/pt-br/team-user-api/team.md) & [Usuário](/retail-media-interface/partner/pt-br/team-user-api/user-1/createuserteaminvite.md), e [Carteiras](/retail-media-interface/partner/pt-br/billing-api/wallet.md). Use-a para criar e atualizar campanhas em vários formatos de anúncios, incluindo Sponsored Product Ads (SPAs), banners estáticos e responsivos Banner X anúncios.

Nossa API do parceiro é uma API baseada em REST que usa protocolos comuns GET, POST, PATCH e DELETE por meio de payloads JSON.

## Principais benefícios

* Automatize operações de campanhas, equipes, usuários e carteiras por meio de endpoints de API REST.
* Gerencie várias campanhas e recursos com eficiência com suporte a operações em lote.
* Permite orquestrar chamadas de API para se adequar ao seu fluxo de trabalho e arquitetura de sistema existentes.
* Crie e gerencie campanhas em Sponsored Product Ads, Banner e Banner X formatos.
* Autenticação baseada em chave de usuário com tokens de tempo limitado para interações de API seguras.

## Pré-requisitos

<figure><img src="/files/1tmcc3J0AzcTwzOCYWyx" alt="" width="100%"><figcaption></figcaption></figure>

Antes de usar a API do parceiro, certifique-se de que os seguintes requisitos sejam atendidos:

### Acesso ao namespace

Você deve ter acesso ao seu namespace designado, que atua como um contêiner para seus dados e configurações. Entre em contato com a Epsilon equipe de suporte para obter detalhes de configuração de namespace específicos para seus varejistas.

### Membro da equipe

Você deve fazer parte de uma equipe de fornecedor ou de varejista principal com as permissões apropriadas dentro do seu namespace.

### Solicitação de integração de API

Agregadores de anúncios, agências e parceiros de marcas devem fazer uma solicitação de integração de API antes de usar as APIs do parceiro. Use o formulário oficial de integração referenciado em [KB0040933 ](https://citrusad.service-now.com/now/nav/ui/classic/params/target/kb_view.do%3Fsysparm_article%3DKB0040933)para iniciar uma nova conexão de API.

### Acesso à API de relatórios

Você deve ter acesso à API de relatórios (data warehouse BigQuery) para consultar tabelas relevantes, como dim\_product, dim\_catalog e dim\_placement. Isso ajuda a validar a prontidão da integração e a explorar metadados.

### Metadados necessários

Certifique-se de que o catálogo de produtos, o posicionamento e as informações da equipe estejam criados e disponíveis em seu namespace. Você pode verificar isso consultando as tabelas apropriadas do BigQuery.

Se você não tiver acesso ao BigQuery, solicite-o por meio do formulário oficial de solicitação de acesso à API. Dependendo das suas necessidades, consulte o artigo apropriado da base de conhecimento:

* **Alterar/remover endpoint da API do BigQuery de relatórios**: Precisa modificar um endpoint de API existente - [KB0040934](https://citrusad.service-now.com/now/nav/ui/classic/params/target/kb_view.do%3Fsysparm_article%3DKB0040934).
* NOVA API do parceiro (API de relatórios)\*\* - [KB0040947](https://citrusad.service-now.com/now/nav/ui/classic/params/target/kb_view.do%3Fsysparm_article%3DKB0040947).

{% hint style="info" %}
Nota de acesso: Alguns links neste documento apontam para recursos internos ou restritos. Certifique-se de estar conectado com as credenciais apropriadas para acessar o conteúdo.
{% endhint %}

## Primeiros passos com as APIs do parceiro

<figure><img src="/files/M44hbuoQ2cb8AJjsN5ED" alt="" width="100%"><figcaption></figcaption></figure>

### Requisitos de autenticação

A API do parceiro utiliza um processo de autorização que exige uma chave de usuário. Os tokens de acesso são recuperados chamando a API de autenticação por chave de usuário:

* Sua chave de usuário recuperada é passada no cabeçalho desta solicitação.
* O token de acesso recuperado é posteriormente usado em qualquer chamada de método para a API do parceiro.
* Os tokens expiram em pouco menos de 24 horas a partir da geração.

{% hint style="info" %}
Um novo token deve ser solicitado quando o anterior expirar. Um cliente não deve gerar um novo token a cada solicitação para nossa API.
{% endhint %}

### Obtenha suas credenciais de API

Para começar a usar as Epsilon Retail Media APIs do parceiro, você precisa das seguintes informações. Se não tiver certeza sobre qualquer um dos detalhes, entre em contato com seu suporte ou abra um chamado para obter assistência.

* Sua chave de usuário para autenticação.
* A URL base para fazer chamadas de API.

### Recupere sua chave de usuário

1. Faça login na sua Epsilon Retail Media conta de equipe.
2. Escolha uma equipe.
3. No menu suspenso do perfil, selecione **User settings**.
4. Navegue até a aba **User key**.
5. Clique em **Show** para revelar sua chave de API.

Use esta chave para autenticar suas solicitações de API. Epsilon Retail Media usa autenticação baseada em chave de usuário. Troque sua chave de usuário por um token de acesso de tempo limitado para autorizar solicitações de API. Para obter mais informações, consulte [Solicitações de autenticação](/retail-media-interface/partner/pt-br/partner-api-authentication/authenticating-requests.md).

### Obtenha sua URL base

Entre em contato com o suporte para obter a URL base correta para o seu ambiente. Exemplo de endpoint:

```
https://campaign.<env>.citrusad.com/v3/campaigns
```

Assim que tiver sua chave de usuário, você poderá se autenticar e começar a fazer chamadas de API para:

* Visualizar e gerenciar suas campanhas publicitárias.
* Gerenciar seus orçamentos de publicidade e gastos.
* Gerenciar detalhes da sua equipe e do usuário.

## Configurar o ambiente

Epsilon Retail Media fornece dois ambientes distintos para cada varejista: Produção e Sandbox. Ambos os ambientes são criados por padrão quando um varejista é integrado.

### Ambiente de Sandbox

{% hint style="info" %}
O acesso ao Sandbox normalmente é fornecido apenas a varejistas e agregadores. Se você não tiver certeza sobre sua elegibilidade, entre em contato com o Suporte.
{% endhint %}

Use este ambiente seguro para testar sua integração antes de ir ao ar. Os varejistas devem usar este ambiente para validar chamadas de API, testar envios de catálogo, simular a criação de campanhas e garantir a funcionalidade ponta a ponta antes de ir ao ar. Use o sandbox para todas as atividades de desenvolvimento, teste e garantia de qualidade (QA). Cada varejista tem uma URL de sandbox exclusiva, geralmente no formato:

```
https://<retailer>-sandbox.citrusad.com
```

O ambiente de sandbox inclui:

<figure><img src="/files/GvC4nQ8i9EE3Dz4Cv9bH" alt="" width="100%"><figcaption></figcaption></figure>

### Ambiente de produção

Mude para a produção somente após a validação bem-sucedida no sandbox. O ambiente de produção é usado para campanhas ativas e veiculação de anúncios em tempo real. Ele dá suporte a operações em escala total, incluindo atualizações de catálogo, sincronização de pedidos e rastreamento de desempenho de anúncios. A URL de produção segue este formato:

```
https://<namespace>.citrusad.com
```

Certifique-se de que todos os dados (catálogos, produtos, pedidos) estejam precisos e completos antes de usar este ambiente.

{% hint style="info" %}
Sempre confirme o ambiente correto antes de fazer chamadas de API, especialmente ao usar credenciais e URLs base. A URL base pode nem sempre corresponder ao namespace, dependendo da configuração de integração do varejista.
{% endhint %}

## Endpoints da API do parceiro

Epsilon Retail Media A API oferece um conjunto de recursos principais agrupados em categorias funcionais, cada um suportado por endpoints dedicados. A tabela abaixo resume as principais APIs voltadas para parceiros, seus propósitos e os métodos HTTP usados.

<figure><img src="/files/xKkMbbWgWcBdNJlRFY4l" alt="" width="100%"><figcaption></figcaption></figure>

### Gerenciamento de campanhas

**O que é um anúncio de produto patrocinado?** Anúncios de Produtos Patrocinados (SPA) são anúncios posicionados em grades de produtos no site do varejista, normalmente encontrados em páginas de busca e de categoria, bem como na PDP e na página inicial, dispostos entre as listagens orgânicas.

**O que é um Banner X Ad?** Banner X os anúncios são unidades publicitárias totalmente responsivas que crescem e mudam de acordo com a área de visualização (viewport) do usuário. Eles são compostos por vários elementos criativos, desde imagens principais e de fundo até textos de cabeçalho e botões de chamada para ação (CTA).

**O que é um Banner?** Um Banner padrão é uma imagem estática com uma URL de clique por trás dela.

#### Campanha de produto

| Endpoint                                                                                                                                                                 | Descrição                                                                               | Método |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------- | ------ |
| [Create a product campaign](/retail-media-interface/partner/pt-br/campaign-management-api/productcampaign-1/createproductcampaign.md)                                    | Cria uma nova campanha de produto usando os detalhes fornecidos no corpo da requisição. | POST   |
| [Retrieve list of all product campaigns](/retail-media-interface/partner/pt-br/campaign-management-api/productcampaign-1/listproductcampaigns.md)                        | Recupera uma lista de todas as campanhas de produto com base nos parâmetros fornecidos. | GET    |
| [Update a product campaign](/retail-media-interface/partner/pt-br/campaign-management-api/productcampaign-1/updateproductcampaign.md)                                    | Atualiza uma campanha de produto existente usando o ID da campanha                      | PATCH  |
| [Get product campaign by ID](/retail-media-interface/partner/pt-br/campaign-management-api/productcampaign-1/getproductcampaign-1.md)                                    | Recupera os detalhes da campanha de produto para o ID de campanha especificado.         | GET    |
| [Change approval state of a product campaign](/retail-media-interface/partner/pt-br/campaign-management-api/productcampaign-1/approveproductcampaign-1.md)               | Atualiza o status de aprovação de uma campanha de produto especificada.                 | POST   |
| [Check booking feasibility for fixed tenancy campaigns](/retail-media-interface/partner/pt-br/campaign-management-api/productcampaign-1/checkfixedtenancyavailable-1.md) | Verifica se a reserva é viável para campanhas de posicionamento fixo.                   | POST   |

#### Banner X Campanha

| Endpoint                                                                                                                                               | Descrição                                                                                                                                                                                     | Método |
| ------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ |
| [Create a Banner X campaign](/retail-media-interface/partner/pt-br/campaign-management-api/bannerxcampaign-1/createbannerxcampaign-1.md)               | Cria uma nova campanha de banner X usando os detalhes fornecidos no corpo da requisição.                                                                                                      | POST   |
| [Get Banner X campaign details](/retail-media-interface/partner/pt-br/campaign-management-api/bannerxcampaign-1/getbannerxcampaign-1.md)               | Recupera os detalhes da campanha de banner X para o ID de campanha especificado.                                                                                                              | GET    |
| [Update Banner X campaign](/retail-media-interface/partner/pt-br/campaign-management-api/bannerxcampaign-1/updatebannerxcampaign.md)                   | Atualiza uma campanha Banner X existente fornecendo o ID da campanha e os dados atualizados da campanha no corpo da requisição.                                                               | PATCH  |
| [Update Banner X campaign approval state](/retail-media-interface/partner/pt-br/campaign-management-api/bannerxcampaign-1/approvebannerxcampaign-1.md) | Atualiza o status de aprovação de uma campanha de banner X especificada.                                                                                                                      | POST   |
| [Retrieve list of all Banner X campaigns](/retail-media-interface/partner/pt-br/campaign-management-api/bannerxcampaign-1/listbannerxcampaigns.md)     | Recupera uma lista de campanhas de banner X com base em filtros e parâmetros especificados, incluindo nome da campanha, ID do posicionamento, ID da equipe, status de aprovação e muito mais. | GET    |

#### Campanha de banner

| Endpoint                                                                                                                                       | Descrição                                                                              | Método |
| ---------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | ------ |
| [Create a banner campaign](/retail-media-interface/partner/pt-br/campaign-management-api/bannercampaign/createbannercampaign-1.md)             | Cria uma nova campanha de banner usando os detalhes fornecidos no corpo da requisição. | POST   |
| [Get banner campaign details](/retail-media-interface/partner/pt-br/campaign-management-api/bannercampaign/getbannercampaign-1.md)             | Recupera os detalhes da campanha de banner para o ID de campanha especificado.         | GET    |
| [Update banner campaign](/retail-media-interface/partner/pt-br/campaign-management-api/bannercampaign/updatebannercampaign.md)                 | Atualiza uma campanha de banner existente usando o ID da campanha.                     | PATCH  |
| [Update banner campaign approval state](/retail-media-interface/partner/pt-br/campaign-management-api/bannercampaign/approvebannercampaign.md) | Atualiza o status de aprovação de uma campanha de banner especificada                  | POST   |

#### Arquivos de campanha

| Endpoint                                                                                                                         | Descrição                                                                                          | Método |
| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | ------ |
| [Upload a campaign file](/retail-media-interface/partner/pt-br/campaign-management-api/creativeassets/uploadfile.md)             | Faz o upload de diferentes tipos de arquivos de campanha                                           | POST   |
| [Retrieve campaign file URL](/retail-media-interface/partner/pt-br/campaign-management-api/creativeassets/getcampaignfileurl.md) | Recupera a URL de um arquivo de campanha usando o ID do arquivo e o tipo de arquivo especificados. | POST   |

#### Padrão de conteúdo

| Endpoint                                                                                                                                                                     | Descrição                                                                                                                                                | Método |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ |
| [Get Banner X content standard details](/retail-media-interface/partner/pt-br/campaign-management-api/bannerxcontentstandard/getbannerxcontentstandard-1.md)                 | Recupera Banner X detalhes do padrão de conteúdo para o ID de padrão de conteúdo especificado.                                                           | GET    |
| [Retrieve list content standards for Banner X campaigns](/retail-media-interface/partner/pt-br/campaign-management-api/bannerxcontentstandard/listbannerxcontentstandard.md) | Recupera a lista de padrões de conteúdo para Banner X campanhas com base nos parâmetros especificados, como namespace, nome e ID do padrão de conteúdo.  | GET    |
| [Get banner content standard details](/retail-media-interface/partner/pt-br/campaign-management-api/bannerxcontentstandard/getbannercontentstandard.md)                      | Recupera os detalhes do padrão de conteúdo do Banner para o ID de padrão de conteúdo especificado.                                                       | GET    |
| [Retrieve list content standards for banner campaigns](/retail-media-interface/partner/pt-br/campaign-management-api/bannerxcontentstandard/listbannercontentstandard.md)    | Recupera a lista de padrões de conteúdo para campanhas de banner com base nos parâmetros especificados, como namespace, nome e ID do padrão de conteúdo. | GET    |

#### Campanha

| Endpoint                                                                                                                                      | Descrição                                                                                                                                                                                             | Método |
| --------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ |
| [Retrieve list of all campaigns](/retail-media-interface/partner/pt-br/campaign-management-api/campaign/listcampaigns-1.md)                   | Recupera uma lista de campanhas com base em filtros e parâmetros especificados, incluindo nome da campanha, tipo de campanha, ID do posicionamento, ID da equipe, status de aprovação e muito mais.   | POST   |
| [Retrieve campaign history](/retail-media-interface/partner/pt-br/campaign-management-api/campaign/getcampaignhistory.md)                     | Recupera o histórico de uma campanha usando seu ID de campanha.                                                                                                                                       | GET    |
| [Retrieve minimum bid details for keywords](/retail-media-interface/partner/pt-br/campaign-management-api/campaign/retrievekeywordsminbid.md) | Recupera detalhes de lances mínimos individuais e o lance mínimo geral da campanha para um conjunto de palavras-chave especificadas em campanhas do tipo de posicionamento Busca e Categoria & Busca. | POST   |
| [Retrieve minimum bid details for category](/retail-media-interface/partner/pt-br/campaign-management-api/campaign/retrievecategoryminbid.md) | Recupera detalhes de lances mínimos individuais e o lance mínimo geral da campanha para campanhas do tipo de posicionamento de categoria.                                                             | POST   |

## Gerenciamento de ativos de criativos

### O que é um ativo de criativo?

Ativos de criativos são imagens usadas em Banner e Banner X campanhas. Esses ativos devem atender a requisitos técnicos específicos para garantir exibição e desempenho adequados.

### Diretrizes de upload:

* Tamanho do arquivo < 4 MB
* Tipos de arquivo: PNG, JPEG, JPG, GIF, SVG e PDF
* Um arquivo por vez
* ID da equipe, ID do espaço e ID do padrão de conteúdo são obrigatórios
* Forneça um caminho absoluto completo para o arquivo

{% hint style="info" %}
Os uploads de ativos de criativos são manipulados por meio dos pontos de extremidade de Arquivo de campanha listados na seção de Gerenciamento de campanhas acima.
{% endhint %}

## Gerenciamento de padrão de conteúdo

### O que é um Padrão de conteúdo?

Os padrões de conteúdo são diretrizes e parâmetros técnicos que ditam como um Banner ou Banner X anúncio deve ser exibido em um espaço designado em um site ou plataforma digital. Os padrões incluem parâmetros como dimensões e tamanho, formato e tamanhos de arquivo, resolução e qualidade, posicionamento e alinhamento, restrições de conteúdo e interatividade.

### Gerenciamento de equipe e usuário

#### O que é uma Equipe?

Uma equipe é uma coleção de usuários e é classificada como uma equipe de fornecedor (anunciante) ou de varejista. As equipes de fornecedores geralmente criam campanhas, enquanto os varejistas revisam campanhas e realizam tarefas administrativas. Um usuário no sistema pode pertencer a várias equipes ou a apenas uma. Normalmente, uma equipe terá usuários, campanhas e carteiras associados a ela.

#### Equipe

| Endpoint                                                                                           | Descrição                                                                                      | Método |
| -------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ------ |
| [Create team](/retail-media-interface/partner/pt-br/team-user-api/team/createteam-1.md)            | Cria uma nova equipe.                                                                          | POST   |
| Atualizar uma equipe                                                                               | Atualiza os detalhes de uma equipe especificada pelo team\_id.                                 | PATCH  |
| Listar todas as equipes                                                                            | Recupera uma lista de equipes fornecendo parâmetros como name, namespace\_id e seller\_id.     | GET    |
| [Get team for specified ID](/retail-media-interface/partner/pt-br/team-user-api/team/getteam-1.md) | Recupera informações detalhadas sobre uma equipe específica, incluindo seus membros.           | GET    |
| Entrar em uma equipe com token de convite                                                          | Permite que os usuários entrem em uma equipe usando um token de convite válido e não expirado. | POST   |

#### Usuário

| Endpoint                                                                                                        | Descrição                                                                                    | Método |
| --------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | ------ |
| [Invite a user to the team](/retail-media-interface/partner/pt-br/team-user-api/user-1/createuserteaminvite.md) | Envia um convite para um usuário entrar em uma equipe especificada.                          | POST   |
| Recuperar detalhes do usuário usando o ID de usuário                                                            | Recupera os detalhes do usuário atualmente conectado na Epsilon Retail Media plataforma.     | GET    |
| [Retrieve user details](/retail-media-interface/partner/pt-br/team-user-api/user-1/getusersforteam.md)          | Recupera os detalhes do usuário com base no ID de equipe fornecido.                          | GET    |
| [Update current user detail](/retail-media-interface/partner/pt-br/team-user-api/user-1/updateuserprofile.md)   | Modifica os detalhes do usuário atualmente conectado na Epsilon Retail Media plataforma.     | PATCH  |
| [Modify user permission](/retail-media-interface/partner/pt-br/team-user-api/user-1/modifyuserpermission.md)    | Atualiza as permissões de um usuário fornecendo tanto o ID do usuário quanto o ID da equipe. | PATCH  |
| [Upload a file](/retail-media-interface/partner/pt-br/team-user-api/user-1/uploadfile-1.md)                     | Faz upload de logotipos para perfis de usuário e equipes.                                    | POST   |
| [Retrieve file URL](/retail-media-interface/partner/pt-br/team-user-api/user-1/getfileurl.md)                   | Recupera a URL para o logotipo de uma equipe ou usuário usando o ID de arquivo especificado. | POST   |
| Remover um usuário                                                                                              | Remove um usuário da equipe.                                                                 | DELETE |

### Gerenciamento de faturamento e carteira

#### O que é uma Carteira?

Uma carteira armazena os fundos de um anunciante com a finalidade de realizar pagamentos (por exemplo, pagar por anúncios realizados).

#### Carteira

| Endpoint                                                                                                             | Descrição                                                                                                                                                          | Método |
| -------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------ |
| [Create a wallet](/retail-media-interface/partner/pt-br/billing-api/wallet/createwallet.md)                          | Cria uma carteira dentro de um namespace especificado e a associa a uma equipe usando o ID da equipe.                                                              | POST   |
| [Update a wallet](/retail-media-interface/partner/pt-br/billing-api/wallet/updatewallet-1.md)                        | Atualiza uma carteira dentro de um namespace e teamId especificados.                                                                                               | PATCH  |
| [Retrieve wallet by ID](/retail-media-interface/partner/pt-br/billing-api/wallet/getwallet-1.md)                     | Recupera os detalhes de uma carteira específica usando seu identificador exclusivo, {id}.                                                                          | GET    |
| [List all wallets](/retail-media-interface/partner/pt-br/billing-api/wallet/listwallets.md)                          | Recupera uma lista de carteiras com base em filtros e parâmetros especificados, incluindo ID da equipe, nome da carteira, ID da carteira, ID externo e muito mais. | GET    |
| [Get the balance of a specific wallet](/retail-media-interface/partner/pt-br/billing-api/wallet/getwalletbalance.md) | Recupera o saldo atual de uma carteira especificada.                                                                                                               | GET    |
| [Manage funds to a specific wallet](/retail-media-interface/partner/pt-br/billing-api/wallet/managefunds.md)         | Gerencia operações de fundos para uma carteira específica.                                                                                                         | POST   |

#### Gasto

| Endpoint                                                                                                       | Descrição                                                                                                     | Método |
| -------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------ |
| [Retrieve campaign spend details](/retail-media-interface/partner/pt-br/billing-api/spend/getcampaignspend.md) | Calcula o orçamento restante para campanhas específicas com base em seu saldo disponível e limites de gastos. | POST   |

### Operação em massa

#### Campanha

| Endpoint                                                                                                                                  | Descrição                                                                                              | Método |
| ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | ------ |
| [Create campaigns in bulk](/retail-media-interface/partner/pt-br/bulk-operation-api/bulkcampaignoperations/bulkcreatecampaign.md)         | Cria várias campanhas simultaneamente (até 1.000) com base no tipo de campanha.                        | POST   |
| [Update campaigns in bulk](/retail-media-interface/partner/pt-br/bulk-operation-api/bulkcampaignoperations/bulkupdatecampaign-1.md)       | Atualiza campanhas dentro de um namespace especificado.                                                | PATCH  |
| [Update campaign approval state](/retail-media-interface/partner/pt-br/bulk-operation-api/bulkcampaignoperations/bulkcampaignapproval.md) | Aprova ou rejeita campanhas dentro de um namespace especificado.                                       | POST   |
| Recuperar status de operação em massa                                                                                                     | Recupera o status e os detalhes de uma operação de campanha em massa usando o ID da operação em massa. | GET    |

#### Carteira

| Endpoint                                                                                                                                   | Descrição                                                                      | Método |
| ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------ |
| [Create wallets in bulk](/retail-media-interface/partner/pt-br/bulk-operation-api/bulkwalletoperations/bulkcreatewallet.md)                | Crie várias carteiras de uma só vez dentro da sua organização (até 1.000).     | POST   |
| [Retrieve bulk wallet operation status](/retail-media-interface/partner/pt-br/bulk-operation-api/bulkwalletoperations/bulkwalletstatus.md) | Recupera o status de uma operação de carteira em massa usando seu ID em massa. | GET    |
| [Update wallets in bulk](/retail-media-interface/partner/pt-br/bulk-operation-api/bulkwalletoperations/bulkupdatewallet.md)                | Atualiza várias carteiras simultaneamente.                                     | PATCH  |

#### Equipe

| Endpoint                                                                                                                                 | Descrição                                                                    | Método |
| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ------ |
| [Create teams in bulk](/retail-media-interface/partner/pt-br/bulk-operation-api/bulkwalletoperations-1/bulkcreateteam.md)                | Cria equipes em massa para uma organização.                                  | POST   |
| [Update teams in bulk](/retail-media-interface/partner/pt-br/bulk-operation-api/bulkwalletoperations-1/bulkupdateteam.md)                | Atualiza várias equipes simultaneamente.                                     | PATCH  |
| [Retrieve bulk team operation status](/retail-media-interface/partner/pt-br/bulk-operation-api/bulkwalletoperations-1/bulkteamstatus.md) | Recupera o status de uma operação de equipe em massa usando seu ID em massa. | GET    |

### Termo de pesquisa sugerido

#### O que são Termos de pesquisa sugeridos?

Os termos de pesquisa sugeridos são uma coleção de termos fornecidos por meio de um arquivo do varejista associando produtos a termos específicos que são apresentados ao usuário ao criar uma campanha na etapa de termos de pesquisa. Para obter mais informações, consulte Termos de pesquisa sugeridos.

| Endpoint                                                                                                                                            | Descrição                                                                                                                                                        | Método |
| --------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ |
| [Lists all suggested search terms](/retail-media-interface/partner/pt-br/suggested-search-term-api/suggestedsearchterm/listsuggestedsearchterms.md) | Recupera termos de pesquisa sugeridos para direcionamento de catálogo com base em parâmetros especificados, como ID do catálogo, código do produto e muito mais. | GET    |

## Melhores práticas

Siga estas melhores práticas para garantir uma integração suave, eficiente e confiável com as Epsilon Retail Media APIs do parceiro:

* Sempre teste no sandbox antes da implantação em produção.
* Use pontos de extremidade em massa para operações múltiplas.
* Verifique problemas de dados específicos nas respostas de erro.
* Use arquivos compactados para carregamentos de dados mais rápidos.
* Atualize os tokens de acesso somente quando estiverem expirados.
* Valide os campos obrigatórios antes de enviar as solicitações.

## Tratamento de erros

Nossas APIs de parceiros retornam respostas de erro JSON estruturadas para dar suporte a um tratamento de exceções robusto.

* **Código de status HTTP**: Códigos de erro padrão (400, 401, 403, 500, etc.)
* **Código de erro**: Identificador de erro específico.
* **Mensagem**: Descrição de erro legível por humanos.
* **Violações de campo**: Erros específicos de validação de campo para problemas de entrada de dados.

Para obter informações detalhadas sobre o tratamento de erros, consulte [Tratamento de erros](/retail-media-interface/partner/pt-br/partner-api-overview/error-handling.md).

## Suporte e recursos

| Recurso                                                                                                                | Descrição                                                               |
| ---------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
| [Frequently asked questions](/retail-media-interface/partner/pt-br/partner-api-overview/frequently-asked-questions.md) | Perguntas e respostas comuns relacionadas ao uso e à integração da API. |
| Notas de versão                                                                                                        | Resumo de atualizações ou alterações recentes na API.                   |
| [Glossary](https://developers.citrusad.com/partner/docs/createupdate-campaign-fields-1)                                | Definições dos principais termos usados em toda a documentação da API.  |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://help.citrusad.com/retail-media-interface/partner/pt-br/partner-api-overview/epsilon-retail-media-partner-apis-overview-1.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.