バージョン2.11

マーケティングAPI

2017年11月7日リリース | 2018年8月7日まで利用可能 | ブログ投稿

• 新機能
• 重要な変更
• 廃止
• 即時廃止

新機能

ビジネスマネージャAPIのデザインを刷新

現在、クライアントと代理店の新しい関係を築いています。以前はuserもなかったため、ビジネスとその資産へのすべてのアクセスや招待をbid/userpermissionsを通じて処理しており、パフォーマンスの問題が生じていました。新しいAPIの主な変更点は次のとおりです。

• ビジネススコープユーザー - 新しいユーザーは特定のビジネスに関連付けられており、このビジネスを対象範囲とする権限を持ちます。ユーザーは、自分のプロフィール、アクセス許可、当該ビジネスに関連付けられたアセットへのアクセスを管理できます。
• 招待 - 新しいエンドポイントを通じてビジネスにアクセスするよう利用者を招待します。これらのエンドポイントでユーザー招待のステータスを確認して更新します。
• アセットカテゴリ - さまざまな種類のアセットをカテゴリに分割し、カテゴリごとに個別のエンドポイントを提供します。これにより、アセットを読み取るときに結果のページ分割が簡単になります。また、ビジネスで何千ものアセットを管理している場合、パフォーマンスの問題も軽減されます。デザイン刷新のため、新しいエンドポイントがいくつか追加されました。

以下は、ビジネス上のユーザーにアクセスするためのものです。

• BUSINESS_ID/business_users
• BUSINESS_ID/system_users
• BUSINESS_ID/pending_users

以下は、ユーザーに割り当てられたアセットにアクセスするためのものです。

• BUSINESS_USER_ID/assigned_pages
• BUSINESS_USER_ID/assigned_ad_accounts
• BUSINESS_USER_ID/assigned_product_catalogs
• SYSTEM_USER_ID/assigned_pages
• SYSTEM_USER_ID/assigned_ad_accounts
• SYSTEM_USER_ID/assigned_product_catalogs
• PENDING_USER_ID/assigned_pages
• PENDING_USER_ID/assigned_ad_accounts
• PENDING_USER_ID/assigned_product_catalogs

以下は、ビジネスページにアクセスするためのものです。

• BUSINESS_ID/owned_pages - ビジネスが所有するページのリストを取得する
• BUSINESS_ID/client_pages - ビジネスのクライアントのページのリストを取得する
• BUSINESS_ID/pending_owned_pages - ビジネスが所有する承認待ちのページのリストを取得する
• BUSINESS_ID/pending_client_pages - ビジネスのクライアントに属する承認待ちのページのリストを取得する

以下は、ビジネス広告アカウントにアクセスするためのものです。

• BUSINESS_ID/owned_ad_accounts - ビジネスが所有する広告アカウントのリストを取得する
• BUSINESS_ID/client_ad_accounts - ビジネスのクライアントの広告アカウントのリストを取得する
• BUSINESS_ID/pending_owned_ad_accounts - ビジネスが所有する承認待ちの広告アカウントのリストを取得する
• BUSINESS_ID/pending_client_ad_accounts - ビジネスのクライアントの承認待ちの広告アカウントのリストを取得する

以下は、ビジネス製品カタログにアクセスするためのものです。

• BUSINESS_ID/owned_product_catalogs - ビジネスが所有する製品カタログのリストを取得する
• BUSINESS_ID/client_product_catalogs - ビジネスのクライアントに属する製品カタログのリストを取得する

以下は、ビジネスアプリにアクセスするためのものです。

• BUSINESS_ID/owned_apps - ビジネスが所有するアプリのリストを取得する
• BUSINESS_ID/client_apps - ビジネスのクライアントのアプリのリストを取得する
• BUSINESS_ID/pending_client_apps - ビジネスのクライアントに属する承認待ちのアプリのリストを取得する

詳しくは、ビジネスマネージャ、API、ビジネスマネージャ、システムユーザー、ビジネスアセット管理API、およびビジネスマネージャAPI、ベストプラクティスをご覧ください。

