AdMel SDK API リファレンス

概要

AdMel SDK は、Unity 向けの音声広告 SDK です。
広告の 初期化・ロード・表示・進行状況の追跡・クリックハンドリング の機能を提供します。

1. SDK のバージョン

Version

public static string Version { get; }

• SDK のバージョンを取得します。バージョン番号は、SDK の更新履歴を確認するために使用できます。

例

Debug.Log("AdMel SDK Version: " + AdMelSdk.Version);

2. SDK の初期化

Initialize(AdMelSdkEnvironment environment, AdPosition position, Vector2 offset = default)

public static void Initialize(AdMelSdkEnvironment environment, AdPosition position, Vector2 offset = default);

• SDK を初期化します。環境に応じたハンドラーを設定し、広告の利用準備を行います。

引数

• environment (AdMelSdkEnvironment) : Production または Development を指定。
• position (AdPosition) : 広告の表示位置。
• offset (Vector2) : 広告のオフセット。デフォルトは (150, 150)。

例

AdMelSdk.Initialize(AdMelSdkEnvironment.Production, AdPosition.TopLeft);

• Production 環境で SDK を初期化します。

3. メディア ID の管理

SetMediaId(string mediaId)

public static void SetMediaId(string mediaId);

• SDK で使用するメディア ID を設定します。メディア ID は、広告のロードや表示に使用されます。

GetMediaId()

public static string GetMediaId();

• 現在使用されているメディア ID を取得します。

例

AdMelSdk.SetMediaId("your_media_id");
string currentMediaId = AdMelSdk.GetMediaId();

4. 広告の管理

LoadAd(string slotId)

public static void LoadAd(string slotId);

• 指定されたスロット ID に関連付けられた広告をロードします。広告のロード後、表示することができます。

引数

• slotId (string) : 広告スロット ID。

例

AdMelSdk.LoadAd("your_slot_id");

ShowAd(string slotId, AdPosition position, Vector2 offset = default)

public static void ShowAd(string slotId, AdPosition position, Vector2 offset = default);

• 指定された位置に広告を表示します。オプションでオフセットを指定できます。

引数

• slotId (string) : 広告スロット ID。
• position (AdPosition) : 広告の表示位置。
• offset (Vector2) : 広告のオフセット。デフォルトは (150, 150)。

例

AdMelSdk.ShowAd("your_slot_id", AdPosition.TopLeft);

• 広告をロードし、画面上部左上に表示します。

5. オートリフレッシュ

EnableAutoRefresh()

public static void EnableAutoRefresh();

• 広告のオートリフレッシュを有効にします。オートリフレッシュが有効な場合、指定した間隔で広告が自動的に更新されます。オートリフレッシュを有効にすることで、広告の更新を手動で行う必要がなくなります。

例

AdMelSdk.EnableAutoRefresh();

• 自動リフレッシュを有効にします。

DisableAutoRefresh()

public static void DisableAutoRefresh();

• 広告のオートリフレッシュを無効にします。無効にすると、広告は手動でロードする必要があります。オートリフレッシュを無効にすることで、広告の更新を手動で制御できます。

例

AdMelSdk.DisableAutoRefresh();

• オートリフレッシュを無効にします。

SetInitialRefreshInterval(float seconds)

public static void SetInitialRefreshInterval(float seconds);

• 初回のリフレッシュまでの時間を設定します。初回のリフレッシュまでの時間を指定することで、広告の初期表示を制御できます。呼び出さない場合は、デフォルトの値（30秒）が使用されます。

引数

• seconds (float) : 初回リフレッシュまでの待機時間（秒）

例

AdMelSdk.SetInitialRefreshInterval(10f);

• 初回リフレッシュまでの待機時間を10秒に設定します。

SetRefreshInterval(float seconds)

public static void SetRefreshInterval(float seconds);

• リフレッシュの間隔を設定します。リフレッシュの間隔を指定することで、広告の更新頻度を制御できます。呼び出さない場合は、デフォルトの値（60秒）が使用されます。

