ドキュメント

Ads 統合プラットフォームのパブリック API を使用した新しい Unity Dashboard への移行

Manage API (legacy)インテグレーションを Ads 統合プラットフォームのパブリック API に移行すると、プログラム機能を失うことなく本番アカウントを New Unity Dashboard に移動できます。
読み終わるまでの所要時間 27 分最終更新 1ヶ月前

Ads 統合プラットフォーム公開 API は、Manage API の最新バージョンです(古い機能)。これにより、従来のUnity Dashboardエクスペリエンス(非推奨)から新しいUnity Dashboardへの移行を、依存するプログラム機能を失うことなくサポートされます。
移行はお客様主導で行われます。Unityは、移行をリクエストするサポート チケットを送信するまで、組織をNew Unity Dashboardに移動しません。Manage API(古い機能)は、それまでは組織で機能し続けます。Unityは、すべての組織が移行するまでプラットフォーム全体のAPIを廃止予定ではありません。
Manage API(古い機能)を使用してプログラムでエンドポイントを管理する場合は、新しい Unity Dashboard に移行する前に Ads 統合プラットフォームのパブリック API を更新してください。以下の表は、収益化とユーザー獲得のお客様向けのエンドポイントの最新情報を示しています。

ユーザータイプ

ダッシュボード

マネージエンドポイント

パブリッシャー収益化
  • アプリ
  • プレースメント
  • テストデバイス
広告主
ユーザー獲得
  • アトリビューション
  • キャンペーン
  • キャンペーンの管理
  • クリエイティブパック
  • クリエイティブ
重要
移行リクエストを送信し、組織が移行されると、Manage API(古い機能)は組織の作業を即座に停止します。入札や配置の調整など、Manage API(古い機能)に基づいて構築された自動化または継続的な最適化に依存している場合は、移行をリクエストする前に Ads 統合プラットフォームのパブリック API を更新してください。そうしないと、組織がNew Unity Dashboardに移行したときにこれらの自動化の実行が停止し、収益に影響する可能性があります。
統合プラットフォームのパブリック API を使用して New Unity Dashboard に移行するには、以下のワークフローを実行します。

Workflow

Steps

テストと検証
  1. テスト組織 を作成します。
  2. テストサービスアカウント を作成します。
  3. テストアカウントの テスト組織のAPIキーを生成します。
  4. Ads 統合プラットフォームのパブリック API インテグレーションを 検証。
移行リクエストと設定
重要
移行の開始前にテストおよび検証ワークフローを完了する必要があります
  1. API 移行のリクエストと設定。
  2. 移行後 設定を完了します。 a.運用サービスアカウントを作成します。 b.本番 API キー を生成します。 c.本番環境で API コールが機能する ことを確認します。

移行したAPIインテグレーションのテストと検証

新しいダッシュボードボード体験に移行する前に、テスト組織、サービスアカウント、API キーを作成します。このテスト環境を使用して、New ダッシュボード エクスペリエンスで API インテグレーション機能を正しく検証します。

前提条件

Ads 統合プラットフォームのパブリック API の使用を開始する前に、Unity ダッシュボードでダッシュボードの Organization ロールをチーム内の誰かに付与してください。
ユーザー Acquisition (ユーザー獲得) エンドポイントを使用するには、ユーザー Acquisition (ユーザー獲得) ダッシュボードでチームの誰かが Manager (マネージャー) ロールを持っている必要があります。

移行した API インテグレーションをテストする

1

Create a test organization

新しい組織を作成し、Unity Dashboard の古い機能 で Ads 統合プラットフォームのパブリック API インテグレーションをテストするには、以下の手順を実行します。
  1. ダッシュボードの上部のナビゲーションゲーションから、現在の組織を選択し、Switch organization (組織の切り替え) > + New (新規) を選択します。
  2. テスト組織の組織名を入力します。
  3. 組織のタイプを選択し、認証情報を入力します。
  4. Create をクリックします。
2

Create a test service account

古い機能 Unity Dashboard でサービスアカウントを作成し、API 呼び出しを認証します。

