Amazon Developer

as

Settings
Sign out
Notifications
Alexa
Amazonアプリストア
Ring
AWS
ドキュメント
Support
Contact Us
My Cases
開発
設計と開発
公開
リファレンス
サポート
Skip to main content
Vega APSクライアントAPIは、Vega向けReact NativeアプリとAmazon Publisher Services(APS)のネイティブコード実装の連係を可能にするブリッジです。このAPIには、入札リクエストに必要なパラメーターを取得するためのgetDeviceParams()メソッドが用意されています。これらのパラメーターをC2S(クライアントからサーバー)またはS2S(サーバー間)統合経由でAPSに送信し、リクエストを完了します。 このユーザーガイドでは、APSクライアントライブラリのインストール方法とAPIの使用方法について説明します。Amazon Publisher Servicesの概要については、Amazon Publisher Servicesを参照してください。

前提条件

まず、Vega SDKをインストール済みであることと、自身のJavaScriptアプリを作成済みであることを確認してください。さらに、C2SまたはS2Sの統合ガイドに従ってクラウド側のオンボーディングを完了している必要があります。また、ペイロードの作成方法について理解しておくことも必要です。 APSデバイス側APIの使用方法は以下のとおりです。

APSClientLibraryの使用を始める

手順1:パッケージの依存関係をアプリに追加する

ライブラリを、パッケージのpackage.jsonファイルに依存関係として追加します。

手順2:マニフェストファイルを更新する

manifest.tomlファイルを更新して、必要な依存関係を追加します。
  1. components.interactiveには、React Nativeのバージョンに応じた適切なruntime-moduleを含める必要があります。
  2. wants.moduleには、id = "/com.amazon.kepler.apslib@IApsDeviceParametersMap"を含める必要があります。
  3. wants.serviceにはid = "com.amazon.admanager.service.main"を含める必要があります。これはdntパラメーターとifaパラメーターで必要です。
サンプルアプリのmanifest.tomlの例を以下に示します。

手順3:APIをアプリにインポートする

JavaScriptアプリに必要なデバイスパラメーターをインポートします。
ApsClientLibraryAPI.getDeviceParamsは非同期に動作し、awaitまたはthen()コンストラクトと使用できるPromiseを返します。成功すると、Promiseのペイロードとして、必須パラメーターとそれに対応する値のマッピングを含むApsDeviceParametersMapが返されます。エラーが発生した場合、Promiseは拒否され、エラーメッセージが表示されます。 この関数では、アプリの読み込み時に呼び出し、戻り値をキャッシュすることが推奨されます。以下のコード例は、then()コンストラクトを使用して成功とエラーの両方のケースを処理する方法を示しています。 この例では、C2S統合の代わりに、S2S統合でApsIntegrationType.c2sを渡すことを想定しています。 次のコードサンプルは、then()コンストラクトを使用して成功ケースとエラーケースの両方を処理する方法を示しています。

手順4:必須パラメーターを確認する

デバイスパラメーターのほかに、サーバーに送信されたHTTPリクエストからIPを取得し、リクエストペイロードの一部として含める必要があります。詳細については、「必須パラメーター」の表を参照してください。

必須パラメーター

パラメーター説明IntegrationType: S2SIntegrationType: C2SこのAPIにより提供
h画面の物理的な高さ(ピクセル単位)。○○○
w画面の物理的な幅(ピクセル単位)。○○○
dntブラウザによってヘッダーに設定された標準の「Do Not Track」フラグ。0=トラッキングに制限なし、1=トラッキング禁止。○○○
ifaデバイスの広告ID。○○○
uaデバイスのユーザーエージェント(文字列)。○○○
makeデバイスの製造元(Amazonなど)。○○○
languageISO-639-1-alpha-2で定義されるデバイスの言語。○○○
modelデバイスのモデル(AFTTなど)。○○○
osデバイスのオペレーティングシステム(Androidなど)。○×○
osvデバイスのオペレーティングシステムのバージョン(5.1.1など)。○×○
ipデバイスに最も近いIPv4アドレス(パブリックIP)(204.78.58.34など)。○××(S2S向けの注: IPはサーバーに送信されたHTTPSリクエストから取得します)

手順5:ペイロードを完成させる

HeaderBiddingリクエストのJSONペイロードの作成を完了し、C2SまたはS2Sの統合ガイドに従って、残りのクラウドとのやり取りの後にHTTPSリクエストを作成します。

アプリのビルドとインストール

アプリのビルド

この例では、mykeplerappという名前のアプリを使用しています。 手順1:アプリの依存関係をインストールします。
手順2:.vpkgファイルを生成します。

パッケージのインストール

パッケージをインストールして実行します。

アプリのインストールと起動

APIリファレンス

クラス

インターフェイス

列挙型

  • ApsIntegrationType - AmazonがAPS統合用にパブリッシャーに提供している型。

型エイリアス

関数

変数

最終更新日 2026年10月26日