はじめに

インストール

bun add @capgo/capacitor-app-tracking-transparency
bunx cap sync

インポート

import { AppTrackingTransparency } from '@capgo/capacitor-app-tracking-transparency';

API オーバービュー

getStatus

現在のトラッキング認証状態を取得します。ユーザーに質問するのではなく

import { AppTrackingTransparency } from '@capgo/capacitor-app-tracking-transparency';

const { status } = await AppTrackingTransparency.getStatus();
if (status === 'authorized') {
  console.log('Tracking is authorized');
}

requestPermission

ユーザーにアプリ関連データのトラッキングのためのアクセス許可を求めます。 iOSのネイティブトラッキング許可ダイアログを表示します。

注: このメソッドはダイアログを一度だけ表示します。以降の呼び出しは ダイアログを表示せずに保存されたアクセス許可状態を返します。

import { AppTrackingTransparency } from '@capgo/capacitor-app-tracking-transparency';

const { status } = await AppTrackingTransparency.requestPermission();
switch (status) {
  case 'authorized':
    console.log('User authorized tracking');
    break;
  case 'denied':
    console.log('User denied tracking');
    break;
  case 'restricted':
    console.log('Tracking is restricted');
    break;
  case 'notDetermined':
    console.log('Status not determined');
    break;
}

型参照

AppTrackingStatusResponse

トラッキングのアクセス許可状態を含むレスポンスオブジェクト。

export interface AppTrackingStatusResponse {
  /**
   * The current tracking authorization status.
   *
   * @since 1.0.0
   */
  status: AppTrackingStatus;
}

AppTrackingStatus

トラッキングのアクセス許可状態の可能な値。

export type AppTrackingStatus = 'authorized' | 'denied' | 'notDetermined' | 'restricted';

真実の源

このページはプラグインの src/definitions.ts公開された API がアップストリームで変更された場合に再度同期を実行してください。