スタートガイド

インストール

AIアシストによるセットアップでプラグインをインストールできます。以下のコマンドを使用して、お使いのAIツールに Capgo のスキルを追加してください：

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

次に、以下のプロンプトを使用します：

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-app-tracking-transparency` plugin in my project.

手動セットアップを希望する場合は、以下のコマンドを実行してプラグインをインストールし、下記のプラットフォーム別の手順に従ってください：

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

インポート

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

クイックスタート

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

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

例: requestPermission

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;
}

よくある落とし穴

• ネイティブ同期: 実行 npx cap sync プラグインのアップグレード後。
• 信頼できる情報源: 信頼 src/definitions.ts GitHub リポジトリ内。

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ネイティブのトラッキング許可ダイアログを表示します。

注意: このメソッドでダイアログが表示されるのは初回のみです。2回目以降の呼び出しでは、ダイアログを表示せずに保存済みの権限ステータスを返します。

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';

Source of Truth

このページはプラグインの src/definitions.tsから生成されています。upstream で公開 API が変更されたら、再度 sync を実行してください。

Getting Startedの続きを進める

使用している場合 スタートガイド ダッシュボードと API の運用を計画するには、これを次と連携させます @capgo/capacitor-app-tracking-transparency の使用方法 @capgo/capacitor-app-tracking-transparency でネイティブ機能を使用する場合、 API の概要 「API の概要」の実装の詳細については、 はじめに 「はじめに」における実装の詳細については、 API キー および「API Keys」の実装の詳細については、 デバイス 実装の詳細については Devices を参照してください。