カルーセル広告、リアルタイムの場所

リアルタイムの場所を示す添付ファイルを含むカルーセル広告を作成できるようになりました。AD_CREATIVE_ID/object_story_specのplace_dataにオプションtype=REALTIMEとlocation_source_id = PAGE_IDを追加しました。これは、以下にあるobject_story_specフィールドで利用可能です。

• POST /AD_ACCOUNT_ID/adcreatives
• GET CREATIVE_ID

来店数、ターゲットとする地域

店舗周辺の半径を超えた地域をターゲットに設定できるようになりました。来店数の増加を目的とした広告セットを作成する際に、targeting_specsフィールドにgeo_locationsパラメーターを追加しました。利用制限がある場合は、Facebook担当者に問い合わせてアクセスしてください。「来店数の増加」の目的をご覧ください。

• POST AD_ACCOUNT_ID/adsetsに新しいオプションがあります。
• country_groupsによるターゲットとtravel_in場所タイプのターゲットを除く、ターゲット設定、場所のすべての地理的エリアをサポートします。
• STORE_VISITSの目的を使用した広告の作成は限定的に利用可能です。来店数の増加をご覧ください。

広告セット、リンク先タイプ

これは、広告のリンク先(つまり、ユーザーが広告または広告内のコールトゥアクションをクリックしたときの移動先)のタイプを反映します。これにより、広告セット内のすべての広告に一貫したリンク先タイプが提供され、広告には異なるタイプの広告クリエイティブのみが含まれるようになります。広告セットのリンク先タイプをご覧ください。

• 広告セットのdestination_typeを追加しました
• /ADSET_IDで利用可能

重要業績評価指標(KPI)

新しいフィールドkpi_typeをAD_ACCOUNT_ID/CAMPAIGN_IDに追加しました。このフィールドは、キャンペーンまたはキャンペーン内の広告オブジェクトに対して、追跡する重要業績評価指標のタイプを記述します。kpi_resultsのkpi_typeによるインサイトデータを確認するには、次の呼び出しを実行します。

• GET CAMPAIGN_ID/insights
• GET ADSET_ID/insights
• GET AD_ID/insights

詳しくは、広告キャンペーンのリファレンスをご覧ください。

重要な変更

広告管理

• right_hand_column広告のターゲット設定の無効化 - AD_ACCOUNT_ID/adsetsのright_hand_columnの無効なクリエイティブを使用してこの位置をターゲット設定する広告はエラーを返します。動画、コレクション、キャンバスの広告形式を使用した、right_hand_columnのみの配置は許可されていません。right_hand_columnのみの配置では、単一画像形式とカルーセル形式のみを使用することができます。

• GET VERSION/RF_PREDICTION_ID/pause_periodsを変更 - 簡単に処理できるようにするため、StringではなくArrayを返すようになりました。

ビジネスマネージャAPI

• フィールドの名前変更 - admin_system_userフィールドの名前がadminに変更され、system_userフィールドの名前がemployeeに変更されました。この変更による影響を受けるのは、以下のエッジです。

  • /{business-id}/userpermissions
  • /{business-id}/system_users

廃止

広告管理

VIDEO_VIEWSの最適化を廃止 - VIDEO_VIEWSの目的を持つキャンペーンでは、最適化目標としてCLICKS、IMPRESSIONS、PAGE_ENGAGEMENT、POST_ENGAGEMENT、REACHを使用できなくなりました。

• これらの最適化目標を使用して広告セットを作成するとエラーが発生します。
• REACH最適化目標で広告セットを複製すると、自動的にVIDEO_VIEWS最適化目標に変換されます。
• 最適化目標としてCLICKS、IMPRESSIONS、PAGE_ENGAGEMENT、またはPOST_ENGAGEMENTを指定して広告セットを複製すると、エラーが返されます。これは、既存の広告セットで広告を作成または複製すると、これらの最適化目標のいずれかの再利用が試行されることが原因です。

この変更の影響を受けるエッジ