Preresuisites

Ads 統合プラットフォームのパブリック API の使用を開始する前に、Unity ダッシュボードでダッシュボードの Organization ロールをチーム内の誰かに付与してください。
古い機能の Unity Dashboard でサービスアカウントを作成するには、以下の行います。
テストサービスアカウントを作成し、広告主固有のロールを追加するには、以下の手順に従います。
  1. ダッシュボードの上部のナビゲーションゲーションから、アカウントの現在の組織 >** Manage organization** を選択し、Organization Settings ページを開きます。
  2. 左のナビゲーションから、「Administration」>「Organization」>「Service Accounts」に移動します。
  3. 「+ New」を選択してテストサービスアカウントを作成します。
  4. テストサービスアカウントの名前と説明を入力し、「Create」をクリックします。 5.作成したテスト サービス アカウント ページで、Organization rolesセクション>+ Manage organization rolesに移動します。 6.「Organization roles(組織の役割)」ダイアログから、「Grow」ドロップダウンに移動し、サービスアカウントに追加するリスト内のすべての広告APIロールを選択します。
3

Generate an API key for your test organziation

サービス アカウントを作成したら、テスト サービス アカウントの Unity Dashboard からリクエストを認証するための API キーを作成します。
API キーを生成する手順は、次のとおりです。
  1. 新しいサービスアカウントの「Keys」セクションに移動します。
  2. 「+ キー追加」を選択してAPIキーを作成します。このキーは、テスト組織からのリクエストを認証します。
重要
ダッシュボードには秘密鍵が 1 回だけ表示されるため、キー ID と秘密鍵は後でのリファレンスのために一緒に安全に保管してください。キー値が失われた場合は、新しいキーを作成する必要があります。
  1. Done を選択します。
4

Validate your Ads Unified Platform public API integration

サービスアカウントを作成し、API キーを生成したら、テスト組織で既存の Manage API (古い機能) ワークフローを複製して、Ads 統合プラットフォームのパブリック API が現在のワークフローをサポートしていることを確認します。
注
Ads 統合プラットフォームの公開 API では、入札プレースメントのみがサポートされます。ウォーターフォールプレースメントは非推奨です。現在のインテグレーションがウォーターフォールプレースメントを管理する場合は、入札に遷移する必要があります。
また、Unity Ads のみが広告プロバイダーの場合は、Unity Ads から LevelPlay に移行します。Unity Adsをメディエーションスタックの一部として使用する場合は、代わりにUnity Adsを入札者として設定します。
可能であれば、現在の本番環境の設定と構成(アプリケーション、プレースメント、キャンペーンなど)をテスト組織内に複製します。ライブ環境をミラーリングすると、パリティの確認が容易になり、移行前に問題を解決できます。
LLM コーディングエージェントを使用して移行を支援する場合は、以下のコーディングエージェントガイドを参照してください。

LLM リファレンス

移行パス

パブリッシャー パブリック API LLM リファレンス
/monetize/v1/…
から
/ads/publisher/public/v1/…
へ
広告主向け公開 API LLM リファレンス
/advertise/v1/…
から
/ads/advertiser/public/v1/…
へ
以下の公開 API リファレンスを参照して、ユースケースを正しくマップしてください。

API移行のリクエストと設定

APIインテグレーションを検証したら、New Unity Dashboardへの移行をリクエストできます。

前提条件

本番アカウントを移行する前に、Ads 統合プラットフォームのパブリック API インテグレーションを検証する必要があります。
1

Request migration to the New Unity Dashboard

テストが完了したら、本番アカウントを New Unity Dashboard に移行します。運用アカウントの移行では、既存の設定 (例えば、アプリケーション、プレースメント、キャンペーン、その他のエンドポイント) と履歴データが New Unity Dashboard に移動します。
Unity Ads サポートチームは、本番アカウントの New Unity Dashboard への移行を監視および管理します。移行を開始する準備ができたら、チケットを送信して移行リクエストを開始します。

Prerequisites

