> ## Documentation Index
> Fetch the complete documentation index at: https://www.ayrshare.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Impulsionar publicação
> Impulsione uma publicação enviando-a para a plataforma de anúncios do Facebook
export const PlansAvailable = ({plans = [], maxPackRequired}) => {
let displayPlans = plans;
if (plans && plans.length === 1) {
const lowerCasePlan = plans[0].toLowerCase();
if (lowerCasePlan === "business") {
displayPlans = ["Launch", "Business", "Enterprise"];
} else if (lowerCasePlan === "premium") {
displayPlans = ["Premium", "Launch", "Business", "Enterprise"];
}
}
return
Available on {displayPlans.length === 1 ? "the " : ""}
{displayPlans.join(", ").replace(/\b\w/g, l => l.toUpperCase())}{" "}
{displayPlans.length > 1 ? "plans" : "plan"}.
{maxPackRequired && window.open('https://www.ayrshare.com/docs/additional/maxpack', '_self')} className="flex items-center mt-2 cursor-pointer">
Max Pack required
}
;
};
export const HeaderAPI = ({noProfileKey, profileKeyRequired}) => <>
API Key of the Primary Profile.
Format: Authorization: Bearer API_KEY
{!noProfileKey && (profileKeyRequired ?
Profile Key of a User Profile.
Format: Profile-Key: PROFILE_KEY
:
Profile Key of a User Profile.
Format: Profile-Key: PROFILE_KEY
)}
;
Impulsione uma publicação existente do Facebook para criar um anúncio.
Este endpoint permite converter suas publicações orgânicas em anúncios pagos com parâmetros personalizados de segmentação, orçamento e agendamento.
- Os valores de orçamento e lance devem ser especificados em USD com até duas casas decimais.
- O anúncio deve ser veiculado por pelo menos 30 horas para atender ao requisito do Facebook.
-
Você pode usar o [endpoint de interesses](/apis/ads/facebook/get-ad-interests) para encontrar IDs de interesses
para segmentação.
- O Facebook pode levar até 24 horas para revisar e aprovar publicações impulsionadas.
-
Se estiver usando `fbPostId` diretamente (em vez do `postId` da Ayrshare), certifique-se de que seja um ID de publicação
válido do Facebook.
### Objetivos do anúncio
Cada anúncio deve ter um objetivo. O objetivo determina como o anúncio será otimizado para exibição.
-
`engagement`: Este objetivo busca aumentar o engajamento, garantindo ao mesmo tempo que o anúncio alcance o
maior número possível de usuários únicos. Equilibra a visibilidade com o engajamento, exibindo o anúncio para o maior
número possível de pessoas diferentes que possam interagir com ele.
-
`interactions`: Projetado para impulsionar interações, como curtidas, comentários e compartilhamentos, no anúncio.
O Facebook prioriza exibir o anúncio para usuários com maior probabilidade de interagir com ele.
-
`awareness_views`: Foca em aumentar o reconhecimento da marca maximizando o número de vezes que o
anúncio é exibido. Prioriza mostrar o anúncio o maior número de vezes possível dentro do orçamento,
independentemente do alcance único.
-
`awareness_audience`: Visa aumentar o reconhecimento da marca maximizando o número de pessoas únicas
que veem o anúncio. Garante que o anúncio alcance o maior número possível de usuários diferentes e maximiza
o tamanho da audiência única em vez de exibi-lo várias vezes para a mesma audiência.
Saiba mais sobre como integrar a Facebook Marketing API com a Ayrshare em nosso [Guia de integração da Facebook Marketing API](https://www.ayrshare.com/blog/facebook-ads-api-boosting-with-the-marketing-api/).
## Parâmetros de cabeçalho
## Parâmetros do corpo
O ID da conta de anúncios do Facebook na qual impulsionar a publicação. O ID da conta pode ser obtido no
[endpoint de contas de anúncios](/apis/ads/facebook/get-ad-accounts).
Nome do seu anúncio (aparece no Gerenciador de Anúncios do Facebook) com o formato `{adName} - {postId or fbPostId} - {current date}`.
Valor máximo do lance em USD. O lance mínimo é de US\$ 1,00.
Orçamento diário em USD. O orçamento mínimo é de US\$ 1,00.
O [ID da publicação social do Facebook](/apis/overview#social-post-id) da publicação a ser impulsionada, que permite
criar um anúncio a partir de uma publicação criada diretamente no Facebook. Este é o ID da [publicação no
Facebook](/apis/history/history-platform), não da Ayrshare. Obrigatório se `postId` não estiver definido.
O objetivo do anúncio. Valores: `engagement`, `interactions`, `awareness_views` e
`awareness_audience`. Consulte os [detalhes dos objetivos de anúncio](/apis/ads/facebook/boost-post#ad-goals) acima para
mais informações.
Localizações de segmentação do anúncio com um objeto de arrays: `countries`, `regions`, `cities`.
Lista de códigos de países.
```json theme={"system"}
{
"countries": ["US", "CA"]
}
```
As regiões exigem o valor `key` da região do Facebook. Consulte o [endpoint de regiões](/apis/ads/facebook/get-ad-regions) para mais informações.
```json theme={"system"}
{
"regions": [{ "key": "3886" }]
}
```
As cidades exigem: `key` (do Facebook), `radius` e `distance_unit`.
`radius` é a distância ao redor da cidade: 10–50 milhas ou 17–80 quilômetros.
`distance_unit` é `mile` ou `kilometer`.
Consulte o [endpoint de cidades](/apis/ads/facebook/get-ad-cities) para mais informações.
```json theme={"system"}
{
"cities": [
{ "key": "2420605", "radius": 25, "distance_unit": "mile" }
]
}
```
O [ID da publicação da Ayrshare](/apis/overview#ayrshare-post-id) da publicação a ser impulsionada. Obrigatório se
`fbPostId` não estiver definido.
O status do anúncio. Valores: `active` e `paused`.
Você pode alterar o status do anúncio posteriormente usando o [endpoint de atualização de anúncio](/apis/ads/facebook/put-ad-update).
Controla o compartilhamento de orçamento no nível da campanha entre conjuntos de anúncios da Meta.
A Meta agora exige este campo em todas as campanhas criadas sem um orçamento no nível da campanha, portanto a Ayrshare sempre o envia — usando `false` por padrão para compatibilidade retroativa.
Defina como `true` para permitir que a Meta compartilhe até \~20% do orçamento de um conjunto de anúncios com outros conjuntos da mesma campanha para otimizar o desempenho geral. Consulte a [referência do grupo de campanhas de anúncios](https://developers.facebook.com/docs/marketing-api/reference/ad-campaign-group/) da Meta para obter detalhes.
Acompanhe o anúncio usando um Facebook Pixel.
O ID do Facebook Pixel para rastrear o anúncio.
```json theme={"system"}
{
"pixelId": 1234567890
}
```
Adicione tags UTM à URL do anúncio.
```json theme={"system"}
{
"urlTags": ["utm_source=ayrshare", "utm_medium=social", "utm_campaign=ayrshare-social"]
}
```
Por exemplo, se a URL de link for `https://www.mysite.com/my-post` e as tags de URL adicionadas forem:
`utm_source=ayrshare`, `utm_medium=social` e `utm_campaign=ayrshare-social`.
A URL do anúncio será:
`https://www.mysite.com/my-post?utm_source=ayrshare&utm_medium=social&utm_campaign=ayrshare-social`.
A Meta exige que anunciantes em [categorias especiais de anúncios](https://www.facebook.com/business/help/298000447747885?helpref=faq_content) identifiquem por conta própria a categoria de sua campanha.
Se sua empresa está em uma dessas categorias, você deve selecionar a categoria apropriada ao impulsionar sua publicação.
Os seguintes valores são suportados:
-
`housing`: Anúncios que promovem ou vinculam diretamente a uma oportunidade de moradia ou serviço relacionado,
incluindo, mas não se limitando a, anúncios de venda ou aluguel de uma casa ou apartamento, seguro
residencial, seguro hipotecário, empréstimos hipotecários, reparos habitacionais e serviços de home equity ou
avaliação.
-
`financial_product_services`: Anúncios que promovem ou vinculam diretamente a uma oferta de produtos e
serviços financeiros, incluindo crédito.
-
`employment`: Anúncios que promovem ou vinculam diretamente a uma oportunidade de emprego, incluindo, mas não
se limitando a, vagas de tempo parcial ou integral, estágios ou programas de certificação profissional. Anúncios
relacionados que se enquadram nesta categoria incluem promoções de bolsas de emprego ou feiras, serviços de
agregação ou anúncios que detalham benefícios que uma empresa possa oferecer, independentemente de uma oferta de emprego específica.
-
`issues_elections_politics`: Anúncios feitos por, em nome de, ou sobre um candidato a cargo público,
uma figura política, um partido político ou que defendam o resultado de uma eleição para cargo
público. Também inclui anúncios sobre qualquer eleição, referendo ou iniciativa de votação, incluindo
campanhas eleitorais do tipo "Vá votar". Anúncios regulamentados como publicidade política ou sobre questões
sociais em qualquer lugar onde o anúncio esteja sendo veiculado. Se selecionar issues, elections ou politics,
você deve selecionar o país onde deseja veicular esses anúncios. É necessário estar
autorizado a veicular anúncios sobre questões sociais, eleições ou política no país especificado.
A Meta exige que os anunciantes identifiquem por conta própria a categoria de sua campanha.
A Meta utiliza revisores humanos e aprendizado de máquina para identificar esses tipos de anúncios.
Se você nos enviar uma `specialAdCategory` incorreta, existe o risco de que seus anúncios sejam pausados até que a campanha seja ajustada.
Data e hora de término no formato ISO 8601 (deve ser pelo menos 30 horas após o início), por exemplo `2025-03-01T00:00:00Z`.
Se não for definida, o anúncio será veiculado indefinidamente e terá data de término `ongoing`.
Exclua localizações usando um objeto com arrays de `countries`, `regions` e `cities`.
Lista de códigos de países para excluir.
```json theme={"system"}
{
"countries": ["US", "CA"]
}
```
As regiões exigem o valor `key` da região do Facebook. Consulte o [endpoint de regiões](/apis/ads/facebook/get-ad-regions) para mais informações.
```json theme={"system"}
{
"regions": [{ "key": "3886" }]
}
```
As cidades exigem: `key` (do Facebook), `radius` e `distance_unit`.
`radius` é a distância ao redor da cidade: 10–50 milhas ou 17–80 quilômetros.
`distance_unit` é `mile` ou `kilometer`.
Consulte o [endpoint de cidades](/apis/ads/facebook/get-ad-cities) para mais informações.
```json theme={"system"}
{
"cities": [
{ "key": "2420605", "radius": 25, "distance_unit": "mile" }
]
}
```
O gênero da audiência. Valores: `all`, `male`, `female`.
Os interesses de segmentação do anúncio como um array de [IDs de
interesse](/apis/ads/facebook/get-ad-interests) do Facebook.
Idade máxima para segmentação do anúncio (padrão: 65).
Idade mínima para segmentação do anúncio (padrão: 18).
Data e hora de início no formato ISO 8601, por exemplo `2025-03-01T00:00:00Z`.
Se não for definida, o anúncio começará imediatamente.
O beneficiário do anúncio para conformidade com o Digital Services Act (DSA) para países da UE. Deve ser definido
em conjunto com `dsaPayor` se qualquer um dos dois for fornecido. Consulte nosso [guia do
DSA](/apis/ads/facebook/get-dsa-recommendations) para mais informações.
O pagador do anúncio para conformidade com o Digital Services Act (DSA) para países da UE. Deve ser definido
em conjunto com `dsaBeneficiary` se qualquer um dos dois for fornecido.
```bash cURL theme={"system"}
curl -X POST https://api.ayrshare.com/api/ads/facebook/boost \
-H "Authorization: Bearer API_KEY" \
-H "Content-Type: application/json" \
-d '{
"postId": "1234567890",
"accountId": "1234567890",
"adName": "My Ad",
"status": "active",
"goal": "engagement",
"minAge": 18,
"maxAge": 65,
"locations": { "countries": ["US"] },
"budget": 100,
"bidAmount": 1,
"startDate": "2025-03-01T00:00:00Z",
"endDate": "2025-03-07T23:59:59Z",
"interests": [1234567890, 1234567891]
}'
```
```javascript JavaScript theme={"system"}
const API_KEY = "API_KEY";
fetch("https://api.ayrshare.com/api/ads/facebook/boost", {
method: "POST",
headers: {
"Content-Type": "application/json",
Authorization: `Bearer ${API_KEY}`
},
body: JSON.stringify({
postId: "1234567890",
accountId: "1234567890",
adName: "My Ad",
status: "active",
goal: "engagement",
minAge: 18,
maxAge: 65,
locations: { countries: ["US"] },
budget: 100,
bidAmount: 1,
startDate: "2025-03-01T00:00:00Z",
endDate: "2025-03-07T23:59:59Z",
interests: [1234567890, 1234567891]
})
})
.then((res) => res.json())
.then((json) => console.log(json))
.catch(console.error);
```
```python Python theme={"system"}
import requests
API_KEY = "API_KEY"
url = "https://api.ayrshare.com/api/ads/facebook/boost"
payload = {
"postId": "1234567890",
"accountId": "1234567890",
"adName": "My Ad",
"status": "active",
"goal": "engagement",
"minAge": 18,
"maxAge": 65,
"locations": {"countries": ["US"]},
"budget": 100,
"bidAmount": 1,
"startDate": "2025-03-01T00:00:00Z",
"endDate": "2025-03-07T23:59:59Z",
"interests": [1234567890, 1234567891]
}
response = requests.post(url, headers={"Authorization": f"Bearer {API_KEY}", "Content-Type": "application/json"}, json=payload)
print(response.json())
```
```php PHP theme={"system"}
"1234567890",
"accountId" => "1234567890",
"adName" => "My Ad",
"status" => "active",
"goal" => "engagement",
"minAge" => 18,
"maxAge" => 65,
"locations" => ["countries" => ["US"]],
"budget" => 100,
"bidAmount" => 1,
"startDate" => "2025-03-01T00:00:00Z",
"endDate" => "2025-03-07T23:59:59Z",
"interests" => [1234567890, 1234567891]
];
$ch = curl_init("https://api.ayrshare.com/api/ads/facebook/boost");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"Content-Type: application/json",
"Authorization: Bearer " . $API_KEY
]);
$response = curl_exec($ch);
$result = json_decode($response, true);
print_r($result);
curl_close($ch);
```
```csharp C# theme={"system"}
using System;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Text.Json;
using System.Threading.Tasks;
class Program
{
static async Task Main()
{
string API_KEY = "API_KEY";
var payload = new
{
postId = "1234567890",
accountId = "1234567890",
adName = "My Ad",
status = "active",
goal = "engagement",
minAge = 18,
maxAge = 65,
locations = new { countries = new[] { "US" } },
budget = 100,
bidAmount = 1,
startDate = "2025-03-01T00:00:00Z",
endDate = "2025-03-07T23:59:59Z",
interests = new[] { 1234567890, 1234567891 }
};
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", API_KEY);
var content = new StringContent(
JsonSerializer.Serialize(payload),
Encoding.UTF8,
"application/json"
);
var response = await client.PostAsync("https://api.ayrshare.com/api/ads/facebook/boost", content);
var responseBody = await response.Content.ReadAsStringAsync();
Console.WriteLine(responseBody);
}
}
```
```go Go theme={"system"}
package main
import (
"bytes"
"encoding/json"
"fmt"
"io/ioutil"
"net/http"
)
func main() {
apiKey := "API_KEY"
payload := map[string]interface{}{
"postId": "1234567890",
"accountId": "1234567890",
"adName": "My Ad",
"status": "active",
"goal": "engagement",
"minAge": 18,
"maxAge": 65,
"locations": map[string]interface{}{"countries": []string{"US"}},
"budget": 100,
"bidAmount": 1,
"startDate": "2025-03-01T00:00:00Z",
"endDate": "2025-03-07T23:59:59Z",
"interests": []int{1234567890, 1234567891},
}
jsonData, err := json.Marshal(payload)
if err != nil {
fmt.Println("Error marshaling JSON:", err)
return
}
req, err := http.NewRequest("POST", "https://api.ayrshare.com/api/ads/facebook/boost", bytes.NewBuffer(jsonData))
if err != nil {
fmt.Println("Error creating request:", err)
return
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer "+apiKey)
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
fmt.Println("Error sending request:", err)
return
}
defer resp.Body.Close()
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
fmt.Println("Error reading response:", err)
return
}
fmt.Println(string(body))
}
```
```java Java theme={"system"}
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;
import com.fasterxml.jackson.databind.ObjectMapper;
public class BoostPost {
public static void main(String[] args) {
String API_KEY = "API_KEY";
String url = "https://api.ayrshare.com/api/ads/facebook/boost";
Map payload = new HashMap<>();
payload.put("postId", "1234567890");
payload.put("accountId", "1234567890");
payload.put("adName", "My Ad");
payload.put("status", "active");
payload.put("goal", "engagement");
payload.put("minAge", 18);
payload.put("maxAge", 65);
Map locations = new HashMap<>();
locations.put("countries", Arrays.asList("US"));
payload.put("locations", locations);
payload.put("budget", 100);
payload.put("bidAmount", 1);
payload.put("startDate", "2025-03-01T00:00:00Z");
payload.put("endDate", "2025-03-07T23:59:59Z");
payload.put("interests", Arrays.asList(1234567890, 1234567891));
try {
ObjectMapper objectMapper = new ObjectMapper();
String requestBody = objectMapper.writeValueAsString(payload);
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create(url))
.header("Content-Type", "application/json")
.header("Authorization", "Bearer " + API_KEY)
.POST(HttpRequest.BodyPublishers.ofString(requestBody))
.build();
HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
} catch (IOException | InterruptedException e) {
e.printStackTrace();
}
}
}
```
```ruby Ruby theme={"system"}
require 'net/http'
require 'uri'
require 'json'
API_KEY = "API_KEY"
uri = URI.parse("https://api.ayrshare.com/api/ads/facebook/boost")
payload = {
postId: "1234567890",
accountId: "1234567890",
adName: "My Ad",
status: "active",
goal: "engagement",
minAge: 18,
maxAge: 65,
locations: { countries: ["US"] },
budget: 100,
bidAmount: 1,
startDate: "2025-03-01T00:00:00Z",
endDate: "2025-03-07T23:59:59Z",
interests: [1234567890, 1234567891]
}
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri.request_uri)
request["Content-Type"] = "application/json"
request["Authorization"] = "Bearer #{API_KEY}"
request.body = payload.to_json
response = http.request(request)
puts response.body
```
```json 200: Post Boosted theme={"system"}
{
"status": "success",
"adId": "120217670757750410",
"adName": "API Post - DE6gpw8kxlonHy2b7Lo - 2025-03-26T23:42:43",
"adStatus": "active",
"bidAmount": 10,
"budget": 100,
"endDate": "2026-03-28T22:30:00Z",
"goal": {
"title": "Get More Engagement",
"description": "This goal seeks to increase engagement...",
"type": "engagement"
},
"interests": [
"6003195554098"
],
"locations": { "countries": ["US"] },
"maxAge": 65,
"minAge": 18,
"postId": "DE6gpw8kxlonHy2b7Lo",
"startDate": "2026-03-26T22:30:00Z"
}
```
```json 400: Invalid Account ID theme={"system"}
{
"action": "boost post",
"status": "error",
"code": 369,
"message": "Unable to boost post. Please try again or contact us if the issue persists.",
"details": "The accountId likely does not exist. Please check the accountId and try again."
}
```
```json 400: Missing Required Parameters theme={"system"}
{
"action": "request",
"status": "error",
"code": 101,
"message": "Missing or incorrect parameters. Please verify with the docs. https://www.ayrshare.com/docs/apis",
"details": "Missing required fields: budget"
}
```