# Unity Ads iOS SDK API リファレンス (Objective-C)

> Unity Ads SDK のパブリック API リファレンスにアクセスして、Objective-C で使用可能なクラス、メソッド、プロパティをビューし、iOS アプリケーションの広告動作を統合およびコントロールできます。

Unity Ads iOS アプリケーションに Unity Ads を統合する際には、Objective-C の Unity Ads iOS SDK API に関するこのリファレンスを参照してください。

このAPIを使用する前に、アプリケーションでMonetizationを有効にするために`UnityAds`ライブラリをインポートしていることを確認してください。詳細については、[UnityAds ライブラリのインポート](/ads-ios/4.19.0/sdk-integration/import-library.md) を参照してください。

## クラス##classes

## UADSBannerAd##uadsbannerad

`UADSBannerAd` クラスはバナー広告のロードと表示を管理します。

### ロード：完了：＿##load:completion:\_

1. **Objective-C**

   ```objective-c
   @interface UADSBannerAd :NSObject
   + (void)ロード:(UADSBannerLoadConfiguration * _Nonnull)config
     completion:(void (^ _Nonnull)(UADSBannerAd * _Nullable, id<UnityAdsError> _Nullable))completion;
   @end
   ```

指定した設定のバナー広告をロードします。

| **Parameters** | **説明**                                                                                      |
| -------------- | ------------------------------------------------------------------------------------------- |
| configuration  | バナー広告をロードするためのオプション。                                                                        |
| completion     | バナーがロードされたときに呼び出されるコールバック。成功した場合はロードされた BannerAd インスタンスを返し、ロードに失敗した場合は UnityAdsError を返します。 |

### ビュー##view

1. **Objective-C**

   ```objective-c
   @interface UADSBannerAd :NSObject
   @プロパティ （nonatomic、readonly、strong） UIView * ＿Nonnull ビュー；
   @end
   ```

バナー広告インスタンスへのアクセスを提供するビュープロパティ。このプロパティを使用して、アプリケーションの既存のビュー階層内の目的の場所にバナー広告を挿入します。

### UADSBannerView##uadsbannerview

