Skip to content

Commit 60f3b1f

Browse files
Merge pull request #485 from AppsFlyerSDK/docs/add-disableAdvertisingIdentifier-api
add disableAdvertisingIdentifier api to docs
2 parents 38373a4 + 8687618 commit 60f3b1f

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

Docs/RN_API.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ The list of available methods for this plugin is described below.
3434
- [sendPushNotificationData](#sendpushnotificationdata)
3535
- [addPushNotificationDeepLinkPath](#addpushnotificationdeeplinkpath)
3636
- [appendParametersToDeepLinkingURL](#appendparameterstodeeplinkingurl)
37+
- [disableAdvertisingIdentifier](#disableAdvertisingIdentifier)
3738
- [Android Only APIs](#android-only-apis)
3839
- [setCollectAndroidID](#setcollectandroidid)
3940
- [setCollectIMEI](#setcollectimei)
@@ -731,6 +732,24 @@ Note:<br>
731732
appsFlyer.appendParametersToDeepLinkingURL('substring-of-url', {param1: 'value', pid: 'value2', is_retargeting: 'true'});
732733
```
733734

735+
---
736+
### disableAdvertisingIdentifier
737+
`disableAdvertisingIdentifier(shouldDisdable): void`
738+
739+
Disables collection of various Advertising IDs by the SDK.<br>
740+
**Anroid:** Google Advertising ID (GAID), OAID and Amazon Advertising ID (AAID)<br>
741+
**iOS:** Apple's advertisingIdentifier (IDFA)
742+
743+
| parameter | type | description |
744+
| ---------- |----------|------------------ |
745+
| shouldDisdable | boolean | Flag that disable/enable Advertising ID collection |
746+
747+
*Example:*
748+
749+
```javascript
750+
appsFlyer.disableAdvertisingIdentifier(true);
751+
```
752+
734753
## Android Only APIs
735754

736755
### setCollectAndroidID

0 commit comments

Comments
 (0)