> For the complete documentation index, see [llms.txt](https://help.impact.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.impact.com/brand/pt-br/what-would-you-like-to-learn-about/platform-features/ads/manage-ads/promotional-themes-for-assets.md).

# Configurar detalhes promocionais para ativos

Use a seção *Detalhes promocionais* de um recurso para vinculá-lo a uma oferta, controlar quando ele fica disponível, determinar o que acontece quando expira ou marcá-lo com um tema sazonal. Isso ajuda você a organizar os recursos por campanha ou época do ano e ajuda os parceiros a encontrar os recursos certos para suas próprias ações de marketing.

## Adicione detalhes promocionais durante a configuração do recurso

A configuração dos detalhes promocionais de um recurso é opcional. Veja como fazer isso durante a configuração do tipo de recurso escolhido:

{% stepper %}
{% step %}

### Associe uma *Oferta* ao seu recurso

1. Depois de preencher *Detalhes do recurso* e *Configuração do recurso* do seu recurso, acesse *Detalhes promocionais*.
2. Em *Oferta*, escolha uma oferta existente no ![](https://526234278-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2Fgit-blob-c2cb550b55c51ea1eeff0acbd6f437a03b621a2c%2F60d033ae8a04c14498d5229c3c0160ac05feea7f605dbd770741793c900469f0.svg?alt=media) **\[Menu suspenso]**.
3. Como alternativa, selecione **Adicionar nova oferta** ![](https://526234278-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2Fgit-blob-c2cb550b55c51ea1eeff0acbd6f437a03b621a2c%2F60d033ae8a04c14498d5229c3c0160ac05feea7f605dbd770741793c900469f0.svg?alt=media) **\[Menu suspenso]** e [crie uma nova oferta](https://help.impact.com/brand/pt-br/what-would-you-like-to-learn-about/platform-features/deals/deal-types-overview.md) para associá-la a este recurso.

<div data-with-frame="true"><figure><img src="https://526234278-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2FDCL43npMvdsHRKHRZ13w%2FScreenshot_2026-10-21_at_2_05_43%E2%80%AFPM.png?alt=media&amp;token=4632a3fa-c705-47d7-9428-af2eef619a99" alt="" width="375"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}

### Adicione *Datas de disponibilidade* ao seu recurso

1. Em *Datas de disponibilidade*, selecione o ![](https://526234278-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2Fgit-blob-82e75b518a6cfe0fb2fedc3e1d21154fc9dee900%2F3754728747f89a16597a42d74f841edf8612889648f257c01aff47a200ac144d.svg?alt=media) **\[Seletor de data]** para definir uma *Data de início* e uma *Data de término* para este recurso.
2. No ![](https://526234278-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2Fgit-blob-c2cb550b55c51ea1eeff0acbd6f437a03b621a2c%2F60d033ae8a04c14498d5229c3c0160ac05feea7f605dbd770741793c900469f0.svg?alt=media) **\[Menu suspenso]**, especifique um **Fuso horário**.

{% hint style="success" %}
**Observação:** Os recursos com data futura não são ativados até a data de início. Para permitir que os parceiros os vejam antes disso, ative **Exibir anúncios futuros** em [padrões de anúncios](https://help.impact.com/brand/pt-br/what-would-you-like-to-learn-about/platform-features/ads/manage-ads/asset-filter-reference-for-brands.md#manage-a-d-defaults).
{% endhint %}
{% endstep %}

{% step %}

### Redirecione os parceiros após a expiração do recurso

1. Selecione ![](https://526234278-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2Fgit-blob-b5e1740618ed6571d97b8fed7c25a7678f85d375%2F299632fb6f4f91fbf9847471754cc6180e4284a65b4960af4c4ea472a159f552.svg?alt=media) **\[Caixa de seleção] Alterar página de destino na expiração**.
2. Selecione **Configurar regra**.
3. Em *Ação*, escolha a regra de expiração que você quer aplicar:

<details>

<summary>Redirecionamento</summary>

1. No ![](https://526234278-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2Fgit-blob-c2cb550b55c51ea1eeff0acbd6f437a03b621a2c%2F60d033ae8a04c14498d5229c3c0160ac05feea7f605dbd770741793c900469f0.svg?alt=media)**\[Menu suspenso]** selecione **Redirecionamento**.
2. Insira o link para o qual o recurso será redirecionado.
3. Opcionalmente, ![](https://526234278-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2FiZjM1xY8o3v1iR3Zaysd%2FToggle.svg?alt=media\&token=b1550d48-bba9-4e81-8604-bc12370c5caa) **\[Ativado]** **Página intersticial** para ativar e configurar uma página intersticial associada a esta regra.
4. No **Modelo** ![](https://526234278-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2Fgit-blob-c2cb550b55c51ea1eeff0acbd6f437a03b621a2c%2F60d033ae8a04c14498d5229c3c0160ac05feea7f605dbd770741793c900469f0.svg?alt=media) **\[Menu suspenso]** selecione **Personalizado** ou **Instalação de aplicativo**.
   * **Personalizada**
     1. Insira um **Texto do cabeçalho**.
     2. Opcionalmente, insira um **Texto do corpo**.
     3. Opcionalmente, insira **Termos adicionais** para este recurso.
     4. Opcionalmente, selecione a ![](https://526234278-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2Fgit-blob-b5e1740618ed6571d97b8fed7c25a7678f85d375%2F299632fb6f4f91fbf9847471754cc6180e4284a65b4960af4c4ea472a159f552.svg?alt=media) **\[Caixa desmarcada]** para **Exigir confirmação do usuário**.
     5. Selecione a ![](https://526234278-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2Fgit-blob-b5e1740618ed6571d97b8fed7c25a7678f85d375%2F299632fb6f4f91fbf9847471754cc6180e4284a65b4960af4c4ea472a159f552.svg?alt=media) **\[Caixa desmarcada]** para **Mostrar o logotipo do parceiro (marca compartilhada)** e exibir o seu logotipo e o do parceiro juntos para uma experiência com marca compartilhada.
     6. Selecione a ![](https://526234278-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2Fgit-blob-b5e1740618ed6571d97b8fed7c25a7678f85d375%2F299632fb6f4f91fbf9847471754cc6180e4284a65b4960af4c4ea472a159f552.svg?alt=media) **\[Caixa desmarcada]** para **Personalizar CSS** e adicione o código CSS desejado à caixa de texto.
     7. Selecione **Visualizar**.
   * **Instalação de aplicativo**
     1. Insira um **Texto do cabeçalho** e **Cor da fonte do cabeçalho**.
     2. Insira um **Subtítulo** e **Cor da fonte do subtítulo**.
     3. Para **Enviar logotipo** e **Enviar imagem de capa**, selecione **Escolher arquivo**. Lembre-se: os formatos GIF, JPG, PNG e SVG são compatíveis. O tamanho máximo do arquivo é 1 MB.
     4. Insira um **Rótulo do botão de download** (por exemplo, *Baixar agora*).
        * Insira uma **Cor da fonte do botão de download** e **Cor de fundo do botão de download**.
        * Insira um **Rótulo do botão Continuar** e **Cor da fonte do botão Continuar**.
     5. Insira uma **Contagem regressiva para redirecionamento automático** com o número de segundos permitidos antes do redirecionamento.
     6. Opcionalmente, insira um **Texto do corpo**.
     7. Selecione a ![](https://526234278-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2Fgit-blob-b5e1740618ed6571d97b8fed7c25a7678f85d375%2F299632fb6f4f91fbf9847471754cc6180e4284a65b4960af4c4ea472a159f552.svg?alt=media) **\[Caixa desmarcada]** para **Mostrar o logotipo do parceiro (marca compartilhada)** e exibir o seu logotipo e o do parceiro juntos para uma experiência com marca compartilhada.
     8. Selecione a ![](https://526234278-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2Fgit-blob-b5e1740618ed6571d97b8fed7c25a7678f85d375%2F299632fb6f4f91fbf9847471754cc6180e4284a65b4960af4c4ea472a159f552.svg?alt=media) **\[Caixa desmarcada]** para **Personalizar CSS** e adicione o código CSS desejado à caixa de texto.
     9. Selecione **Visualizar**.

</details>

<details>

<summary>Bloquear</summary>

1. Opcionalmente, ![](https://526234278-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2FiZjM1xY8o3v1iR3Zaysd%2FToggle.svg?alt=media\&token=b1550d48-bba9-4e81-8604-bc12370c5caa) **\[Ative o botão]** para **Usar página intersticial** para ativar e configurar uma página intersticial associada a esta regra.
2. No **Modelo** ![](https://526234278-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2Fgit-blob-c2cb550b55c51ea1eeff0acbd6f437a03b621a2c%2F60d033ae8a04c14498d5229c3c0160ac05feea7f605dbd770741793c900469f0.svg?alt=media) **\[Menu suspenso]** selecione **Personalizado**.
3. Insira um **Texto do cabeçalho**.
4. Opcionalmente, insira um **Texto do corpo**.
5. Selecione **Visualizar**.

</details>

<details>

<summary>intersticial</summary>

1. No **Modelo** ![](https://526234278-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2Fgit-blob-c2cb550b55c51ea1eeff0acbd6f437a03b621a2c%2F60d033ae8a04c14498d5229c3c0160ac05feea7f605dbd770741793c900469f0.svg?alt=media) **\[Menu suspenso]** selecione **Personalizado** ou **Instalação de aplicativo**.
   * **Personalizada**
     1. Insira um **Texto do cabeçalho**.
        * Opcionalmente, insira um **Texto do corpo**.
        * Opcionalmente, insira **Termos adicionais** e condições a serem aplicados.
        * Selecione a ![](https://526234278-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2Fgit-blob-b5e1740618ed6571d97b8fed7c25a7678f85d375%2F299632fb6f4f91fbf9847471754cc6180e4284a65b4960af4c4ea472a159f552.svg?alt=media) **\[Caixa desmarcada]** para **Exigir confirmação do usuário**.
        * Selecione a ![](https://526234278-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2Fgit-blob-b5e1740618ed6571d97b8fed7c25a7678f85d375%2F299632fb6f4f91fbf9847471754cc6180e4284a65b4960af4c4ea472a159f552.svg?alt=media) **\[Caixa desmarcada]** para **Mostrar o logotipo do parceiro (marca compartilhada)** e exibir o seu logotipo e o do parceiro juntos para uma experiência com marca compartilhada.
        * Selecione a ![](https://526234278-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2Fgit-blob-b5e1740618ed6571d97b8fed7c25a7678f85d375%2F299632fb6f4f91fbf9847471754cc6180e4284a65b4960af4c4ea472a159f552.svg?alt=media) **\[Caixa desmarcada]** para **Personalizar CSS** e adicione o código CSS desejado à caixa de texto.
        * Selecione **Visualizar**.
   * **Instalação de aplicativo**
     1. Insira um **Texto do cabeçalho** e **Cor da fonte do cabeçalho**.
     2. Insira um **Subtítulo** e **Cor da fonte do subtítulo**.
     3. Para **Enviar logotipo** e **Enviar imagem de capa**, selecione **Escolher arquivo**. Lembre-se: os formatos GIF, JPG, PNG e SVG são compatíveis. O tamanho máximo do arquivo é 1 MB.
     4. Insira um **Rótulo do botão de download** (por exemplo, *Baixar agora*).
        * Insira uma **Cor da fonte do botão de download** e **Cor de fundo do botão de download**.
        * Insira um **Rótulo do botão Continuar** e **Cor da fonte do botão Continuar**.
     5. Insira uma **Contagem regressiva para redirecionamento automático**, para indicar os segundos permitidos antes do redirecionamento.
     6. Opcionalmente, insira um **Texto do corpo**.
     7. Selecione a ![](https://526234278-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2Fgit-blob-b5e1740618ed6571d97b8fed7c25a7678f85d375%2F299632fb6f4f91fbf9847471754cc6180e4284a65b4960af4c4ea472a159f552.svg?alt=media) **\[Caixa desmarcada]** para **Mostrar o logotipo do parceiro (marca compartilhada)** e exibir o seu logotipo e o do parceiro juntos para uma experiência com marca compartilhada.
     8. Selecione a ![](https://526234278-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2Fgit-blob-b5e1740618ed6571d97b8fed7c25a7678f85d375%2F299632fb6f4f91fbf9847471754cc6180e4284a65b4960af4c4ea472a159f552.svg?alt=media) **\[Caixa desmarcada]** para **Personalizar CSS** e adicione o código CSS desejado à caixa de texto.
     9. Selecione **Visualizar** e, quando estiver satisfeito com a visualização, selecione **Enviar**.

</details>

<details>

<summary>Links diretos para dispositivos móveis</summary>

1. Em **Modelo** ![](https://526234278-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2Fgit-blob-c2cb550b55c51ea1eeff0acbd6f437a03b621a2c%2F60d033ae8a04c14498d5229c3c0160ac05feea7f605dbd770741793c900469f0.svg?alt=media) **\[Menu suspenso]**, selecione **Links diretos para dispositivos móveis**.
2. Insira o **Texto do cabeçalho** e **Cor da fonte do cabeçalho**.
3. Insira o **Subcabeçalho** e **Cor da fonte do subcabeçalho**.
4. Para **Enviar logotipo** e **Enviar imagem de capa**, selecione **Escolher arquivo**. Lembre-se: os formatos GIF, JPG, PNG e SVG são compatíveis. O tamanho máximo do arquivo é 1 MB.
5. Insira um **Rótulo do botão Abrir app** (por exemplo, *Abrir app*).
   * Insira uma **Cor da fonte do botão Abrir app** e **Cor de fundo do botão Abrir app**.
   * Insira um **Rótulo do link Continuar** e **Cor da fonte do link Continuar**.
6. Escolha quando o **App será aberto** selecionando uma das opções: ![](https://526234278-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2Fgit-blob-590bdf4e1ffbcc1fe86ad456bebab6a28c64af1f%2Ffd6e4291628446bb1fe27a831f7874b256a28cc84833d72cce2e73b94641edb7.svg?alt=media) **\[Botão de opção]** **Assim que o intersticial carregar** ou ![](https://526234278-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2Fgit-blob-590bdf4e1ffbcc1fe86ad456bebab6a28c64af1f%2Ffd6e4291628446bb1fe27a831f7874b256a28cc84833d72cce2e73b94641edb7.svg?alt=media) **\[Botão de opção]** **Quando o botão for tocado**.
7. Marque ![](https://526234278-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2Fgit-blob-b5e1740618ed6571d97b8fed7c25a7678f85d375%2F299632fb6f4f91fbf9847471754cc6180e4284a65b4960af4c4ea472a159f552.svg?alt=media) **\[Caixa desmarcada]** para ativar o **Redirecionamento automático** e informe o número de segundos até o redirecionamento.
8. Insira um **Caminho URI padrão** a ser usado ao construir o [URI móvel](https://help.impact.com/brand/pt-br/what-would-you-like-to-learn-about/platform-features/tracking/mobile-app-tracking/configure-deep-linking-logic-with-uri-schemes.md) usando o esquema de URL do programa configurado em [*Configurações gerais de rastreamento*](https://app.impact.com/secure/advertiser/tracking-settings/general-trackingsettings-flow.ihtml).
9. Insira uma **Expressão regular de URI personalizada** para definir o padrão de correspondência de URIs móveis no esquema de URL personalizado do app.
10. Selecione a ![](https://526234278-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2Fgit-blob-b5e1740618ed6571d97b8fed7c25a7678f85d375%2F299632fb6f4f91fbf9847471754cc6180e4284a65b4960af4c4ea472a159f552.svg?alt=media) **\[Caixa desmarcada]** para **Personalizar CSS** e adicione o código CSS desejado à caixa de texto.
11. Selecione **Visualizar**.

</details>

4. Para salvar sua regra, selecione **Enviar.**
   {% endstep %}

{% step %}

### Aplique um *Sazonal*  ao seu recurso

1. Em *Sazonal*, aplique um período sazonal ao recurso usando o ![](https://526234278-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2Fgit-blob-c2cb550b55c51ea1eeff0acbd6f437a03b621a2c%2F60d033ae8a04c14498d5229c3c0160ac05feea7f605dbd770741793c900469f0.svg?alt=media) **\[Menu suspenso]**.
2. Em **Opções promocionais adicionais**, selecione as opções aplicáveis:
   * ![](https://526234278-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2Fgit-blob-9fd92d4378edf839f6a1f6fc0beaa1660b3892b5%2F69842c54f03332c1e2eed608d72b25ad10248384a914164a7255a1e94dc76ee2.svg?alt=media) **\[Caixas desmarcadas]** **A oferta é um item mais vendido**
   * ![](https://526234278-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2Fgit-blob-9fd92d4378edf839f6a1f6fc0beaa1660b3892b5%2F69842c54f03332c1e2eed608d72b25ad10248384a914164a7255a1e94dc76ee2.svg?alt=media) **\[Caixas desmarcadas]** **Permitir que um parceiro de mídia solicite seu próprio código promocional exclusivo para esta promoção**
     {% endstep %}

{% step %}

### Concluir a configuração do seu recurso

1. Para ver instruções sobre como concluir *Configurações avançadas* ou salvar seu recurso, consulte o documento de ajuda correspondente ao tipo do seu recurso:
   * [**Imagem, e-mail, texto patrocinado, link de texto, cupom, artigo ou vídeo**](https://help.impact.com/brand/pt-br/what-would-you-like-to-learn-about/platform-features/ads/create-an-asset.md#advanced-settings)
   * [**Widget personalizado**](https://help.impact.com/brand/pt-br/what-would-you-like-to-learn-about/platform-features/reach-out-to-partners/generate-leads/create-a-custom-widget.md#update-advanced-settings)
     {% endstep %}
     {% endstepper %}

## Configurar detalhes promocionais de um recurso existente

Você pode adicionar detalhes promocionais a um recurso existente a qualquer momento.

1. Na barra de navegação à esquerda, selecione ![](https://526234278-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2Fgit-blob-230534471fef5f40808e921e41ee44e4a06ded03%2Fe6cb9548999afdc1ed3ce4942e4cb5b45b5cecbd323267aac2a7cd1915fccc09.svg?alt=media) **\[Engajamento]** → **Conteúdo** → [**Anúncios**](https://app.impact.com/secure/advertiser/engage/ads/manage-all-ads-flow.ihtml).
2. Passe o cursor sobre o recurso que você quer atualizar e selecione **Atualizar**.
3. Na seção *Detalhes promocionais* , preencha os campos descritos acima e selecione **Salvar**.

<div data-with-frame="true"><figure><img src="https://526234278-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2F8m7I1OCBEVXiqicnzbwI%2FScreenshot_2026-10-21_at_1_54_45%E2%80%AFPM.png?alt=media&amp;token=df31d115-1f7d-41a7-9dfb-3b40c1b8c741" alt="" width="563"><figcaption></figcaption></figure></div>


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.impact.com/brand/pt-br/what-would-you-like-to-learn-about/platform-features/ads/manage-ads/promotional-themes-for-assets.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
