Skip to content

Commit

Permalink
Merge pull request #485 from AppsFlyerSDK/docs/add-disableAdvertising…
Browse files Browse the repository at this point in the history
…Identifier-api

add disableAdvertisingIdentifier api to docs
  • Loading branch information
amit-kremer93 committed Jul 30, 2023
2 parents 38373a4 + 8687618 commit 60f3b1f
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions Docs/RN_API.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ The list of available methods for this plugin is described below.
- [sendPushNotificationData](#sendpushnotificationdata)
- [addPushNotificationDeepLinkPath](#addpushnotificationdeeplinkpath)
- [appendParametersToDeepLinkingURL](#appendparameterstodeeplinkingurl)
- [disableAdvertisingIdentifier](#disableAdvertisingIdentifier)
- [Android Only APIs](#android-only-apis)
- [setCollectAndroidID](#setcollectandroidid)
- [setCollectIMEI](#setcollectimei)
Expand Down Expand Up @@ -731,6 +732,24 @@ Note:<br>
appsFlyer.appendParametersToDeepLinkingURL('substring-of-url', {param1: 'value', pid: 'value2', is_retargeting: 'true'});
```

---
### disableAdvertisingIdentifier
`disableAdvertisingIdentifier(shouldDisdable): void`

Disables collection of various Advertising IDs by the SDK.<br>
**Anroid:** Google Advertising ID (GAID), OAID and Amazon Advertising ID (AAID)<br>
**iOS:** Apple's advertisingIdentifier (IDFA)

| parameter | type | description |
| ---------- |----------|------------------ |
| shouldDisdable | boolean | Flag that disable/enable Advertising ID collection |

*Example:*

```javascript
appsFlyer.disableAdvertisingIdentifier(true);
```

## Android Only APIs

### setCollectAndroidID
Expand Down

0 comments on commit 60f3b1f

Please sign in to comment.