バージョン自動アップグレードを可能にするための、マーケティングAPIのバージョンの廃止に関する近日行われる変更
全体的なAPIエクスペリエンスをさらにシームレスで効果的なものにして強化するために、マーケティングAPIのバージョンの自動アップグレード機能がまもなくリリースされます。2024年5月より、バージョン間で影響を受けない、マーケティングAPIエンドポイントの自動バージョンアップグレード機能を有効にします。これは廃止されるバージョンと次にリリースされるバージョンの間でエンドポイントに影響がない場合、リクエストがそのまま失敗するのではなく、次の利用可能のバージョンに呼び出しを自動的にアップグレードします。
APIのバージョン管理はAPIの変更を扱う一般的な方法であり、重要な変更を配布する際に使われる最も一般的なものです。新しいバージョンがリリースされると、古いバージョンは廃止されます。APIが廃止中に、アプリが廃止されたAPIバージョンを呼び出した場合、「(#2635) 広告APIの廃止されたバージョンを呼び出しました。最新のバージョンに更新してください: vXXX」というエラーを受け取ります。
2024年5月14日に、v17.0が廃止されます。v18.0の更新履歴によれば、次のエンドポイントが影響を受けます。
- POST /act_{ad-account-id}/reachfrequencypredictions
- GET /act_{ad-account-id}/reachestimate
- GET /act_{ad-account-id}/delivery_estimate
- POST /act_{ad-account-id}/adsets
- POST /{adset-id}
- POST /act_{ad-account-id}/saved_audiences
- POST /{saved-audience-id}
- POST /act_{ad-account-id}/credit_cards
v17.0が2024年5月14日に廃止された後、アプリがPOST /{adset-id}をv17.0を使って呼び出すと、次の利用可能なバージョンv18.0によって影響されるエンドポイントに自動アップグレードが適用されないため、このAPIリクエストは失敗します。
v17.0が廃止された後、アプリがv17.0を使ってGET /{ad-account-id}/insightsを呼び出す場合、プラットフォームは呼び出しを次の利用可能なバージョンv18.0にアップグレードします。
アプリがすでに呼び出しをv17.0より上のバージョンで行っている場合、バージョン廃止日に行われる変更は何もありません。
バージョン自動アップグレードをオプトアウトするには、マーケティングAPIアプリ製品カードの[設定] > [広告APIバージョン設定]を確認して、この機能を無効にしてください。
呼び出しが自動アップグレードされているか確認するには、API応答ヘッダーを調べて詳細を確認してください。
- 通知ヘッダーの例: ‘X-Ad-Api-Version-Warning:‘ The call has been auto-upgraded to v17.0 as v16.0 has been deprecated’’
詳しい動作については、マーケティングAPIのバージョン管理をご覧ください。
各バージョンで影響を受けるエンドポイントを確認するには、更新履歴を参照してください。
影響を受けるエンドポイント
- すべてのマーケティングAPIエンドポイント
開発者ドキュメントへのリンク
機能に関するヘルプ記事へのリンク
