マーケティングAPI

エンゲージメントのカスタムオーディエンス

FacebookやInstagramのコンテンツに反応した利用者に基づいてカスタムオーディエンスを作成します。現在サポートされているオーディエンスタイプには、ページ、Instagramビジネスプロフィール、リード獲得広告、インスタントエクスペリエンス広告、ショッピング、拡張現実があります。

このガイドでは、ページエンゲージメントオーディエンスを例として使って、APIについて説明します。Facebookでは、あなたのページとエンゲージした利用者を継続的に追加することで、ページエンゲージメントのカスタムオーディエンスを更新します。最初にこのオーディエンスを作成するときに、すでにページとエンゲージした利用者のリストがオーディエンスに自動入力されます。

  • 2018年9月以降、ウェブサイトやアプリのカスタムオーディエンス、エンゲージメントのカスタムオーディエンス、オフラインコンバージョンデータから作成するオーディエンスのsubtypeのサポートは終了しています。例外として、動画のエンゲージメントカスタムオーディエンスのsubtypeは引き続きサポートされます。

  • ヨーロッパのオーディエンスを作成する場合、またはヨーロッパの利用者をターゲット設定する場合は、2020年12月2日のバージョン管理されない変更を参照してください。

オーディエンスの作成

エンゲージメントカスタムオーディエンスを作成するには、お持ちの広告アカウントについて広告マネージャでカスタムオーディエンス利用規約に同意する必要があります。

page_engagedイベントに基づいて、ページとエンゲージした利用者をリストするオーディエンスを作成するには、以下のようにします。

curl -X POST \
  -F 'name="My Test Engagement Custom Audience"' \
  -F 'rule={
       "inclusions": {
         "operator": "or",
         "rules": [
           {
             "event_sources": [
               {
                 "id": "<PAGE_ID>",
                 "type": "page"
               }
             ],
             "retention_seconds": 31536000,
             "filter": {
               "operator": "and",
               "filters": [
                 {
                   "field": "event",
                   "operator": "eq",
                   "value": "page_engaged"
                 }
               ]
             }
           }
         ]
       }
     }' \
  -F 'prefill=1' \
  -F 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v21.0/act_<AD_ACCOUNT_ID>/customaudiences

パラメーター

名前説明

name

文字列

必須。
カスタムオーディエンスの名前。

rule

JSONオブジェクト

必須。
オーディエンスを定義するルール。ウェブサイトカスタムオーディエンスと同じ構文に従います。

カスタムオーディエンスのタイプには、エンゲージメントカスタムオーディエンスが含まれます。利用可能なフィールドの一覧については、カスタムオーディエンスのリファレンスをご覧ください。

注: 広告アカウントごとに、最大500のエンゲージメントカスタムオーディエンスを作成できます。

エンゲージメントルール

誰かがFacebookによりカスタムオーディエンスに加えられるかどうかは、オーディエンスルールにより調べることができます。

ルールのevent_sources内のtypeフィールドとidフィールドに、エンゲージメントオブジェクトのtypeとidを指定します。idフィールドには、単一のオブジェクトIDか、同じタイプのIDの配列を指定できます。

サポートされるイベントソースと対応するエンゲージメントオブジェクトIDは、次のとおりです。

  • page: FacebookページID。
  • lead: リード獲得フォームのID。
  • ig_lead_generation: リード獲得フォームのID。
  • canvas: キャンバスID。
  • ig_business: InstagramビジネスプロフィールID。
  • shopping_page: FacebookショップページID。
  • shopping_ig: InstagramショップID。
  • ar_experience: ARエフェクトを使うインスタントエクスペリンス。
  • ar_effects: 自分独自のFacebookまたはInstagramエフェクト。広告で使われるエフェクトはこれに含まれません。

各ルールは、object_idとevent_nameで構成されます。

ページ

object_idをページIDに設定します。event_nameには、次のいずれかのエンゲージメントイベントを使います。

  • page_engaged: FacebookまたはMessengerで、ページを訪れた利用者、またはページのいずれかのコンテンツまたは広告とエンゲージした利用者。これは最も包括的なエンゲージメントタイプであり、ほかのすべてのエンゲージメントタイプが含まれます。
  • page_visited: ページを訪れた利用者。
  • page_liked: 現在あなたのページに「いいね！」している利用者(ページへの「いいね！」に関連する保存期間とルールの詳細を参照)。
  • page_messaged: ページにメッセージを送った利用者。
  • page_cta_clicked: ページ上のいずれかのCTAボタン([問い合わせる]、[今すぐ購入]など)をクリックした利用者。
  • page_or_post_save: ページまたはいずれかのページ投稿を保存した利用者。
  • page_post_interaction: いずれかのページ投稿とインタラクションをした利用者。この場合のインタラクションには、リアクション(いいね！、超いいね！、うけるね、すごいね、悲しいね、ひどいね)、共有、コメント、リンククリック、カルーセルスワイプが含まれます。

