@react-native-firebase/analytics 20.3.0 → 20.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +12 -0
- package/__tests__/analytics.test.ts +324 -1
- package/ios/RNFBAnalytics/RNFBAnalyticsModule.m +28 -0
- package/lib/index.d.ts +65 -5
- package/lib/index.js +40 -52
- package/lib/modular/index.d.ts +47 -4
- package/lib/modular/index.js +300 -373
- package/lib/version.js +1 -1
- package/package.json +3 -3
package/lib/modular/index.d.ts
CHANGED
@@ -1143,6 +1143,7 @@ export function logViewSearchResults(
|
|
1143
1143
|
* For Web, the values passed persist on the current page and are passed with all
|
1144
1144
|
* subsequent events.
|
1145
1145
|
*
|
1146
|
+
* @platform ios
|
1146
1147
|
* @param analytics Analytics instance.
|
1147
1148
|
* @param params Parameters to be added to the map of parameters added to every event.
|
1148
1149
|
*/
|
@@ -1152,10 +1153,11 @@ export function setDefaultEventParameters(
|
|
1152
1153
|
): Promise<void>;
|
1153
1154
|
|
1154
1155
|
/**
|
1155
|
-
*
|
1156
|
+
* Start privacy-sensitive on-device conversion management.
|
1156
1157
|
* This is iOS-only.
|
1157
|
-
* This is a no-op if you do not include '$RNFirebaseAnalyticsGoogleAppMeasurementOnDeviceConversion = true' in your Podfile
|
1158
|
+
* This is a no-op if you do not include '$RNFirebaseAnalyticsGoogleAppMeasurementOnDeviceConversion = true' in your Podfile.
|
1158
1159
|
*
|
1160
|
+
* @platform ios
|
1159
1161
|
* @param analytics Analytics instance.
|
1160
1162
|
* @param emailAddress email address, properly formatted complete with domain name e.g, 'user@example.com'
|
1161
1163
|
*/
|
@@ -1165,10 +1167,26 @@ export function initiateOnDeviceConversionMeasurementWithEmailAddress(
|
|
1165
1167
|
): Promise<void>;
|
1166
1168
|
|
1167
1169
|
/**
|
1168
|
-
*
|
1170
|
+
* Start privacy-sensitive on-device conversion management.
|
1169
1171
|
* This is iOS-only.
|
1170
|
-
* This is a no-op if you do not include '$RNFirebaseAnalyticsGoogleAppMeasurementOnDeviceConversion = true' in your Podfile
|
1172
|
+
* This is a no-op if you do not include '$RNFirebaseAnalyticsGoogleAppMeasurementOnDeviceConversion = true' in your Podfile.
|
1173
|
+
* You need to pass the sha256-hashed of normalized email address to this function. See [this link](https://firebase.google.com/docs/tutorials/ads-ios-on-device-measurement/step-3#use-hashed-credentials) for more information.
|
1171
1174
|
*
|
1175
|
+
* @platform ios
|
1176
|
+
* @param analytics Analytics instance.
|
1177
|
+
* @param hashedEmailAddress sha256-hashed of normalized email address, properly formatted complete with domain name e.g, 'user@example.com'
|
1178
|
+
*/
|
1179
|
+
export function initiateOnDeviceConversionMeasurementWithHashedEmailAddress(
|
1180
|
+
analytics: Analytics,
|
1181
|
+
hashedEmailAddress: string,
|
1182
|
+
): Poromise<void>;
|
1183
|
+
|
1184
|
+
/**
|
1185
|
+
* Start privacy-sensitive on-device conversion management.
|
1186
|
+
* This is iOS-only.
|
1187
|
+
* This is a no-op if you do not include '$RNFirebaseAnalyticsGoogleAppMeasurementOnDeviceConversion = true' in your Podfile.
|
1188
|
+
*
|
1189
|
+
* @platform ios
|
1172
1190
|
* @param analytics Analytics instance.
|
1173
1191
|
* @param phoneNumber phone number in E.164 format - that is a leading + sign, then up to 15 digits, no dashes or spaces.
|
1174
1192
|
*/
|
@@ -1177,6 +1195,21 @@ export function initiateOnDeviceConversionMeasurementWithPhoneNumber(
|
|
1177
1195
|
phoneNumber: string,
|
1178
1196
|
): Promise<void>;
|
1179
1197
|
|
1198
|
+
/**
|
1199
|
+
* Start privacy-sensitive on-device conversion management.
|
1200
|
+
* This is iOS-only.
|
1201
|
+
* This is a no-op if you do not include '$RNFirebaseAnalyticsGoogleAppMeasurementOnDeviceConversion = true' in your Podfile.
|
1202
|
+
* You need to pass the sha256-hashed of phone number in E.164 format. See [this link](https://firebase.google.com/docs/tutorials/ads-ios-on-device-measurement/step-3#use-hashed-credentials) for more information.
|
1203
|
+
*
|
1204
|
+
* @platform ios
|
1205
|
+
* @param analytics Analytics instance.
|
1206
|
+
* @param hashedPhoneNumber sha256-hashed of normalized phone number in E.164 format - that is a leading + sign, then up to 15 digits, no dashes or spaces.
|
1207
|
+
*/
|
1208
|
+
export function initiateOnDeviceConversionMeasurementWithHashedPhoneNumber(
|
1209
|
+
analytics: Analytics,
|
1210
|
+
hashedPhoneNumber: string,
|
1211
|
+
): Promise<void>;
|
1212
|
+
|
1180
1213
|
/**
|
1181
1214
|
* Checks four different things.
|
1182
1215
|
* 1. Checks if it's not a browser extension environment.
|
@@ -1210,3 +1243,13 @@ export function setConsent(
|
|
1210
1243
|
* @returns {void}
|
1211
1244
|
*/
|
1212
1245
|
export function settings(options: FirebaseAnalyticsTypes.SettingsOptions): void;
|
1246
|
+
|
1247
|
+
/**
|
1248
|
+
* Retrieves the session id from the client.
|
1249
|
+
* On iOS, Firebase SDK may return an error that is handled internally and may take many minutes to return a valid value. Check native debug logs for more details.
|
1250
|
+
*
|
1251
|
+
* Returns the session id or null if session is expired, null on android if FirebaseAnalytics.ConsentType.ANALYTICS_STORAGE has been set to FirebaseAnalytics.ConsentStatus.DENIED and null on iOS if ConsentType.analyticsStorage has been set to ConsentStatus.denied.
|
1252
|
+
* @param {Analytics} instance.
|
1253
|
+
* @returns {Promise<number | null>}
|
1254
|
+
*/
|
1255
|
+
export function getSessionId(analytics: Analytics): Promise<number | null>;
|