バージョン2.11

マーケティングAPI

2017年11月7日リリース | ブログ投稿

• 新機能
• 重要な変更
• 廃止されたもの
• 即時廃止されたもの

新機能

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

クライアントとエージェンシーを表すリレーションシップが新しくなりました。以前はuserもありませんでした。ビジネスやアセットへのすべてのアクセスと招待をbid/userpermissions経由で処理していたため、パフォーマンスの問題が生じていました。新しいAPIの特徴:

• Business-scoped Users - 新しい利用者は特定のビジネスに紐づけられ、そのビジネスを対象としたアクセス許可が与えられます。利用者は、そのビジネスに関連付けられたプロフィール、アクセス許可、アセットへのアクセスを管理できます。
• 招待 - 新しいエンドポイント経由でビジネスにアクセスするよう利用者を招待します。これらのエンドポイントで利用者への招待のステータスを確認し、アップデートします。
• アセットのカテゴリ - 異なる種類のアセットを分類し、カテゴリごとのエンドポイントを設けました。これにより、アセットの読み取り時に結果のページネーションが簡単になります。ビジネスで数千のアセットを管理している場合は、パフォーマンスの問題も緩和されます。今回、複数の新しいエンドポイントが追加されました。

ビジネスで利用者にアクセスするには:

• 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の種類を示すAD_ACCOUNT_ID/CAMPAIGN_IDに、新しくkpi_typeフィールドが追加されました。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のみの配置には、1件の画像およびカルーセル形式のみ使用できます。

• 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が廃止されました - 詳細測定APIから削除されました。このフィールドは、Atlas APIのレポートスケジュールとしても知られていました。これは、recurrence_valuesに置き換えられました。詳しくは、「詳細測定、レポートスケジュール」をご覧ください。

ビジネス管理

ビジネスマネージャ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

以前作成され、現在既存のイベント広告とリンク広告は引き続き掲載されますが、この変更の適用後に広告素材を変更したり、新しい広告を作成することはできません。エラーが返されます。詳しくは、「イベント広告と近隣エリア広告」、と広告のリファレンスをご覧ください。