マーケティングAPI

ターゲット設定検索

広告セットのターゲットを、ターゲット設定の仕様に指定したいくつかの条件に設定します。ほとんどのターゲットは、Japanという国や、Tokyoという都市など、定義済みの値になっています。

有効な値は、マーケティングAPIのターゲット設定検索を使用して確認できます(https://graph.facebook.com/{API_VERSION}/search)。クエリ文字列は、UTF8形式で指定する必要があります。

ターゲット設定のオプションステータス

ターゲットオブジェクトの現在および/または計画されたステータスを確認するには、targeting_option_listパラメーターを使用します。

curl -G \
  -d 'targeting_option_list=[<TARGETING_OPTION_ ID>,<TARGETING_OPTION_ID>]' 
  -d 'type=targetingoptionstatus'  
  https://graph.facebook.com/<API_VERSION>/search

応答:

{"data":[{"id":"<TARGETING_OPTION_ ID>","current_status":"NON-DELIVERABLE"},{"id":"<TARGETING_OPTION_ID>","current_status":"NON-DELIVERABLE","future_plan":[{"key":"2018-05-10T00:00:00+0000","value":"DEPRECATING"}]}]

返されるフィールド

フィールド値

current_status

  • NORMAL
  • NON-DELIVERABLE - 広告セットは所定のルールに従って配信を続けることができますが、配信を行いません。
  • DEPRECATING - この目標をターゲットとして設定する広告セットは引き続き配信されますが、広告セットの新規作成やアップデートには使用できません。アップデート後、この条件を含む広告セットは、該当する条件が削除されるまで却下されます。
  • INCLUSION-ONLY - オブジェクトをターゲット設定の除外で使用することはできません。
  • UNKNOWN

future_plan

ステータスへのタイムスタンプのマップ。日付と計画されたステータスのマップを返します。このステータスはcurrent_statusで使用可能な値と同じものです。

地理

国、国グループ、都市、州、郵便番号によるターゲット検索は、type=adgeolocationで行います。任意パラメーターはtype=adgeolocationで指定できます。米国の国コードを見つけるには、次のようにします。

curl -G \
  -d 'location_types=["country"]' \
  -d 'type=adgeolocation' \
  -d 'q=un' \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v<API_VERSION>/search

応答:

{
  "data": [
    {
      "key": "GB", 
      "name": "United Kingdom", 
      "type": "country", 
      "supports_city": false, 
      "supports_region": false
    }, 
    {
      "key": "AE", 
      "name": "United Arab Emirates", 
      "type": "country", 
      "supports_city": false, 
      "supports_region": false
    }, 
    {
      "key": "UM", 
      "name": "United States Minor Outlying Islands", 
      "type": "country", 
      "supports_city": false, 
      "supports_region": false
    }
  ]
}

keyは、国や国グループなどのカテゴリごとに固定されたユニークな数値です。その他のフィールドは、nameを含め、変更されることがあります。ターゲット設定の仕様を定義するには、keyを使用します。

応答の中で:

  • supports_regionがtrueであれば、その国には地域コードがあります
  • supports_cityがtrueであれば、その国には都市コードがあります
名前 説明

location_types

型: 配列

country、country_group、region、city、zip、geo_market、またはelectoral_district(最後のものは米国のみ)。
location_typesはtype=adcountryなどより優先されます。

region_id

型: 整数

検索対象の地域

country_code

型: 文字列

検索対象の国: country_code=US

国

ターゲットを設定することのできる国にはすべて国コードがあります。type=adgeolocation&location_types=['country']の任意パラメーター:

名前 説明

q

型: 文字列

値をオートコンプリートする文字列。location_types=['country']ですべての国をリストするには、これをブランクにし(q=)、制限を大きな数に設定します(limit=1000)

match_country_code

型: ブーリアン

デフォルトはfalseです。

国コードで国を検索します。国をcountry_codeとnameで検索する場合の比較

国グループ

すべての国グループには、国のリストを検索して取得するためのコードがあります。mercosurという名前のすべての国グループの場合は、以下のとおりです。

curl -G \
  -d 'location_types=["country_group"]' \
  -d 'type=adgeolocation' \
  -d 'q=mercosur' \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v<API_VERSION>/search

応答:

{
  "data": [
    {
      "key": "mercosur",
      "name": "Mercosur",
      "type": "country_group",
      "country_codes": [
        "BR",
        "AR",
        "UY",
        "PY",
        "VE"
      ],
      "is_worldwide": false,
      "supports_region": true,
      "supports_city": true
    }
  ]
}

is_worldwideがtrueであれば、全世界が含まれる国グループです。supports_regionがtrueであれば、その国グループには地域コードがあります。supports_cityがtrueであれば、そのグループには都市コードがあります。

地域

コードの先頭がalのすべての地域を検索するには、次のようにします。

curl -G \
  -d 'location_types=["region"]' \
  -d 'type=adgeolocation' \
  -d 'q=al' \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v<API_VERSION>/search

応答:

{
  "data": [
    {
      "key": "3843",
      "name": "Alabama",
      "type": "region",
      "country_code": "US",
      "country_name": "United States",
      "supports_region": true,
      "supports_city": true
    },
    {
      "key": "3844",
      "name": "Alaska",
      "type": "region",
      "country_code": "US",
      "country_name": "United States",
      "supports_region": true,
      "supports_city": true
    },
    {
      "key": "527",
      "name": "Alberta",
      "type": "region",
      "country_code": "CA",
      "country_name": "Canada",
      "supports_region": true,
      "supports_city": true
    },
    {
      "key": "1089",
      "name": "Alsace",
      "type": "region",
      "country_code": "FR",
      "country_name": "France",
      "supports_region": true,
      "supports_city": true
    }
  ]
}

type=adgeolocation&location_types=['region']のオプションは次のとおりです。

名前 説明

q

型: 文字列

値をオートコンプリートする文字列。location_types=['region']のすべての国を取得するには: パラメーターは指定せず(q=)、制限を大きな数に設定します(limit=1000)

supports_regionがtrueであれば、この地域をターゲットに設定できます。supports_cityがtrueであれば、その地域には都市コードがあります。

都市

2019年3月以来、いくつかの都市が他の役割に再分類されましたが、cityは引き続き使用できます。検索すると、以前の都市が結果として返されます。

先頭がManhattanのすべての都市のコードを検索するには、次のようにします。

curl -G \
     -d 'location_types=["city"]' \
     -d 'type=adgeolocation' \
     -d 'q=Manhattan' \
     -d 'access_token=ACCESS_TOKEN' \
     https://graph.facebook.com/VERSION/search

応答:

{
  "data": [
    {
      "key": "2447439",
      "name": "Manhattan",
      "type": "city",
      "country_code": "US",
      "country_name": "United States",
      "region": "Kansas",
      "region_id": 3859,
      "supports_region": true,
      "supports_city": true
    },
    {
      "key": "2439596",
      "name": "Manhattan",
      "type": "city",
      "country_code": "US",
      "country_name": "United States",
      "region": "Illinois",
      "region_id": 3856,
      "supports_region": true,
      "supports_city": true
    },
    {
      "key": "2479541",
      "name": "Manhattan",
      "type": "city",
      "country_code": "US",
      "country_name": "United States",
      "region": "Montana",
      "region_id": 3869,
      "supports_region": true,
      "supports_city": true
    },
    {
      "key": "2428908",
      "name": "Manhattan",
      "type": "city",
      "country_code": "US",
      "country_name": "United States",
      "region": "Florida",
      "region_id": 3852,
      "supports_region": true,
      "supports_city": true
    },
    {
      "key": "2703980",
      "name": "Manhattan",
      "type": "subcity",
      "country_code": "US",
      "country_name": "United States",
      "region": "New York",
      "region_id": 3875,
      "supports_region": true,
      "supports_city": true,
      "geo_hierarchy_level": "SUBCITY",
      "geo_hierarchy_name": "BOROUGH"
    },
   ...

supports_regionがtrueであれば、この都市の地域をターゲット設定に利用できます。supports_cityがtrueに設定されていれば、その都市をターゲット設定に利用できます。

地理的エリア

ターゲットに利用できるその他の地理的エリアがあります。以下に記載されているとおり、一部のエリアはまだ定義されていません。

エリア説明

LARGE_GEO_AREA

一般に知られた、数百平方キロメートル以上の範囲に及ぶ地区または行政区域。例: LebanonのAkkar。

MEDIUM_GEO_AREA

一般に知られた、複数の都市の範囲に及ぶ郡。例: United StatesのVirginia州のHenrico郡

SMALL_GEO_AREA

一般に知られた、都市または町に近接した住宅地。例: SpainのMarbella付近のEl Rosario。

SUBCITY

区など。例: New YorkのBrooklyn。

NEIGHBORHOOD

都市内のエリア。例: TexasのBarton Estates, Irving。

SUBNEIGHBORHOOD

まだ利用できません。

METRO_AREA

大都市の周りの人口密集地。まだ利用できません。

地理的エリアの階層は、大きいものから小さいものの順に、次のとおりです:

  • REGION
  • LARGE_GEO_AREA
  • MEDIUM_GEO_AREA
  • SMALL_GEO_AREA
  • METRO_AREA
  • CITY
  • SUBCITY
  • NEIGHBORHOOD
  • SUBNEIGHBORHOOD

郵便番号

Facebook上でターゲットを設定するために郵便番号を検索することもできます。郵便番号の検索には、adgeolocationにlocation_types=['zip']を指定することをおすすめします。国ごとにサポートされる郵便番号のリストについては、Metaヘルプセンターをご覧ください。

先頭が9の郵便番号を検索するには、次のようにします。

curl -G \
  -d 'location_types=["zip"]' \
  -d 'type=adgeolocation' \
  -d 'q=9' \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/LATEST-API-VERSION/search

応答:

{
  "data": [
    {
      "key": "US:90028",
      "name": "90028",
      "type": "zip",
      "country_code": "US",
      "country_name": "United States",
      "region": "California",
      "region_id": 3847,
      "primary_city": "Los Angeles",
      "primary_city_id": 2420379,
      "supports_region": true,
      "supports_city": true
    },
    {
      "key": "US:94110",
      "name": "94110",
      "type": "zip",
      "country_code": "US",
      "country_name": "United States",
      "region": "California",
      "region_id": 3847,
      "primary_city": "San Francisco",
      "primary_city_id": 2421836,
      "supports_region": true,
      "supports_city": true
    },
    {
      "key": "US:94501",
      "name": "94501",
      "type": "zip",
      "country_code": "US",
      "country_name": "United States",
      "region": "California",
      "region_id": 3847,
      "primary_city": "Alameda",
      "primary_city_id": 2417628,
      "supports_region": true,
      "supports_city": true
    },
    {
      "key": "US:95190",
      "name": "95190",
      "type": "zip",
      "country_code": "US",
      "country_name": "United States",
      "region": "California",
      "region_id": 3847,
      "primary_city": "San Jose",
      "primary_city_id": 2421846,
      "supports_region": true,
      "supports_city": true
    }
  ]
}

ロケール

ロケールコードによってターゲットを設定できるロケール。先頭がenのすべてのロケールを検索するには、次のようにします。

curl -G \
  -d 'type=adlocale' \
  -d 'q=en' \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v<API_VERSION>/search

応答:

{
{
      "data": [
        {
          "key": 51, 
          "name": "English (Upside Down)"
        }, 
        {
          "key": 6, 
          "name": "English (US)"
        }, 
        {
          "key": 24, 
          "name": "English (UK)"
        }
      ]
    }
}
名前 説明

q

型: 文字列

値をオートコンプリートする文字列。すべてのロケールを取得するには、これをブランクにし(q=)、制限を大きな数に設定します(limit=1000)

DMAコード

これを取得するには、type=adgeolocationとlocation_types=['geo_market']をクエリに指定します。先頭が「New」のDMAコードを検索するには、次のようにします。

curl -G \
  -d 'location_types=["geo_market"]' \
  -d 'type=adgeolocation' \
  -d 'q=New' \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v<API_VERSION>/search

結果は次のようになります。

{
  "data": [
    {
      "key": "DMA:622",
      "name": "New Orleans",
      "type": "geo_market",
      "country_code": "US",
      "country_name": "United States",
      "supports_region": true,
      "supports_city": true
    },
    {
      "key": "DMA:501",
      "name": "New York",
      "type": "geo_market",
      "country_code": "US",
      "country_name": "United States",
      "supports_region": true,
      "supports_city": true
    },
    {
      "key": "DMA:533",
      "name": "Hartford &amp; New Haven",
      "type": "geo_market",
      "country_code": "US",
      "country_name": "United States",
      "supports_region": true,
      "supports_city": true
    },
    {
....
    }
  ]
}

選挙区

ターゲットを設定する選挙区を検索するには、type=adgeolocationとlocation_types=['electoral_district']を指定します。カリフォルニアの選挙区を検索するには、次のようにします。

curl -G \
  -d 'location_types=["electoral_district"]' \
  -d 'type=adgeolocation' \
  -d 'q=California' \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v<API_VERSION>/search

応答:

{
  "data": [
    {
      "key": "US:CA14",
      "name": "California's 14th District",
      "type": "electoral_district",
      "country_code": "US",
      "country_name": "United States",
      "region": "California",
      "region_id": 3847,
      "supports_region": true,
      "supports_city": true
    },
    {
      "key": "US:CA02",
      "name": "California's 2nd District",
      "type": "electoral_district",
      "country_code": "US",
      "country_name": "United States",
      "region": "California",
      "region_id": 3847,
      "supports_region": true,
      "supports_city": true
    },
 ...
}

地理的な所在地のメタデータ

type=adgeolocationmetaでは、次のような追加の任意パラメーターを使用できます。

curl -G \
  -d 'cities=[2418779]' \
  -d 'zips=["US:90210"]' \
  -d 'countries=["US","JP"]' \
  -d 'regions=[10]' \
  -d 'type=adgeolocationmeta' \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v<API_VERSION>/search

応答は、次のような、地理的な所在地を指定されたメタデータのJSONオブジェクトになります。

{
  "data": {
    "countries": {
      "US": {
        "key": "US", 
        "type": "country", 
        "name": "United States", 
        "supports_city": true, 
        "supports_region": true
      }, 
      "JP": {
        "key": "JP", 
        "type": "country", 
        "name": "Japan", 
        "supports_city": true, 
        "supports_region": true
      }
    }, 
    "regions": {
      "10": {
        "key": "10", 
        "type": "region", 
        "name": "Dubai", 
        "country_code": "AE", 
        "supports_city": true, 
        "supports_region": false
      }
    }, 
    "cities": {
      "2418779": {
        "key": "2418779", 
        "type": "city", 
        "name": "Danville", 
        "region_id": 3847, 
        "region": "California", 
        "country_code": "US", 
        "supports_city": true, 
        "supports_region": true
      }
    }, 
    "zips": {
      "US:90210": {
        "key": "US:90210", 
        "type": "zip", 
        "name": "90210", 
        "primary_city": "Beverly Hills", 
        "region_id": 3847, 
        "region": "California", 
        "country_code": "US", 
        "supports_city": true, 
        "supports_region": true
      }
    }
  }
}

オプション:

名前 説明

countries

型: 文字列

国コードの配列

regions

型: 整数

地域コードの配列

country_groups

型: 文字列

国グループコードの配列

cities

型: 整数

都市キーの配列

zips

型: 文字列

郵便番号全体の配列。例: US:92103

範囲の提案

特定の場所の周辺にターゲットを設定するには、十分な人数にリーチする範囲の提案をsuggested_radiusで取得することができます。

curl -G \
  -d 'latitude=37.449478' \
  -d 'longitude=-122.173016' \
  -d 'type=adradiussuggestion' \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v<API_VERSION>/search

応答は、suggested_radiusとdistance_unitを含むJSONオブジェクトになります。

{
  "data": [
    {
      "suggested_radius": 10,
      "distance_unit": "mile"
    }
  ]
}

distance_unitを指定してsuggested_radiusを取得する例を次に示します。

curl -G \
  -d 'latitude=37.449478' \
  -d 'longitude=-122.173016' \
  -d 'type=adradiussuggestion' \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v<API_VERSION>/search
{
  "data": [
    {
      "suggested_radius": 16,
      "distance_unit": "kilometer"
    }
  ]
}

次のパラメーターを使用します。

名前 説明

latitude

型: 浮動小数点数

必須。

この場所の緯度

longitude

型: 浮動小数点数

必須。

この場所の経度

distance_unit

型: 文字列

任意。

測定の単位。mileまたはkilometer

範囲の提案と併用する近隣エリア広告についても参照してください。

興味・関心

GETリクエストを/searchエンドポイントに送信し、typeをadinterestに、qを検索する特定の興味・関心に設定します。

curl -G \
  -d 'type=adinterest' \
  -d 'q=baseball' \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v<API_VERSION>/search

応答は以下のフィールドを返します。

名前 説明

id

整数

趣味・関心のターゲットのFacebook ID

locale

文字列

利用可能な場合に、特定のロケール(language_TERRITORYの形式で指定)の言語でコンテンツを取得します。デフォルトはen_USです

name

文字列

興味・関心の名称

path

文字列の配列

カテゴリとすべての親カテゴリをターゲット設定に含めます

興味・関心の提案

GETリクエストを検索/searchエンドポイントに送信し、typeをadinterestsuggestionに設定すると、指定の興味・関心に関連する提案された興味のリストを取得できます。

クエリの例

curl -G \
  -d 'interest_list=["Basketball"]' \
  -d 'type=adinterestsuggestion' \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/<API_VERSION>/search

応答の例

{
  "data": [
    {
      "id": "6003598240487",
      "name": "la biblia",
      "audience_size": 7419780,
      "path": [
  ],
      "description": null
   },
   {
      "id": "6003022269556",
      "name": "Rugby football",
      "audience_size": 13214830,
      "path": [
  ],
      "description": null
   },
   {
      "id": "6003146664949",
      "name": "Netball",
      "audience_size": 4333770,
      "path": [
  ],
"description": null
   },
   {
      "id": "6003013291881",
      "name": "Kaizer Chiefs F.C.",
      "audience_size": 1812850,
      "path": [
  ],
      "description": null
  },
  ....
  {
      "id": "6003400886535",
      "name": "espn sportscenter",
      "audience_size": 222960,
      "path": [
  ],
     "description": null
  },
  {
     "id": "6002925969459",
     "name": "watching movies",
     "audience_size": 4630950,
     "path": [
  ],
     "description": null
  },
  {
     "id": "6003214125247",
     "name": "lakers",
     "audience_size": 340360,
     "path": [
  ],
     "description": null
  }

オプションは次のとおりです。

名前 説明

interest_list

型: 文字列の配列

必須。

提案を求める語句のリスト。大文字/小文字が区別されます。

制限

  • 利用可能なすべての関心事が検索できるわけではありません。
  • 趣味・関心の名前は随時変更されることがあるため、名前が変更された時点で名前による検証が失敗する可能性があります。このため、趣味・関心の検証には、名前ではなく、interest_fbid_listを使用することをおすすめします。語句が有効であることを確認するには、type=adinterestvalidと検証する趣味・関心を指定してクエリを実行します。
curl -G \
  -d 'interest_list=["Japan","nonexistantkeyword"]' \
  -d 'type=adinterestvalid' \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v<API_VERSION>/search

応答:

{
  "data": [
    {
      "name": "Japan",
      "valid": true,
      "id": 6003700426513,
      "audience_size": 68310258
    },
    {
      "name": "nonexistantkeyword",
      "valid": false
    }
  ]
}

オプション:

名前 説明

interest_list

型: 文字列の配列

必須(interest_fbid_listがない場合)。

検証する語句のリスト。大文字/小文字が区別されます。

interest_fbid_list

型: IDの配列

必須(interest_listがない場合)。

検証するIDのリスト。

興味・関心

ターゲットにできる興味・関心を閲覧するには、typeをadTargetingCategoryに、classをinterestsに設定したGETリクエストを/searchエンドポイントに送信します。

curl -G \
  -d 'type=adTargetingCategory' \
  -d 'class=interests' \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v<API_VERSION>/search

制限

  • すべての興味・関心が検索で返されるわけではありません。

行動

利用者のアクションまたは過去の購入行動に基づいてターゲットを設定します。行動のターゲットについて使用可能なすべてのオプションを取得するには、type=adTargetingCategory&class=behaviorsを使用します。

curl -G \
  -d 'type=adTargetingCategory' \
  -d 'class=behaviors' \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v<API_VERSION>/search

この応答には次の内容が含まれています。

名前 説明

name

型: 文字列

行動のターゲットの名前

id

型: 整数

行動ターゲットのFacebook ID

audience_size_lower_bound

整数

ターゲットオーディエンスサイズの推定下限

audience_size_upper_bound

整数

ターゲットオーディエンスサイズの推定上限

path

型: 文字列の配列

このターゲット設定のカテゴリとすべての親カテゴリ

description

型: 文字列

ターゲットオーディエンスの説明

type

型: 文字列

ターゲット設定のカテゴリクラス

利用者層データ

これには、職場、教育、役職のタイプや、交際ステータスのタイプが含まれます。また、最近のライフイベントに基づくターゲット設定( 3か月後、6か月後、および1年後)も可能です。ターゲットを設定する学校は、IDと名前で参照できます。

先頭がhaのすべての学校を検索するには、次のようにします。

curl -G \
  -d 'type=adeducationschool' \
  -d 'q=ha' \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v<API_VERSION>/search

応答:

 {
  "data": [
    {
      "name": "Harvard University", 
      "id": 105930651606,
      "coverage": 8395398,
      "subtext": "Cambridge, Massachusetts"
    }, 
    {
      "name": "Hajvery University", 
      "id": 148971135122588,
      "coverage": 124162
    }, 
    {
      "name": "Harvard-Westlake School", 
      "id": 107799365910274,
      "coverage": 14106
    }
  ]
}

大学の専攻

ターゲットを設定する専攻は、IDと名前で参照できます。先頭がphのすべての専攻を検索するには、次のようにします。

curl -G \
  -d 'type=adeducationmajor' \
  -d 'q=ph' \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v<API_VERSION>/search

応答:

{
  "data": [
    {
      "name": "Photography", 
      "id": 108170975877442,
      "coverage": 613618
    }, 
    {
      "name": "Physics", 
      "id": 109279729089828,
      "coverage": 942491
    }, 
    {
      "name": "Philosophy", 
      "id": 108026662559095,
      "coverage": 701271
    }
  ]
}

勤務先

ターゲットを設定できる勤務先は、IDと名前で参照します。先頭がmicのすべての勤務先を検索するには、次のようにします。

curl -G \
  -d 'type=adworkemployer' \
  -d 'q=mic' \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v<API_VERSION>/search

応答:

{
  "data": [
    {
      "name": "Western Michigan University", 
      "id": 10022826163,
      "coverage": 24366
    }, 
    {
      "name": "University of Michigan", 
      "id": 21105780752,
      "coverage": 17357
    }, 
    {
      "name": "Michigan State University - SPARTANS", 
      "id": 8891783019,
      "coverage": 65853
    }
  ]
}

役職

各自が申告している役職でターゲットを設定できるものには、IDと名前が付いています。Business Analystを含むすべての役職を取得するには、次のようにします。

curl -G \
  -d 'type=adworkposition' \
  -d 'q=Business Analyst' \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v<API_VERSION>/search

応答:

{
   "data": [
    {
      "name": "Business Analyst", 
      "id": 105763692790962,
      "coverage": 282124
    }, 
    {
      "name": "Financial Analyst", 
      "id": 112930925387573,
      "coverage": 212889
    }
  ]
}

応答には次のフィールドが含まれています。

名前 説明

name

型: 文字列

利用者データのターゲットの名前

id

型: 整数

利用者データのターゲットのFacebook ID

coverage

型: 整数

ターゲットオーディエンスの推定サイズ

subtext

型: 文字列

ターゲットオーディエンスの説明

このAPIの共通パラメーターを次に示します。タイプに固有のインプットパラメーターについては、以下の詳細を参照してください。

パラメーター名 説明

q

ほとんどの検索タイプで必須。

値をオートコンプリートする文字列。

type

必須。

取得するオートコンプリートデータのタイプ。以下を参照

list

任意。

FIPSコードの代わりに優先されるFacebookグローバルIDを取得します。adzipcode用にサポートされています

使用する場合、値はGLOBALと等しい必要があります

limit

任意。

返される結果の最大数(デフォルトは8)

オートコンプリートデータのカテゴリに基づいて、適切なtypeを指定してください。ロケールを取得するには、type=adlocaleを指定します。有効なカテゴリは次のとおりです。

`type`パラメーターの値 説明

adeducationschool

大学ターゲット設定のオートコンプリート

adeducationmajor

大学専攻ターゲット設定のオートコンプリート

adgeolocation

国、都市、州、郵便番号のオートコンプリートを結合したもの

adgeolocation.adcountry

国のオートコンプリート

adgeolocation.adzipcode

郵便番号のオートコンプリート

adgeolocation.adgeolocationmeta

地理的な場所の追加メタデータ

adgeolocation.adradiussuggestion

特定の場所周辺の提案範囲が返されます

adinterest

ロケールターゲット設定のオートコンプリート

adinterest.adinterestsuggestion

趣味・関心のターゲットに基づく提案

adinterest.adinterestvalid

文字列が趣味・関心のターゲットオプションとして有効かどうかを検証します。

adlocale

ロケールターゲット設定のオートコンプリート

adTargetingCategory

パラメーターのqは無視されます。パラメーターclassのクラスに使用できるすべてのターゲット設定オプションを確認してください。
classに指定できる値: interests、behaviors、demographics、life_events、industries、income、family_statuses、user_device、user_os

adworkemployer

勤務先のオートコンプリート値

adworkposition

役職のオートコンプリート値

利用者データの閲覧

利用者データのターゲットについて使用可能なすべてのオプションを取得するには、type=adTargetingCategoryとclassを使用します。

名前 説明

class

型: 文字列

次のいずれかを指定します。life_events、industries、income、family_statuses、user_device。demographicsを指定すると、すべてを取得できます。


利用者データのターゲットオプションは、一部の国では利用できません。このAPI呼び出しを行うときに使用されたアクセストークンに対応する利用者の母国設定に応じて、Facebookから返される結果は異なることがあります(結果が空のこともあります)。

応答には次のフィールドが含まれています。

名前 説明

name

型: 文字列

利用者データのターゲットの名前

id

型: 整数

利用者層データターゲットのFacebook ID

audience_size_lower_bound

整数

ターゲットオーディエンスサイズの推定下限

audience_size_upper_bound

整数

ターゲットオーディエンスサイズの推定上限

description

型: 文字列

ターゲットオーディエンスの説明

type

型: 文字列

利用者データのタイプ。すべての利用者層データを取得する場合に役立ちます

path

型: 文字列の配列

このターゲット設定が属するカテゴリとすべての親カテゴリが含まれます