Premiers pas

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-admob` plugin in my project.

Si vous préférez la configuration manuelle, installez le plugin avec les commandes suivantes, puis suivez les instructions spécifiques à chaque plateforme ci-dessous :

bun add @capgo/capacitor-admob
npx cap sync

Importer

import { AdMob } from '@capgo/capacitor-admob';

Démarrage rapide

import { AdMob } from '@capgo/capacitor-admob';

await AdMob.start();

Exemple : configuration

import { AdMob } from '@capgo/capacitor-admob';

await AdMob.configure({
  appMuted: false,
  appVolume: 0.5
});

Exemple : configRequest

import { AdMob, MaxAdContentRating } from '@capgo/capacitor-admob';

await AdMob.configRequest({
  maxAdContentRating: MaxAdContentRating.PG,
  tagForChildDirectedTreatment: true,
  testDeviceIds: ['test-device-id']
});

Erreurs courantes

• Écouteurs : supprimez les handles lors du démontage des écrans.
• Initialiser une seule fois: exécutez le setup lors du bootstrap de l'app.
• Source de vérité: confiance src/definitions.ts dans le repo GitHub.

Aperçu de API

start

Initialisez et démarrez le SDK AdMob.

import { AdMob } from '@capgo/capacitor-admob';

await AdMob.start();

configure

Configurez les paramètres AdMob.

import { AdMob } from '@capgo/capacitor-admob';

await AdMob.configure({
  appMuted: false,
  appVolume: 0.5
});

configRequest

Configurez les paramètres de la requête publicitaire.

import { AdMob, MaxAdContentRating } from '@capgo/capacitor-admob';

await AdMob.configRequest({
  maxAdContentRating: MaxAdContentRating.PG,
  tagForChildDirectedTreatment: true,
  testDeviceIds: ['test-device-id']
});

adCreate

Créez une nouvelle instance d'annonce.

import { AdMob } from '@capgo/capacitor-admob';

await AdMob.adCreate({
  adUnitId: 'ca-app-pub-3940256099942544/1033173712'
});

adIsLoaded

Vérifiez si une annonce est chargée et prête à être affichée.

import { AdMob } from '@capgo/capacitor-admob';

const isLoaded = await AdMob.adIsLoaded({ id: 1 });
if (isLoaded) {
  await AdMob.adShow({ id: 1 });
}

adLoad

Load an ad.

import { AdMob } from '@capgo/capacitor-admob';

await AdMob.adLoad({ id: 1 });

adShow

Afficher une publicité chargée.

import { AdMob } from '@capgo/capacitor-admob';

await AdMob.adShow({ id: 1 });

adHide

Masquer une publicité actuellement affichée.

import { AdMob } from '@capgo/capacitor-admob';

await AdMob.adHide({ id: 1 });

trackingAuthorizationStatus

Récupérer le statut actuel de l'autorisation de suivi (iOS uniquement).

import { AdMob, TrackingAuthorizationStatus } from '@capgo/capacitor-admob';

const { status } = await AdMob.trackingAuthorizationStatus();
if (status === TrackingAuthorizationStatus.notDetermined) {
  await AdMob.requestTrackingAuthorization();
}

requestTrackingAuthorization

Demander l'autorisation de suivi à l'utilisateur (iOS uniquement).

import { AdMob } from '@capgo/capacitor-admob';

const { status } = await AdMob.requestTrackingAuthorization();
console.log('User tracking status:', status);

Référence de type

AdMobConfig

Options de configuration pour AdMob.

export type AdMobConfig = {
  /** Whether the app should be muted */
  appMuted?: boolean;
  /** The app volume (0.0 to 1.0) */
  appVolume?: number;
};

RequestConfig

Configuration pour les requêtes publicitaires.

export type RequestConfig = {
  /** Maximum ad content rating */
  maxAdContentRating?: MaxAdContentRating;
  /** Whether to use the same app key */
  sameAppKey?: boolean;
  /** Tag for child-directed treatment (true, false, or null for unspecified) */
  tagForChildDirectedTreatment?: boolean | null;
  /** Tag for under age of consent (true, false, or null for unspecified) */
  tagForUnderAgeOfConsent?: boolean | null;
  /** Array of test device IDs */
  testDeviceIds?: string[];
};

MobileAdOptions

Options de base pour les publicités mobiles.

export type MobileAdOptions = {
  /** The ad unit ID from AdMob */
  adUnitId: string;
};

TrackingAuthorizationStatus

Suivi du statut d'autorisation pour l'iOS App Tracking Transparency.

export enum TrackingAuthorizationStatus {
  /** User has not yet received an authorization request */
  notDetermined = 0,
  /** User restricted, device is unable to provide authorization */
  restricted = 1,
  /** User denied authorization */
  denied = 2,
  /** User authorized access */
  authorized = 3,
}

MaxAdContentRating

Énumération du classement maximal du contenu publicitaire pour restreindre les publicités selon le contenu.

export enum MaxAdContentRating {
  /** General Audiences */
  G = 'G',
  /** Mature Audiences */
  MA = 'MA',
  /** Parental Guidance */
  PG = 'PG',
  /** Teen */
  T = 'T',
  /** Unspecified rating */
  UNSPECIFIED = '',
}

Source de vérité

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

Continuer depuis Getting Started

Si vous utilisez Premiers pas pour planifier les opérations du dashboard et de API, connectez-l’à Utiliser @capgo/capacitor-admob pour la capacité native dans Utiliser @capgo/capacitor-admob, Aperçu de API pour les détails d'implémentation dans l'aperçu de API, Introduction pour les détails d'implémentation dans l'Introduction, Clés API pour les détails d'implémentation dans les clés API, et Appareils pour le détail d’implémentation dans Devices.