リード獲得広告

object_idをFORM_IDに設定し、次のいずれかのリード獲得広告イベントをトラッキングするようにruleを設定します。

  • lead_generation_submitted: フォームの記入を完了して送信したすべての人。
  • lead_generation_dropoff: フォームを送信しないで閉じたすべての人。これには、いずれかのフィールドに記入した人も、まったく記入しなかった人も含まれます。
  • lead_generation_opened: リード獲得フォームを開いたすべての人(フォームを送信したかどうかを問わない)。

インスタントエクスペリエンス

object_idを"CANVAS_ID"に設定します。次のいずれかのイベントをトラッキングするruleを設定する必要があります。

  • instant_shopping_document_open
  • instant_shopping_document_pause
  • instant_shopping_document_resume
  • instant_shopping_document_close
  • instant_shopping_did_scroll
  • instant_shopping_element_click
  • instant_shopping_element_impression

Instagramビジネスプロフィール

object_idに"INSTAGRAM_BUSINESS_PROFILE_ID"を指定し、次のいずれかのInstagramビジネスプロフィールイベントをトラッキングするruleを設定する必要があります。

  • ig_business_profile_all: Instagramビジネスプロフィールを訪れた利用者、またはInstagramビジネスプロフィールのいずれかのコンテンツまたは広告とエンゲージした利用者。これは最も包括的なエンゲージメントタイプであり、ほかのすべてのエンゲージメントタイプが含まれます。これは、ig_business_profile_engaged、ig_user_messaged_business、ig_user_messaged_businessの和集合です。
  • ig_business_profile_engaged: あなたのInstagramビジネスプロフィールとエンゲージした利用者、またはあなたのInstagramビジネスプロフィールのいずれかのコンテンツまたは広告とエンゲージした利用者。
  • ig_user_messaged_business: Instagramビジネスプロフィールにメッセージを送った利用者。
  • ig_business_profile_visit: Instagramビジネスプロフィールを訪れた利用者。
  • ig_business_profile_ad_saved: Instagramビジネスプロフィールのいずれかのオーガニックコンテンツまたは広告を保存した利用者。
  • ig_ad_like
  • ig_ad_comment
  • ig_ad_share
  • ig_ad_save
  • ig_ad_cta_click
  • ig_ad_carousel_swipe
  • ig_organic_like
  • ig_organic_comment
  • ig_organic_share
  • ig_organic_save
  • ig_organic_swipe
  • ig_organic_carousel_swipe

現在、Instagramメディアクリエイタータイプは、動画のエンゲージメントカスタムオーディエンスの作成ではサポートされていません。

ショッピング

次のいずれかのイベントをトラッキングするショッピングエンゲージメントルールを設定する必要があります。

  • VIEW_CONTENT: 商品詳細ページを閲覧した人。このオプションは全世界で利用可能です。
  • ADD_TO_CART: ショッピングカートに商品を追加した人。このオプションを利用できるのは、チェックアウトが有効になっているビジネスと、米国の消費者のみです。
  • PURCHASE: 商品を購入した人。このオプションを利用できるのは、チェックアウトが有効になっているビジネスと、米国の消費者のみです。

商品を閲覧した人を追加するルールを作成するには、次のようにします。

curl -i -X POST
-F 'name="test_api"'\
-F 'rule= {
	"inclusions": {
		"operator": "or",
		"rules": [
			{
				"event_sources": [
					{
						"id": "<ID>",
						"type": "shopping_ig"
					}
				]
				"retention_seconds": <RETENTION_SECONDS>,
				"filter": {
					"operator": "and",
					"filters": [
						{
						"field":"event",
						"operator":"eq",
						"value": "VIEW_CONTENT"
						}
					]
				}
			}
		]
	}
}
-F 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/v21.0/act_<AD_ACCOUNT_ID>/customaudiences

ヨーロッパでは、新しいプライバシー規則により、page_messagedとig_user_messaged_businessのパラメーターを利用できない場合があります。

拡張現実

拡張現実エンゲージメントカスタムオーディエンスには、ARエクスペリエンスとARエフェクトの2つの構成要素を含めることができます。

  • ARエクスペリエンスエンゲージメントカスタムオーディエンスの場合は、object_idをAR広告データコンテナIDに設定し、event_nameファイルにはar_camera_openまたはcamera_cta_clickのどちらかを使います。
  • ARエフェクトエンゲージメントカスタムオーディエンスの場合は、object_idをARエフェクトIDに設定し、event_nameフィールドにar_effect_openを使います。

最大保存日数

法的要件/プライバシー要件に基づき、Facebookは、イベントソースタイプごとに異なる最大保存日数を設定しています。

