API de marketing

Descripción de la segmentación

Obtén descripciones de un conjunto de especificaciones de segmentación en formato legible. Realiza una llamada HTTP GET a https://graph.facebook.com/{AD_ID}/targetingsentencelines para leer las descripciones de la segmentación de ads específicos.

Descripción de la segmentación de anuncios existentes

Para obtener la conexión targetingsentencelines de un anuncio existente:

use FacebookAds\Object\Ad;

$ad = new Ad(<AD_ID>);
$targeting_description = $ad->getTargetingDescription();

// Output targeting description
foreach ($targeting_description->targetingsentencelines as $description) {
  echo $description['content'].PHP_EOL;
  foreach ($description['children'] as $child) {
    echo "\t".$child.PHP_EOL;
  }
}
from facebookads.adobjects.ad import Ad

ad = Ad(<AD_ID>)
targeting_description = ad.get_targeting_sentence_lines().get_one()

# Output the targeting description
for description in targeting_description['targetingsentencelines']:
    print(description['content'])
    for child in description['children']:
        print("\t" + child)
curl -G \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v2.5/<AD_ID>/targetingsentencelines

La respuesta:

{
    "id": "<AD_ID>/targetingsentencelines",
    "targetingsentencelines": [
    {
        "content": "Location - Living In:",
        "children": [
            "Japan",
            "United States"
        ]
    },
    {
        "content": "Age:",
        "children": [
            "20 - 24"
        ]
    },
    {
        "content": "Gender:",
        "children": [
            "Male"
        ]
    }]
}

Las respuestas incluyen estos campos:

Nombre Descripción

id

Tipo: cadena

Identificador de targetingsentencelines.

targetingsentencelines

Tipo: matriz de objetos JSON

Descripción de la especificación de segmentación en formato legible. Cada objeto contiene content o el tipo de segmentación, y children o la especificación de segmentación. Este campo solo tiene en cuenta ubicaciones efectivas.

Descripción de la segmentación de cuentas publicitarias

También puedes obtener descripciones de la segmentación y una especificación de segmentación con una llamada HTTP GET en relación con una cuenta publicitaria en https://graph.facebook.com/{AD_ACCOUNT_ID}/targetingsentencelines.

Por ejemplo, para obtener descripciones de la segmentación de personas de género masculino que viven en EE. UU. o Japón y que tienen entre 20 y 24 años:

use FacebookAds\Object\AdAccount;
use FacebookAds\Object\Fields\TargetingFields;
use FacebookAds\Object\Targeting;

$account = new AdAccount('act_<AD_ACCOUNT_ID>');
$targeting = new Targeting();
$targeting->setData(array(
  TargetingFields::GEO_LOCATIONS => array(
    'countries' => array('US', 'JP')
  ),
  TargetingFields::GENDERS => array(1),
  TargetingFields::AGE_MIN => 20,
  TargetingFields::AGE_MAX => 24,
));

$params = array(
  'targeting_spec' => $targeting->exportData(),
);

foreach ($account->getTargetingSentenceLines(array(), $params) as $description) {
  echo $description->{'content'}.PHP_EOL;
  foreach ($description->{'children'} as $child) {
    echo " - ".$child.PHP_EOL;
  }
}
from facebookads.adobjects.adaccount import AdAccount
from facebookads.adobjects.targeting import Targeting

account = AdAccount('act_<AD_ACCOUNT_ID>')
params = {
    'targeting_spec': {
        Targeting.Field.geo_locations: {
            Targeting.Field.countries: ['US', 'JP'],
        },
        Targeting.Field.genders: [1],
        Targeting.Field.age_min: 20,
        Targeting.Field.age_max: 24,
    },
}

targeting_description = account.get_targeting_sentence_lines(params=params) \
    .get_one()

# Output the targeting description
for description in targeting_description['targetingsentencelines']:
    print(description['content'])
    for child in description['children']:
        print("\t" + child)
curl -G \
  --data-urlencode 'targeting_spec={ 
    "age_max": 24, 
    "age_min": 20, 
    "genders": [1], 
    "geo_locations": {"countries":["US","JP"]} 
  }' \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v2.11/act_<AD_ACCOUNT_ID>/targetingsentencelines

Respuesta:

{
    "params": {
        "genders": [1],
        "age_min": 20,
        "age_max": 24,
        "geo_locations": {
            "countries": [
                "US",
                "JP"
            ]
        }
    },
    "targetingsentencelines": [{
        "content": "Location - Living In:",
        "children": [
            "Japan",
            "United States"
        ]
    }, {
        "content": "Age:",
        "children": [
            "20 - 24"
        ]
    }, {
        "content": "Gender:",
        "children": [
            "Male"
        ]
    }]
}

Los parámetros adicionales son los siguientes:

Nombre Descripción

targeting_spec

Tipo: objeto JSON

Obligatorio.

Obtén la descripción de la segmentación de esta especificación de segmentación.

hide_targeting_spec_from_return

Tipo: booleano

Opcional.

Si la respuesta ha solicitado targeting_spec inclusive. El valor predeterminado es false.

Las respuestas tienen estos campos:

Nombre Descripción

targetingsentencelines

Tipo: matriz de objetos JSON

Descripción de la especificación de segmentación en formato legible. Cada objeto tiene content o el tipo de segmentación, y children o la especificación de segmentación.

params

Tipo: objeto JSON

Especificación de segmentación que has proporcionado.