UMP連携

概要

UMP（User Messaging Platform）SDKは、GDPR（一般データ保護規則）およびCCPA（カリフォルニア消費者プライバシー法）準拠のために、パーソナライズド広告に対するユーザーの同意を管理します。

UMP連携にはadrop-ads-backfillモジュールが必要です。はじめにのインストールガイドを先に完了してください。

基本的な使い方

Adrop初期化後にConsent Managerを使用してユーザーの同意を要求します。

import AdropAds

class ViewController: UIViewController {

    override func viewDidLoad() {
        super.viewDidLoad()

        // Adrop.initialize()の後に呼び出し
        Adrop.consentManager?.requestConsentInfoUpdate(from: self) { result in
            if let error = result.error {
                print("同意エラー: \(error)")
            }
        }
    }
}

@import AdropAds;

@implementation ViewController

- (void)viewDidLoad {
    [super viewDidLoad];

    // Adrop.initialize()の後に呼び出し
    if (Adrop.consentManager != nil) {
        [Adrop.consentManager requestConsentInfoUpdateFrom:self completion:^(AdropConsentResult *result) {
            if (result.error != nil) {
                NSLog(@"同意エラー: %@", result.error);
            }
        }];
    }
}

@end

同意結果

requestConsentInfoUpdateのコールバックは、以下のプロパティを持つAdropConsentResultオブジェクトを返します：

プロパティ	型	説明
`status`	`AdropConsentStatus`	現在の同意ステータス
`canRequestAds`	`Bool`	広告リクエストが可能かどうか
`canShowPersonalizedAds`	`Bool`	パーソナライズド広告の表示が可能かどうか
`error`	`Error?`	リクエスト失敗時のエラー

Adrop.consentManager?.requestConsentInfoUpdate(from: self) { result in
    print("Status: \(result.status)")
    print("Can request ads: \(result.canRequestAds)")
    print("Can show personalized ads: \(result.canShowPersonalizedAds)")

    if let error = result.error {
        print("Error: \(error)")
    }
}

[Adrop.consentManager requestConsentInfoUpdateFrom:self completion:^(AdropConsentResult *result) {
    NSLog(@"Status: %ld", (long)result.status);
    NSLog(@"Can request ads: %d", result.canRequestAds);
    NSLog(@"Can show personalized ads: %d", result.canShowPersonalizedAds);

    if (result.error != nil) {
        NSLog(@"Error: %@", result.error);
    }
}];

同意ステータス

Consent Managerは次のステータスのいずれかを返します：

ステータス	説明
`unknown`	同意ステータスがまだ決定されていない
`required`	同意が必要（ポップアップが表示される）
`notRequired`	同意は不要（非GDPR地域）
`obtained`	すでに同意を取得済み

プライバシー設定（Privacy Options）

ユーザーは最初の同意後も同意内容を変更できる必要があります。UMPがプライバシー設定のエントリーポイントを要求する場合は、アプリの設定画面にプライバシー設定の項目を用意し、そこからプライバシー設定フォームを表示してください。

iOS SDK（adrop-ads）とバックフィル（adrop-ads-backfill）1.15.0以降が必要で、両モジュールのバージョンを揃えてください。バックフィルが古い場合、ステータスは常にunknownを返し、フォームも表示されません。この2つのメソッドはSwiftでのみ利用できます。

エントリーポイントの表示が必要かを確認

import AdropAds

class SettingsViewController: UIViewController {

    // 設定画面が表示されるたびに再取得
    override func viewWillAppear(_ animated: Bool) {
        super.viewWillAppear(animated)

        let status = Adrop.consentManager?.getPrivacyOptionsRequirementStatus()

        // 必要なときだけエントリーポイントを表示
        privacySettingsButton.isHidden = status != .required
    }
}

ステータス	説明
`unknown`	未判定 — 今回のアプリ起動で`requestConsentInfoUpdate()`が完了していない、またはインストールされているバックフィルがプライバシー設定に未対応です
`required`	エントリーポイントを表示する必要があります
`notRequired`	エントリーポイントは不要です

すでに同意済みのユーザーを含め、アプリ起動ごとにrequestConsentInfoUpdate()を呼び出してください。この呼び出しが完了して初めて、エントリーポイントの必要性が今回の起動の値を反映します。呼び出さないと再訪ユーザーにエントリーポイントが表示されません。同意フォーム自体は必要なときだけ表示されます。

プライバシー設定フォームの表示

// 設定画面の「プライバシー設定」項目からフォームを表示（ビューコントローラー内）
@objc private func privacySettingsTapped() {
    Adrop.consentManager?.showPrivacyOptionsForm(from: self) { [weak self] result in
        if let error = result.error {
            print("エラー: \(error)")
            return
        }

        // 同意が変更された可能性があるため、エントリーポイントがまだ必要かを再取得
        self?.updatePrivacySettingsVisibility()
    }
}

