広告キャンペーンのアップデート

このページでは、マネージドパートナー広告にオンボーディングしたマネージドパートナー(販売者)の広告キャンペーンをアップデートする際の手順を紹介しています。

必要なアクセス許可

販売者広告アップデートAPIを呼び出すには、以下のアクセス許可が必要です。

  • 販売者のビジネス管理者

ターゲットとするDSA規制地域(欧州連合)

欧州連合(EU)やその関連地域をターゲットとする広告キャンペーンの場合、dsa_payorフィールドとdsa_beneficiaryフィールドが必須になります。これらの2つのフィールドで提供された情報は、その広告のスポンサーと受益者を示すために、エンドユーザーに表示されます。これらのフィールドが指定されていない場合、広告主はMPAキャンペーンを編集できず、APIから以下にリストするエラーコードと共に失敗した場合の応答が返されます。

販売者広告アップデートAPI呼び出し

リクエスト

curl \
  -F 'access_token=<ACCESS_TOKEN>' \
  -F 'asyncbatch=[ 
       { 
         "method": "POST", 
         "relative_url": "act_<ACCOUNT_ID>/managed_partner_ads", 
         "name": "create1", 
         "body": "campaign_group_id=123456789&lifetime_budget=100000" 
       }, 
     ]' \
  "https://graph.facebook.com/v21.0"

このAPI呼び出しに対する応答は、ASYNC_SESSION_IDと共に直ちに返されます。引き続きリクエストが処理される間、[COMPLETED|FAILED]ターミナル状態に達するまで、ASYNC_SESSION_IDがポーリングされます。

パラメーター

名前説明

campaign_group_id

文字列

必須。
アップデートが必要なキャンペーンのID。

campaign_group_status

文字列

任意。
ACTIVEまたはPAUSED

dsa_payor

文字列(最大512文字)

任意。
キャンペーンのスポンサー。


注: このフィールドは、EUやその関連地域をターゲットとするキャンペーンでは必須です。

dsa_beneficiary

文字列(最大512文字)

任意。
キャンペーンの受益者。


注: このフィールドは、EUやその関連地域をターゲットとするキャンペーンでは必須です。

end_time

日時

任意。
広告キャンペーンの新しい終了時間(UTC UNIXタイムスタンプ)。この終了時間は、前の終了時間よりも前になるようにアップデートすることはできません。必ず前の終了時間よりも後になるように指定してください。

lifetime_budget

数値文字列

任意。
キャンペーンの新しい予算(広告アカウントの通貨)。この予算は、前の予算よりも小さくなるようにアップデートすることはできません。必ず、前の予算よりも大きくなるように指定してください。

応答

{
  "async_sessions": [
    {
      "id": "<ASYNC_SESSION_ID>",
      "name": "<ASYNC_SESSION_NAME>"
    }
  ]
}

ASYNC_SESSION_IDを使って、マネージドパートナー広告にオンボーディングされた販売者の対応するIDを取得します。

詳しくは、非同期セッションをポーリングして応答を得る方法をご覧ください。

成功した場合の応答

ステータスがCOMPLETEDの場合、非同期セッションをポーリングした結果得られるデータは次のようになります。

{
  "result": "{\"id\":\"<NEWLY_UPDATED_CAMPAIGN_ID>\",\"success\":true}",
  "id": "<ASYNC_SESSION_ID>"
}

失敗した場合の応答

ステータスがFAILEDの場合、非同期セッションをポーリングした結果得られるデータは次のようになります。

エラーコード

エラーコードエラーサブコード説明

1800700

2310172

この広告セットの費用を負担している人または組織を入力してください。

1800701

2310171

この広告セットから利益を得ている人または組織を入力してください。