capacitor-meta-ads/dist/docs.json

Capacitor plugin for Meta Audience Network ads integration with support for rewarded video and interstitial ads

{
  "api": {
    "name": "MetaAdsPlugin",
    "slug": "metaadsplugin",
    "docs": "",
    "tags": [],
    "methods": [
      {
        "name": "initialize",
        "signature": "(options: { appId: string; testMode?: boolean; }) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ appId: string; testMode?: boolean | undefined; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [],
        "docs": "Initialize Meta Audience Network SDK",
        "complexTypes": [],
        "slug": "initialize"
      },
      {
        "name": "loadRewardedVideo",
        "signature": "(options: { placementId: string; }) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ placementId: string; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [],
        "docs": "Load a rewarded video ad",
        "complexTypes": [],
        "slug": "loadrewardedvideo"
      },
      {
        "name": "showRewardedVideo",
        "signature": "() => Promise<{ success: boolean; reward?: RewardInfo; }>",
        "parameters": [],
        "returns": "Promise<{ success: boolean; reward?: RewardInfo | undefined; }>",
        "tags": [],
        "docs": "Show a rewarded video ad",
        "complexTypes": [
          "RewardInfo"
        ],
        "slug": "showrewardedvideo"
      },
      {
        "name": "isRewardedVideoLoaded",
        "signature": "() => Promise<{ loaded: boolean; }>",
        "parameters": [],
        "returns": "Promise<{ loaded: boolean; }>",
        "tags": [],
        "docs": "Check if rewarded video ad is loaded",
        "complexTypes": [],
        "slug": "isrewardedvideoloaded"
      },
      {
        "name": "loadInterstitial",
        "signature": "(options: { placementId: string; }) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ placementId: string; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [],
        "docs": "Load an interstitial ad",
        "complexTypes": [],
        "slug": "loadinterstitial"
      },
      {
        "name": "showInterstitial",
        "signature": "() => Promise<{ success: boolean; }>",
        "parameters": [],
        "returns": "Promise<{ success: boolean; }>",
        "tags": [],
        "docs": "Show an interstitial ad",
        "complexTypes": [],
        "slug": "showinterstitial"
      },
      {
        "name": "isInterstitialLoaded",
        "signature": "() => Promise<{ loaded: boolean; }>",
        "parameters": [],
        "returns": "Promise<{ loaded: boolean; }>",
        "tags": [],
        "docs": "Check if interstitial ad is loaded",
        "complexTypes": [],
        "slug": "isinterstitialloaded"
      },
      {
        "name": "setTestMode",
        "signature": "(options: { enabled: boolean; }) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ enabled: boolean; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [],
        "docs": "Set test mode",
        "complexTypes": [],
        "slug": "settestmode"
      },
      {
        "name": "addTestDevice",
        "signature": "(options: { deviceId: string; }) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ deviceId: string; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [],
        "docs": "Add test device",
        "complexTypes": [],
        "slug": "addtestdevice"
      }
    ],
    "properties": []
  },
  "interfaces": [
    {
      "name": "RewardInfo",
      "slug": "rewardinfo",
      "docs": "",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "type",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "string"
        },
        {
          "name": "amount",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "number"
        }
      ]
    }
  ],
  "enums": [],
  "typeAliases": [],
  "pluginConfigs": []
}