マーケティングAPI

ターゲット設定の説明

一連のターゲット設定の仕様について、人間が読める形式の説明を取得します。特定のadsのターゲット設定の説明を確認するには、https://graph.facebook.com/{AD_ID}/targetingsentencelinesに対してHTTP GETを実行します。

既存の広告のターゲット設定に関する説明

既存の広告のtargetingsentencelinesをリンクする方法は以下のとおりです。

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

応答は次のようになります。

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

応答には、以下のフィールドが含まれます。

名前 説明

id

型: 文字列

targetingsentencelinesのID。

targetingsentencelines

型: JSONオブジェクトの配列

ターゲット設定の仕様に関する人間が読める形式の説明。各オブジェクトには、contentまたはターゲット設定タイプ、およびchildrenまたはターゲット設定の仕様が含まれます。このフィールドでは、有効な配置のみが考慮されます。

広告アカウントのターゲット設定に関する説明

https://graph.facebook.com/{AD_ACCOUNT_ID}/targetingsentencelinesで、広告アカウントへのHTTP GETを使用し、ターゲット設定の説明や仕様を取得することもできます。

例えば、米国または日本に住む、20～24歳の男性ユーザーについては、以下のようにターゲット設定に関する説明を取得します。

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

応答は次のようになります。

{
    "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"
        ]
    }]
}

追加パラメーターには以下が含まれます。

名前 説明

targeting_spec

型: JSONオブジェクト

必須。

このターゲット設定の仕様における、ターゲット設定の説明を取得する。

hide_targeting_spec_from_return

型: ブール

任意。

targeting_specを含む応答を要求するかどうか。デフォルトはfalseです。

応答には、以下のフィールドが含まれます。

名前 説明

targetingsentencelines

型: JSONオブジェクトの配列

ターゲット設定の仕様に関する人間が読める形式の説明。各オブジェクトには、contentまたはターゲット設定タイプ、およびchildrenまたはターゲット設定の仕様が含まれます。

params

型: JSONオブジェクト

自身が指定したターゲット設定の仕様。

Metaがパラメーターを自動修正した場合、paramsはご自身が指定したものと異なることがあります。例えば、{'age_min':10}をリクエストした場合、応答のparamsは、サポートされる最小値の{'age_min':13}となります。