フォームが閉じると、SDKが変更後の同意を反映してからAdropConsentResultを返します。フォームはエントリーポイントの表示が必要なときだけ開き、それ以外では保存された同意を変更せず、現在の状態とエラーを返します。

ビューコントローラーの代わりにnilを渡すと、UMPが最前面の画面にフォームを表示します。設定画面をモーダルで表示している場合に便利です。

デバッグ設定（テストモード）

開発中にGDPR/CCPA同意フローをテストしてください：

import AdropAds

#if DEBUG
// 同意リクエスト前にデバッグ地域を設定
Adrop.consentManager?.setDebugSettings(
    testDeviceIdentifiers: ["YOUR_DEVICE_IDENTIFIER"],  // Xcodeコンソールで確認
    geography: .EEA  // GDPRテスト
)

// テスト用に同意状態をリセット
Adrop.consentManager?.reset()
#endif

@import AdropAds;

#ifdef DEBUG
// 同意リクエスト前にデバッグ地域を設定
[Adrop.consentManager setDebugSettingsWithTestDeviceIdentifiers:@[@"YOUR_DEVICE_IDENTIFIER"]
                                                      geography:AdropConsentDebugGeographyEEA];

// テスト用に同意状態をリセット
[Adrop.consentManager reset];
#endif

デバッグ地域

地域	説明
`disabled`	実際のデバイス位置を使用
`EEA`	GDPRテスト（欧州経済領域）
`regulatedUSState`	CCPAテスト（カリフォルニアなど）
`other`	非規制地域テスト

デバッグ設定は開発中のみ使用してください。本番リリース前に削除または無効化してください。reset()はテスト専用です。本番コードでは呼び出さず、ユーザーに同意を変更させる場合はshowPrivacyOptionsForm()を使用してください。

追加メソッド

メソッド	戻り値	説明
`getConsentStatus()`	`AdropConsentStatus`	現在の同意状態を返します
`canRequestAds()`	`Bool`	同意状態に基づいて広告リクエスト可能かどうかを返します
`getPrivacyOptionsRequirementStatus()`	`AdropPrivacyOptionsRequirementStatus`	プライバシー設定のエントリーポイントを表示する必要があるかを返します
`showPrivacyOptionsForm(from:completion:)`	`Void`	ユーザーが同意を変更できるプライバシー設定フォームを表示します
`reset()`	`Void`	同意情報をリセットします（テスト専用）

// 同意状態を個別に確認
if let status = Adrop.consentManager?.getConsentStatus() {
    switch status {
    case .obtained:
        print("同意完了")
    case .required:
        print("同意必要")
    case .notRequired:
        print("同意不要")
    case .unknown:
        print("同意状態不明")
    }
}

// 広告リクエスト可能か確認
if Adrop.consentManager?.canRequestAds() == true {
    // 広告をロード
}

// 同意情報をリセット（テスト用）
Adrop.consentManager?.reset()

ベストプラクティス

早期リクエスト

SDK初期化直後、アプリライフサイクルの早い段階で同意を要求し、アプリ起動ごとに呼び出してください。

エラー処理

同意エラーを適切に処理し、フォールバック動作を提供してください。

全シナリオテスト

リリース前にデバッグ設定を使用してすべての同意シナリオをテストしてください。

プライバシー設定の提供

プライバシー設定のエントリーポイントが必要なステータスの場合は、設定画面に表示し、ユーザーがいつでも同意を変更できるようにしてください。

ターゲティング

ユーザーおよびコンテキストターゲティング設定

はじめに

SDKインストールおよび設定ガイド

リファレンス

クラス、デリゲート、エラーコード

SDKガイド

AI

Android

iOS

React Native

Flutter

Web

REST API

概要

基本的な使い方

同意結果

同意ステータス

プライバシー設定（Privacy Options）

エントリーポイントの表示が必要かを確認

プライバシー設定フォームの表示

デバッグ設定（テストモード）

デバッグ地域

追加メソッド

ベストプラクティス

早期リクエスト

エラー処理

全シナリオテスト

プライバシー設定の提供

関連ドキュメント

ターゲティング

はじめに

リファレンス

​概要

​基本的な使い方

​同意結果

​同意ステータス

​プライバシー設定（Privacy Options）

​エントリーポイントの表示が必要かを確認

​プライバシー設定フォームの表示

​デバッグ設定（テストモード）

​デバッグ地域

​追加メソッド

​ベストプラクティス

早期リクエスト

エラー処理

全シナリオテスト

プライバシー設定の提供

​関連ドキュメント

ターゲティング

はじめに

リファレンス

概要

基本的な使い方

同意結果

同意ステータス

プライバシー設定（Privacy Options）

エントリーポイントの表示が必要かを確認

プライバシー設定フォームの表示

デバッグ設定（テストモード）

デバッグ地域

追加メソッド

ベストプラクティス

関連ドキュメント