Prise en main

Installer

Vous pouvez utiliser notre configuration assistée par IA pour installer le plugin. Ajoutez les skills Capgo à votre outil d'IA avec la commande suivante :

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

Utilisez ensuite le prompt suivant :

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

Si vous préférez une installation manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à chaque plateforme ci-dessous :

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

Importer

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

Démarrage rapide

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

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

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

Erreurs courantes

• Sync native : exécuter npx cap sync après les mises à jour du plugin.
• Source de vérité : fiez-vous src/definitions.ts au repo GitHub.

Aperçu de API

getStatus

Récupère le statut actuel de l'autorisation de suivi sans solliciter l'utilisateur.

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

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

requestPermission

Demande l'autorisation de l'utilisateur pour accéder aux données de l'application à des fins de suivi. Affiche la boîte de dialogue native d'autorisation de suivi sur iOS.

Note : cette méthode n'affichera la boîte de dialogue qu'une seule fois. Les appels suivants renverront le statut d'autorisation stocké sans afficher la boîte de dialogue.

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

Référence de type

AppTrackingStatusResponse

Objet de réponse contenant le statut d'autorisation de suivi.

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

AppTrackingStatus

Valeurs possibles pour le statut d'autorisation de suivi.

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

Source de vérité

Cette page est générée à partir de src/definitions.ts. Relancez la synchronisation lorsque l’API public change en amont.

Continuer depuis Getting Started

Si vous utilisez Prise en main pour planifier les opérations du dashboard et de API, connectez-l’avec Utiliser @capgo/capacitor-app-tracking-transparency pour la capacité native dans l'utilisation de @capgo/capacitor-app-tracking-transparency, Aperçu de API pour les détails d'implémentation dans « Vue d'ensemble de API », Introduction pour les détails d'implémentation dans l'introduction, Clés API pour les détails d'implémentation dans « Clés API », et Appareils pour les détails d'implémentation dans Devices.