Add PMax Audience Signal
Add an audience signal to an existing Performance Max campaign.
Audience signals hint Google AI about who your ideal customers are. Uses in-market segments (actively researching), affinity segments (long-term interests), and custom audiences (remarketing lists, customer match).
Use search_audiences tool first to discover relevant audience segment IDs.
Parameters:
- campaign_id: The PMax campaign ID
- audience_config: Dict with segment IDs
Execution time: 2-5 seconds
curl --request POST \
--url https://api.adspirer.ai/api/v1/tools/add_pmax_audience_signal/execute \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"arguments": {
"audience_config": {
"affinity_audience_ids": [
10003100
],
"custom_audience_ids": [
"customers/1234567890/customAudiences/555"
],
"in_market_audience_ids": [
90013100
],
"user_list_ids": [
"customers/1234567890/userLists/999"
]
},
"campaign_id": "<campaign_id>",
"customer_id": "string"
}
}
'import requests
url = "https://api.adspirer.ai/api/v1/tools/add_pmax_audience_signal/execute"
payload = { "arguments": {
"audience_config": {
"affinity_audience_ids": [10003100],
"custom_audience_ids": ["customers/1234567890/customAudiences/555"],
"in_market_audience_ids": [90013100],
"user_list_ids": ["customers/1234567890/userLists/999"]
},
"campaign_id": "<campaign_id>",
"customer_id": "string"
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
arguments: {
audience_config: {
affinity_audience_ids: [10003100],
custom_audience_ids: ['customers/1234567890/customAudiences/555'],
in_market_audience_ids: [90013100],
user_list_ids: ['customers/1234567890/userLists/999']
},
campaign_id: '<campaign_id>',
customer_id: 'string'
}
})
};
fetch('https://api.adspirer.ai/api/v1/tools/add_pmax_audience_signal/execute', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.adspirer.ai/api/v1/tools/add_pmax_audience_signal/execute",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'arguments' => [
'audience_config' => [
'affinity_audience_ids' => [
10003100
],
'custom_audience_ids' => [
'customers/1234567890/customAudiences/555'
],
'in_market_audience_ids' => [
90013100
],
'user_list_ids' => [
'customers/1234567890/userLists/999'
]
],
'campaign_id' => '<campaign_id>',
'customer_id' => 'string'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.adspirer.ai/api/v1/tools/add_pmax_audience_signal/execute"
payload := strings.NewReader("{\n \"arguments\": {\n \"audience_config\": {\n \"affinity_audience_ids\": [\n 10003100\n ],\n \"custom_audience_ids\": [\n \"customers/1234567890/customAudiences/555\"\n ],\n \"in_market_audience_ids\": [\n 90013100\n ],\n \"user_list_ids\": [\n \"customers/1234567890/userLists/999\"\n ]\n },\n \"campaign_id\": \"<campaign_id>\",\n \"customer_id\": \"string\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.adspirer.ai/api/v1/tools/add_pmax_audience_signal/execute")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"arguments\": {\n \"audience_config\": {\n \"affinity_audience_ids\": [\n 10003100\n ],\n \"custom_audience_ids\": [\n \"customers/1234567890/customAudiences/555\"\n ],\n \"in_market_audience_ids\": [\n 90013100\n ],\n \"user_list_ids\": [\n \"customers/1234567890/userLists/999\"\n ]\n },\n \"campaign_id\": \"<campaign_id>\",\n \"customer_id\": \"string\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.adspirer.ai/api/v1/tools/add_pmax_audience_signal/execute")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"arguments\": {\n \"audience_config\": {\n \"affinity_audience_ids\": [\n 10003100\n ],\n \"custom_audience_ids\": [\n \"customers/1234567890/customAudiences/555\"\n ],\n \"in_market_audience_ids\": [\n 90013100\n ],\n \"user_list_ids\": [\n \"customers/1234567890/userLists/999\"\n ]\n },\n \"campaign_id\": \"<campaign_id>\",\n \"customer_id\": \"string\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"quota": {
"limit": 150,
"period_end": "2026-05-01",
"tier": "plus",
"used": 42
},
"text": "(tool-specific textual output for add_pmax_audience_signal)"
},
"success": true,
"tool": "add_pmax_audience_signal"
}{
"error": "You have 25 meta_ads accounts connected. Please specify which account to use by passing the ad_account_id parameter:\n - Acme Holdings (ad_account_id=\"act_123456789\")\n - Acme EU (ad_account_id=\"act_987654321\")",
"is_error": true,
"success": false,
"tool": "add_pmax_audience_signal"
}{
"error": "Not authenticated. Please connect your Adspirer account first at https://adspirer.ai",
"is_error": true,
"success": false,
"tool": "add_pmax_audience_signal"
}{
"error": "🚨 Monthly limit reached (150/150 tool calls on Plus tier).\nUpgrade to Pro at https://adspirer.ai to keep building.",
"is_error": true,
"quota": {
"limit": 150,
"period_end": "2026-05-01",
"tier": "plus",
"upgrade_url": "https://adspirer.ai",
"used": 150
},
"success": false,
"tool": "add_pmax_audience_signal"
}{
"error": "Tool not found: add_pmax_audience_signal",
"is_error": true,
"success": false,
"tool": "add_pmax_audience_signal"
}{
"error": "Upstream platform rate limit hit (Meta Business Use Case throttle at 95%). Retry after 60 seconds.",
"is_error": true,
"success": false,
"tool": "add_pmax_audience_signal"
}{
"error": "Internal error: RuntimeError",
"is_error": true,
"success": false,
"tool": "add_pmax_audience_signal"
}Authorizations
API key from https://adspirer.ai/keys. Prefix sk_live_. Treat as a secret — never commit.
Headers
Client-generated UUID to make writes idempotent. Strongly recommended for write tools. A repeat call with the same key returns the cached result instead of re-executing. Example: 550e8400-e29b-41d4-a716-446655440000
Body
All tool arguments are wrapped in an arguments object. The fields accepted inside arguments are listed below — required fields are marked with a red asterisk.
Input schema for adding an audience signal to a PMax campaign.
Show child attributes
Show child attributes
Response
Tool executed successfully. data.text carries the human-readable result (markdown-friendly). data.quota shows your current usage against the plan limit. data.structured appears when the tool emits machine-parseable structured content. data.content appears for tools that return non-text blocks (images, resources).
Returned on HTTP 200. data.text is the primary human-readable output. data.quota is always present for billable calls. data.structured is set only when the tool emits machine-parseable structured content. data.content is set only when the tool emits non-text content blocks.
Was this page helpful?
curl --request POST \
--url https://api.adspirer.ai/api/v1/tools/add_pmax_audience_signal/execute \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"arguments": {
"audience_config": {
"affinity_audience_ids": [
10003100
],
"custom_audience_ids": [
"customers/1234567890/customAudiences/555"
],
"in_market_audience_ids": [
90013100
],
"user_list_ids": [
"customers/1234567890/userLists/999"
]
},
"campaign_id": "<campaign_id>",
"customer_id": "string"
}
}
'import requests
url = "https://api.adspirer.ai/api/v1/tools/add_pmax_audience_signal/execute"
payload = { "arguments": {
"audience_config": {
"affinity_audience_ids": [10003100],
"custom_audience_ids": ["customers/1234567890/customAudiences/555"],
"in_market_audience_ids": [90013100],
"user_list_ids": ["customers/1234567890/userLists/999"]
},
"campaign_id": "<campaign_id>",
"customer_id": "string"
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
arguments: {
audience_config: {
affinity_audience_ids: [10003100],
custom_audience_ids: ['customers/1234567890/customAudiences/555'],
in_market_audience_ids: [90013100],
user_list_ids: ['customers/1234567890/userLists/999']
},
campaign_id: '<campaign_id>',
customer_id: 'string'
}
})
};
fetch('https://api.adspirer.ai/api/v1/tools/add_pmax_audience_signal/execute', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.adspirer.ai/api/v1/tools/add_pmax_audience_signal/execute",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'arguments' => [
'audience_config' => [
'affinity_audience_ids' => [
10003100
],
'custom_audience_ids' => [
'customers/1234567890/customAudiences/555'
],
'in_market_audience_ids' => [
90013100
],
'user_list_ids' => [
'customers/1234567890/userLists/999'
]
],
'campaign_id' => '<campaign_id>',
'customer_id' => 'string'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.adspirer.ai/api/v1/tools/add_pmax_audience_signal/execute"
payload := strings.NewReader("{\n \"arguments\": {\n \"audience_config\": {\n \"affinity_audience_ids\": [\n 10003100\n ],\n \"custom_audience_ids\": [\n \"customers/1234567890/customAudiences/555\"\n ],\n \"in_market_audience_ids\": [\n 90013100\n ],\n \"user_list_ids\": [\n \"customers/1234567890/userLists/999\"\n ]\n },\n \"campaign_id\": \"<campaign_id>\",\n \"customer_id\": \"string\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.adspirer.ai/api/v1/tools/add_pmax_audience_signal/execute")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"arguments\": {\n \"audience_config\": {\n \"affinity_audience_ids\": [\n 10003100\n ],\n \"custom_audience_ids\": [\n \"customers/1234567890/customAudiences/555\"\n ],\n \"in_market_audience_ids\": [\n 90013100\n ],\n \"user_list_ids\": [\n \"customers/1234567890/userLists/999\"\n ]\n },\n \"campaign_id\": \"<campaign_id>\",\n \"customer_id\": \"string\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.adspirer.ai/api/v1/tools/add_pmax_audience_signal/execute")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"arguments\": {\n \"audience_config\": {\n \"affinity_audience_ids\": [\n 10003100\n ],\n \"custom_audience_ids\": [\n \"customers/1234567890/customAudiences/555\"\n ],\n \"in_market_audience_ids\": [\n 90013100\n ],\n \"user_list_ids\": [\n \"customers/1234567890/userLists/999\"\n ]\n },\n \"campaign_id\": \"<campaign_id>\",\n \"customer_id\": \"string\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"quota": {
"limit": 150,
"period_end": "2026-05-01",
"tier": "plus",
"used": 42
},
"text": "(tool-specific textual output for add_pmax_audience_signal)"
},
"success": true,
"tool": "add_pmax_audience_signal"
}{
"error": "You have 25 meta_ads accounts connected. Please specify which account to use by passing the ad_account_id parameter:\n - Acme Holdings (ad_account_id=\"act_123456789\")\n - Acme EU (ad_account_id=\"act_987654321\")",
"is_error": true,
"success": false,
"tool": "add_pmax_audience_signal"
}{
"error": "Not authenticated. Please connect your Adspirer account first at https://adspirer.ai",
"is_error": true,
"success": false,
"tool": "add_pmax_audience_signal"
}{
"error": "🚨 Monthly limit reached (150/150 tool calls on Plus tier).\nUpgrade to Pro at https://adspirer.ai to keep building.",
"is_error": true,
"quota": {
"limit": 150,
"period_end": "2026-05-01",
"tier": "plus",
"upgrade_url": "https://adspirer.ai",
"used": 150
},
"success": false,
"tool": "add_pmax_audience_signal"
}{
"error": "Tool not found: add_pmax_audience_signal",
"is_error": true,
"success": false,
"tool": "add_pmax_audience_signal"
}{
"error": "Upstream platform rate limit hit (Meta Business Use Case throttle at 95%). Retry after 60 seconds.",
"is_error": true,
"success": false,
"tool": "add_pmax_audience_signal"
}{
"error": "Internal error: RuntimeError",
"is_error": true,
"success": false,
"tool": "add_pmax_audience_signal"
}