除外セクションのあるエンゲージメントルール

エンゲージメントオーディエンスのルールは、ウェブサイトカスタムオーディエンスのルールと互換性があります。したがって、複数の包含ルールと除外ルールを含めることができます。少なくとも1つのルールに合致する利用者がオーディエンスに追加されます。

次の例では、ページを訪れた利用者またはページとエンゲージした利用者を包含し、コールトゥアクションをクリックした利用者を除外するオーディエンスが作成されます。

curl -X POST \
  -F 'name="My Test Engagement Custom Audience"' \
  -F 'rule={
       "inclusions": {
         "operator": "or",
         "rules": [
           {
             "event_sources": [
               {
                 "id": "<PAGE_ID>",
                 "type": "page"
               }
             ],
             "retention_seconds": 31536000,
             "filter": {
               "operator": "and",
               "filters": [
                 {
                   "field": "event",
                   "operator": "eq",
                   "value": "page_engaged"
                 }
               ]
             }
           }
         ]
       },
       "exclusions": {
         "operator": "or",
         "rules": [
           {
             "event_sources": [
               {
                 "id": "<PAGE_ID>",
                 "type": "page"
               }
             ],
             "retention_seconds": 31536000,
             "filter": {
               "operator": "and",
               "filters": [
                 {
                   "field": "event",
                   "operator": "eq",
                   "value": "page_cta_clicked"
                 }
               ]
             }
           }
         ]
       }
     }' \
  -F 'prefill=1' \
  -F 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v21.0/act_<AD_ACCOUNT_ID>/customaudiences

詳しくは、ウェブサイトのカスタムオーディエンスをご覧ください。

複数のルール

エンゲージメントオーディエンスに複数のルールを設定して、少なくとも1つのルールに合致する利用者がオーディエンスに追加されるようにすることができます。ページにメッセージを送った利用者またはコールトゥアクションをクリックした利用者を含むオーディエンスを作成する例を以下に示します:

curl -X POST \
  -F 'name="My Test Engagement Custom Audience"' \
  -F 'rule={
       "inclusions": {
         "operator": "or",
         "rules": [
           {
             "event_sources": [
               {
                 "id": "<PAGE_ID>",
                 "type": "page"
               }
             ],
             "retention_seconds": 31536000,
             "filter": {
               "operator": "and",
               "filters": [
                 {
                   "field": "event",
                   "operator": "eq",
                   "value": "page_engaged"
                 },
                 {
                   "field": "event",
                   "operator": "eq",
                   "value": "page_engaged"
                 }
               ]
             }
           }
         ]
       }
     }' \
  -F 'prefill=1' \
  -F 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v21.0/act_<AD_ACCOUNT_ID>/customaudiences

複数のページ

ルールは単一のページに限定されません。各ルールを複数のページに適用できます。少なくとも1つのページとエンゲージした利用者がいれば、オーディエンスに含められます。

3つのページのうち少なくとも1つを訪れたすべての利用者を含むオーディエンスの例を以下に示します。

curl -X POST \
  -F 'name="My Test Engagement Custom Audience"' \
  -F 'rule={
       "inclusions": {
         "operator": "or",
         "rules": [
           {
             "event_sources": [
               {
                 "id": "<PAGE_ID>",
                 "type": "page"
               },
               {
                 "id": "<PAGE_ID>",
                 "type": "page"
               }
             ],
             "retention_seconds": 31536000,
             "filter": {
               "operator": "and",
               "filters": [
                 {
                   "field": "event",
                   "operator": "eq",
                   "value": "page_engaged"
                 }
               ]
             }
           }
         ]
       }
     }' \
  -F 'prefill=1' \
  -F 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v21.0/act_<AD_ACCOUNT_ID>/customaudiences

カスタムオーディエンスについて詳しくは、カスタムオーディエンスのリファレンスをご覧ください。

ページへの「いいね！」の保存期間とルール

ページへの「いいね！」オーディエンスには保存期間がありません(retention_seconds=0)。また、ページへの「いいね！」のルールを他のページイベントと組み合わせることはできません。

ページへの「いいね！」オーディエンスの作成例を以下に示します。

curl -X POST \
  -F 'name="Page Likes Audience Name"' \
  -F 'rule={
       "inclusions": {
         "operator": "or",
         "rules": [
           {
             "event_sources": [
               {
                 "id": "<PAGE_ID>",
                 "type": "page"
               }
             ],
             "retention_seconds": 0,
             "filter": {
               "operator": "and",
               "filters": [
                 {
                   "field": "event",
                   "operator": "eq",
                   "value": "page_liked"
                 }
               ]
             }
           }
         ]
       }
     }' \
  -F 'prefill=1' \
  -F 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v21.0/act_<AD_ACCOUNT_ID>/customaudiences