The state of an app in its lifecycle.

kUnknown is an invalid state that is used to capture uninitialized values. kTermination is used to indicate that the app is about to be terminated.

The status value of the consent type.

Supported statuses are kConsentStatusGranted and kConsentStatusDenied.

The type of consent to set.

Supported consent types are mapped to corresponding constants in the Android and iOS SDKs. Omitting a type retains its previous status.

The callback type for logging messages from the SDK.

The callback is invoked whenever the SDK logs a message. Currently only works for Windows Desktop.

Get the instance ID from the analytics service.

Note: This isnot the same ID as the ID returned by firebase::instance_id::InstanceId.

Get the result of the most recentGetAnalyticsInstanceId() call.

Asynchronously retrieves the identifier of the current app session.

The session ID retrieval could fail due to Analytics collection disabled, or if the app session was expired.

Get the result of the most recentGetSessionId() call.

Initialize the Analytics API.

This must be called prior to calling any other methods in thefirebase::analytics namespace.

See also:firebase::App::GetInstance().

Initiates on-device conversion measurement given a user email address on iOS and tvOS (no-op on Android).

On iOS and tvOS, this method requires the dependency GoogleAppMeasurementOnDeviceConversion to be linked in, otherwise the invocation results in a no-op.

Initiates on-device conversion measurement given a SHA256-hashed user email address.

Requires dependency GoogleAppMeasurementOnDeviceConversion to be linked in, otherwise it is a no-op.

Initiates on-device conversion measurement given a SHA256-hashed phone number in E.164 format.

Requires dependency GoogleAppMeasurementOnDeviceConversion to be linked in, otherwise it is a no-op.

Initiates on-device conversion measurement given a phone number in E.164 format on iOS (no-op on Android).

On iOS, requires dependency GoogleAppMeasurementOnDeviceConversion to be linked in, otherwise it is a no-op.

Returns whether the desktop Analytics SDK is initialized.

Returns true if the Analytics SDK is initialized, false otherwise. The method only works on windows and is a NO-OP on iOS and Android.

Log an event with one string parameter.

See also:LogEvent(const char*, const Parameter*, size_t)

Log an event with one float parameter.

See also:LogEvent(const char*, const Parameter*, size_t)

Log an event with one 64-bit integer parameter.

See also:LogEvent(const char*, const Parameter*, size_t)

Log an event with one integer parameter (stored as a 64-bit integer).

See also:LogEvent(const char*, const Parameter*, size_t)

Log an event with no parameters.

See also:LogEvent(const char*, const Parameter*, size_t)

Log an event with associated parameters.

An Event is an important occurrence in your app that you want to measure. You can report up to 500 different types of events per app and you can associate up to 25 unique parameters with each Event type.

Some common events are documented inAnalytics Events (event_names.h), but you may also choose to specify custom event types that are associated with your specific app.

Log an event with associated parameters.

An Event is an important occurrence in your app that you want to measure. You can report up to 500 different types of events per app and you can associate up to 25 unique parameters with each Event type.

Some common events are documented inAnalytics Events (event_names.h), but you may also choose to specify custom event types that are associated with your specific app.

Notifies the current state of the app's lifecycle.

This method is used to notify the Analytics SDK about the current state of the app's lifecycle. The Analytics SDK will use this information to log events, update user properties, upload data, etc. The method only works on windows and is a NO-OP on iOS and Android.

kTermination is used to indicate that the app is about to be terminated. The caller will be blocked until all pending data is uploaded or an error occurs. The caller must ensure the OS does not terminate background threads before the call returns. Currently only works for Windows Desktop.

Clears all analytics data for this app from the device and resets the app instance id.

Sets whether analytics collection is enabled for this app on this device.

This setting is persisted across app sessions. By default it is enabled.

Sets the applicable end user consent state (e.g., for device identifiers) for this app on this device.

Use the consent map to specify individual consent type values. Settings are persisted across app sessions. By default consent types are set to "granted".

Adds parameters that will be set on every event logged from the SDK.

Adds parameters that will be set on every event logged from the SDK, including automatic ones. The values passed in the parameters bundle will be added to the map of default event parameters. These parameters persist across app runs. They are of lower precedence than event parameters, so if an event parameter and a parameter set using this API have the same name, the value of the event parameter will be used. The same limitations on event parameters apply to default event parameters.

Adds parameters that will be set on every event logged from the SDK.

Adds parameters that will be set on every event logged from the SDK, including automatic ones. The values passed in the parameters bundle will be added to the map of default event parameters. These parameters persist across app runs. They are of lower precedence than event parameters, so if an event parameter and a parameter set using this API have the same name, the value of the event parameter will be used. The same limitations on event parameters apply to default event parameters.

Sets whether desktop debug mode is enabled.

This methods enables desktop debug mode for the analytics SDK. The method only works on windows and is a NO-OP on iOS and Android.

Allows the passing of a callback to be used when the SDK logs any messages regarding its behaviour.

The callback must be thread-safe.

Sets the duration of inactivity that terminates the current session.

Note: The default value is 1800000 (30 minutes).

This feature must be used in accordance withGoogle's Privacy Policy

Set a user property to the given value.

Properties associated with a user allow a developer to segment users into groups that are useful to their application. Up to 25 properties can be associated with a user.

Suggested property names are listedAnalytics User Properties (user_property_names.h) but you're not limited to this set. For example, the "gamertype" property could be used to store the type of player where a range of values could be "casual", "mid_core", or "core".

Terminate the Analytics API.

Cleans up resources associated with the API.