• POST ACCOUNT_ID/adsets
• POST AD_ACCOUNT_ID/ads
• POST CAMPAIGN_ID/copies
• POST ADSET_ID/copies
• POST AD_ID/copies

reachを廃止 -ブランドの認知度アップの目的のoptimization_goalとして使用する場合。/adsetでは削除されました。広告想起の最適化にのみ使用できます。これにより、リーチを専用の目的として使用する利用者による混乱を回避できます。

BRAND_AWARENESS最適化を廃止 - AD_RECALL_LIFTに置き換えられました。これは、新しい、より効率的な広告配信モデルを反映しています。新しい最適化目標では、同じ広告セット内の静止画広告と動画広告、手動入札などの混合クリエイティブがサポートされます。BRAND_AWARENESSは以下では利用できなくなりました。

• POST /ADSET_ID
• GET /ADSET_ID
• POST /AD_ACCOUNT_ID/adsets

frequency_capを廃止 - 次のlifetime_frequency_capおよびfrequency_cap_reset_periodフィールドも含む。

• POST AD_ACCOUNT_ID/adsets
• GET /ADSET_ID
• POST /ADSET_ID

代わりにfrequency_control_specsを使用します。

POST_ENGAGEMENT顧客獲得単価を廃止 - この目的では、POST_ENGAGEMENTをbilling_eventとして使用できなくなりました。これにより、広告の配信と測定がより適切に調整されます。これは、/AD_SET_IDエンドポイントに影響します。

広告インサイトと効果測定

以下のvideo_15_sec_watched_actionsを廃止。

• GET AD_ACCOUNT_ID/insights
• GET CAMPAIGN_ID/insights
• GET ADSET_ID/insights
• GET AD_ID/insights
• POST AD_ACCOUNT_ID/insights
• POST CAMPAIGN_ID/insights
• POST ADSET_ID/insights
• POST AD_ID/insights

recurrence_valueを廃止 - Advanced Measurement APIから。このフィールドは、アトラスAPIではレポートスケジュールとも呼ばれていました。recurrence_valuesに置き換えられました。Advanced Measurement、レポートスケジュールをご覧ください。

ビジネスの管理

ビジネスマネージャAPIのデザイン刷新により、以下のエンドポイントが廃止されました。

• BUSINESS_ID/userpermissions
• BUSINESS_ID/business_persona
• business_persona_id

以下のアセット管理用エンドポイントが廃止されました。

• BUSINESS_ID/pages
• BUSINESS_ID/adaccounts
• BUSINESS_ID/product_catalogs
• BUSINESS_ID/apps

アセットにアクセスするには、BUSINESS_ID/owned_ASSETまたはBUSINESS_ID/client_ASSETを使用します。

以下の別のビジネスに属するアセット管理用エンドポイントが廃止されました。

• BUSINESS_ID/assigned_ad_accounts
• BUSINESS_ID/assigned_pages
• BUSINESS_ID/assigned_product_catalogs

代わりに、BUSINESS_USER_ID/assigned_ASSETを使用します。

即時廃止

これらの廃止はすべてのAPIバージョンに影響し、2017年11月14日に有効になります。

イベント広告とリンク広告

有効なページにリンクされていないイベント広告やリンク広告の作成および編集を廃止しました。次のフォーマットは無効になり、エラーを返します。

以下の署名が廃止されています。

• イベント広告

  • 目的: EVENT_RESPONSES
  • クリエイティブフィールド: body、object_id
• リンク広告

  • 目的: LINK_CLICKS
  • クリエイティブフィールド: title、body、object_url(image_fileまたはimage_hash)

サポートされている署名

• イベント広告

  • 目的: EVENT_RESPONSES
  • クリエイティブフィールド: object_story_idまたはobject_story_spec
• リンク広告

  • 目的: LINK_CLICKS
  • クリエイティブフィールド: object_story_idまたはobject_story_spec

以前に作成した既存のイベント広告とリンク広告は引き続き実行されますが、この変更が有効になると、広告クリエイティブを変更したり、新しい広告を作成したりすることができなくなり、エラーが発生します。イベント広告およびローカル広告と広告、リファレンスをご覧ください。