> **Warning:**
>
> **バージョン 4.19.0 で非推奨になりました。バージョン 5.0.0 で削除予定**
>
> 代わり[に `UADSBannerAd`](/ads-ios/4.19.0/sdk-integration/api/ios-api-objc.md#uadsbannerad) を使用してください。移行の詳細については、[iOS 非推奨 API](/ads-ios/4.19.0/sdk-integration/api/ios-deprecated-apis.md) を参照してください。

`UADSBannerView` はバナー広告をロードおよび表示するための前のクラスです。

### UADSBannerViewDelegate##uadsbannerviewdelegate

> **Warning:**
>
> **バージョン 4.19.0 で非推奨になりました。バージョン 5.0.0 で削除予定**
>
> 代わり[に `UADSBannerAdDelegate`](/ads-ios/4.19.0/sdk-integration/api/ios-api-objc.md#uadsbanneraddelegate) を使用してください。移行の詳細については、[iOS 非推奨 API](/ads-ios/4.19.0/sdk-integration/api/ios-deprecated-apis.md) を参照してください。

`UADSBannerViewDelegate` はバナー広告イベントを処理するための以前のデリゲートプロトコルです。

## UADSBannerLoadConfiguration##uadsbannerloadconfiguration

`UADSBannerLoadConfiguration` クラスはバナー広告のロードに必要なオプションをカプセル化します。これには、配置 ID、バナーサイズ、任意の広告マークアップ、任意デリゲート、その他のパラメータの指定が含まれます。

1. **Objective-C**

   ````objective-c
   @interface BannerLoadConfiguration :NSObject
   @プロパティ （非アトミック、強） NSString *placementId;
   @プロパティ （nonatomic、strong、nullable） NSString *adMarkup;
   @プロパティ （非アトミック、割り当て） CGSize bannerSize;
   @プロパティ （非アトミック、弱、null 可能） id<UADSBannerAdDelegate> デリゲート； @プロパティ （非アトミック、強、null 可能） NSString *mediationAdUnitId； @プロパティ （非アトミック、強、null 可能） MediationInfo *mediationInfo； @プロパティ （非アトミック、強） NSDictionary<nsstring *, nsstring *>
   *extras; @end ```
   </Tab>
   </Tabs>

   <Table>
   <TableHeader>
   <TableRow>
     <TableHeaderCell>**Property**</TableHeaderCell>
     <TableHeaderCell>**説明**</TableHeaderCell>
     <TableHeaderCell>**必須**</TableHeaderCell>
   </TableRow>
   </TableHeader>

   <TableBody>
   <TableRow>
     <TableCell>`placementId`</TableCell>
     <TableCell>Unity 収益化ダッシュボードで定義された配置 ID。</TableCell>
     <TableCell>はい</TableCell>
   </TableRow>

   <TableRow>
     <TableCell>`adMarkup`</TableCell>
     <TableCell>入札を通じて広告をロードするときに使用される広告マークアップデータ。</TableCell>
     <TableCell>いいえ</TableCell>
   </TableRow>

   <TableRow>
     <TableCell>`bannerSize`</TableCell>
     <TableCell>バナー広告のサイズ。</TableCell>
     <TableCell>はい</TableCell>
   </TableRow>

   <TableRow>
     <TableCell>`delegate`</TableCell>
     <TableCell>バナー広告イベントをハンドルするデリゲート。</TableCell>
     <TableCell>はい</TableCell>
   </TableRow>

   <TableRow>
     <TableCell>`mediationAdUnitId`</TableCell>
     <TableCell>メディエーションパートナーのダッシュボードで定義された広告単位または配置 ID。</TableCell>
     <TableCell>いいえ</TableCell>
   </TableRow>

   <TableRow>
     <TableCell>`mediationInfo`</TableCell>
     <TableCell>メディエーションインテグレーションの詳細を指定します。</TableCell>
     <TableCell>いいえ</TableCell>
   </TableRow>

   <TableRow>
     <TableCell>`extras`</TableCell>
     <TableCell>追加のカスタム キーと値のペア。</TableCell>
     <TableCell>いいえ</TableCell>
   </TableRow>
   </TableBody>
   </Table>

   ## UADSBannerLoadConfigurationBuilder##uadsbannerloadconfigurationbuilder

   `UADSBannerLoadConfigurationBuilder` を使用して、`UADSBannerLoadConfiguration` クラスのインスタンスを作成し、返します。

   ### initWithPlacementId:adMarkup:bannerSize:delegate##initwithplacementid:admarkup:bannersize:delegate

   <Tabs>
   <Tab title="Objective-C">
   ```objective-c
   - (null でないインスタンスタイプ)initWithPlacementId:(NSString * _Nonnull)placementId
                                    bannerSize:(CGSize)bannerSize
                                      デリゲート:(id <UADSBannerAdDelegate> _Nonnull)デリゲート;
   ````

`BannerLoadConfigurationBuilder` の新しいインスタンスを作成します。

| **Property**  | **説明**                       | **必須** |
| ------------- | ---------------------------- | ------ |
| `placementId` | Unity 収益化ダッシュボードで定義された配置 ID。 | はい     |
| `bannerSize`  | バナー広告のサイズ。                   | はい     |
| `delegate`    | バナー広告イベントをハンドルするデリゲート。       | はい     |

**戻り値**：`UADSBannerLoadConfigurationBuilder` のインスタンス

### withAdMarkup:\_##withadmarkup:\_

1. **Objective-C**

   ```objective-c
   - (null 以外のインスタンスタイプ)withAdMarkup:(NSString * _Nonnull)adMarkup
   ```

adMarkup を`UADSBannerLoadConfigurationBuilder`に追加します。

| **パラメーター** | **説明**                             |
| ---------- | ---------------------------------- |
| adMarkup   | 入札を通じて広告をロードするときに使用される広告マークアップデータ。 |

### withMediationAdUnitId:\_##withmediationadunitid:\_

1. **Objective-C**

   ```objective-c
   - (nonnull instancetype)withMediationAdUnitId:(NSString * _Nonnull)mediationAdUnitId
   ```

メディエーション広告単位 ID を`UADSBannerLoadConfigurationBuilder`に追加します。

| **パラメーター**        | **説明**                                   |
| ----------------- | ---------------------------------------- |
| mediationAdUnitId | メディエーションパートナーのダッシュボードで定義された広告単位または配置 ID。 |

**戻り値**：更新された `UADSBannerLoadConfigurationBuilder` インスタンス。

### withMediationInfo:\_##withmediationinfo:\_

1. **Objective-C**

   ```objective-c
   - (null でないインスタンスタイプ)withMediationInfo:(UADSMediationInfo * _Nonnull)info
   ```

メディエーション情報を`UADSBannerLoadConfigurationBuilder`に追加します。

| **パラメーター**    | **説明**                                         |
| ------------- | ---------------------------------------------- |
| mediationInfo | メディエーションのインテグレーションに関する詳細（名前、バージョン、アダプタのバージョン）。 |

**戻り値**：更新された UADSBannerLoadConfigurationBuilder インスタンス

### withExtras:\_##withextras:\_

1. **Objective-C**

   ```objective-c
   - (nonnull instancetype)withExtras:(NSDictionary<NSString *, NSString *> * _Nonnull)extras
   ```

余分なキーと値のパラメータを`UADSBannerLoadConfigurationBuilder`に追加します。

| **パラメーター** | **説明**              |
| ---------- | ------------------- |
| extras     | バナー ロードのカスタム パラメータ。 |

**戻り値**：更新された `UADSBannerLoadConfigurationBuilder` インスタンス。

### ビルド /build##build

1. **Objective-C**

   ```objective-c
   - (UADSBannerLoadConfiguration * _Nonnull)ビルド
   ```

`UADSBannerLoadConfiguration` インスタンスをビルドして返します。

**戻り値**：`UADSBannerLoadConfiguration` のインスタンス

### UADSBannerLoadOptions##uadsbannerloadoptions

> **Warning:**
>
> **バージョン 4.19.0 で非推奨になりました。バージョン 5.0.0 で削除予定**
>
> 代わり[に`UADSBannerLoadConfiguration`](/ads-ios/4.19.0/sdk-integration/api/ios-api-objc.md#uadsbannerloadconfiguration)と[`UADSBannerLoadConfigurationBuilder`](/ads-ios/4.19.0/sdk-integration/api/ios-api-objc.md)を使用します。移行の詳細については、[iOS 非推奨 API](/ads-ios/4.19.0/sdk-integration/api/ios-deprecated-apis.md) を参照してください。

`UADSBannerLoadOptions` はバナー ロード オプションを指定するための前のクラスです。

## UADSInitializationConfiguration##uadsinitializationconfiguration

1. **Objective-C**

   ```objective-c
   @interface UADSInitializationConfiguration: NSObject
   @property (nonatomic, strong) NSString *gameId;
   @property (nonatomic, assign) BOOL isTestModeEnabled;
   @property (nonatomic, assign) UADSLogLevel logLevel;
   @property (nonatomic, strong, nullable) UADSMediationInfo *mediationInfo;
   @property (nonatomic, strong) NSDictionary<NSString *, NSString *> *extras;
   @end
   ```

`UADSInitializationConfiguration` クラスは、Unity Ads SDK の初期化に必要なアプリケーションに関する重要な情報で構成される オブジェクトを作成します。

| **Property**        | **型**                                          | **説明**                      | **必須** |
| ------------------- | ---------------------------------------------- | --------------------------- | ------ |
| `gameId`            | `NSString *`                                   | Unity プロジェクトの一意の識別子。        | はい     |
| `isTestModeEnabled` | `BOOL`                                         | テスト モードを有効または無効にします。        | いいえ    |
| `logLevel`          | `UADSLogLevel`                                 | ログ出力の詳細レベルを指定します。           | いいえ    |
| `mediationInfo`     | `UADSMediationInfo * _Nullable`                | メディエーションインテグレーションの詳細を指定します。 | いいえ    |
| `extras`            | `NSDictionary&lt;NSString *, NSString *&gt; *` | カスタム設定の追加のキーと値のペア。          | いいえ    |

## UADSInitializationConfigurationBuilder##uadsinitializationconfigurationbuilder

`UADSInitConfigurationBuilder` を使用して、`UADSInitializationConfiguration` クラスのインスタンスを作成し、返します。

### initWithgameID:\_##initwithgameid:\_

1. **Objective-C**

   ```objective-c
   - (非 null インスタンスタイプ)initWithGameId:(NSString * _Nonnull)gameId
   ```

`UADSInitConfigurationBuilder` の新しいインスタンスを作成します。

| **パラメーター** | **説明**                                             |
| ---------- | -------------------------------------------------- |
| gameId     | Unity Ads 管理ツールまたは Unity エディターによって与えられるゲームの一意の識別子。 |

**戻り値**：`UADSInitConfigurationBuilder` のインスタンス

### withTestMode:\_##withtestmode:\_

1. **Objective-C**

   ```objective-c
   - (null 以外のインスタンスタイプ)withTestMode:(ブーリアン)testMode
   ```

テストモードを設定します。

| **パラメーター** | **説明**                                         |
| ---------- | ---------------------------------------------- |
| testMode   | このフラグを `true` に設定すると、テストモードを示し、テスト広告のみが表示されます。 |

**戻り値**：更新された `UADSInitConfigurationBuilder` インスタンス。

### withLogLevel:\_##withloglevel:\_

1. **Objective-C**

   ```objective-c
   - (null でないインスタンスタイプ)withLogLevel:(enum UADSLogLevel)logLevel
   ```

ログに含まれる詳細の量を定義する[ログ レベル](#uadsloglevel)を、なしから完全なデバッグ情報までの範囲で設定します。

| **パラメーター** | **説明**            |
| ---------- | ----------------- |
| level      | ログ出力の詳細レベルを指定します。 |

**戻り値**：更新された `UADSInitConfigurationBuilder` インスタンス。

### withMediationInfo:\_##withmediationinfo:\_

1. **Objective-C**

   ```objective-c
   - (null でないインスタンスタイプ)withMediationInfo:(UADSMediationInfo * _Nonnull)info
   ```

メディエーション情報を設定します。メディエーション名、バージョン、アダプターのバージョンなど、アプリケーションのメディエーションインテグレーションに関する詳細を提供します。

| **パラメーター** | **説明**                      |
| ---------- | --------------------------- |
| info       | メディエーションインテグレーションの詳細を指定します。 |

**戻り値**：更新された `UADSInitConfigurationBuilder` インスタンス。

### withExtras:\_##withextras:\_

1. **Objective-C**

   ```objective-c
   - (nonnull instancetype)withExtras:(NSDictionary<NSString *, NSString *> * _Nonnull)extras
   ```

追加のパラメーターを設定します。

| **パラメーター** | **説明**             |
| ---------- | ------------------ |
| extras     | カスタム設定の追加のキーと値のペア。 |

**戻り値**：更新された `UADSInitConfigurationBuilder` インスタンス。

### ビルド /build##build

1. **Objective-C**

   ```objective-c
   - (UADSInitializationConfiguration * _Nonnull)ビルド
   ```

UADSInitializationConfiguration インスタンスをビルドして返します。

**戻り値**：`UADSInitializationConfiguration` のインスタンス

## UADSInterstitialAd##uadsinterstitialad

`UADSInterstitialAd` クラスは、インタースティシャル広告のロードと表示を管理します。

### ロード：完了：＿##load:completion:\_

1. **Objective-C**

   ```objective-c
   @インターフェース UADSInterstitialAd ：NSObject
   + (void)ロード:(UADSLoadConfiguration * _Nonnull)設定
     completion:(void (^ _Nonnull)(UADSInterstitialAd * _Nullable, id<UnityAdsError> _Nullable))completion;
   @end
   ```

指定された設定のインタースティシャル広告をロードします。

| **Parameters** | **説明**                                                          |
| -------------- | --------------------------------------------------------------- |
| configuration  | 広告のロードオプションを含む UADSLoadConfiguration のインスタンス。                   |
| completion     | ロード処理が完了したときに呼び出されるコールバック。UADSInterstitialAd インスタンスまたはエラーを返します。 |

### show：デリゲート：＿##show:delegate:\_

1. **Objective-C**

   ```objective-c
   @インターフェース UADSInterstitialAd ：NSObject
   - (void)show:(UADSShowConfiguration * _Nullable)設定
       デリゲート:(id <UADSInterstitialShowDelegate> _Nonnull)デリゲート;
   @end
   ```

ロードされたインタースティシャル広告を表示します。

| **パラメーター**    | **説明**                                                 |
| ------------- | ------------------------------------------------------ |
| configuration | 広告を表示するための任意設定。                                        |
| delegate      | 広告イベントをハンドルする`UADSInterstitialShowDelegate`に準拠したデリゲート。 |

### onAdExpired##onadexpired

広告の有効期限が切れたときにトリガーされるコールバックバックを登録します。

1. **Objective-C**

   ```objective-c
   @interface UnityAd :NSObject
   @プロパティ (非アトミック、コピー) void (^ _Nullable onAdExpired)(UnityAd * _Nonnull);
   @end
   ```

## UADSLoadConfiguration##uadsloadconfiguration

`UADSLoadConfiguration` クラスは、Unity Ads のロードに必要なオプションをカプセル化します。これには、配置 ID、任意の広告マークアップ、追加のパラメータの指定が含まれます。

1. **Objective-C**

   ```objective-c
   @interface UADSLoadConfiguration: NSObject
   @property (nonatomic, strong) NSString *placementId;
   @property (nonatomic, strong, nullable) NSString *adMarkup;
   @property (nonatomic, strong, nullable) NSString *mediationAdUnitId;
   @property (nonatomic, strong, nullable) UADSMediationInfo *mediationInfo;
   @property (nonatomic, strong) NSDictionary<NSString *, NSString *> *extras;
   @end
   ```

`UADSLoadConfiguration` の新しいインスタンスを作成します。

| **Property**        | **説明**                             | **必須** |
| ------------------- | ---------------------------------- | ------ |
| `placementId`       | Unity 収益化ダッシュボードで定義された配置 ID。       | はい     |
| `adMarkup`          | 入札を通じて広告をロードするときに使用される広告マークアップデータ。 | いいえ    |
| `mediationAdUnitId` | メディエーションパートナーのダッシュボードで使用される配置 ID。  | いいえ    |
| `mediationInfo`     | メディエーションインテグレーションの詳細を指定します。        | いいえ    |
| `extras`            | 設定用の追加のカスタム キーと値のペア。               | いいえ    |

| **注：** adMarkup プロパティは、すべての入札実装で必須です。ウォーターフォール実装の場合は、adMarkup を nil に設定できます。 |
| ---------------------------------------------------------------------------- |

## UADSLoadConfigurationBuilder##uadsloadconfigurationbuilder

`UADSLoadConfigurationBuilder` を使用して、`UADSLoadConfiguration` クラスのインスタンスを作成し、返します。

### initWithPlacementId:\_##initwithplacementid:\_

1. **Objective-C**

   ```objective-c
   - - (nonnull instancetype)initWithPlacementId:(NSString * _Nonnull)placementId;
   ```

`UADSLoadConfigurationBuilder` の新しいインスタンスを作成します。

| **パラメーター**    | **説明**                       |
| ------------- | ---------------------------- |
| `placementId` | Unity 収益化ダッシュボードで定義された配置 ID。 |

**戻り値**：`UADSLoadConfigurationBuilder` のインスタンス

### withAdMarkup:\_##withadmarkup:\_

1. **Objective-C**

   ```objective-c
   - (null 以外のインスタンスタイプ)withAdMarkup:(NSString * _Nonnull)adMarkup
   ```

adMarkup を`UADSLoadConfigurationBuilder`に追加します。

| **Property** | **説明**                             |
| ------------ | ---------------------------------- |
| `adMarkup`   | 入札を通じて広告をロードするときに使用される広告マークアップデータ。 |

**戻り値**：更新された `UADSLoadConfigurationBuilder` インスタンス。

### withMediationAdUnitId:\_##withmediationadunitid:\_

1. **Objective-C**

   ```objective-c
   - (nonnull instancetype)withMediationAdUnitId:(NSString * _Nonnull)mediationAdUnitId
   ```

メディエーション広告単位 ID を`UADSLoadConfigurationBuilder`に追加します。

| **Property**        | **説明**                            |
| ------------------- | --------------------------------- |
| `mediationAdUnitId` | メディエーションパートナーのダッシュボードで使用される配置 ID。 |

**戻り値**：更新された `UADSLoadConfigurationBuilder` インスタンス。

### withMediationInfo:\_##withmediationinfo:\_

1. **Objective-C**

   ```objective-c
   - (null でないインスタンスタイプ)withMediationInfo:(UADSMediationInfo * _Nonnull)info
   ```

メディエーション情報を`UADSLoadConfigurationBuilder`に追加します。

| **パラメーター**    | **説明**                                           |
| ------------- | ------------------------------------------------ |
| mediationInfo | メディエーションインテグレーションの詳細を指定します（名前、バージョン、アダプタのバージョン）。 |

**戻り値**：更新された `UADSLoadConfigurationBuilder` インスタンス。

### withExtras:\_##withextras:\_

1. **Objective-C**

   ```objective-c
   - (nonnull instancetype)withExtras:(NSDictionary<NSString *, NSString *> * _Nonnull)extras
   ```

余分な設定キーと値のペアを`UADSLoadConfigurationBuilder`に追加します。

| **パラメーター** | **説明**                    |
| ---------- | ------------------------- |
| extras     | 広告ロード用のカスタムパラメータのディクショナリ。 |

**戻り値**：更新された `UADSLoadConfigurationBuilder` インスタンス。

### ビルド /build##build

1. **Objective-C**

   ```objective-c
   - (UADSLoadConfiguration * _Nonnull)ビルド
   ```

`UADSLoadConfiguration` インスタンスをビルドして返します。

**戻り値**：`UADSLoadConfiguration` のインスタンス

### UADSLoadOptions##uadsloadoptions

> **Warning:**
>
> **バージョン 4.19.0 で非推奨になりました。バージョン 5.0.0 で削除予定**
>
> 代わり[に `UADSLoadConfigurationBuilder`](/ads-ios/4.19.0/sdk-integration/api/ios-api-objc.md#uadsloadconfigurationbuilder) を使用してください。移行の詳細については、[iOS 非推奨 API](/ads-ios/4.19.0/sdk-integration/api/ios-deprecated-apis.md) を参照してください。

`UADSLoadOptions` は、広告ロード オプションを指定するための前のクラスです。

## UADSMediationInfo##uadsmediationinfo

メディエーションインテグレーションの詳細を指定します。

1. **Objective-C**

   ```objective-c
   @インターフェース UADSMediationInfo ：NSObject
   - (非 null インスタンスタイプ)initWithName:(NSString * _Nonnull)name
                                version:(NSString * _Nonnull)version
                         adapterVersion:(NSString * _Nonnull)adapterVersion
   @end
   ```

| **Parameters** | **説明**                                 |
| -------------- | -------------------------------------- |
| name           | アプリケーションに統合されているメディエーションプラットフォームの名前。   |
| version        | アプリケーションに統合されているメディエーションSDKのバージョン。     |
| adapterVersion | メディエーション パートナー用の Unity Ads アダプタのバージョン。 |

**戻り値**：`UADSMediationInfo` のインスタンス

### UADSMediationMetaData##uadsmediationmetadata

> **Warning:**
>
> **バージョン 4.19.0 で非推奨になりました。バージョン 5.0.0 で削除予定**
>
> 代わり[に `UADSMediationInfo`](/ads-ios/4.19.0/sdk-integration/api/ios-api-objc.md#uadsmediationinfo) を使用してください。移行の詳細については、[iOS 非推奨 API](/ads-ios/4.19.0/sdk-integration/api/ios-deprecated-apis.md) を参照してください。

`UADSMediationMetaData` は、メディエーションパートナー情報を渡すための前のクラスです。

## UADSRewardedAd##uadsrewardedad

UADSRewardedAd クラスは、リワード広告のロードと表示を管理します。

### ロード：完了：＿##load:completion:\_

1. **Objective-C**

   ```objective-c
   + (void)ロード:(UADSLoadConfiguration * _Nonnull)設定
     completion:(void (^ _Nonnull)(UADSRewardedAd * _Nullable, id<UnityAdsError> _Nullable))completion;
   ```

指定されたオプションのリワード広告をロードします。

| **Parameters** | **説明**                                                                                       |
| -------------- | -------------------------------------------------------------------------------------------- |
| configuration  | 広告のロードオプションを含む UADSLoadConfiguration のインスタンス。                                                |
| completion     | 広告のロードが完了したときに呼び出されるコールバック。成功した場合は UADSRewardedAd インスタンスを返し、ロードに失敗した場合は UnityAdsError を返します。 |

### show：デリゲート：＿##show:delegate:\_

1. **Objective-C**

   ```objective-c
   - (void)show:(UADSShowConfiguration * _Nullable)設定
       デリゲート:(id <UADSRewardedShowDelegate> _Nonnull)デリゲート;
   ```

ロードされたリワード広告を表示します。

| **パラメーター**    | **説明**                |
| ------------- | --------------------- |
| configuration | 広告を表示するための任意設定。       |
| delegate      | リワード広告イベントを処理するデリゲート。 |

### onAdExpired##onadexpired

広告の有効期限が切れたときにトリガーされるコールバックバックを登録します。

1. **Objective-C**

   ```objective-c
   @interface UnityAd :NSObject
   @プロパティ (非アトミック、コピー) void (^ _Nullable onAdExpired)(UnityAd * _Nonnull);
   @end
   ```

## UADSShowConfiguration##uadsshowconfiguration

`UADSShowConfiguration` クラスは、Unity Ads を表示するときにキーと値のペアの形式で渡す追加のパラメータを指定します。

1. **Objective-C**

   ```objective-c
   @interface UADSShowConfigurationBuilder : NSObject
   @property (nonatomic, weak, nullable) UIViewController *viewController;
   @property (nonatomic, strong, nullable) NSString *customRewardString;
   @property (nonatomic, strong) NSDictionary<NSString *, NSString *> *extras;
   @end
   ```

任意の追加パラメータを持つ`UADSShowConfiguration`の新しいインスタンスを作成します。

| **Property**         | **説明**                                        | **必須** |
| -------------------- | --------------------------------------------- | ------ |
| `viewController`     | 広告の表示に使用されるビューコントローラー。                        | いいえ    |
| `customRewardString` | アドインプレッションのカスタム報酬識別子。                         | いいえ    |
| `extras`             | 広告を表示するときに含める追加のキーと値のパラメータ。デフォルトは空のディクショナリです。 | いいえ    |

## UADSShowConfigurationBuilder##uadsshowconfigurationbuilder

`UADSShowConfigurationBuilder` を使用して、`UADSShowConfiguration` クラスのインスタンスを作成し、返します。

### init##init

1. **Objective-C**

   ```objective-c
   - (null でないインスタンスタイプ)init;
   ```

`UADSShowConfigurationBuilder` の新しいインスタンスを作成します。

### withViewController:\_##withviewcontroller:\_

1. **Objective-C**

   ```objective-c
   - (非 null インスタンスタイプ)withViewController:(UIViewController * _Nonnull)viewController
   ```

広告を表示するビューコントローラーを設定します。

| **パラメーター**       | **説明**              |
| ---------------- | ------------------- |
| `viewController` | 広告を表示するビュー コントローラー。 |

**戻り値**：更新された `UADSShowConfigurationBuilder` インスタンス。

### withCustomRewardString:\_##withcustomrewardstring:\_

1. **Objective-C**

   ```objective-c
   - (null でないインスタンスタイプ)withCustomRewardString:(NSString * _Nonnull)customRewardString
   ```

アドインプレッションのカスタム報酬識別子を設定します。

| **パラメーター**           | **説明**                 |
| -------------------- | ---------------------- |
| `customRewardString` | アドインプレッションの一意のリワード ID。 |

**戻り値**：更新された `ShowConfigurationBuilder` インスタンス。

### withExtras:\_##withextras:\_

1. **Objective-C**

   ```objective-c
   - (nonnull instancetype)withExtras:(NSDictionary<NSString *, NSString *> * _Nonnull)extras
   ```

広告を表示するときに余分なキーと値のパラメータを追加します。

| **パラメーター** | **説明**              |
| ---------- | ------------------- |
| `extras`   | 広告ディスプレイのカスタムパラメータ。 |

**戻り値**：更新された `UADSShowConfigurationBuilder` インスタンス。

### ビルド /build##build

1. **Objective-C**

   ```objective-c
   - (UADSShowConfiguration * _Nonnull)ビルド
   ```

`UADSShowConfiguration` インスタンスをビルドして返します。

**戻り値**：`UADSShowConfiguration` のインスタンス

### UADSShowOptions##uadsshowoptions

> **Warning:**
>
> **バージョン 4.19.0 で非推奨になりました。バージョン 5.0.0 で削除予定**
>
> 代わり[に `UADSShowConfigurationBuilder`](/ads-ios/4.19.0/sdk-integration/api/ios-api-objc.md#uadsshowconfigurationbuilder) を使用してください。移行の詳細については、[iOS 非推奨 API](/ads-ios/4.19.0/sdk-integration/api/ios-deprecated-apis.md) を参照してください。

`UADSShowOptions` は、広告表示オプションを指定する前のクラスです。

## UADSTokenConfiguration##uadstokenconfiguration

1. **Objective-C**

   ```objective-c
   @interface UADSTokenConfiguration : NSObject
   @property (nonatomic, assign) AdFormat UADSAdFormat;
   @property (nonatomic, strong, nullable) UADSMediationInfo *mediationInfo;
   @property (nonatomic, strong, nullable) NSString *mediationAdUnitId;
   @property (nonatomic, strong, nullable) NSString *placementId;
   @property (nonatomic, assign) CGSize bannerSize;
   @property (nonatomic, strong) NSDictionary<NSString *, NSString *> *extras;
   @end
   ```

`UADSTokenConfiguration` インターフェースは、入札トークンの取得に必要な重要な情報で構成される オブジェクトを作成します。

| **Property**        | **説明**                               | **必須** |
| ------------------- | ------------------------------------ | ------ |
| `adFormat`          | 広告形式のタイプ（インタースティシャル、リワード、バナー）を指定します。 | はい     |
| `mediationInfo`     | メディエーションインテグレーションの詳細を指定します。          | いいえ    |
| `mediationAdUnitId` | メディエーションパートナーのダッシュボードで使用される配置 ID。    | いいえ    |
| `placementId`       | Unity 収益化ダッシュボードで定義された配置 ID。         | いいえ    |
| `bannerSize`        | バナー広告のサイズ（トークンがバナー広告を要求した場合）。        | いいえ    |
| `extras`            | カスタム設定の追加のキーと値のペア。                   | いいえ    |

### UADSTokenConfigurationBuilder##uadstokenconfigurationbuilder

`UADSTokenConfigurationBuilder` を使用して、`UADSTokenConfiguration` クラスのインスタンスを作成し、返します。

### initWithAdFormat:\_##initwithadformat:\_

1. **Objective-C**

   ```objective-c
   - (null でないインスタンスタイプ)initWithAdFormat:(enum UADSAdFormat)adFormat
   ```

`UADSTokenConfigurationBuilder` の新しいインスタンスを作成します。

| **パラメーター** | **説明**                                               |
| ---------- | ---------------------------------------------------- |
| adFormat   | 広告のタイプ (インタースティシャル、リワード、バナー) を指定する AdFormat のインスタンス。 |

**戻り値**：`UADSTokenConfigurationBuilder` のインスタンス

### withMediationInfo:\_##withmediationinfo:\_

1. **Objective-C**

   ```objective-c
   - (null でないインスタンスタイプ)withMediationInfo:(UADSMediationInfo * _Nonnull)mediationInfo
   ```

メディエーションインテグレーションの詳細を指定します。

| **パラメーター**    | **説明**                      |
| ------------- | --------------------------- |
| mediationInfo | メディエーションインテグレーションの詳細を指定します。 |

**戻り値**：更新された `TokenConfigurationBuilder` インスタンス。

### withMediationAdUnitId:\_##withmediationadunitid:\_

1. **Objective-C**

   ```objective-c
   - (nonnull instancetype)withMediationAdUnitId:(NSString * _Nonnull)mediationAdUnitId
   ```

メディエーション広告単位 ID を`TokenConfiguration`に追加します。

| **Property**        | **説明**                            |
| ------------------- | --------------------------------- |
| `mediationAdUnitId` | メディエーションパートナーのダッシュボードで使用される配置 ID。 |

**戻り値**：更新された `UADSTokenConfigurationBuilder` インスタンス。

### withPlacementId:\_##withplacementid:\_

1. **Objective-C**

   ```objective-c
   - (null でないインスタンスタイプ)withPlacementId:(NSString * _Nonnull)placementId
   ```

Unity 収益化ダッシュボードで定義された配置 ID を指定します。

| **パラメーター**  | **説明**                       |
| ----------- | ---------------------------- |
| placementId | Unity 収益化ダッシュボードで定義された配置 ID。 |

**戻り値**：更新された `UADSTokenConfigurationBuilder` インスタンス。

### withBannerSize：＿##withbannersize:\_

1. **Objective-C**

   ```objective-c
   - (null でないインスタンスタイプ)withBannerSize:(CGSize)bannerSize
   ```

トークンがバナー広告を要求した場合のバナー広告のサイズを指定します。

| **パラメーター** | **説明**                        |
| ---------- | ----------------------------- |
| bannerSize | バナー広告のサイズ（トークンがバナー広告を要求した場合）。 |

**戻り値**：更新された `UADSTokenConfigurationBuilder` インスタンス。

### withExtras:\_##withextras:\_

1. **Objective-C**

   ```objective-c
   - (nonnull instancetype)withExtras:(NSDictionary<NSString *, NSString *> * _Nonnull)extras
   ```

カスタム設定の追加のキーと値のペアを指定します。

| **パラメーター** | **説明**             |
| ---------- | ------------------ |
| extras     | カスタム設定の追加のキーと値のペア。 |

**戻り値**：更新された `UADSTokenConfigurationBuilder` インスタンス。

### ビルド /build##build

1. **Objective-C**

   ```objective-c
   - (UADSTokenConfiguration * _Nonnull)ビルド
   ```

`UADSTokenConfiguration` インスタンスをビルドして返します。

**戻り値**：`UADSTokenConfiguration` のインスタンス

## UnityAds##unityads

`UnityAds` クラスは、SDK の主要エントリーポイントとして機能する静的クラスです。初期化、トークンの取得、プライバシーの同意を処理し、グローバル SDK プロパティへのアクセスを提供します。

### 初期化##initialization

#### initialize(\_, completion:)##initialize(\_-completion:)

指定した設定で Unity Ads SDK を初期化します。completion ブロックは、初期化が成功または失敗で完了したときに呼び出されます。

1. **Objective-C**

   ```objective-c
   + (void) initialize:(UADSInitializationConfiguration *) 設定
            completion:(void (^)(id<UnityAdsError> )) completion;
   ```

| **パラメーター**    | **説明**                                                       |
| ------------- | ------------------------------------------------------------ |
| configuration | SDK の初期化に必要な設定を含む UADSInitializationConfiguration オブジェクト。    |
| completion    | SDK 初期化が完了したときに呼び出されるコールバック。初期化に失敗した場合は UnityAdsError を返します。 |

### GetToken##gettoken

#### getToken(\_, completion:)##gettoken(\_-completion:)

指定された`UADSTokenConfiguration`に基づいて入札トークンをフェッチし、完了ブロックに渡します。

1. **Objective-C**

   ```objective-c
   + (void) getToken:(UADSTokenConfiguration *) 設定
          completion:(void (^)(NSString * )) completion;
   ```

| **パラメーター**    | **説明**                                                             |
| ------------- | ------------------------------------------------------------------ |
| configuration | 広告形式、メディエーション情報、およびその他のパラメータを指定する `UADSTokenConfiguration` オブジェクト。 |
| completion    | トークンの取得に成功した場合は完了ブロックが呼び出され、エラーが発生した場合は null が返されます。               |

### 静的変数##static-variables

#### IsInitialized##isinitialized

Unity Ads SDK が正常に初期化されたかどうかを判別します。

1. **Objective-C**

   ```objective-c
   + (ブーリアン)isInitialized
   ```

**戻り値**：`true`の場合、Unity Ads は正常に初期化されています。

#### getVersion##getversion

現在使用中の Unity Ads SDK のバージョンを判別します。

1. **Objective-C**

   ```objective-c
   + (NSString *)getVersion
   ```

**戻り値**：現在インストールされている Unity Ads SDK のバージョン。

#### userIdentifier##useridentifier

アプリケーションの各ユーザーに一意のIDを設定します。

1. **Objective-C**

   ```objective-c
   @objc public static var userIdentifier:文字列 {...}
   ```

### プライバシー##privacy

#### setUserConsent()##setuserconsent()

パーソナライズ広告に対するユーザーのオプトインの選択肢を表示します。

1. **Objective-C**

   ```objective-c
   + (void)setUserConsent:(BOOL)consentGranted;
   ```

#### setUserOptOut()##setuseroptout()

ユーザーにデータ収集とパーソナライズ広告をオプトアウトするオプションを提供します。

1. **Objective-C**

   ```objective-c
   + (void)setUserOptOut:(ブーリアン)optOut;
   ```

#### setNonBehavioral()##setnonbehavioral()

コンテキスト依存連動型（パーソナライズされていない）広告のディスプレイを有効にします。

1. **Objective-C**

   ```objective-c
   + (void)setNonBehavioral:(ブーリアン)nonBehavioral;
   ```

### UADSMetaData##uadsmetadata

> **Warning:**
>
> **バージョン 4.19.0 で非推奨になりました。バージョン 5.0.0 で削除予定**
>
> [`UnityAds`](/ads-ios/4.19.0/sdk-integration/api/ios-api-objc.md#unityads) で、`setUserConsent:`、`setUserOptOut:`、および `setNonBehavioral:` の型付きプライバシー方式を使用します。移行の詳細については、[iOS 非推奨 API](/ads-ios/4.19.0/sdk-integration/api/ios-deprecated-apis.md) を参照してください。

`UADSMetaData`は、GDPRやその他のプライバシー関連のフラグを設定するための前のクラスです。

### UnityAdsInitializationDelegate##unityadsinitializationdelegate

> **Warning:**
>
> **バージョン 4.19.0 で非推奨になりました。バージョン 5.0.0 で削除予定**
>
> 代わり[に `UnityAds initialize:completion:`](/ads-ios/4.19.0/sdk-integration/api/ios-api-objc.md#unityads) で補完ブロックを使用します。移行の詳細については、[iOS 非推奨 API](/ads-ios/4.19.0/sdk-integration/api/ios-deprecated-apis.md) を参照してください。

`UnityAdsInitializationDelegate` は、SDK 初期化コールバックの以前のデリゲートプロトコルです。

### UnityAdsLoadDelegate##unityadsloaddelegate

> **Warning:**
>
> **バージョン 4.19.0 で非推奨になりました。バージョン 5.0.0 で削除予定**
>
> 代わり[に、`UADSInterstitialAd load:completion:`](/ads-ios/4.19.0/sdk-integration/api/ios-api-objc.md#uadsinterstitialad) または [`UADSRewardedAd load:completion:`](/ads-ios/4.19.0/sdk-integration/api/ios-api-objc.md#uadsrewardedad) で補完ブロックを使用します。移行の詳細については、[iOS 非推奨 API](/ads-ios/4.19.0/sdk-integration/api/ios-deprecated-apis.md) を参照してください。

`UnityAdsLoadDelegate`は、広告ロードコールバックの以前のデリゲートプロトコルです。

### UnityAdsShowDelegate##unityadsshowdelegate

> **Warning:**
>
> **バージョン 4.19.0 で非推奨になりました。バージョン 5.0.0 で削除予定**
>
> 代わり[に `UADSInterstitialShowDelegate`](/ads-ios/4.19.0/sdk-integration/api/ios-api-objc.md#uadsinterstitialshowdelegate) または [`UADSRewardedShowDelegate`](/ads-ios/4.19.0/sdk-integration/api/ios-api-objc.md#uadsrewardedshowdelegate) を使用します。移行の詳細については、[iOS 非推奨 API](/ads-ios/4.19.0/sdk-integration/api/ios-deprecated-apis.md) を参照してください。

`UnityAdsShowDelegate` は、広告表示コールバックの以前のデリゲートプロトコルです。

## 列挙型##enum

### UADSAdFormat##uadsadformat

Unity Ads でサポートされているさまざまなタイプの広告フォーマットを定義します。

1. **Objective-C**

   ```objective-c
   typedef enum {
     UADSAdFormatUnspecified = 0,
     UADSAdFormatInterstitial = 1,
     UADSAdFormatRewarded = 2,
     UADSAdFormatBanner = 3,
   } UADSAdFormat;
   ```

| **パラメーター**               | **説明**                                     |
| ------------------------ | ------------------------------------------ |
| UADSAdFormatUnspecified  | 指定された広告形式はありません。                           |
| UADSAdFormatInterstitial | アプリケーションで自然なポーズで表示される全画面の広告。               |
| UADSAdFormatRewarded     | 完了後にユーザーに報酬を付与する広告。                        |
| UADSAdFormatBanner       | アプリケーションのレイアウト内に表示される矩形広告。通常は画面の上下に固定されます。 |

### UnityAdsAdFormat##unityadsadformat

> **Warning:**
>
> **バージョン 4.19.0 で非推奨になりました。バージョン 5.0.0 で削除予定**
>
> 代わり[に `UADSAdFormat`](/ads-ios/4.19.0/sdk-integration/api/ios-api-objc.md#uadsadformat) を使用してください。移行の詳細については、[iOS 非推奨 API](/ads-ios/4.19.0/sdk-integration/api/ios-deprecated-apis.md) を参照してください。

`UnityAdsAdFormat` は、広告形式タイプの以前の enum です。

### UADSLogLevel##uadsloglevel

Unity Ads のロギング レベルを定義します。

1. **Objective-C**

   ```objective-c
   typedef enum {
     UADSLogLevelDisabled = 0,
     UADSLogLevelError = 1,
     UADSLogLevelInfo = 2,
     UADSLogLevelDebug = 3,
   } UADSLogLevel;
   ```

| **パラメーター**           | **説明**                                                     |
| -------------------- | ---------------------------------------------------------- |
| UADSLogLevelDisabled | ログ出力なし。                                                    |
| UADSLogLevelError    | init/ロード/show 操作の重大なエラーと失敗のみをログに記録します。                     |
| UADSLogLevelInfo     | キー操作イベント（初期化の開始/完了、ロードの開始/完了、開始/終了の表示、トークンの生成など）をログに記録します。 |
| UADSLogLevelDebug    | すべての情報に加えて、ネットワーク リクエストや内部エラーなどの詳細な内部操作をログに記録します。          |

### UADSShowFinishState##uadsshowfinishstate

表示後の広告の終了状態を表します。

1. **Objective-C**

   ```objective-c
   typedef enum {
     UADSShowFinishStateSkipped = 0,
     UADSShowFinishStateCompleted = 1,
   } UADSShowFinishState
   ```

| **パラメーター**                   | **説明**                            |
| ---------------------------- | --------------------------------- |
| UADSShowFinishStateSkipped   | ユーザーが広告を終了する前に広告をクローズまたはスキップしました。 |
| UADSShowFinishStateCompleted | 最後まで再生された広告。                      |

## プロトコル##protocol

### UADSBannerAdDelegate##uadsbanneraddelegate

1. **Objective-C**

   ```objective-c
   @protocol UADSBannerAdDelegate <NSObject>
   - (void)bannerImpression:(UADSBannerAd * _Nonnull)banner;
   - (void)bannerDidClick:(UADSBannerAd * _Nonnull)banner;
   - (void)bannerDidFailShow:(UADSBannerAd * _Nonnull)バナーエラー:(id<UnityAdsError> _Nonnull)error;
   @end
   ```

| **メソッド**                   | **説明**                                             |
| -------------------------- | -------------------------------------------------- |
| `bannerImpression:`        | バナー広告が表示（インプレッション記録）されたときに呼び出されます。                 |
| `bannerDidClick:`          | ユーザーがバナー広告をクリックしたときに呼び出されます。                       |
| `bannerDidFailShow:error:` | バナーの表示に失敗した場合に呼び出され、失敗を説明する`UnityAdsError`が表示されます。 |

### UADSInterstitialShowDelegate##uadsinterstitialshowdelegate

1. **Objective-C**

   ```objective-c
   @protocol UADSInterstitialShowDelegate <NSObject>
   - (void)showDidStart:(UADSInterstitialAd * _Nonnull)unityAd;
   - (void)showDidClick:(UADSInterstitialAd * _Nonnull)unityAd;
   - (void)showDidComplete:(UADSInterstitialAd * _Nonnull)unityAd with:(enum UADSShowFinishState)finishState;
   - (void)showDidFail:(UADSInterstitialAd * _Nonnull)unityAd error:(id<UnityAdsError> _Nonnull)error;
   @end
   ```

| **メソッド**                | **説明**                                                                     |
| ----------------------- | -------------------------------------------------------------------------- |
| `showDidStart:`         | インタースティシャル広告の表示が開始されたときに呼び出されます。                                           |
| `showDidClick:`         | インタースティシャル広告がクリックされたときに呼び出されます。                                            |
| `showDidComplete:with:` | 広告の表示が終了したときに呼び出されます。`UADSShowFinishState`（`skipped`または`completed`）を提供します。 |
| `showDidFail:error:`    | 広告の表示に失敗した場合に呼び出され、失敗を説明する`UnityAdsError`が表示されます。                          |

### UADSRewardedShowDelegate##uadsrewardedshowdelegate

1. **Objective-C**

   ```objective-c
   @protocol UADSRewardedShowDelegate <NSObject>
   - (void)showDidStart:(UADSRewardedAd * _Nonnull)unityAd;
   - (void)showDidClick:(UADSRewardedAd * _Nonnull)unityAd;
   - (void)showDidComplete:(UADSRewardedAd * _Nonnull)unityAd with:(enum UADSShowFinishState)finishState;
   - (void)showDidFail:(UADSRewardedAd * _Nonnull)unityAd error:(id<UnityAdsError> _Nonnull)error;
   - (void)showDidReceiveReward:(UADSRewardedAd * _Nonnull)unityAd;
   @end
   ```

| **メソッド**                | **説明**                                                                     |
| ----------------------- | -------------------------------------------------------------------------- |
| `showDidStart:`         | リワード広告の表示が開始されたときに呼び出されます。                                                 |
| `showDidClick:`         | リワード広告がクリックされたときに呼び出されます。                                                  |
| `showDidComplete:with:` | 広告の表示が終了したときに呼び出されます。`UADSShowFinishState`（`skipped`または`completed`）を提供します。 |
| `showDidFail:error:`    | 広告の表示に失敗した場合に呼び出され、失敗を説明する`UnityAdsError`が表示されます。                          |
| `showDidReceiveReward:` | ユーザーが広告から報酬を獲得したときに呼び出されます。                                                |

## UnityAdsError##unityadserror

1. **Objective-C**

   ```objective-c
   @protocol UnityAdsError
   @プロパティ （非アトミック、読み取り専用） NSInteger コード；
   @プロパティ （nonatomic、readonly、copy） NSString * ＿Nonnull message；
   @end
   ```

| **パラメーター** | **説明** |
| ---------- | ------ |
| code       |        |
| message    |        |

### UADSBannerErrorCode##uadsbannererrorcode

> **Warning:**
>
> **バージョン 4.19.0 で非推奨になりました。バージョン 5.0.0 で削除予定**
>
> 代わりに `id<UnityAdsError>` プロトコルを使用します。移行の詳細については、[iOS 非推奨 API](/ads-ios/4.19.0/sdk-integration/api/ios-deprecated-apis.md) を参照してください。

`UADSBannerErrorCode` はバナー固有のエラーコードを表す以前の enum です。

### UnityAdsInitializationError##unityadsinitializationerror

> **Warning:**
>
> **バージョン 4.19.0 で非推奨になりました。バージョン 5.0.0 で削除予定**
>
> 代わりに `id<UnityAdsError>` プロトコルを使用します。移行の詳細については、[iOS 非推奨 API](/ads-ios/4.19.0/sdk-integration/api/ios-deprecated-apis.md) を参照してください。

`UnityAdsInitializationError` は、初期化エラー タイプの以前の enum です。

### UnityAdsLoadError##unityadsloaderror

> **Warning:**
>
> **バージョン 4.19.0 で非推奨になりました。バージョン 5.0.0 で削除予定**
>
> 代わりに `id<UnityAdsError>` プロトコルを使用します。移行の詳細については、[iOS 非推奨 API](/ads-ios/4.19.0/sdk-integration/api/ios-deprecated-apis.md) を参照してください。

`UnityAdsLoadError` は、広告ロードエラータイプの以前の enum です。

### UnityAdsShowError##unityadsshowerror

> **Warning:**
>
> **バージョン 4.19.0 で非推奨になりました。バージョン 5.0.0 で削除予定**
>
> 代わりに `id<UnityAdsError>` プロトコルを使用します。移行の詳細については、[iOS 非推奨 API](/ads-ios/4.19.0/sdk-integration/api/ios-deprecated-apis.md) を参照してください。

`UnityAdsShowError` は、広告表示エラータイプの以前の enum です。