# Unity Ads Android SDK API リファレンス

> Unity Ads SDK 公開 API リファレンスにアクセスして、Java で使用可能なクラス、メソッド、プロパティを表示し、Android アプリケーションの広告動作を統合したり、コントロールしたりします。

この記事は以下の API ドキュメントを含んでいます。

**クラス**

* [`UnityAds`](#unityads)
* [`UnityAdsLoadOptions`](#unityadsloadoptions)
* [`BannerView`](#bannerview)
* [`UnityBannerSize`](#unitybannersize)

**列挙型**

* [`PlacementState`](#placementstate)
* [`FinishState`](#finishstate)
* [`UnityAdsInitializationError`](#unityadsinitializationerror)
* [`UnityAdsLoadError`](#unityadsloaderror)
* [`UnityAdsShowError`](#unityadsshowerror)
* [`UnityAdsShowCompletionState`](#unityadsshowcompletionstate)
* [`UnityAdsError`](#unityadserror)

**インターフェース**

* [`IUnityAdsInitializationListener`](#iunityadsinitializationlistener)
* [`IUnityAdsLoadListener`](#iunityadsloadlistener)
* [`IUnityAdsShowListener`](#iunityadsshowlistener)

## クラス##classes

### UnityAds##unityads

この名前空間は、動画リワード広告、非リワード型動画広告、バナー広告などの [インタースティシャル広告コンテンツを実装する](/grow/ads/android-sdk/interstitial-ads.md) ために使用します。

#### initialize##initialize

```java
initialize(final Context context, final String gameId, final boolean testMode, final IUnityAdsInitializationListener initializationListener)
```

指定された [ゲーム ID](/grow/dashboard/get-started/project/settings.md#game-ids)、[テストモード](/grow/ads/optimization/test-ads-integration.md) のステータス、初期化リスナーを使用して、広告サービスを初期化します。

| パラメーター                   | 説明                                                                                                                  |
| ------------------------ | ------------------------------------------------------------------------------------------------------------------- |
| `context`                | 現在の Android [`Context`](https://developer.android.com/reference/android/content/Context)。                           |
| `gameId`                 | プラットフォーム固有のプロジェクトの Unity ゲーム識別子。[Unity の収益化ダッシュボード](https://cloud.unity.com/monetization) から見つけることができます。            |
| `testMode`               | テストモードを使用すると、実際の広告を表示することなく、インテグレーションをテストできます。`true` を使用してテストモードで初期化します。                                            |
| `initializationListener` | 任意で [`IUnityAdsInitializationListener`](#iunityadsinitializationlistener) コールバックを使用して SDK を有効にします (バージョン 3.7.0 以降)。 |

#### load##load

```java
public static void load(final String adUnitId, final UnityAdsLoadOptions loadOptions, final IUnityAdsLoadListener listener)
```

指定された広告ユニットの広告コンテンツをロードします。[`show`](#show) を呼び出す前に、`load` を呼び出す必要があります。

| **パラメーター**    | **説明**                                                                                            |
| ------------- | ------------------------------------------------------------------------------------------------- |
| `adUnitId`    | 広告コンテンツと共にロードする広告ユニットの識別子。                                                                        |
| `loadOptions` | 広告の動作を変更するオプションのコレクション。                                                                           |
| `listener`    | 任意で [`IUnityAdsLoadListener`](#iunityadsloadlistener) コールバックを使用して広告コンテンツをロードします (バージョン 3.7.0 以降)。 |

#### show##show

```java
public static void show(final Activity activity, final String adUnitId, final UnityAdsShowOptions options, final IUnityAdsShowListener showListener)
```

指定した広告ユニットにロードされた広告コンテンツを表示します。

| パラメーター         | 説明                                                                                             |
| -------------- | ---------------------------------------------------------------------------------------------- |
| `activity`     | 現在の Android [`Activity`](https://developer.android.com/reference/android/app/Activity)。        |
| `adUnitId`     | 表示する広告ユニットの識別子。                                                                                |
| `options`      | 広告の動作を変更する [オプション](#unityadsloadoptions) のコレクション。                                              |
| `showListener` | 任意で [`IUnityAdsShowListener`](#iunityadsshowlistener) コールバックを使用してコンテンツを表示します (バージョン 3.7.0 以降)。 |

#### addListener##addlistener

> **Important:**
>
> SDK バージョン 4.0 で削除されました。詳細については、非推奨の API クラス を参照してください。

```java
public static void addListener(IUnityAdsListener listener)
```

Unity Ads コールバックを受け取るリスナーを追加します。バージョン 3.1.0 以降では、複数のリスナーを登録できます。これは [メディエーション](/grow/ads/mediation/unity-ads-in-mediation.md) の顧客にとって特に便利です。

| **パラメーター** | **説明**                 |
| ---------- | ---------------------- |
| `listener` | Unity Ads コールバックのリスナー。 |

#### removeListener##removelistener

> **Important:**
>
> SDK バージョン 4.0 で削除されました。詳細については、非推奨の API クラス を参照してください。

```java
public static void removeListener(IUnityAdsListener listener)
```

アクティブな `IUnityAdsListener` を削除します。

| **パラメーター** | **説明**                 |
| ---------- | ---------------------- |
| `listener` | Unity Ads コールバックのリスナー。 |

#### getVersion##getversion

```java
public static String getVersion()
```

現在の Unity Ads SDK のバージョンを返します。

#### getPlacementState##getplacementstate

```java
public static PlacementState getPlacementState(String adUnitId)
```

指定された広告ユニットの [状態](#placementstate) を返します。

| **パラメーター** | **説明**              |
| ---------- | ------------------- |
| `adUnitId` | クエリを実行する広告ユニットの識別子。 |

#### setDebugMode##setdebugmode

```java
public static void setDebugMode(boolean debugMode)
```

SDK からのログ出力数を制御します。より堅実にログを残すには、`true` に設定します。

#### getDebugMode##getdebugmode

```java
public static boolean getDebugMode()
```

SDK がデバッグモードである場合は `true` を返します。

#### isInitialized##isinitialized

```java
public static boolean isInitialized()
```

SDK が正常に初期化された場合は `true`、それ以外の場合は `false` を返します。

#### isSupported##issupported

```java
public static bool isSupported()
```

SDK が現在のプラットフォームでサポートされる場合は `true`、それ以外の場合は `false` を返します。

### UnityAdsLoadOptions##unityadsloadoptions

```java
public class UnityAdsLoadOptions extends UnityAdsBaseOptions
```

このクラスには、[`load`](#load) メソッドに追加する任意のメタデータが含まれています。サードパーティのメディエーションのヘッダー入札を使用しているお客様は、Unity ネットワークからの入札者が広告オークションで落札した場合にこれを使用する必要があります。

#### setAdMarkup##setadmarkup

```java
public void setAdMarkup(String adMarkup)
```

このメソッドは、入札者サービスから返される広告マークアップを取得します。Unity の広告ネットワークからの入札者がヘッダー入札オークションで落札すると、Unity Ads SDK はメディエーションエクスチェンジから広告マークアップを受け取ります。広告マークアップ文字列には、Unity が広告をロードおよび表示するために必要な情報が含まれています。

#### setObjectId##set-ad-markup

```java
public void setObjectId(String objectId)
```

このメソッドは、ロードされた広告オブジェクト ID を、表示する広告オブジェクト ID として設定します。

### BannerView##bannerview

```java
public BannerView(Activity activity, String adUnitId, UnityBannerSize size)
```

| **パラメーター** | **説明**                                                                                  |
| ---------- | --------------------------------------------------------------------------------------- |
| `activity` | 現在の Android [`Activity`](https://developer.android.com/reference/android/app/Activity)。 |
| `adUnitId` | 表示する広告ユニットの識別子。                                                                         |
| `size`     | バナーオブジェクトの [`size`](#unitybannersize)。                                                  |

#### getPlacementId##getplacementid

```java
public String getPlacementId()
```

バナー広告ユニットの広告ユニット ID を返します。

#### getSize##getsize

```java
public UnityBannerSize getSize()
```

バナーの [`size`](#unitybannersize)。

#### setListener##setlistener

```java
public void setListener(IListener listener)
```

バナーのアクティブリスナーを設定します。

#### getListener##getlistener

```java
public IListener getListener()
```

バナーのアクティブリスナーを取得します。

#### load##bannerload

```java
public void load()
```

バナーに広告をリクエストするための基本メソッドです。

#### destroy##destroy

```java
public void destroy()

```

不要になったバナーをビュー階層から削除するには、このメソッドを呼び出します。

### UnityBannerSize##unitybannersize

```java
public UnityBannerSize(int width, int height)
```

このクラスを使用して、[バナーオブジェクト](#bannerview) の高さと幅を定義します。

#### getWidth##getwidth

```java
public int getWidth()
```

[バナーオブジェクト](#bannerview) の幅をピクセル単位で返します。

#### getHeight##getheight

```java
public int getHeight()
```

[バナーオブジェクト](#bannerview) の高さをピクセル単位で返します。

## 列挙型##enums

### PlacementState##placementstate

広告ユニットの状態を表す列挙型。

| 値               | 説明                        |
| --------------- | ------------------------- |
| `READY`         | 広告ユニットは広告を表示できる状態になっています。 |
| `NOT_AVAILABLE` | 広告ユニットは利用できません。           |
| `DISABLED`      | 広告ユニットは無効になっています。         |
| `WAITING`       | 広告ユニットは準備中です。             |
| `NO_FILL`       | 広告ユニットには表示する広告がありません。     |

### FinishState##finishstate

ユーザーと広告とのインタラクションの状態を表す列挙型。広告が完了すると、SDK がこの値を [`onUnityAdsDidFinish`](#onunityadsdidfinish) コールバックメソッドに渡します。

| 値           | 説明                                       |
| ----------- | ---------------------------------------- |
| `ERROR`     | Unity サービスのエラーにより広告を最後まで表示できなかったことを示します。 |
| `SKIPPED`   | ユーザーが広告をスキップしたことを示します。                   |
| `COMPLETED` | ユーザーが最後まで広告を見たことを示します。                   |

### UnityAdsInitializationError##unityadsinitializationerror

SDK の初期化に失敗した理由を表す列挙型です。

| 値                     | 説明                                                     |
| --------------------- | ------------------------------------------------------ |
| `INTERNAL_ERROR`      | 環境または内部サービスが原因でエラーが発生しました。                             |
| `INVALID_ARGUMENT`    | [`initialize`](#initialize) メソッド内の無効な引数が原因でエラーが発生しました。 |
| `AD_BLOCKER_DETECTED` | URL がブロックされたことが原因でエラーが発生しました。                          |

### UnityAdsShowCompletionState##unityadsshowcompletionstate

広告が終了した原因を表す列挙型です。

| 値           | 説明                                                                |
| ----------- | ----------------------------------------------------------------- |
| `SKIPPED`   | ユーザーが広告をスキップしたことを示します。                                            |
| `COMPLETED` | 広告が最後まで再生されたことを示します。これは一般的にユーザーが広告全体を視聴したことで報酬を受け取ることができることを示します。 |

### UnityAdsLoadError##unityadsloaderror

広告ユニットのロードが失敗した理由を表す列挙型。

| **値**               | **説明**                                       |
| ------------------- | -------------------------------------------- |
| `INITIALIZE_FAILED` | SDK が初期化されていないことによって広告のロードに失敗しました。           |
| `INTERNAL_ERROR`    | Unity Ads の内部サービスエラーによって広告のロードに失敗しました。       |
| `INVALID_ARGUMENT`  | [`load`](#load) メソッド内の無効な引数により広告のロードに失敗しました。 |
| `NO_FILL`           | ネットワークに利用可能なコンテンツがなかったため広告のロードに失敗しました。       |
| `TIMEOUT`           | 指定の時間内に広告をロードできませんでした。                       |

### UnityAdsShowError##unityadsshowerror

広告ユニットの表示に失敗した理由を表す列挙型。

| 値                    | 説明                                          |
| -------------------- | ------------------------------------------- |
| `NOT_INITIALIZED`    | SDK が初期化されていなかったため広告の表示に失敗しました。             |
| `NOT_READY`          | 広告ユニットの準備ができていなかったため広告の表示に失敗しました。           |
| `VIDEO_PLAYER_ERROR` | メディアプレイヤーのエラーにより広告の表示に失敗しました。               |
| `INVALID_ARGUMENT`   | [`show`](#show) メソッド内の無効な引数により広告の表示に失敗しました。 |
| `NO_CONNECTION`      | インターネット接続エラーにより広告の表示に失敗しました。                |
| `ALREADY_SHOWING`    | 広告がすでに表示されていたため広告の表示に失敗しました。                |
| `INTERNAL_ERROR`     | Unity Ads の内部サービスエラーによって広告の表示に失敗しました。       |

### UnityAdsError##unityadserror

```java
...
```

追加に失敗した理由を表す列挙型です。

## インターフェース##interfaces

### IUnityAdsInitializationListener##iunityadsinitializationlistener

```java
void onInitializationComplete();
void onInitializationFailed(UnityAds.UnityAdsInitializationError error, String message);
```

このインターフェースは、[`initialize`](#initialize) の結果をハンドルするために実装します。

#### onInitializationComplete##oninitializationcomplete

このコールバックメソッドは、SDK が問題なく初期化されたときのロジックをハンドルします。

#### onInitializationFailed##oninitializationfailed

このコールバックメソッドは、SDK の初期化が失敗したときのロジックをハンドルします。

| パラメーター    | 説明                                                                           |
| --------- | ---------------------------------------------------------------------------- |
| `error`   | 初期化の失敗の原因となった [`UnityAdsInitializationError`](#unityadsinitializationerror)。 |
| `message` | エラーに関連するメッセージです。                                                             |

### IUnityAdsLoadListener##iunityadsloadlistener

```java
void onUnityAdsAdLoaded(String placementId);
void onUnityAdsFailedToLoad(String placementId, UnityAds.UnityAdsLoadError error, String message);
```

このインターフェースは、[`load`](#load) の結果をハンドルするために実装します。

#### onUnityAdsAdLoaded##onunityadsadloaded

このコールバックメソッドは、広告ユニットが正常にロードされたときのロジックを処理します。

| パラメーター     | 説明                     |
| ---------- | ---------------------- |
| `adUnitId` | コンテンツをロードした広告ユニットの識別子。 |

#### onUnityAdsFailedToLoad##onunityadsfailedtoload

このコールバックメソッドは、広告ユニットのロードが失敗したときのロジックを処理します。

| パラメーター     | 説明                                                      |
| ---------- | ------------------------------------------------------- |
| `adUnitId` | コンテンツのロードに失敗した広告ユニットの識別子。                               |
| `error`    | ロード失敗の原因となった [`UnityAdsLoadError`](#unityadsloaderror)。 |
| `message`  | エラーに関連するメッセージです。                                        |

### IUnityAdsShowListener##iunityadsshowlistener

```java
void onUnityAdsShowFailure(String placementId, UnityAds.UnityAdsShowError error, String message);
void onUnityAdsShowStart(String placementId);
void onUnityAdsShowClick(String placementId);
UnityAds.UnityAdsShowCompletionState state;
```

このインターフェースは、[`show`](#show) の結果をハンドルするために実装します。

#### onUnityAdsShowFailure##onunityadsshowfailure

このコールバックメソッドは、広告ユニットの表示が失敗したときのロジックを処理します。

| パラメーター     | 説明                                                     |
| ---------- | ------------------------------------------------------ |
| `adUnitId` | コンテンツの表示に失敗した広告ユニットの識別子。                               |
| `error`    | 表示失敗の原因となった [`UnityAdsShowError`](#unityadsshowerror)。 |
| `message`  | エラーに関連するメッセージです。                                       |

#### onUnityAdsShowStart##onunityadsshowstart

このコールバックメソッドは、広告再生開始時のロジックをハンドルします。

| パラメーター     | 説明                      |
| ---------- | ----------------------- |
| `adUnitId` | コンテンツを表示している広告ユニットの識別子。 |

#### onUnityAdsShowClick##onunityadsshowclick

このコールバックメソッドは、ユーザーが広告をクリックしたときのロジックをハンドルします。

| パラメーター     | 説明                      |
| ---------- | ----------------------- |
| `adUnitId` | コンテンツを表示している広告ユニットの識別子。 |

#### onUnityAdsShowComplete##onunityadsshowcomplete

このコールバックメソッドは、広告視聴終了時のロジックをハンドルします。

| パラメーター                                                | 説明                        |
| ----------------------------------------------------- | ------------------------- |
| `adUnitId`                                            | コンテンツを表示している広告ユニットの識別子。   |
| [`showCompletionState`](#unityadsshowcompletionstate) | 広告がスキップされたか、完全視聴したかを示します。 |

#### onUnityAdsReady##onunityadsready

> **Important:**
>
> SDK バージョン 4.0 で削除されました。詳細については、非推奨の API クラス を参照してください。

指定された広告ユニットを通じて表示する広告コンテンツの準備ができているときのロジックを指定します。

| パラメーター     | 説明                  |
| ---------- | ------------------- |
| `adUnitId` | 準備ができている広告ユニットの識別子。 |

#### onUnityAdsDidError##onunityadsdiderror

> **Important:**
>
> SDK バージョン 4.0 で削除されました。詳細については、非推奨の API クラス を参照してください。

エラーによって広告コンテンツの表示に失敗したときのロジックを指定します。

| パラメーター                    | 説明                  |
| ------------------------- | ------------------- |
| [`error`](#unityadserror) | 広告視聴失敗の原因となったエラーです。 |
| `message`                 | エラーに関連するメッセージです。    |

#### onUnityAdsDidStart##onunityadsdidstart

> **Important:**
>
> SDK バージョン 4.0 で削除されました。詳細については、非推奨の API クラス を参照してください。

プレイヤーが広告の表示をトリガーしたときのロジックを指定します。

| パラメーター     | 説明                   |
| ---------- | -------------------- |
| `adUnitId` | 広告を表示している広告ユニットの識別子。 |

#### OnUnityAdsDidFinish##onunityadsdidfinish

> **Important:**
>
> SDK バージョン 4.0 で削除されました。詳細については、非推奨の API クラス を参照してください。

プレイヤーが広告を最後まで見たときのロジックを指定します。

| パラメーター     | 説明                                            |
| ---------- | --------------------------------------------- |
| `adUnitId` | 表示が完了した広告ユニットの識別子。                            |
| `result`   | 表示している広告の [結果として生成されたユーザーイベント](#finishstate)。 |

### IListener##ilistener

```java
String mObjectId = UUID.randomUUID().toString();
void onBannerLoaded(BannerView bannerAdView);
void onBannerShown(BannerView bannerAdView);
void onBannerClick(BannerView bannerAdView);
void onBannerFailedToLoad(BannerView bannerAdView, BannerErrorInfo errorInfo);
void onBannerLeftApplication(BannerView bannerView);
```

#### onBannerLoaded##onbannerloaded

このコールバックは、バナーが広告のロードを終了したときに呼び出されます。ビューパラメーターは、ビュー階層に挿入されるバナーを参照します。

| パラメーター         | 説明                               |
| -------------- | -------------------------------- |
| `bannerAdView` | ロードされた [バナーオブジェクト](#bannerview)。 |

#### onBannerClick##onbannerclick

このコールバックはバナーがクリックされたときに呼び出されます。

| パラメーター         | 説明                               |
| -------------- | -------------------------------- |
| `bannerAdView` | ロードされた [バナーオブジェクト](#bannerview)。 |

#### onBannerError##onbannererror

このコールバックはバナー表示時にエラーが発生したときに呼び出されます。

| パラメーター         | 説明                               |
| -------------- | -------------------------------- |
| `bannerAdView` | ロードされた [バナーオブジェクト](#bannerview)。 |
| `errorInfo`    | バナーのロードエラーについての情報を含んでいるクラスです。    |

#### onBannerLeftApplication##onbannerleftapplication

このコールバックはバナーがアプリ外部へリンクするときに呼び出されます。

| パラメーター         | 説明                               |
| -------------- | -------------------------------- |
| `bannerAdView` | ロードされた [バナーオブジェクト](#bannerview)。 |