Create custom audience

Build an audience of your customers, website visitors, mobile app visitors or people similar to them.

Use the following parameters:

Name

Type

Required

Description

name

String

Yes

Audience name

rule

JSON Object

Yes

Audience rules applied to referring URL.

Available Fields : Documentation

"rule" :
{
   "inclusions": {
     "operator": "or",
     "rules": [
       {
         "event_sources": [
           {
             "id": "814765166375068",
             "type": "pixel"
           }
         ],
         "retention_seconds": 8400,
         "filter": {
           "operator": "and",
           "filters": [
             {
               "field": "url",
               "operator": "i_contains",
               "value": "shoes"
             }
           ]
         }
       }
     ]
   }
}

retention_days

Int / Number

Optional

Number of days to retain someone in audience. Between 1 and 180 days

prefill

Boolean

Optional

Optional. Default is true. Available options are: true: Include website activity recorded before audience creation. false: Only include website traffic from the time of audience creation.

POST https://us-central1-appgregator.cloudfunctions.net/facebook/custom-audience/

Query Parameters

Name

Type

Description

name*

String

ft-4

connection_name*

String

fbads-01

adaccount_id*

String

act_1217648562383717

Headers

Name

Type

Description

x-api-key*

String

U2Fsd...

{
    "id": "23851054958460684"
}

Body JSON

{
    "name" : "My new CA",
    "subtype" : "CUSTOM",
    "description" : "People who bought from my website",
    "customer_file_source" : "USER_PROVIDED_ONLY"
}

curl --location --request POST 'https://us-central1-appgregator.cloudfunctions.net/facebook/custom-audience?name=ft-4&connection_name=fbads-01&adaccount_id=act_1217648562383717' \
--header 'x-api-key: U2Fsd...' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name" : "My new CA",
    "subtype" : "CUSTOM",
    "description" : "People who bought from my website",
    "customer_file_source" : "USER_PROVIDED_ONLY"
}'

var axios = require('axios');
var data = JSON.stringify({
  "name": "My new CA",
  "subtype": "CUSTOM",
  "description": "People who bought from my website",
  "customer_file_source": "USER_PROVIDED_ONLY"
});

var config = {
  method: 'post',
  url: 'https://us-central1-appgregator.cloudfunctions.net/facebook/custom-audience?name=ft-4&connection_name=fbads-01&adaccount_id=act_1217648562383717',
  headers: { 
    'x-api-key': 'U2Fsd...', 
    'Content-Type': 'application/json'
  },
  data : data
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://us-central1-appgregator.cloudfunctions.net/facebook/custom-audience?name=ft-4&connection_name=fbads-01&adaccount_id=act_1217648562383717',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{
    "name" : "My new CA",
    "subtype" : "CUSTOM",
    "description" : "People who bought from my website",
    "customer_file_source" : "USER_PROVIDED_ONLY"
}',
  CURLOPT_HTTPHEADER => array(
    'x-api-key: U2Fsd...',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

PreviousCustom Audience NextList

Last updated 3 years ago