本番アカウントを移行する前に、Ads 統合プラットフォームのパブリック API インテグレーションを検証する必要があります。

Submit a migration request ticket

Unity Ads サポートチームに移行リクエストチケットを送信するには、New Unity Dashboard で以下の手順に従います。
重要
マイグレーションは元に戻せません。移行が完了すると、Manage API (古い機能) は即座に動作を停止し、インテグレーションで Ads 統合プラットフォームのパブリック API が使用されるまで自動化または最適化が停止します。広告配信には影響しません。
  1. Unity サポートポータルにアクセスします。
  2. チケットタイプとして「Migrate to the New ダッシュボード Experience」を選択します。
  3. 名前、組織 ID、組織の役割 (所有者かどうか) など、必要な情報を入力します。
  4. チケットを送信します。 5.サポートによって、移行日時が確認されます。このメッセージの受信を確認する必要があります。確認しないと、移行が続行されません。

Complete post-migration configurations

Unityサポート チームが移行を完了したら、以下の移行後設定タスクを実行する必要があります。
  1. 運用サービスアカウントを作成します。
  2. 本番 API キー を生成します。
  3. アクティブな組織の本番ワークフローで API コールが機能する ことを確認します。
注
設定を古いダッシュボードに戻すことはサポートされていません。新しい API を使用して、すべての修正とデバッグを完了します。
2

Create a production service account

移行後は、Ads 統合プラットフォームのパブリック API 用に、アクティブな組織用の新しいサービスアカウントを作成する必要があります(テスト組織で作成したテストサービスアカウントとは別のアカウント)。新しいサービス アカウントを本番API呼び出しで使用するため、検証済みのAPIワークフローが実際の組織を反映します。
New Unity Dashboard のサービス アカウントを作成するには、次の手順に従います。
ユーザー Acquisition (ユーザー獲得) ダッシュボードからサービスアカウントを作成し、広告主固有のロールを追加するには、以下の手順に従います。
  1. ユーザー Acquisition (ユーザー獲得) ダッシュボード > Settings > Organization > Manage organization > Service accounts > + New の順に移動します。
  2. + Manage organization roles を選択します。
  3. サービスアカウント名とサービスアカウントの説明を入力します。
  4. 作成した新しいサービス アカウント ページで、Organization rolesセクション>+ Manage organization rolesに移動します。 5.「Organization roles(組織の役割)」ダイアログから、「Grow」ドロップダウンに移動し、サービスアカウントに追加するリスト内のすべての広告APIロールを選択します。
3

Generate a production API key

新しいサービスアカウントで、Unity Dashboard からリクエストを認証するための API キーを生成します。キーを生成する手順は、次のとおりです。
  1. 作成した新しいサービス アカウントで、Keys セクションに移動します。
  2. 「+ キー追加」を選択してAPIキーを作成します。これにより、検証済み API ワークフローのキーとテストサービスアカウントが、稼働中の組織に関連付けられた新しい API キーと新しいサービスアカウントに置き換えられます。
重要
ダッシュボードには秘密鍵が 1 回だけ表示されるため、キー ID と秘密鍵は後でのリファレンスのために一緒に安全に保管してください。キー値が失われた場合は、新しいキーを作成する必要があります。
  1. Done を選択します。
4

Confirm API calls work in production

API呼び出しによって、稼働中のアプリケーション、プレースメント、キャンペーン、その他のエンドポイントに対して正しいデータとレスポンスが返されることを確認します。API キーの入れ替えなど、必要な変更を加えて、API 呼び出しをテスト組織ではなく、実際のアクティブな組織に合わせてください。
移行後に API 呼び出しにギャップや予期しない動作が見つかった場合は、古い機能ではなく新しい Ads 統合プラットフォームのパブリック API を使用してデバッグおよび修正してください。
注
設定を古いダッシュボードに戻すことはサポートされていません。新しい API を使用して、すべての修正とデバッグを完了します。
問題の解決や新しいAPIの実装についてヘルプが必要な場合は、アカウント マネージャーまたはUnityサポートに接触してください。