ビジネスマネージャAPIは、他のビジネスに所属するオーディエンスにアクセスする際の明確な役割と責任を確立します。
カスタムオーディエンスがパーティー間で共有されている場合は、まず、ビジネスマネージャ間でパートナーシップ関係を構築する必要があります。これは、ビジネスマネージャのBusiness Settings
の[Partners
]セクションで行います。オーディエンスを共有しているパーティーは、ビジネスマネージャで指定されたカスタムオーディエンスサービス規約に従っていることを確認することも求められます。Facebook、カスタムオーディエンス規約を参照してください。
共有関係が構築されると、ビジネスは別のビジネスマネージャとオーディエンスを共有できるようになります。ただし、オーディエンスは一方向にしか共有できません。つまり、オーディエンスはビジネス#1からビジネス#2に共有されます。ビジネス#2は、ビジネス#2からビジネス#1への別個の共有関係を構築しない限り、自分のオーディエンスをビジネス#1と共有することができません。
2018年以降に、ビジネスマネージャ間でカスタムオーディエンスを共有するには、ビジネスが次のようにオーディエンス共有関係を構築する必要があります。オーディエンスを共有するための関係をリクエストするには、ビジネスマネージャ管理者アクセス許可が必要です。2つのビジネスマネージャ間で既に関係が構築されている場合、広告主は相手のビジネスと直接オーディエンスを共有できます。リファレンス、カスタムオーディエンスとリファレンス、カスタムオーディエンス共有アカウント情報も参照してください。
関係を作成するには、次の呼び出しを特定のcustom_audience_id
に発行します。
POST {custom_audience_id}/adaccounts?adaccounts=[<ad_account_id>]&relationship_type=[<relationship_type>]
リクエストの処理方法は、相手のビジネスとの関係がどのような状況にあるかに応じて変わります。
リクエストに渡された広告アカウントごとに、Facebookからsharing_data
オブジェクトが返されます。以下はその例です。
{ success: true, sharing_data : [ { "ad_acct_id": "<AD_ACCOUNT_ID>" "audience_share_status" : "in progress" "errors" : [] }, ... ] }
このリクエストのオプションとパラメーターを以下に示します。
レベル | 説明 |
---|---|
型: リスト:数値文字列 | オーディエンスを共有する広告アカウントのID。 |
型: リスト:文字列 | 必須。 オーディエンスを所有しているビジネスと、そのオーディエンスを共有する相手である受信側のビジネスの間の関係を表します。適用されるすべての値の配列。 使用可能な値: |
ビジネスマネージャの管理者アクセス許可を持っていないのに、オーディエンスを共有しようとすると、次のようなエラーが表示されます。
[ { "ad_acct_id": "<AD_ACCOUNT_ID>" "audience_share_status" : "not shared" "errors" : [ "You don't have permission to initiate a sharing relationship for this ad account/business" ] } ... ]
リクエストを行っても、受信側の広告アカウントを所有しているビジネスとの間に関係が構築されていなければ、そのビジネスは保留共有オーディエンス関係リクエストを受け取ることになります。このステータスはそのビジネスのビジネスマネージャに表示されます。この時点で、ビジネスは関係リクエストを承認または拒否することができます。
POST <SHARING_RELATIONSHIP_ID>?request_response=approve
成功すると、ビジネスに次の応答が返されます。
{ success: bool }
オプションは次のとおりです。
名前 | 説明 |
---|---|
型: 文字列 | 関係リクエストを受信するビジネスがそのリクエストを承認するか拒否するか。 使用可能な値: |
関係リクエストを受信したビジネスがリクエストを承認したら、そのビジネスとオーディエンスを共有できるようになります。リクエストを実行すると、sharing_data
は次のようになります。
[ { "ad_acct_id": "<AD_ACCOUNT_ID>" "audience_share_status" : "shared" "errors" : [] } ... ]
ビジネスマネージャ管理者が保留関係リクエストでオーディエンスを共有している場合、FacebookはオーディエンスIDに既存の関係を付加します。
[ { "ad_acct_id": "<AD_ACCOUNT_ID>" "audience_share_status" : "in progress" "errors" : [] } ... ]
オーディエンスを共有するためのリクエストでは複数の広告アカウントを指定できるため、応答にはそれぞれのアカウントの結果が含まれます。
[ { "ad_acct_id": "<AD_ACCOUNT_ID>" "audience_share_status" : "shared" "errors" : [] } { "ad_acct_id": "<AD_ACCOUNT_ID>" "audience_share_status" : "in progress" "errors" : [] } { "ad_acct_id": "<AD_ACCOUNT_ID>" "audience_share_status" : "not shared" "errors" : [ "You don't have permission to initiate a sharing relationship for this ad account/business" ] } ... ]
自分のビジネスが受信したオーディエンス共有のリクエストを確認する方法は、次のとおりです。
GET <BUSINESS_ID>/received_audience_sharing_requests?fields=custom_audiences,initiator,recipient,relationship_type,request_status,request_type
応答は次のようになります。
{ "data": [ { "initiator": { "id": "<BUSINESS_ID>", "name": "business_name1" }, "recipient": { "id": "<BUSINESS_ID>", "name": "business_name2" }, "request_status": "IN_PROGRESS", "relationship_type": "[<relationship_type>]", "id": "<SHARING_RELATIONSHIP_ID>", "custom_audiences": [ { "id": "<CUSTOM_AUDIENCE_ID>", "name": "<CUSTOM_AUDIENCE_NAME>", "share_account_name": "<ACCOUNT_NAME>", "share_account_id": "<ACCOUNT_ID>" } ] } ... ], "paging": { "cursors": { "before": "<CURSOR>", "after": "<CURSOR>" } } }
他者とオーディエンスを共有するために自分のビジネスが送信したリクエストを確認する方法は、次のとおりです。
GET <BUSINESS_ID>/initiated_audience_sharing_requests?fields=custom_audiences,initiator,recipient,relationship_type,request_status,request_type
応答は次のようになります。
{ "data": [ { "initiator": { "id": "<BUSINESS_ID>", "name": "business_name1" }, "recipient": { "id": "<BUSINESS_ID>", "name": "business_name2" }, "request_status": "IN_PROGRESS", "relationship_type": "[<relationship_type>]", "id": "<SHARING_RELATIONSHIP_ID>", "custom_audiences": [ { "id": "<CUSTOM_AUDIENCE_ID>", "name": "<CUSTOM_AUDIENCE_NAME>", "share_account_name": "<ACCOUNT_NAME>", "share_account_id": "<ACCOUNT_ID>" } ] } ... ], "paging": { "cursors": { "before": "<CURSOR>", "after": "<CURSOR>" } } }