引数

• seconds (float) : リフレッシュ間隔（秒）

例

AdMelSdk.SetRefreshInterval(30f);

• リフレッシュ間隔を30秒に設定します。

UpdateSlotId(string slotId)

public static void UpdateSlotId(string slotId);

• 広告スロット ID を更新します。

引数

• slotId (string) : 広告スロット ID

例

AdMelSdk.UpdateSlotId("your_slot_id");

• 広告スロット ID を “your_slot_id” に更新します。

UpdateAdPosition(AdPosition position, Vector2 offset = default)

public static void UpdateAdPosition(string slotId, AdPosition position, Vector2 offset = default);

• 広告の表示位置を更新します。

引数

• position (AdPosition) : 広告の表示位置
• offset (Vector2) : 広告の表示位置のオフセット

例

AdMelSdk.UpdateAdPosition(AdPosition.BottomCenter, new Vector2(0f, 20f));

• 広告の表示位置を下部中央に設定し、オフセットを (0, 20) に設定します。

6. コールバック

AdMel SDK では、以下のコールバックが用意されています。これらのコールバックは、SDK の状態や広告のロード、表示に関するイベントを管理するために使用されます。

SDK 初期化イベント

• onSdkInitialized
  • SDK が正常に初期化されたときに呼び出されます。初期化が成功した場合、SDK の機能を使用できます。
• onSdkInitializationFailed
  • SDK の初期化が失敗したときに呼び出されます。エラーコードとエラーメッセージが渡されます。初期化に失敗した場合、SDK の機能を使用することはできません。

広告ロードイベント

• onAudioAdLoaded
  • 音声広告が正常にロードされたときに呼び出されます。ロードが成功した場合、広告を表示できます。
• onAudioAdLoadFailed
  • 音声広告のロードが失敗したときに呼び出されます。エラーコードとエラーメッセージが渡されます。ロードに失敗した場合、広告を表示することはできません。

広告表示イベント

• onAdStarted
  • 広告の表示が開始されたときに呼び出されます。
• onAdClosed
  • 広告の表示が完了したときに呼び出されます。
• onAudioAdStarted
  • 広告の音声が開始されたときに呼び出されます。
• onAudioAdCompleted
  • 広告の音声が完了したときに呼び出されます。
• onAudioAdClicked
  • 広告がクリックされたときに呼び出されます。

広告進行状況イベント

• onAudioProgressReached
  • 音声広告の特定の進行状況に達したときに呼び出されます。進行状況とメッセージが渡されます。進行状況に達した場合、広告の進行状況を追跡できます。

例

AdMelSdkCallbacks.onSdkInitialized += () => {
    Debug.Log("SDK initialized successfully.");
};

AdMelSdkCallbacks.onSdkInitializationFailed += (int errorCode, string errorMessage) => {
    Debug.LogError($"SDK initialization failed: {errorCode} - {errorMessage}");
};

AdMelSdkCallbacks.onAudioAdLoaded += () => {
    Debug.Log("Audio ad loaded successfully.");
};

AdMelSdkCallbacks.onAudioAdLoadFailed += (int errorCode, string errorMessage) => {
    Debug.LogError($"Audio ad load failed: {errorCode} - {errorMessage}");
};


AdMelSdkCallbacks.onAdStarted += () => {
    Debug.Log("Ad started.");
};

AdMelSdkCallbacks.onAdClosed += () => {
    Debug.Log("Ad closed.");
};

AdMelSdkCallbacks.onAudioAdStarted += () => {
    Debug.Log("Audio ad started.");
};

AdMelSdkCallbacks.onAudioAdCompleted += () => {
    Debug.Log("Audio ad completed.");
};

AdMelSdkCallbacks.onAudioAdClicked += () => {
    Debug.Log("Audio ad clicked.");
};

AdMelSdkCallbacks.onAudioProgressReached += (float progress, string message) => {
    Debug.Log($"Audio ad progress reached: {progress} - {message}");
};