Skip to content

Commit

Permalink
chore
Browse files Browse the repository at this point in the history
  • Loading branch information
rdlabo committed Aug 29, 2023
1 parent 9142754 commit 4fa7404
Show file tree
Hide file tree
Showing 3 changed files with 134 additions and 120 deletions.
160 changes: 80 additions & 80 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -301,6 +301,9 @@ AdMob.addListener(RewardAdPluginEvents.Rewarded, async () => {
* [`addListener(BannerAdPluginEvents.Opened, ...)`](#addlistenerbanneradplugineventsopened-)
* [`addListener(BannerAdPluginEvents.Closed, ...)`](#addlistenerbanneradplugineventsclosed-)
* [`addListener(BannerAdPluginEvents.AdImpression, ...)`](#addlistenerbanneradplugineventsadimpression-)
* [`requestConsentInfo(...)`](#requestconsentinfo)
* [`showConsentForm()`](#showconsentform)
* [`resetConsentInfo()`](#resetconsentinfo)
* [`prepareInterstitial(...)`](#prepareinterstitial)
* [`showInterstitial()`](#showinterstitial)
* [`addListener(InterstitialAdPluginEvents.FailedToLoad, ...)`](#addlistenerinterstitialadplugineventsfailedtoload-)
Expand All @@ -316,9 +319,6 @@ AdMob.addListener(RewardAdPluginEvents.Rewarded, async () => {
* [`addListener(RewardAdPluginEvents.Dismissed, ...)`](#addlistenerrewardadplugineventsdismissed-)
* [`addListener(RewardAdPluginEvents.FailedToShow, ...)`](#addlistenerrewardadplugineventsfailedtoshow-)
* [`addListener(RewardAdPluginEvents.Showed, ...)`](#addlistenerrewardadplugineventsshowed-)
* [`requestConsentInfo(...)`](#requestconsentinfo)
* [`showConsentForm()`](#showconsentform)
* [`resetConsentInfo()`](#resetconsentinfo)
* [Interfaces](#interfaces)
* [Type Aliases](#type-aliases)
* [Enums](#enums)
Expand Down Expand Up @@ -541,6 +541,47 @@ Unimplemented
--------------------


### requestConsentInfo(...)

```typescript
requestConsentInfo(options?: AdmobConsentRequestOptions) => Promise<AdmobConsentInfo>
```

Request user consent information

| Param | Type | Description |
| ------------- | --------------------------------------------------------------------------------- | --------------------- |
| **`options`** | <code><a href="#admobconsentrequestoptions">AdmobConsentRequestOptions</a></code> | ConsentRequestOptions |

**Returns:** <code>Promise&lt;<a href="#admobconsentinfo">AdmobConsentInfo</a>&gt;</code>

--------------------


### showConsentForm()

```typescript
showConsentForm() => Promise<AdmobConsentInfo>
```

Shows a google user consent form (rendered from your GDPR message config).

**Returns:** <code>Promise&lt;<a href="#admobconsentinfo">AdmobConsentInfo</a>&gt;</code>

--------------------


### resetConsentInfo()

```typescript
resetConsentInfo() => Promise<void>
```

Resets the UMP SDK state. Call requestConsentInfo function again to allow user modify their consent

--------------------


### prepareInterstitial(...)

```typescript
Expand Down Expand Up @@ -775,47 +816,6 @@ addListener(eventName: RewardAdPluginEvents.Showed, listenerFunc: () => void) =>
--------------------


### requestConsentInfo(...)

```typescript
requestConsentInfo(options?: AdmobConsentRequestOptions) => Promise<AdmobConsentInfo>
```

Request user consent information

| Param | Type | Description |
| ------------- | --------------------------------------------------------------------------------- | --------------------- |
| **`options`** | <code><a href="#admobconsentrequestoptions">AdmobConsentRequestOptions</a></code> | ConsentRequestOptions |

**Returns:** <code>Promise&lt;<a href="#admobconsentinfo">AdmobConsentInfo</a>&gt;</code>

--------------------


### showConsentForm()

```typescript
showConsentForm() => Promise<AdmobConsentInfo>
```

Shows a google user consent form (rendered from your GDPR message config).

**Returns:** <code>Promise&lt;<a href="#admobconsentinfo">AdmobConsentInfo</a>&gt;</code>

--------------------


### resetConsentInfo()

```typescript
resetConsentInfo() => Promise<void>
```

Resets the UMP SDK state. Call requestConsentInfo function again to allow user modify their consent

--------------------


### Interfaces


Expand Down Expand Up @@ -890,6 +890,23 @@ https://developers.google.com/android/reference/com/google/android/gms/ads/AdErr
| **`message`** | <code>string</code> | Gets the message describing the error. |


#### AdmobConsentInfo

| Prop | Type | Description |
| ---------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------- |
| **`status`** | <code><a href="#admobconsentstatus">AdmobConsentStatus</a></code> | The consent status of the user. |
| **`isConsentFormAvailable`** | <code>boolean</code> | If `true` a consent form is available and vice versa. |


#### AdmobConsentRequestOptions

| Prop | Type | Description |
| ----------------------------- | --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
| **`debugGeography`** | <code><a href="#admobconsentdebuggeography">AdmobConsentDebugGeography</a></code> | Sets the debug geography to test the consent locally. |
| **`testDeviceIdentifiers`** | <code>string[]</code> | An array of test device IDs to allow. Note: On iOS, the ID may renew if you uninstall and reinstall the app. |
| **`tagForUnderAgeOfConsent`** | <code>boolean</code> | Set to `true` to provide the option for the user to accept being shown personalized ads. |


#### AdLoadInfo

| Prop | Type |
Expand Down Expand Up @@ -925,23 +942,6 @@ https://developers.google.com/admob/android/rewarded-video-adapters?hl=en
| **`amount`** | <code>number</code> | Rewarded amount user got |


#### AdmobConsentInfo

| Prop | Type | Description |
| ---------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------- |
| **`status`** | <code><a href="#admobconsentstatus">AdmobConsentStatus</a></code> | The consent status of the user. |
| **`isConsentFormAvailable`** | <code>boolean</code> | If `true` a consent form is available and vice versa. |


#### AdmobConsentRequestOptions

| Prop | Type | Description |
| ----------------------------- | --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
| **`debugGeography`** | <code><a href="#admobconsentdebuggeography">AdmobConsentDebugGeography</a></code> | Sets the debug geography to test the consent locally. |
| **`testDeviceIdentifiers`** | <code>string[]</code> | An array of test device IDs to allow. Note: On iOS, the ID may renew if you uninstall and reinstall the app. |
| **`tagForUnderAgeOfConsent`** | <code>boolean</code> | Set to `true` to provide the option for the user to accept being shown personalized ads. |


### Type Aliases


Expand Down Expand Up @@ -1004,6 +1004,25 @@ From T, pick a set of properties whose keys are in the union K
| **`AdImpression`** | <code>"bannerAdImpression"</code> | Similarly, this method should be called when an impression is recorded for the ad by the mediated SDK. |


#### AdmobConsentStatus

| Members | Value | Description |
| ------------------ | --------------------------- | ------------------------------------------------------------------------------------- |
| **`NOT_REQUIRED`** | <code>'NOT_REQUIRED'</code> | User consent not required. |
| **`OBTAINED`** | <code>'OBTAINED'</code> | User consent already obtained. |
| **`REQUIRED`** | <code>'REQUIRED'</code> | User consent required but not yet obtained. |
| **`UNKNOWN`** | <code>'UNKNOWN'</code> | Unknown consent status, AdsConsent.requestInfoUpdate needs to be called to update it. |


#### AdmobConsentDebugGeography

| Members | Value | Description |
| -------------- | -------------- | -------------------------------------------------- |
| **`DISABLED`** | <code>0</code> | Debug geography disabled. |
| **`EEA`** | <code>1</code> | Geography appears as in EEA for debug devices. |
| **`NOT_EEA`** | <code>2</code> | Geography appears as not in EEA for debug devices. |


#### InterstitialAdPluginEvents

| Members | Value | Description |
Expand All @@ -1026,25 +1045,6 @@ From T, pick a set of properties whose keys are in the union K
| **`Dismissed`** | <code>'onRewardedVideoAdDismissed'</code> | Emits when the AdReward video is not visible to the user anymore. **Important**: This has nothing to do with the reward it self. This event will emits in this two cases: 1. The user starts the video ad but close it before the reward emit. 2. The user start the video and see it until end, then gets the reward and after that the ad is closed. |
| **`Rewarded`** | <code>'onRewardedVideoAdReward'</code> | Emits when user get rewarded from AdReward |


#### AdmobConsentStatus

| Members | Value | Description |
| ------------------ | --------------------------- | ------------------------------------------------------------------------------------- |
| **`NOT_REQUIRED`** | <code>'NOT_REQUIRED'</code> | User consent not required. |
| **`OBTAINED`** | <code>'OBTAINED'</code> | User consent already obtained. |
| **`REQUIRED`** | <code>'REQUIRED'</code> | User consent required but not yet obtained. |
| **`UNKNOWN`** | <code>'UNKNOWN'</code> | Unknown consent status, AdsConsent.requestInfoUpdate needs to be called to update it. |


#### AdmobConsentDebugGeography

| Members | Value | Description |
| -------------- | -------------- | -------------------------------------------------- |
| **`DISABLED`** | <code>0</code> | Debug geography disabled. |
| **`EEA`** | <code>1</code> | Geography appears as in EEA for debug devices. |
| **`NOT_EEA`** | <code>2</code> | Geography appears as not in EEA for debug devices. |

</docgen-api>

## TROUBLE SHOOTING
Expand Down
92 changes: 53 additions & 39 deletions demo/angular/ios/App/Podfile.lock
Original file line number Diff line number Diff line change
@@ -1,43 +1,57 @@
PODS:
- Capacitor (3.0.0):
- Capacitor (5.0.0):
- CapacitorCordova
- CapacitorCommunityAdmob (3.1.0):
- CapacitorCommunityAdmob (5.0.0):
- Capacitor
- Google-Mobile-Ads-SDK (~> 8.0)
- CapacitorCordova (3.0.0)
- Google-Mobile-Ads-SDK (8.0.0):
- GoogleAppMeasurement (~> 7.0)
- GoogleUserMessagingPlatform (~> 1.1)
- GoogleAppMeasurement (7.6.0):
- GoogleUtilities/AppDelegateSwizzler (~> 7.0)
- GoogleUtilities/MethodSwizzler (~> 7.0)
- GoogleUtilities/Network (~> 7.0)
- "GoogleUtilities/NSData+zlib (~> 7.0)"
- nanopb (~> 2.30907.0)
- GoogleUserMessagingPlatform (1.4.0)
- GoogleUtilities/AppDelegateSwizzler (7.2.2):
- Google-Mobile-Ads-SDK (= 10.1.0)
- CapacitorCordova (5.0.0)
- Google-Mobile-Ads-SDK (10.1.0):
- GoogleAppMeasurement (< 11.0, >= 7.0)
- GoogleUserMessagingPlatform (>= 1.1)
- GoogleAppMeasurement (10.14.0):
- GoogleAppMeasurement/AdIdSupport (= 10.14.0)
- GoogleUtilities/AppDelegateSwizzler (~> 7.11)
- GoogleUtilities/MethodSwizzler (~> 7.11)
- GoogleUtilities/Network (~> 7.11)
- "GoogleUtilities/NSData+zlib (~> 7.11)"
- nanopb (< 2.30910.0, >= 2.30908.0)
- GoogleAppMeasurement/AdIdSupport (10.14.0):
- GoogleAppMeasurement/WithoutAdIdSupport (= 10.14.0)
- GoogleUtilities/AppDelegateSwizzler (~> 7.11)
- GoogleUtilities/MethodSwizzler (~> 7.11)
- GoogleUtilities/Network (~> 7.11)
- "GoogleUtilities/NSData+zlib (~> 7.11)"
- nanopb (< 2.30910.0, >= 2.30908.0)
- GoogleAppMeasurement/WithoutAdIdSupport (10.14.0):
- GoogleUtilities/AppDelegateSwizzler (~> 7.11)
- GoogleUtilities/MethodSwizzler (~> 7.11)
- GoogleUtilities/Network (~> 7.11)
- "GoogleUtilities/NSData+zlib (~> 7.11)"
- nanopb (< 2.30910.0, >= 2.30908.0)
- GoogleUserMessagingPlatform (2.1.0)
- GoogleUtilities/AppDelegateSwizzler (7.11.5):
- GoogleUtilities/Environment
- GoogleUtilities/Logger
- GoogleUtilities/Network
- GoogleUtilities/Environment (7.2.2):
- PromisesObjC (~> 1.2)
- GoogleUtilities/Logger (7.2.2):
- GoogleUtilities/Environment (7.11.5):
- PromisesObjC (< 3.0, >= 1.2)
- GoogleUtilities/Logger (7.11.5):
- GoogleUtilities/Environment
- GoogleUtilities/MethodSwizzler (7.2.2):
- GoogleUtilities/MethodSwizzler (7.11.5):
- GoogleUtilities/Logger
- GoogleUtilities/Network (7.2.2):
- GoogleUtilities/Network (7.11.5):
- GoogleUtilities/Logger
- "GoogleUtilities/NSData+zlib"
- GoogleUtilities/Reachability
- "GoogleUtilities/NSData+zlib (7.2.2)"
- GoogleUtilities/Reachability (7.2.2):
- "GoogleUtilities/NSData+zlib (7.11.5)"
- GoogleUtilities/Reachability (7.11.5):
- GoogleUtilities/Logger
- nanopb (2.30907.0):
- nanopb/decode (= 2.30907.0)
- nanopb/encode (= 2.30907.0)
- nanopb/decode (2.30907.0)
- nanopb/encode (2.30907.0)
- PromisesObjC (1.2.12)
- nanopb (2.30909.0):
- nanopb/decode (= 2.30909.0)
- nanopb/encode (= 2.30909.0)
- nanopb/decode (2.30909.0)
- nanopb/encode (2.30909.0)
- PromisesObjC (2.3.1)

DEPENDENCIES:
- "Capacitor (from `../../node_modules/@capacitor/ios`)"
Expand All @@ -62,16 +76,16 @@ EXTERNAL SOURCES:
:path: "../../node_modules/@capacitor/ios"

SPEC CHECKSUMS:
Capacitor: 06cd8cd01340f5b162e9528bf5569d87a6f29009
CapacitorCommunityAdmob: 71fd26fcaf7d175a3206d0a03563e0af6299091a
CapacitorCordova: 183c8d1af3851da6d7a371f273462c8e64e15464
Google-Mobile-Ads-SDK: 9509c62617e8d77e2524833eed0b73dd028f0bc6
GoogleAppMeasurement: c542a2feaac9ab98fd074e8f1a02c3585bbfbd47
GoogleUserMessagingPlatform: b168e8c46cd8f92aa3e34b584c4ca78a411ce367
GoogleUtilities: 31c5b01f978a70c6cff2afc6272b3f1921614b43
nanopb: 59221d7f958fb711001e6a449489542d92ae113e
PromisesObjC: 3113f7f76903778cf4a0586bd1ab89329a0b7b97
Capacitor: b332cb737d447561e854039fb72195206685dce2
CapacitorCommunityAdmob: dfa5cf8cdd1d78c27b685d87413c51a91c761c69
CapacitorCordova: 4ea17670ee562680988a7ce9db68dee5160fe564
Google-Mobile-Ads-SDK: 894be2e3e3e8281004bda14381f9af7ad73eeffd
GoogleAppMeasurement: 7fee012a868315d418f365fbc8d394d8e020e749
GoogleUserMessagingPlatform: dce302b8f1b84d6e945812ee7a15c3f65a102cbf
GoogleUtilities: 13e2c67ede716b8741c7989e26893d151b2b2084
nanopb: b552cce312b6c8484180ef47159bc0f65a1f0431
PromisesObjC: c50d2056b5253dadbd6c2bea79b0674bd5a52fa4

PODFILE CHECKSUM: f0d366267849c47b62eaa8e58a0c0dc287e0d27b
PODFILE CHECKSUM: caf5c0243508aa7da79d79fc34adc99fda665398

COCOAPODS: 1.10.1
COCOAPODS: 1.12.1
2 changes: 1 addition & 1 deletion demo/angular/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 4fa7404

Please sign in to comment.