diff --git a/src/content/docs/api/ad-spend-api/cost-id.mdx b/src/content/docs/api/ad-spend-api/cost-id.mdx
index c2a43d7f4..e33fa7d4d 100644
--- a/src/content/docs/api/ad-spend-api/cost-id.mdx
+++ b/src/content/docs/api/ad-spend-api/cost-id.mdx
@@ -10,9 +10,9 @@ A **Cost ID** is a unique cost engagement identifier value between 12 and 256 ch
Here are some points to consider when using `cost_id` with the Ad spend API:
-* To avoid matching a value from one of Adjust's other network partners, the `cost_id` value must be unique. Adjust recommends using a UUID (Universally Unique Identifier) or prefixing your ID with your company’s name. For example: `network_name_848dsf4939fgwjn028erg4`.
-* You can use your pre-existing `click_id` or `impression_id`. If you don't generate your own click or impression IDs, then you can combine two or more placeholders to form it. For example for CPI, you could combine the user’s IDFA (ID For Advertisers) and the app ID.
+* To avoid matching a value from one of Adjust's other network partners, the `cost_id` value must be unique. Adjust recommends using a UUID (Universally Unique Identifier) or prefixing your ID with your company’s name. For example: `network_name_848dsf4939fgwjn028erg4`.
+* You can use your pre-existing `click_id` or `impression_id`. If you don't generate your own click or impression IDs, then you can combine two or more placeholders to form it. For example for CPI, you could combine the user’s IDFA (ID For Advertisers) and the app ID.
## Tracking CPM with Adjust
-To send CPM (Cost Per Mille) data to Adjust, send `cost_id` through the impression tracker URL and refer to it in the ad spend API call. Ensure that you send the CPM with each impression.
+To send CPM (Cost Per Mille) data to Adjust, send `cost_id` through the impression tracker URL and refer to it in the ad spend API call. Ensure that you send the CPM with each impression.
diff --git a/src/content/docs/api/app-automation-api/app-endpoint.mdx b/src/content/docs/api/app-automation-api/app-endpoint.mdx
index d4149e064..2ac0e4d79 100644
--- a/src/content/docs/api/app-automation-api/app-endpoint.mdx
+++ b/src/content/docs/api/app-automation-api/app-endpoint.mdx
@@ -200,9 +200,9 @@ GET https://settings.adjust.com/api/app/{adjust_app_token}/channels
-| Name | Data type | In | Description |
-| -------------------- | --------- | --------------------------------------------------------------------------------------------------- | ----------- |
-| `adjust_app_token`\* | String | Path The Adjust app token. You can find this in the Adjust dashboard or in your /app POST response. |
+| Name | Data type | In | Description |
+| -------------------- | --------- | ---- | ---------------------------------------------------------------------------------------------- |
+| `adjust_app_token`\* | String | Path | The Adjust app token. You can find this in the Adjust dashboard or in your /app POST response. |
diff --git a/src/content/docs/api/app-automation-api/authentication.mdx b/src/content/docs/api/app-automation-api/authentication.mdx
index 9a04f840d..d526f1159 100644
--- a/src/content/docs/api/app-automation-api/authentication.mdx
+++ b/src/content/docs/api/app-automation-api/authentication.mdx
@@ -20,19 +20,19 @@ If you've configured SSO, your API tokens aren't available in the Adjust dashboa
Your Adjust API token is located in your **profile**. To find it, follow these steps:
-1. Select the settings icon () in the bottom left corner.
-2. Select Account settings. Your account settings page opens.
-3. Select the My profile tab.
-4. Your API Token is shown with your User Details. Select the copy button () to copy the token to your system clipboard.
+1. Select the settings icon in the bottom left corner.
+2. Select **Account settings**. Your account settings page opens.
+3. Select the **My profile** tab.
+4. Your **API Token** is shown with your **User Details**. Select the copy button to copy the token to your system clipboard.
## Reset your Adjust API token
You can reset your Adjust API token at any time. Resetting your token invalidates the old token. This means that any requests made using the old token won't work. If you reset your Adjust API token, you need to make sure to update it wherever it's in use.
-1. Select the settings icon () in the bottom left corner.
-2. Select Account settings. Your account settings page opens.
-3. Select the My Profile tab.
-4. Your API Token is shown with your User details.
-5. Select Reset API token. A popup modal appears.
-6. Enter your account password in the modal and select Reset to reset your API token. The modal closes and a confirmation appears in the top right of the screen.
-7. Select the copy button () next to the API Token to copy the token to your system clipboard.
+1. Select the settings icon in the bottom left corner.
+2. Select **Account settings**. Your account settings page opens.
+3. Select the **My Profile** tab.
+4. Your **API Token** is shown with your **User details**.
+5. Select **Reset API token**. A popup modal appears.
+6. Enter your account password in the modal and select **Reset** to reset your API token. The modal closes and a confirmation appears in the top right of the screen.
+7. Select the copy button next to the **API Token** to copy the token to your system clipboard.
diff --git a/src/content/docs/api/app-automation-api/channel-setup.mdx b/src/content/docs/api/app-automation-api/channel-setup.mdx
index 7ce3d0a4a..215df5273 100644
--- a/src/content/docs/api/app-automation-api/channel-setup.mdx
+++ b/src/content/docs/api/app-automation-api/channel-setup.mdx
@@ -31,42 +31,19 @@ All parameters need to be passed as a key-value pair inside the `channel_setup`
-
-
-- - Partner
- - Required parameters
- - Description
-- - `snapchat`
- - `snap_app_id`
- - Your app's Snapchat ID.
-- - `facebook`
- - `app_id`
- - Your app's Facebook ID.
-- - `google`
- - `link_id`
- - Your Google Ads link ID.
-- - `gameanalytics`
- - `key`
- - Your unique GameAnalytics game key.
-- - `tapjoy`
- - `app_id`
- - Your app's Tapjoy ID.
-- - `unityads`
- - `game_id`
- - Your app's Unity Ads ID.
-- - `vungle`
- - `app_id`
- - Your app's Vungle ID.
-- - `chartboost`
- - - `app_id`
- - `token`
- - - `app_id`: Your app's Chartboost ID.
- - `token`: Your app's signature.
-- - `inmobi`
- - - `property_id`
- - `advertiser_id`
- - - `property_id`: Your app's ID in Inmobi.
- - `advertiser_id`: Your Inmobi advertiser ID.
+
+
+| Partner | Required parameters | Description |
+| --------------- | ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
+| `snapchat` | `snap_app_id` | Your app's Snapchat ID. |
+| `facebook` | `app_id` | Your app's Facebook ID. |
+| `google` | `link_id` | Your Google Ads link ID. |
+| `gameanalytics` | `key` | Your unique GameAnalytics game key. |
+| `tapjoy` | `app_id` | Your app's Tapjoy ID. |
+| `unityads` | `game_id` | Your app's Unity Ads ID. |
+| `vungle` | `app_id` | Your app's Vungle ID. |
+| `chartboost` | | - `app_id`: Your app's Chartboost ID.
- `token`: Your app's signature.
|
+| `inmobi` | - `property_id`
- `advertiser_id`
| - `property_id`: Your app's ID in Inmobi.
- `advertiser_id`: Your Inmobi advertiser ID.
|
diff --git a/src/content/docs/api/app-automation-api/status-endpoint.mdx b/src/content/docs/api/app-automation-api/status-endpoint.mdx
index b63269812..aff1c8df5 100644
--- a/src/content/docs/api/app-automation-api/status-endpoint.mdx
+++ b/src/content/docs/api/app-automation-api/status-endpoint.mdx
@@ -29,14 +29,12 @@ Use this endpoint to return the status of a settings copy process. You receive y
}
```
-
+### Statuses
-- `NEW` - the ticket was created, but the migration job hasn't started.
-- `OPENED` - the job for this ticket has started.
-- `FAILED` - the job failed.
-- `COMPLETED` - the job was completed successfully.
-
-
+- `NEW`: the ticket was created, but the migration job hasn't started.
+- `OPENED`: the job for this ticket has started.
+- `FAILED`: the job failed.
+- `COMPLETED`: the job was completed successfully.
## Example
diff --git a/src/content/docs/api/blocklist-api/authentication.mdx b/src/content/docs/api/blocklist-api/authentication.mdx
index c335cc1c8..618c0b985 100644
--- a/src/content/docs/api/blocklist-api/authentication.mdx
+++ b/src/content/docs/api/blocklist-api/authentication.mdx
@@ -20,19 +20,19 @@ If you've configured SSO, your API tokens aren't available in the Adjust dashboa
Your Adjust API token is located in your **profile**. To find it, follow these steps:
-1. Select the settings icon () in the bottom left corner.
-2. Select Account settings. Your account settings page opens.
-3. Select the My profile tab.
-4. Your API Token is shown with your User Details. Select the copy button () to copy the token to your system clipboard.
+1. Select the settings icon in the bottom left corner.
+2. Select **Account settings**. Your account settings page opens.
+3. Select the **My profile** tab.
+4. Your **API Token** is shown with your **User Details**. Select the copy button to copy the token to your system clipboard.
## Reset your Adjust API token
You can reset your Adjust API token at any time. Resetting your token invalidates the old token. This means that any requests made using the old token won't work. If you reset your Adjust API token, you need to make sure to update it wherever it's in use.
-1. Select the settings icon () in the bottom left corner.
-2. Select Account settings. Your account settings page opens.
-3. Select the My Profile tab.
-4. Your API Token is shown with your User details.
-5. Select Reset API token. A popup modal appears.
-6. Enter your account password in the modal and select Reset to reset your API token. The modal closes and a confirmation appears in the top right of the screen.
-7. Select the copy button () next to the API Token to copy the token to your system clipboard.
+1. Select the settings icon in the bottom left corner.
+2. Select **Account settings**. Your account settings page opens.
+3. Select the **My Profile** tab.
+4. Your **API Token** is shown with your **User details**.
+5. Select **Reset API token**. A popup modal appears.
+6. Enter your account password in the modal and select **Reset** to reset your API token. The modal closes and a confirmation appears in the top right of the screen.
+7. Select the copy button next to the **API Token** to copy the token to your system clipboard.
diff --git a/src/content/docs/api/blocklist-api/index.mdx b/src/content/docs/api/blocklist-api/index.mdx
index b6cd3bbfc..3e4f7229d 100644
--- a/src/content/docs/api/blocklist-api/index.mdx
+++ b/src/content/docs/api/blocklist-api/index.mdx
@@ -11,11 +11,11 @@ slug: en/api/blocklist-api
-Use the Adjust Blocklist API to block traffic from fraudulent or outdated tracker URLs. Blocklisted trackers display a BLOCKLISTED label in the dashboard.
+Use the Adjust Blocklist API to block traffic from fraudulent or outdated tracker URLs. Blocklisted trackers display a **BLOCKLISTED** label in the dashboard.
You can blocklist tracker URLs for Dynamic and Module partners. You can't blocklist SAN partner tracker URLs. If you want to block traffic from a SAN partner URL, you need to delete the SAN partner.
-
+
See [Self-attributing network setup
](https://help.adjust.com/en/suite/article/self-attributing-network-san-setup) for a list of SAN partners.
@@ -59,10 +59,10 @@ Viewing the status of links is currently available only in the Classic dashboard
You can check which links are blocklisted in the Adjust dashboard. To do this:
-1. Find your app and select your app options caret ().
-2. Select Tracker URLs.
-3. Select Settings () next to your link.
+1. Find your app and select your app options caret (`^`).
+2. Select **Tracker URLs**.
+3. Select **Settings** next to your link.
-Links on the blocklist display as BLOCKLISTED.
+Links on the blocklist display as **BLOCKLISTED**.
-You can't EDIT blocklisted links. The only option you have is to hide the link. When you hide a link, you hide it from your list of active links. You can hide or unhide a blocklisted link at any time. For more on hiding links, see [Tracker maintenance](https://help.adjust.com/en/article/tracker-maintenance).
+You can't **EDIT** blocklisted links. The only option you have is to hide the link. When you hide a link, you hide it from your list of active links. You can hide or unhide a blocklisted link at any time. For more on hiding links, see [Tracker maintenance](https://help.adjust.com/en/article/tracker-maintenance).
diff --git a/src/content/docs/api/campaign-api/authentication.mdx b/src/content/docs/api/campaign-api/authentication.mdx
index 3f8158a68..dfcca4203 100644
--- a/src/content/docs/api/campaign-api/authentication.mdx
+++ b/src/content/docs/api/campaign-api/authentication.mdx
@@ -20,19 +20,19 @@ If you've configured SSO, your API tokens aren't available in the Adjust dashboa
Your Adjust API token is located in your **profile**. To find it, follow these steps:
-1. Select the settings icon () in the bottom left corner.
-2. Select Account settings. Your account settings page opens.
-3. Select the My profile tab.
-4. Your API Token is shown with your User Details. Select the copy button () to copy the token to your system clipboard.
+1. Select the settings icon in the bottom left corner.
+2. Select **Account settings**. Your account settings page opens.
+3. Select the **My profile** tab.
+4. Your **API Token** is shown with your **User Details**. Select the copy button to copy the token to your system clipboard.
## Reset your Adjust API token
You can reset your Adjust API token at any time. Resetting your token invalidates the old token. This means that any requests made using the old token won't work. If you reset your Adjust API token, you need to make sure to update it wherever it's in use.
-1. Select the settings icon () in the bottom left corner.
-2. Select Account settings. Your account settings page opens.
-3. Select the My Profile tab.
-4. Your API Token is shown with your User details.
-5. Select Reset API token. A popup modal appears.
-6. Enter your account password in the modal and select Reset to reset your API token. The modal closes and a confirmation appears in the top right of the screen.
-7. Select the copy button () next to the API Token to copy the token to your system clipboard.
+1. Select the settings icon in the bottom left corner.
+2. Select **Account settings**. Your account settings page opens.
+3. Select the **My Profile** tab.
+4. Your **API Token** is shown with your **User details**.
+5. Select **Reset API token**. A popup modal appears.
+6. Enter your account password in the modal and select **Reset** to reset your API token. The modal closes and a confirmation appears in the top right of the screen.
+7. Select the copy button next to the **API Token** to copy the token to your system clipboard.
diff --git a/src/content/docs/api/campaign-api/create-tracker.mdx b/src/content/docs/api/campaign-api/create-tracker.mdx
index 5e11e4bcf..0b232da2e 100644
--- a/src/content/docs/api/campaign-api/create-tracker.mdx
+++ b/src/content/docs/api/campaign-api/create-tracker.mdx
@@ -46,15 +46,6 @@ Create a new tracker or subtracker associated to your app.
-
-
-- Network = `1`
-- Campaign = `2`
-- Adgroup = `3`
-- Creative = `4`
-
-
-
```json title="Response format"
{
"name": "String",
@@ -71,6 +62,13 @@ Create a new tracker or subtracker associated to your app.
}
```
+#### Tracker levels
+
+- Network = `1`
+- Campaign = `2`
+- Adgroup = `3`
+- Creative = `4`
+
## Example
diff --git a/src/content/docs/api/device-api/authentication.mdx b/src/content/docs/api/device-api/authentication.mdx
index 232b0631c..4743e5457 100644
--- a/src/content/docs/api/device-api/authentication.mdx
+++ b/src/content/docs/api/device-api/authentication.mdx
@@ -20,19 +20,19 @@ If you've configured SSO, your API tokens aren't available in the Adjust dashboa
Your Adjust API token is located in your **profile**. To find it, follow these steps:
-1. Select the settings icon () in the bottom left corner.
-2. Select Account settings. Your account settings page opens.
-3. Select the My profile tab.
-4. Your API Token is shown with your User Details. Select the copy button () to copy the token to your system clipboard.
+1. Select the settings icon in the bottom left corner.
+2. Select **Account settings**. Your account settings page opens.
+3. Select the **My profile** tab.
+4. Your **API Token** is shown with your **User Details**. Select the copy button to copy the token to your system clipboard.
## Reset your Adjust API token
You can reset your Adjust API token at any time. Resetting your token invalidates the old token. This means that any requests made using the old token won't work. If you reset your Adjust API token, you need to make sure to update it wherever it's in use.
-1. Select the settings icon () in the bottom left corner.
-2. Select Account settings. Your account settings page opens.
-3. Select the My Profile tab.
-4. Your API Token is shown with your User details.
-5. Select Reset API token. A popup modal appears.
-6. Enter your account password in the modal and select Reset to reset your API token. The modal closes and a confirmation appears in the top right of the screen.
-7. Select the copy button () next to the API Token to copy the token to your system clipboard.
+1. Select the settings icon in the bottom left corner.
+2. Select **Account settings**. Your account settings page opens.
+3. Select the **My Profile** tab.
+4. Your **API Token** is shown with your **User details**.
+5. Select **Reset API token**. A popup modal appears.
+6. Enter your account password in the modal and select **Reset** to reset your API token. The modal closes and a confirmation appears in the top right of the screen.
+7. Select the copy button next to the **API Token** to copy the token to your system clipboard.
diff --git a/src/content/docs/api/gdpr-api/index.mdx b/src/content/docs/api/gdpr-api/index.mdx
index df3ad3b03..59b3ee56d 100644
--- a/src/content/docs/api/gdpr-api/index.mdx
+++ b/src/content/docs/api/gdpr-api/index.mdx
@@ -5,7 +5,7 @@ category-title: GDPR API
slug: en/api/gdpr-api
---
-Adjust offers an API endpoint to facilitate RTBF (Right to be Forgotten) requests. This endpoint performs the following actions for a given device:
+Adjust offers an API endpoint to facilitate RTBF (Right to be Forgotten) requests. This endpoint performs the following actions for a given device:
- Permanently deletes all the user’s personal data from Adjust for the specified app.
- Stops receiving the user’s information from the Adjust SDK for the specified app.
diff --git a/src/content/docs/api/kpi-service/authentication.mdx b/src/content/docs/api/kpi-service/authentication.mdx
deleted file mode 100644
index fd9be7c6c..000000000
--- a/src/content/docs/api/kpi-service/authentication.mdx
+++ /dev/null
@@ -1,38 +0,0 @@
----
-title: "KPI service authentication"
-description: "You need a bearer token to use the KPI service."
-slug: en/api/kpi-service/authentication
-sidebar-position: 1
-sidebar-label: Authentication
----
-
-You need a [bearer token](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication) to use the KPI service. You can get this token in the Adjust dashboard by following the steps in this article.
-
-## Find your Adjust API token
-
-Before you can start making API calls, you first need to find your Adjust API token. You can find your Adjust API token in your Adjust dashboard.
-
-
-
-If you've configured SSO, your API tokens aren't available in the Adjust dashboard. Reach out to your Adjust representative or support@adjust.com for help with API tokens.
-
-
-
-Your Adjust API token is located in your **profile**. To find it, follow these steps:
-
-1. Select the settings icon () in the bottom left corner.
-2. Select Account settings. Your account settings page opens.
-3. Select the My profile tab.
-4. Your API Token is shown with your User Details. Select the copy button () to copy the token to your system clipboard.
-
-## Reset your Adjust API token
-
-You can reset your Adjust API token at any time. Resetting your token invalidates the old token. This means that any requests made using the old token won't work. If you reset your Adjust API token, you need to make sure to update it wherever it's in use.
-
-1. Select the settings icon () in the bottom left corner.
-2. Select Account settings. Your account settings page opens.
-3. Select the My Profile tab.
-4. Your API Token is shown with your User details.
-5. Select Reset API token. A popup modal appears.
-6. Enter your account password in the modal and select Reset to reset your API token. The modal closes and a confirmation appears in the top right of the screen.
-7. Select the copy button () next to the API Token to copy the token to your system clipboard.
diff --git a/src/content/docs/api/kpi-service/cohort-metrics.mdx b/src/content/docs/api/kpi-service/cohort-metrics.mdx
deleted file mode 100644
index 7fc646104..000000000
--- a/src/content/docs/api/kpi-service/cohort-metrics.mdx
+++ /dev/null
@@ -1,632 +0,0 @@
----
-title: "Cohort metrics"
-description: "Use these endpoints to retrieve cohort metrics for your app."
-slug: en/api/kpi-service/cohort-metrics
-sidebar-position: 4
----
-
-
-
-These endpoints return JSON by default. You can return CSV by adding the following header to your call: `Accept: text/csv`
-
-
-
-Use these endpoints to retrieve cohort metrics for your app.
-
-## Fetch cohort metrics
-
-```http title="Endpoint" "/{app_token}/cohorts"
-GET https://api.adjust.com/kpis/v1/{app_token}/cohorts
-```
-
-Returns cohort metrics associated with an app. Metrics are returned in a `kpi_values` array in the same order as the metrics in your request.
-
-### Parameters
-
-
-
-| Parameter | Format | In | Description |
-| --------------------- | ------- | ----- | ----------------------------------------------------------------------------------------------------------------------------- |
-| `app_token` | String | Path | Your app's 10 character identifier. |
-| `start_date` | Date | Query | The start date of the selected period. `YYYY-MM-DD` format. |
-| `end_date` | Date | Query | The end date of the selected period. `YYYY-MM-DD` format. |
-| `utc_offset` | Time | Query | UTC offset for timezones. `[+-]HH:MM` format. |
-| `kpis` | String | Query | Comma-separated list of metrics. Use App metrics, Fraud metrics, and Ad spend metrics |
-| `sandbox` | Boolean | Query | Whether results come from sandbox or production data. Defaults to production (`false`). |
-| `attribution_type` | String | Query | The type of attribution to include in the results. Available options: `click` \| `impression` \| `all` |
-| `period` | String | Query | The cohort period you want results for. Available options: `day` \| `week` \| `month` |
-| `reattributed` | String | Query | Filter metrics by: installed users (`false`) \| reattributed users (`true`) \| all users (`default`) |
-| `events` | String | Query | Comma-separated list of event tokens. |
-| `countries` | String | Query | Comma-separated list of ISO 3166 alpha-2 country names. |
-| `os_names` | String | Query | Comma-separated list of OS names. |
-| `device_types` | String | Query | Comma-separated list of device types. |
-| `grouping` | String | Query | Grouping parameters. [See Result grouping](/en/api/kpi-service/grouping) for more information. |
-| `tracker_filter` | String | Query | The tracker tokens of any trackers you want to include in your results. Only metrics relating to these trackers are returned. |
-| `human_readable_kpis` | Boolean | Query | Replace metrics with human readable alternatives (for example: "Lifetime Value" instead of `lifetime_value`). |
-
-
-
-### Example
-
-
-
-
-```console title="cURL" "start_date" "end_date" "kpis" "countries"
-$ curl \
---header 'Authorization: Token token={your_api_token}' \
--L -X GET 'http://api.adjust.com/kpis/v1/2eb2na2w54c3/cohorts?start_date=2022-05-01&end_date=2022-05-31&kpis=sessions&countries=de,gb'
-```
-
-```json title="Success response"
-{
- "result_parameters": {
- "kpis": ["sessions"],
- "start_date": "2022-07-01",
- "end_date": "2022-07-28",
- "sandbox": false,
- "countries": ["de", "gb"],
- "events": [
- {
- "name": "General Revenue Event",
- "token": "0"
- }
- ],
- "trackers": [
- {
- "token": "12djsk",
- "name": "Network 1",
- "has_subtrackers": false
- }
- ],
- "grouping": ["trackers", "weeks", "events", "periods"],
- "period": "week",
- "attribution_type": "click",
- "utc_offset": "00:00",
- "day_def": "24h",
- "attribution_source": "dynamic"
- },
- "result_set": {
- "token": "2eb2na2w54c3",
- "name": "First tracker",
- "currency": "EUR",
- "trackers": [
- {
- "token": "12djsk",
- "dates": [
- {
- "date": "2022-04-27",
- "events": [
- {
- "token": "0",
- "periods": [
- {
- "period": "0",
- "kpi_values": [4295]
- }
- ]
- }
- ]
- },
- {
- "date": "2022-05-04",
- "events": [
- {
- "token": "0",
- "periods": [
- {
- "period": "0",
- "kpi_values": [10073]
- }
- ]
- }
- ]
- },
- {
- "date": "2022-05-11",
- "events": [
- {
- "token": "0",
- "periods": [
- {
- "period": "0",
- "kpi_values": [10080]
- }
- ]
- }
- ]
- },
- {
- "date": "2022-05-18",
- "events": [
- {
- "token": "0",
- "periods": [
- {
- "period": "0",
- "kpi_values": [10080]
- }
- ]
- }
- ]
- },
- {
- "date": "2022-05-25",
- "events": [
- {
- "token": "0",
- "periods": [
- {
- "period": "0",
- "kpi_values": [5213]
- }
- ]
- }
- ]
- }
- ]
- }
- ]
- }
-}
-```
-
-
-
-
-
-```console title="cURL" "start_date" "end_date" "kpis" "countries"
-$ curl \
---header 'Authorization: Token token={your_api_token}' \
---location --request GET 'http://api.adjust.com/kpis/v1/2eb2na2w54c3/cohorts?start_date=2022-05-01&end_date=2022-05-31&kpis=sessions,installs&grouping=trackers,weeks,events&countries=de,gb' \
---header 'Accept: text/csv'
-```
-
-```text title="Success response"
-tracker_token,tracker_name,date,event_token,event_name,period,sessions
-12djsk,Network 1,2022-04-27,0,General Revenue Event,0,4295
-12djsk,Network 1,2022-05-04,0,General Revenue Event,0,10073
-12djsk,Network 1,2022-05-11,0,General Revenue Event,0,10080
-12djsk,Network 1,2022-05-18,0,General Revenue Event,0,10080
-12djsk,Network 1,2022-05-25,0,General Revenue Event,0,5212
-```
-
-
-
-
-## Fetch cohort metrics for multiple apps
-
-```http title="Endpoint" "/{app_tokens}/cohorts"
-GET https://api.adjust.com/kpis/v1/{app_tokens}/cohorts
-```
-
-Returns cohort metrics associated with multiple apps. Metrics are returned in a `kpi_values` array in the same order as the metrics in your request.
-
-### Parameters
-
-
-
-| Parameter | Format | In | Description |
-| --------------------- | ------- | ----- | ----------------------------------------------------------------------------------------------------------------------------- |
-| `app_tokens` | String | Query | A comma-separated list of app tokens. |
-| `start_date` | Date | Query | The start date of the selected period. `YYYY-MM-DD` format. |
-| `end_date` | Date | Query | The end date of the selected period. `YYYY-MM-DD` format. |
-| `utc_offset` | Time | Query | UTC offset for timezones. `[+-]HH:MM` format. |
-| `kpis` | String | Query | Comma-separated list of metrics. Comma-separated list of metrics. Use App metrics, Fraud metrics, and Ad spend metrics |
-| `sandbox` | Boolean | Query | Whether results come from sandbox or production data. Defaults to production (`false`). |
-| `countries` | String | Query | Comma-separated list of ISO 3166 alpha-2 country names. |
-| `os_names` | String | Query | Comma-separated list of OS names. |
-| `device_types` | String | Query | Comma-separated list of device types. |
-| `grouping` | String | Query | Grouping parameters. [See Result grouping](/en/api/kpi-service/grouping) for more information. |
-| `tracker_filter` | String | Query | The tracker tokens of any trackers you want to include in your results. Only metrics relating to these trackers are returned. |
-| `human_readable_kpis` | Boolean | Query | Replace metrics with human readable alternatives (for example: "Lifetime Value" instead of `lifetime_value`). |
-
-
-
-### Example
-
-
-
-
-```console title="cURL" "2eb2na2w54c3,3fdwnag4ecf2"
-$ curl \
---header 'Authorization: Token token={your_app_token}' \
--L -X GET 'http://api.adjust.com/kpis/v1/2eb2na2w54c3,3fdwnag4ecf2/cohorts?start_date=2022-05-01&end_date=2022-05-31&kpis=sessions&countries=de,gb&human_readable_kpis=true'
-```
-
-```json title="Success response"
-{
- "result_parameters": {
- "kpis": ["Sessions"],
- "start_date": "2022-05-01",
- "end_date": "2022-05-31",
- "sandbox": false,
- "countries": ["de", "gb"],
- "grouping": ["apps", "periods"],
- "period": "day",
- "attribution_type": "click",
- "utc_offset": "00:00",
- "day_def": "24h",
- "attribution_source": "dynamic"
- },
- "result_set": {
- "apps": [
- {
- "token": "2eb2na2w54c3",
- "name": "app name",
- "currency": "EUR",
- "periods": [
- {
- "period": "0",
- "kpi_values": [3]
- }
- ]
- },
- {
- "token": "3fdwnag4ecf2",
- "name": "test app",
- "currency": "EUR",
- "periods": [
- {
- "period": "0",
- "kpi_values": [40158]
- }
- ]
- }
- ]
- }
-}
-```
-
-
-
-
-### CSV
-
-```console title="cURL" "2eb2na2w54c3,3fdwnag4ecf2"
-$ curl \
---header 'Authorization: Token token={your_app_token}' \
--L -X GET 'http://api.adjust.com/kpis/v1/2eb2na2w54c3,3fdwnag4ecf2/cohorts?start_date=2022-05-01&end_date=2022-05-31&kpis=sessions&countries=de,gb&human_readable_kpis=true' \
---header 'Accept: text/csv'
-```
-
-```text title="Success response"
-App Token,App Name,Days after Install,Sessions
-2eb2na2w54c3,app name,0,3
-3fdwnag4ecf2,test app,0,40162
-```
-
-
-
-
-## Retrieve cohort metrics for a tracker
-
-```http title="Endpoint" "/{app_token}/trackers/{tracker_token}/cohorts"
-GET https://api.adjust.com/kpis/v1/{app_token}/trackers/{tracker_token}/cohorts
-```
-
-Returns cohort metrics associated with a specific tracker. Metrics are returned in a `kpi_values` array in the same position the KPIs in your request.
-
-### Parameters
-
-
-
-| Parameter | Format | In | Description |
-| --------------------- | ------- | ----- | ----------------------------------------------------------------------------------------------------------------------------- |
-| `app_token` | String | Path | Your app's 10 character identifier. |
-| `tracker_token` | String | Path | Your tracker's 6 character identifier. |
-| `start_date` | Date | Query | The start date of the selected period. YYYY-MM-DD format. |
-| `end_date` | Date | Query | The end date of the selected period. YYYY-MM-DD format. |
-| `utc_offset` | Time | Query | UTC offset for timezones. [+-]HH:MM format. |
-| `kpis` | String | Query | Comma-separated list of metrics. Use App metrics, Fraud metrics, and Ad spend metrics |
-| `sandbox` | Boolean | Query | Whether results come from sandbox or production data. Defaults to production (false). |
-| `attribution_type` | String | Query | The type of attribution to include in the results. `click` \| `impression` \| `all` |
-| `period` | String | Query | The cohort period you want results for. `day` \| `week` \| `month` |
-| `reattributed` | String | Query | Filter metrics by: installed users (`false`) \| reattributed users (`true`) \| all users (`default`) |
-| `events` | String | Query | Comma-separated list of event tokens. |
-| `countries` | String | Query | Comma-separated list of ISO 3166 alpha-2 country names. |
-| `os_names` | String | Query | Comma-separated list of OS names. |
-| `device_types` | String | Query | Comma-separated list of device types. |
-| `grouping` | String | Query | Grouping parameters. [See Result grouping](/en/api/kpi-service/grouping) for more information. |
-| `tracker_filter` | String | Query | The tracker tokens of any trackers you want to include in your results. Only metrics relating to these trackers are returned. |
-| `human_readable_kpis` | Boolean | Query | Replace metrics with human readable alternatives (for example "Lifetime Value" instead of `lifetime_value`). |
-
-
-
-### Example
-
-
-
-
-```console title="cURL" "12djsk"
-$ curl \
---header 'Authorization: Token token={your_api_token}' \
--L -X GET 'http://api.adjust.com/kpis/v1/2eb2na2w54c3/trackers/12djsk/cohorts?start_date=2022-05-01&end_date=2022-05-31&kpis=sessions&countries=de,gb'
-```
-
-```json title="Success response"
-{
- "result_parameters": {
- "kpis": ["sessions"],
- "start_date": "2022-07-01",
- "end_date": "2022-07-28",
- "sandbox": false,
- "countries": ["de", "gb"],
- "events": [
- {
- "name": "General Revenue Event",
- "token": "0"
- }
- ],
- "trackers": [
- {
- "token": "12djsk",
- "name": "Network 1",
- "has_subtrackers": false
- }
- ],
- "grouping": ["trackers", "weeks", "events", "periods"],
- "period": "week",
- "attribution_type": "click",
- "utc_offset": "00:00",
- "day_def": "24h",
- "attribution_source": "dynamic"
- },
- "result_set": {
- "token": "2eb2na2w54c3",
- "name": "First tracker",
- "currency": "EUR",
- "trackers": [
- {
- "token": "12djsk",
- "dates": [
- {
- "date": "2022-04-27",
- "events": [
- {
- "token": "0",
- "periods": [
- {
- "period": "0",
- "kpi_values": [4295]
- }
- ]
- }
- ]
- },
- {
- "date": "2022-05-04",
- "events": [
- {
- "token": "0",
- "periods": [
- {
- "period": "0",
- "kpi_values": [10073]
- }
- ]
- }
- ]
- },
- {
- "date": "2022-05-11",
- "events": [
- {
- "token": "0",
- "periods": [
- {
- "period": "0",
- "kpi_values": [10080]
- }
- ]
- }
- ]
- },
- {
- "date": "2022-05-18",
- "events": [
- {
- "token": "0",
- "periods": [
- {
- "period": "0",
- "kpi_values": [10080]
- }
- ]
- }
- ]
- },
- {
- "date": "2022-05-25",
- "events": [
- {
- "token": "0",
- "periods": [
- {
- "period": "0",
- "kpi_values": [5213]
- }
- ]
- }
- ]
- }
- ]
- }
- ]
- }
-}
-```
-
-
-
-
-
-```console title="cURL" "12djsk"
-$ curl \
---header 'Authorization: Token token={your_api_token}' \
--L -X GET 'http://api.adjust.com/kpis/v1/2eb2na2w54c3/trackers/12djsk/cohorts?start_date=2022-05-01&end_date=2022-05-31&kpis=sessions,installs&grouping=trackers,weeks,events&countries=de,gb' \
---header 'Accept: text/csv'
-```
-
-```text title="Success response"
-tracker_token,tracker_name,date,event_token,event_name,period,sessions
-12djsk,Network 1,2022-04-27,0,General Revenue Event,0,4295
-12djsk,Network 1,2022-05-04,0,General Revenue Event,0,10073
-12djsk,Network 1,2022-05-11,0,General Revenue Event,0,10080
-12djsk,Network 1,2022-05-18,0,General Revenue Event,0,10080
-12djsk,Network 1,2022-05-25,0,General Revenue Event,0,5212
-```
-
-
-
-
-## Response format
-
-
-
-
-```json title="Response format"
-{
- "result_parameters": {
- "kpis": ["string"],
- "start_date": "2022-07-01",
- "end_date": "2022-07-28",
- "sandbox": false,
- "countries": ["string"],
- "events": [
- {
- "name": "string",
- "token": "string"
- }
- ],
- "trackers": [
- {
- "token": "string",
- "name": "string",
- "has_subtrackers": false
- }
- ],
- "grouping": ["string"],
- "period": "string",
- "attribution_type": "string",
- "utc_offset": "00:00",
- "day_def": "string",
- "attribution_source": "string"
- },
- "result_set": {
- "token": "string",
- "name": "string",
- "currency": "string",
- "apps": [
- {
- "token": "string",
- "name": "string",
- "currency": "string",
- "periods": [
- {
- "period": "0",
- "kpi_values": [3]
- }
- ]
- }
- ],
- "trackers": [
- {
- "token": "string",
- "dates": [
- {
- "date": "2022-06-27",
- "events": [
- {
- "token": "string",
- "periods": [
- {
- "period": "string",
- "kpi_values": [1]
- }
- ]
- }
- ]
- }
- ]
- }
- ]
- }
-}
-```
-
-
-
-
-
-```text title="Response format"
-tracker_token,tracker_name,date,event_token,event_name,period,{kpi}
-string,string,2022-06-27,0,string,0,1
-```
-
-
-
-
-### Response values
-
-
-
-| Error code | Description |
-| --------------------------- | -------------------------------------------------------------------------------------------------------------- |
-| `400 Bad Request` | Malformed request passed by the client. |
-| `401 Unauthorized` | Authentication failed. |
-| `403 Forbidden` | Client doesn't have access to information such as KPIs, selected time period, or cohort period in the request. |
-| `404 Not Found` | Request data not found. |
-| `499 Client closed request` | The transaction closed before all information was returned by the server. |
-
-
-
-## Default parameters
-
-
-
-| Parameter | Default values |
-| --------- | ---------------- |
-| `kpis` | `retention_rate` |
-
-
-
-## Parameter values
-
-
-
-- `android`
-- `bada`
-- `blackberry`
-- `ios`
-- `linux`
-- `macos`
-- `server`
-- `symbian`
-- `unknown`
-- `webos`
-- `windows`
-- `windows-phone`
-- `android-tv`
-- `apple-tv`
-- `fire-tv`
-- `roku-os`
-- `smart-cast`
-- `tizen`
-
-
-
-
-
-- `bot`
-- `console`
-- `ipod`
-- `mac`
-- `pc`
-- `phone`
-- `server`
-- `simulator`
-- `tablet`
-- `tv`
-- `unknown`
-
-
diff --git a/src/content/docs/api/kpi-service/event-metrics.mdx b/src/content/docs/api/kpi-service/event-metrics.mdx
deleted file mode 100644
index 07a3ff981..000000000
--- a/src/content/docs/api/kpi-service/event-metrics.mdx
+++ /dev/null
@@ -1,410 +0,0 @@
----
-title: "Event metrics"
-description: "Use these endpoints to retrieve event metrics for your app."
-slug: en/api/kpi-service/event-metrics
-sidebar-position: 3
----
-
-
-
-These endpoints return JSON by default. You can return CSV by adding the following header to your call: `Accept: text/csv`
-
-
-
-Use these endpoints to retrieve event metrics for your app.
-
-## Fetch event metrics
-
-```http title="Endpoint" "/{app_token}/events"
-GET https://api.adjust.com/kpis/v1/{app_token}/events
-```
-
-Returns event metrics associated with an app. Metrics are returned in a `kpi_values` array in the same order as the metrics in your request.
-
-### Parameters
-
-
-
-| Parameter | Format | In | Description |
-| --------------------- | ------- | ----- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `app_token` | String | Path | Your app's 10 character identifier. |
-| `start_date` | Date | Query | The start date of the selected period. `YYYY-MM-DD` format. |
-| `end_date` | Date | Query | The end date of the selected period. `YYYY-MM-DD` format. |
-| `utc_offset` | Time | Query | UTC offset for timezones. `[+-]HH:MM` format. |
-| `kpis` | String | Query | Comma-separated list of Event metrics. Prepend your event token to each metric. Example: `token1_revenue` |
-| `sandbox` | Boolean | Query | Whether results come from sandbox or production data. Defaults to production (`false`). |
-| `events` | String | Query | Comma-separated list of event tokens. |
-| `attribution_type` | String | Query | The type of attribution to include in the results. `click` \| `impression` \| `all` |
-| `attribution_source` | String | Query | Determines whether in-app activity is assigned to the user’s install source (`first`) or divided among the install source and subsequent rces of reattribution (`dynamic`). The default setting is `dynamic`. |
-| `countries` | String | Query | Comma-separated list of ISO 3166 alpha-2 country names. |
-| `os_names` | String | Query | Comma-separated list of OS names. |
-| `device_types` | String | Query | Comma-separated list of device types. |
-| `grouping` | String | Query | Grouping parameters. [See Result grouping](/en/api/kpi-service/grouping) for more information. |
-| `tracker_filter` | String | Query | The tracker tokens of any trackers you want to include in your results. Only metrics relating to these trackers are returned. |
-| `partner_ids` | String | Query | Comma-separated list of partner IDs. Only metrics from the partners in this list are returned. |
-| `human_readable_kpis` | Boolean | Query | Replace metrics with human readable alternatives (for example: "Lifetime Value" instead of `lifetime_value`). |
-
-
-
-### Example
-
-
-
-
-```console title="cURL" "2eb2na2w54c3"
-$ curl \
---header 'Authorization: Token token={your_api_token}' \
--L -X GET 'http://api.adjust.com/kpis/v1/2eb2na2w54c3/events?start_date=2022-05-01&end_date=2022-05-31&kpis=sessions,installs&countries=de,gb'
-```
-
-```json title="Success response"
-{
- "result_parameters": {
- "kpis": ["revenue", "events", "revenue_per_event"],
- "start_date": "2022-05-01",
- "end_date": "2022-05-31",
- "sandbox": false,
- "countries": ["de", "gb"],
- "events": [
- { "token": "abcdef", "name": "Login" },
- { "token": "badcfe", "name": "Level Up" }
- ],
- "grouping": ["trackers", "weeks", "events"],
- "trackers": [
- {
- "token": "12djsk",
- "name": "Network 1",
- "has_subtrackers": true
- }
- ]
- },
- "result_set": {
- "token": "2eb2na2w54c3",
- "name": "app name",
- "currency": "USD",
- "trackers": [
- {
- "token": "12djsk",
- "dates": [
- {
- "date": "2022-05-02",
- "events": [
- {
- "token": "abcdef",
- "kpi_values": [4, 5, 0.8]
- },
- {
- "token": "badcfe",
- "kpi_values": [3, 5, 7.2]
- }
- ]
- },
- {
- "date": "2022-05-09",
- "events": [
- {
- "token": "badcfe",
- "kpi_values": [4, 5, 0.8]
- }
- ]
- }
- ]
- }
- ]
- }
-}
-```
-
-
-
-
-
-```console title="cURL" "2eb2na2w54c3"
-$ curl \
---header 'Authorization: Token token={your_api_token}' \
---header 'Accept: text/csv' \
--L -X GET 'http://api.adjust.com/kpis/v1/2eb2na2w54c3/events?start_date=2022-05-01&end_date=2022-05-31&kpis=sessions,installs&countries=de,gb'
-```
-
-```text title="Success response"
-tracker_token,tracker_name,date,event_token,revenue,events,revenue_per_event
-12djsk,Network 1,2022-05-02,abcdef,4,5,0.8
-12djsk,Network 1,2022-05-02,badcfe,3,5,7.2
-12djsk,Network 1,2022-05-09,badcfe,4,5,0.8
-```
-
-
-
-
-## Fetch tracker event metrics
-
-```http "/{app_token}/trackers/{tracker_token}/events"
-GET https://api.adjust.com/kpis/v1/{app_token}/trackers/{tracker_token}/events
-```
-
-Returns event metrics associated with a specific tracker. Metrics are returned in a `kpi_values` array in the same position the KPIs in your request.
-
-### Parameters
-
-
-
-| Parameter | Format | In | Description |
-| --------------------- | ------- | ----- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `app_token` | String | Path | Your app's 10 character identifier. |
-| `tracker_token` | String | Path | Your tracker's 6 character identifier. |
-| `start_date` | Date | Query | The start date of the selected period. `YYYY-MM-DD` format. |
-| `end_date` | Date | Query | The end date of the selected period. `YYYY-MM-DD` format. |
-| `utc_offset` | Time | Query | UTC offset for timezones. `[+-]HH:MM` format. |
-| `kpis` | String | Query | Comma-separated list of Event metrics. Prepend your event token to each metric. Example: `token1_revenue` |
-| `sandbox` | Boolean | Query | Whether results come from sandbox or production data. Defaults to production (`false`). |
-| `events` | String | Query | Comma-separated list of event tokens. |
-| `attribution_type` | String | Query | The type of attribution to include in the results. `click` \| `impression` \| `all` |
-| `attribution_source` | String | Query | Determines whether in-app activity is assigned to the user’s install source (`first`) or divided among the install source and subsequent rces of reattribution (`dynamic`). The default setting is `dynamic`. |
-| `countries` | String | Query | Comma-separated list of ISO 3166 alpha-2 country names. |
-| `os_names` | String | Query | Comma-separated list of OS names. |
-| `device_types` | String | Query | Comma-separated list of device types. |
-| `grouping` | String | Query | Grouping parameters. [See Result grouping](/en/api/kpi-service/grouping) for more information. |
-| `tracker_filter` | String | Query | The tracker tokens of any trackers you want to include in your results. Only metrics relating to these trackers are returned. |
-| `partner_ids` | String | Query | Comma-separated list of partner IDs. Only metrics from the partners in this list are returned. |
-| `human_readable_kpis` | Boolean | Query | Replace metrics with human readable alternatives (for example "Lifetime Value" instead of `lifetime_value`). |
-
-
-
-### Example
-
-
-
-
-```console title="cURL" "2eb2na2w54c3" "12djsk"
-$ curl \
---header 'Authorization: Token token={your_api_token}' \
--L -X GET 'http://api.adjust.com/kpis/v1/2eb2na2w54c3/trackers/12djsk/events?start_date=2022-05-01&end_date=2022-05-31&kpis=sessions,installs&countries=de,gb'
-```
-
-```json title="Success response"
-{
- "result_parameters": {
- "kpis": ["revenue", "events", "revenue_per_event"],
- "start_date": "2022-05-01",
- "end_date": "2022-05-31",
- "sandbox": false,
- "countries": ["de", "gb"],
- "events": [
- { "token": "abcdef", "name": "Login" },
- { "token": "badcfe", "name": "Level Up" }
- ],
- "grouping": ["trackers", "weeks", "events"],
- "trackers": [
- {
- "token": "12djsk",
- "name": "Network 1",
- "has_subtrackers": true
- }
- ]
- },
- "result_set": {
- "token": "2eb2na2w54c3",
- "name": "app name",
- "currency": "USD",
- "trackers": [
- {
- "token": "12djsk",
- "dates": [
- {
- "date": "2022-05-02",
- "events": [
- {
- "token": "abcdef",
- "kpi_values": [4, 5, 0.8]
- },
- {
- "token": "badcfe",
- "kpi_values": [3, 5, 7.2]
- }
- ]
- },
- {
- "date": "2022-05-09",
- "events": [
- {
- "token": "badcfe",
- "kpi_values": [4, 5, 0.8]
- }
- ]
- }
- ]
- }
- ]
- }
-}
-```
-
-
-
-
-
-```console title="cURL" "2eb2na2w54c3" "12djsk"
-$ curl \
---header 'Authorization: Token token={your_api_token}' \
---header 'Accept: text/csv' \
--L -X GET 'http://api.adjust.com/kpis/v1/2eb2na2w54c3/trackers/12djsk/events?start_date=2022-05-01&end_date=2022-05-31&kpis=revenue,events,revenue_per_event&grouping=trackers,weeks,events&countries=de,gb'
-```
-
-```text title="Success response"
-tracker_token,tracker_name,date,event_token,revenue,events,revenue_per_event
-12djsk,Network 1,2022-05-02,abcdef,4,5,0.8
-12djsk,Network 1,2022-05-02,badcfe,3,5,7.2
-12djsk,Network 1,2022-05-09,badcfe,4,5,0.8
-```
-
-
-
-
-## Response format
-
-
-
-
-```json title="Response format"
-{
- "result_parameters": {
- "kpis": ["string"],
- "start_date": "2022-07-01",
- "end_date": "2022-07-28",
- "sandbox": false,
- "countries": ["string"],
- "events": [
- {
- "name": "string",
- "token": "string"
- }
- ],
- "trackers": [
- {
- "token": "string",
- "name": "string",
- "has_subtrackers": true
- }
- ],
- "grouping": ["string"],
- "attribution_type": "string",
- "utc_offset": "00:00",
- "attribution_source": "string"
- },
- "result_set": {
- "token": "string",
- "name": "string",
- "currency": "string",
- "trackers": [
- {
- "token": "string",
- "dates": [
- {
- "date": "2022-06-27",
- "events": [
- {
- "token": "string",
- "kpi_values": [12887]
- }
- ]
- }
- ]
- },
- {
- "token": "string",
- "dates": [
- {
- "date": "2022-06-27",
- "events": [
- {
- "token": "string",
- "kpi_values": [2]
- }
- ]
- }
- ]
- }
- ]
- }
-}
-```
-
-
-
-
-
-```text title="Success response"
-tracker_token,tracker_name,date,event_token,event_name,metric
-string,string,2022-06-27,string,string,12887
-string,string,2022-06-27,string,string,2
-```
-
-
-
-
-### Response codes
-
-
-
-| Error code | Description |
-| --------------------------- | -------------------------------------------------------------------------------------------------------------- |
-| `400 Bad Request` | Malformed request passed by the client. |
-| `401 Unauthorized` | Authentication failed. |
-| `403 Forbidden` | Client doesn't have access to information such as KPIs, selected time period, or cohort period in the request. |
-| `404 Not Found` | Request data not found. |
-| `499 Client closed request` | The transaction closed before all information was returned by the server. |
-
-
-
-## Default parameters
-
-
-
-- - Parameter
- - Default values
-- - `kpis`
- - - `revenue_events`
- - `revenue`
-
-
-
-## Parameter values
-
-
-
-- `android`
-- `bada`
-- `blackberry`
-- `ios`
-- `linux`
-- `macos`
-- `server`
-- `symbian`
-- `unknown`
-- `webos`
-- `windows`
-- `windows-phone`
-- `android-tv`
-- `apple-tv`
-- `fire-tv`
-- `roku-os`
-- `smart-cast`
-- `tizen`
-
-
-
-
-
-- `bot`
-- `console`
-- `ipod`
-- `mac`
-- `pc`
-- `phone`
-- `server`
-- `simulator`
-- `tablet`
-- `tv`
-- `unknown`
-
-
diff --git a/src/content/docs/api/kpi-service/grouping.mdx b/src/content/docs/api/kpi-service/grouping.mdx
deleted file mode 100644
index f3a0dfd9f..000000000
--- a/src/content/docs/api/kpi-service/grouping.mdx
+++ /dev/null
@@ -1,82 +0,0 @@
----
-title: "Result grouping"
-description: "Group results to format your data."
-slug: en/api/kpi-service/grouping
-sidebar-position: 6
----
-
-The KPI service gives you grouping options to enable you to format your data how you want. You can pass several grouping options in each call.
-
-The KPI service groups results based on the order in which you pass grouping options. If you pass the following, the KPI service groups results by tracker and nests results for each country.
-
-```text "trackers" "countries"
-grouping=trackers,countries
-```
-
-If you pass the following, the KPI service groups results by country and nests results for each tracker.
-
-```text "countries" "trackers"
-grouping=countries,trackers
-```
-
-## Tracker grouping options
-
-
-
-- - Grouping option
- - Description
-- - `apps`
- - Groups results by app token and app name.
-- - `trackers`
- - Groups results by network trackers. This grouping doesn't affect calls that include a `tracker_token` in the URL path.
-- - `networks`
- - Groups results by network.
- - All networks if no `tracker_token` is specified in the URL path.
- - Networks associated with the `tracker_token` if it's specified in the URL path.
-- - `campaigns`
- - Groups results by network campaigns.
- - All campaigns if no `tracker_token` is specified in the URL path.
- - Campaigns associated with the `tracker_token` if it's specified in the URL path.
-- - `adgroups`
- - Groups results by ad groups.
- - All ad groups if no `tracker_token` is specified in the URL path.
- - Ad groups associated with the `tracker_token` if it's specified in the URL path.
-- - `creatives`
- - Groups results by creatives.
- - All creatives if no `tracker_token` is specified in the URL path.
- - Creatives associated with the `tracker_token` if it's specified in the URL path.
-
-
-
-## Time grouping options
-
-
-
-When grouping by weeks or months, make sure your date range includes whole weeks or months. If your selection starts in the middle of a week or month, this group will be incomplete.
-
-
-
-
-
-| Grouping option | Description |
-| --------------- | ------------------------------------------------------------------------------------------------------------------- |
-| `hour` | Groups results by hour. All periods included in the result set are returned as date fields in an array of `dates`. |
-| `day` | Groups results by day. All periods included in the result set are returned as date fields in an array of `dates`. |
-| `week` | Groups results by week. All periods included in the result set are returned as date fields in an array of `dates`. |
-| `month` | Groups results by month. All periods included in the result set are returned as date fields in an array of `dates`. |
-
-
-
-## Other grouping options
-
-
-
-| Grouping option | Description |
-| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `countries` | Groups results by country in the ISO 3166 Alpha-2 code format. All countries included in the result set are returned as country fields in an array of `countries`. |
-| `region` | Groups results by region. All device types included in the result set are returned as region fields in an array of `regions`. |
-| `device_types` | Groups results by device type. All device types included in the result set are returned as device_type fields in an array of `device_types`. |
-| `os_names` | Groups results by OS name. All device types included in the result set are returned as os_name fields in an array of `os_names`. |
-| `partners` | Groups results by partner. All device types included in the result set are returned as partner fields in an array of `partners`. |
-
-
diff --git a/src/content/docs/api/kpi-service/index.mdx b/src/content/docs/api/kpi-service/index.mdx
deleted file mode 100644
index 505b015f8..000000000
--- a/src/content/docs/api/kpi-service/index.mdx
+++ /dev/null
@@ -1,38 +0,0 @@
----
-title: "KPI service"
-description: "Use the Adjust KPI service to fetch aggregated data for your apps."
-category-title: KPI service
-slug: en/api/kpi-service
----
-
-Use the Adjust KPI service to fetch aggregated data for your apps.
-
-
-
-Adjust customers should switch to [Datascape](https://help.adjust.com/en/article/datascape) and [Automate](https://help.adjust.com/en/classic/article/automate-classic) for reporting. See the [Report Service API](/en/api/rs-api) article for information on how to programmatically interact with Datascape.
-
-
-
-## How it works
-
-The KPI service enables you to return metrics about your app. Adjust supplies different endpoints for the different kinds of metrics associated with each app. For a full list of metrics, check out the [KPI glossary](https://help.adjust.com/en/article/kpi-glossary).
-
-1. Authenticate your calls
-
- To use the KPI service, you first need to get your Adjust API token. Follow the instructions in the [Authentication article](/en/api/kpi-service/authentication) to find out how to use this token with the API.
-
-2. Fetch your app metrics
-
-
-
- Many of the KPI Service KPIs for ad spend [are deprecated](https://help.adjust.com/en/article/cost-aggregation-deprecation) are deprecated and return a value of `0`. To report on data from the new Ad Spend pipeline, use the [Report service API](/en/api/rs-api).
-
-
-
- Call the KPI service to return metrics associated with your app. Choose from the following endpoints:
-
- - [Overview metrics](/en/api/kpi-service/overview-metrics)
- - [Event metrics](/en/api/kpi-service/event-metrics)
- - [Cohort metrics](/en/api/kpi-service/cohort-metrics)
-
- You can specify how the service groups your data by passing [grouping options](https://help.adjust.com/en/article/result-grouping).
diff --git a/src/content/docs/api/kpi-service/overview-metrics.mdx b/src/content/docs/api/kpi-service/overview-metrics.mdx
deleted file mode 100644
index d15d93835..000000000
--- a/src/content/docs/api/kpi-service/overview-metrics.mdx
+++ /dev/null
@@ -1,447 +0,0 @@
----
-title: "Overview metrics"
-description: "Use these endpoints to retrieve metrics for your app."
-slug: en/api/kpi-service/overview-metrics
-sidebar-position: 2
----
-
-
-
-These endpoints return JSON by default. You can return CSV by adding the following header to your call: `Accept: text/csv`
-
-
-
-Use these endpoints to retrieve metrics for your app.
-
-## Fetch app metrics
-
-```http title="Endpoint" "/{app_token}"
-GET https://api.adjust.com/kpis/v1/{app_token}
-```
-
-Returns metrics associated with an app. Metrics are returned in a `kpi_values` array in the same order as the metrics in your request.
-
-### Parameters
-
-
-
-| Parameter | Format | In | Description |
-| ----------------------- | ------- | ----- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `app_token`\* | String | Path | Your app's 10 character identifier. |
-| `start_date` | Date | Query | The start date of the selected period. `YYYY-MM-DD` format. |
-| `end_date` | Date | Query | The end date of the selected period. `YYYY-MM-DD` format. |
-| `utc_offset` | Time | Query | UTC offset for timezones. `[+-]HH:MM` format. |
-| `kpis` | String | Query | Comma-separated list of metrics. Use App metrics, Fraud metrics, and Ad spend |
-| `event_kpis` | String | Query | Comma-separated list of Event metrics. Prepend your event token to each metric. Example: `token1_revenue`. |
-| `reattributed` | String | Query | Filter metrics by: installed users (`false`) \| reattributed users (`true`) \| all users |
-| `sandbox` | Boolean | Query | Whether results come from sandbox or production data. Defaults to production (`false`). |
-| `attribution_type` | String | Query | The type of attribution to include in the results. Available options: `click` \| `impression` \| `all` |
-| `attribution_source` | String | Query | Determines whether in-app activity is assigned to the user’s install source (`first`) or divided among the install source and subsequent sources of reattribution (`dynamic`). The default setting is `dynamic`. |
-| `countries` | String | Query | Comma-separated list of ISO 3166 alpha-2 country names. |
-| `os_names` | String | Query | Comma-separated list of OS names. |
-| `device_types` | String | Query | Comma-separated list of device types. |
-| `regions` | String | Query | Comma-separated list of standard or account-specific business regions. Add `+` or `-` before the region name to include (default) or exclude it. |
-| `grouping` | String | Query | Grouping parameters. [See Result grouping](/en/api/kpi-service/grouping) for more information. |
-| `tracker_filter` | String | Query | The tracker tokens of any trackers you want to include in your results. Only metrics relating to these trackers are returned. |
-| `cohort_revenue_period` | String | Query | The number of days following reattribution to sum up revenue for. |
-| `human_readable_kpis` | Boolean | Query | Replace metrics with human readable alternatives (for example "Lifetime Value" instead of `lifetime_value`). |
-
-
-
-### Example
-
-
-
-
-```console title="cURL" "2eb2na2w54c3"
-$ curl \
---header 'Authorization: Token token={your_api_token}' \
---location --request GET 'http://api.adjust.com/kpis/v1/2eb2na2w54c3?start_date=2022-05-01&end_date=2022-05-31&kpis=sessions,installs&countries=de,gb'
-```
-
-```json title="Success response"
-{
- "result_parameters": {
- "kpis": ["sessions", "installs"],
- "start_date": "2022-05-01",
- "end_date": "2022-05-31",
- "sandbox": false,
- "countries": ["de", "gb"],
- "trackers": [
- {
- "token": "12djsk",
- "name": "Network 1",
- "has_subtrackers": true
- },
- {
- "token": "15jvui",
- "name": "Network 2",
- "has_subtrackers": true
- }
- ],
- "grouping": ["trackers"]
- },
- "result_set": {
- "token": "2eb2na2w54c3",
- "name": "app name",
- "currency": "USD",
- "trackers": [
- {
- "token": "12djsk",
- "kpi_values": [39629, 39629]
- },
- {
- "token": "15jvui",
- "kpi_values": [557, 880]
- }
- ]
- }
-}
-```
-
-
-
-
-
-```console title="cURL" "2eb2na2w54c3"
-$ curl \
---header 'Authorization: Token token={your_api_token}' \
---header 'Accept: text/csv' \
--L -X GET 'http://api.adjust.com/kpis/v1/2eb2na2w54c3?start_date=2022-05-01&end_date=2022-05-31&kpis=sessions,installs&countries=de,gb'
-```
-
-```text title="Success response"
-tracker_token,tracker_name,sessions,installs
-12djsk,Network 1,39629,39629
-15jvui,Network 2,557,880
-```
-
-
-
-
-## Multiple apps overview endpoint
-
-Returns metrics associated with multiple apps. Metrics are returned in a `kpi_values` array in the same order as the metrics in your request.
-
-```http title="Endpoint" "/{app_tokens}"
-GET https://api.adjust.com/kpis/v1/{app_tokens}
-```
-
-### Parameters
-
-
-
-| Parameter | Format | In | Description |
-| --------------------- | ------- | ----- | ----------------------------------------------------------------------------------------------------------------------------- |
-| `app_tokens`\* | String | Query | A comma-separated list of app tokens. |
-| `start_date` | Date | Query | The start date of the selected period. `YYYY-MM-DD` format. |
-| `end_date` | Date | Query | The end date of the selected period. `YYYY-MM-DD` format. |
-| `utc_offset` | Time | Query | UTC offset for timezones. `[+-]HH:MM` format. |
-| `kpis` | String | Query | Comma-separated list of metrics. Use App metrics, Fraud metrics, and Ad spend |
-| `sandbox` | Boolean | Query | Whether results come from sandbox or production data. Defaults to production (`false`). |
-| `countries` | String | Query | Comma-separated list of ISO 3166 alpha-2 country names. |
-| `os_names` | String | Query | Comma-separated list of OS names. |
-| `device_types` | String | Query | Comma-separated list of device types. |
-| `grouping` | String | Query | Grouping parameters. [See Result grouping](/en/api/kpi-service/grouping) for more information. |
-| `tracker_filter` | String | Query | The tracker tokens of any trackers you want to include in your results. Only metrics relating to these trackers are returned. |
-| `human_readable_kpis` | Boolean | Query | Replace metrics with human readable alternatives (for example "Lifetime Value" instead of `lifetime_value`). |
-
-
-
-### Example
-
-
-
-
-```console title="cURL" "2eb2na2w54c3,3fdwnag4ecf2"
-$ curl --location --request GET 'http://api.adjust.com/kpis/v1/2eb2na2w54c3,3fdwnag4ecf2?start_date=2022-05-01&end_date=2022-05-31&kpis=sessions&countries=de,gb&human_readable_kpis=true' \
---header 'Authorization: Token token={your_app_token}' \
-```
-
-```json title="Success response"
-{
- "result_parameters": {
- "kpis": ["Sessions"],
- "start_date": "2022-05-01",
- "end_date": "2022-05-31",
- "sandbox": false,
- "countries": ["de", "gb"],
- "grouping": ["apps"],
- "attribution_type": "click",
- "utc_offset": "00:00",
- "attribution_source": "dynamic"
- },
- "result_set": {
- "apps": [
- {
- "token": "2eb2na2w54c3",
- "name": "app name",
- "currency": "EUR",
- "kpi_values": [3]
- },
- {
- "token": "3fdwnag4ecf2",
- "name": "test app",
- "currency": "EUR",
- "kpi_values": [40149]
- }
- ]
- }
-}
-```
-
-
-
-
-
-```console title="cURL" "2eb2na2w54c3,3fdwnag4ecf2"
-$ curl --location --request GET 'http://api.adjust.com/kpis/v1/2eb2na2w54c3,3fdwnag4ecf2?start_date=2022-05-01&end_date=2022-05-31&kpis=sessions&countries=de,gb&human_readable_kpis=true' \
---header 'Authorization: Token token={your_app_token}' \
---header 'Accept: text/csv'
-```
-
-```text title="Success response"
-App Token,App Name,Sessions
-2eb2na2w54c3,app name,3
-3fdwnag4ecf2,test app,40149
-```
-
-
-
-
-## Fetch tracker overview
-
-```http title="Endpoint" "/{app_token}/trackers/{tracker_token}"
-GET https://api.adjust.com/kpis/v1/{app_token}/trackers/{tracker_token}
-```
-
-Returns metrics associated with a specific tracker. Metrics are returned in a `kpi_values` array in the same position the KPIs in your request.
-
-### Parameters
-
-
-
-| Parameter | Format | In | Description |
-| ----------------------- | ------- | ----- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `app_token` | String | Path | Your app's 10 character identifier. |
-| `tracker_token` | String | Path | Your tracker's 6 character identifier. |
-| `start_date` | Date | Query | The start date of the selected period. `YYYY-MM-DD` format. |
-| `end_date` | Date | Query | The end date of the selected period. `YYYY-MM-DD` format. |
-| `utc_offset` | Time | Query | UTC offset for timezones. `[+-]HH:MM` format. |
-| `kpis` | String | Query | Comma-separated list of metrics. Use App metrics, Fraud metrics, and Ad spend |
-| `event_kpis` | String | Query | Comma-separated list of Event metrics. Prepend your event token to each metric. for example `token1_revenue` |
-| `reattributed` | String | Query | Filter metrics by: installed users (`false`) \| reattributed users (`true`) \| all users |
-| `sandbox` | Boolean | Query | Whether results come from sandbox or production data. Defaults to production (`false`). |
-| `attribution_type` | String | Query | The type of attribution to include in the results. Available options: `click` \| `impression` \| `all` |
-| `attribution_source` | String | Query | Determines whether in-app activity is assigned to the user’s install source (`first`) or divided among the install source and subsequent sources of reattribution (`dynamic`). The default setting is `dynamic`. |
-| `countries` | String | Query | Comma-separated list of ISO 3166 alpha-2 country names. |
-| `os_names` | String | Query | Comma-separated list of OS names. |
-| `device_types` | String | Query | Comma-separated list of device types. |
-| `regions` | String | Query | Comma-separated list of standard or account-specific business regions. Add `+` or `-` before the region name to include (default) or exclude it. |
-| `grouping` | String | Query | Grouping parameters. [See Result grouping](/en/api/kpi-service/grouping) for more information. |
-| `tracker_filter` | String | Query | The tracker tokens of any trackers you want to include in your results. Only metrics relating to these trackers are returned. |
-| `cohort_revenue_period` | String | Query | The number of days following reattribution to sum up revenue for. |
-| `human_readable_kpis` | Boolean | Query | Replace metrics with human readable alternatives (for example: "Lifetime Value" instead of `lifetime_value`). |
-
-
-
-### Example
-
-
-
-
-```console title="cURL" "2eb2na2w54c3" "12djsk"
-$ curl \
---header 'Authorization: Token token={your_api_token}' \
--L -X GET 'http://api.adjust.com/kpis/v1/2eb2na2w54c3/trackers/12djsk?start_date=2022-05-01&end_date=2022-05-31&kpis=sessions,installs&countries=de,gb'
-```
-
-```json title="Success response"
-{
- "result_parameters": {
- "kpis": ["sessions", "installs"],
- "start_date": "2022-05-01",
- "end_date": "2022-05-31",
- "sandbox": false,
- "countries": ["de", "gb"],
- "trackers": [
- {
- "token": "12djsk",
- "name": "Network 1",
- "has_subtrackers": true
- }
- ],
- "grouping": ["trackers"]
- },
- "result_set": {
- "token": "2eb2na2w54c3",
- "name": "app name",
- "currency": "USD",
- "trackers": [
- {
- "token": "12djsk",
- "kpi_values": [39629, 39629]
- }
- ]
- }
-}
-```
-
-
-
-
-
-```console title="cURL" "2eb2na2w54c3" "12djsk"
-$ curl \
---header 'Authorization: Token token={your_api_token}' \
--L -X GET 'http://api.adjust.com/kpis/v1/2eb2na2w54c3/trackers/12djsk?start_date=2022-05-01&end_date=2022-05-31&kpis=sessions,installs&countries=de,gb' \
---header 'Accept: text/csv'
-```
-
-```text title="Success response"
-tracker_token,tracker_name,sessions,installs
-12djsk,Network 1,39629,39629
-```
-
-
-
-
-## Response format
-
-
-
-
-```json title="Response format"
-{
- "result_parameters": {
- "kpis": ["string", "string"],
- "start_date": "2022-01-01",
- "end_date": "2022-01-31",
- "sandbox": false,
- "countries": ["string"],
- "trackers": [
- {
- "token": "string",
- "name": "string",
- "has_subtrackers": true
- },
- {
- "token": "string",
- "name": "string",
- "has_subtrackers": true
- }
- ],
- "grouping": ["string"]
- },
- "result_set": {
- "token": "string",
- "name": "string",
- "currency": "string",
- "apps": [
- {
- "token": "string",
- "name": "string",
- "currency": "string",
- "kpi_values": [3]
- }
- ],
- "trackers": [
- {
- "token": "string",
- "kpi_values": [100, 130.24]
- },
- {
- "token": "string",
- "kpi_values": [557, 0.802]
- }
- ]
- }
-}
-```
-
-
-
-
-
-```text title="Success response"
-tracker_token,tracker_name,kpi1,kpi2
-string,string,39623,39623
-```
-
-
-
-
-### Response codes
-
-
-
-| Error code | Description |
-| --------------------------- | -------------------------------------------------------------------------------------------------------------- |
-| `400 Bad Request` | Malformed request passed by the client. |
-| `401 Unauthorized` | Authentication failed. |
-| `403 Forbidden` | Client doesn't have access to information such as KPIs, selected time period, or cohort period in the request. |
-| `404 Not Found` | Request data not found. |
-| `499 Client closed request` | The transaction closed before all information was returned by the server. |
-
-
-
-## Default parameters
-
-
-
-- - Parameter
- - Default values
-- - `kpis`
- - - clicks
- - installs
- - click_conversion_rate
- - reattributions
- - sessions
- - revenue_events
- - revenue
- - daus
- - waus
- - maus
-
-
-
-## Parameter values
-
-
-
-- `android`
-- `bada`
-- `blackberry`
-- `ios`
-- `linux`
-- `macos`
-- `server`
-- `symbian`
-- `unknown`
-- `webos`
-- `windows`
-- `windows-phone`
-- `android-tv`
-- `apple-tv`
-- `fire-tv`
-- `roku-os`
-- `smart-cast`
-- `tizen`
-
-
-
-
-
-- `bot`
-- `console`
-- `ipod`
-- `mac`
-- `pc`
-- `phone`
-- `server`
-- `simulator`
-- `tablet`
-- `tv`
-- `unknown`
-
-
diff --git a/src/content/docs/api/kpi-service/skad-metrics.mdx b/src/content/docs/api/kpi-service/skad-metrics.mdx
deleted file mode 100644
index e3aac83a1..000000000
--- a/src/content/docs/api/kpi-service/skad-metrics.mdx
+++ /dev/null
@@ -1,239 +0,0 @@
----
-title: "SKAdNetwork metrics"
-description: "Use these endpoints to retrieve SKAdNetwork metrics for your app."
-slug: en/api/kpi-service/skad-metrics
-sidebar-position: 5
----
-
-Use this endpoint to retrieve [SKAdNetwork](https://help.adjust.com/en/article/skadnetwork) metrics for your app.
-
-
-
-These endpoints return JSON by default. You can return CSV by adding the following header to your call: `Accept: text/csv`
-
-
-
-## Fetch SKAdNetwork metrics
-
-```http title="Endpoint" "/{app_token}/skadnetwork"
-GET https://api.adjust.com/kpis/v1/{app_token}/skadnetwork
-```
-
-Returns SKAdNetwork metrics associated with an app. Metrics are returned in a `kpi_values` array in the same order as the metrics in your request.
-
-### Parameters
-
-
-
-| Parameter | Format | In | Description |
-| --------------------- | ------- | ----- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `app_token` | String | Path | Your app's 10 character identifier. |
-| `start_date` | Date | Query | The start date of the selected period. `YYYY-MM-DD` format. |
-| `end_date` | Date | Query | The end date of the selected period. `YYYY-MM-DD` format. |
-| `utc_offset` | Time | Query | UTC offset for timezones. `[+-]HH:MM` format. |
-| `kpis` | String | Query | Comma-separated list of SKAdNetwork metrics. Use SKAdNetwork app metrics and SKAdNetwork event metrics. |
-| `sandbox` | Boolean | Query | Whether results come from sandbox or production data. Defaults to production (`false`). |
-| `attribution_type` | String | Query | The type of attribution to include in the results. `click` \| `impression` \| `all` |
-| `attribution_source` | String | Query | Determines whether in-app activity is assigned to the user’s install source (`first`) or divided among the install source and subsequent sources of reattribution (`dynamic`). The default setting is `dynamic`. |
-| `countries` | String | Query | Comma-separated list of ISO 3166 alpha-2 country names. |
-| `device_types` | String | Query | Comma-separated list of device types. |
-| `regions` | String | Query | Comma-separated list of standard or account-specific business regions. Add `+` or `-` before the region name to include (default) or exclude it. |
-| `grouping` | String | Query | Grouping parameters. [See Result grouping](/en/api/kpi-service/grouping) for more information. |
-| `human_readable_kpis` | Boolean | Query | Replace metrics with human readable alternatives (for example "Lifetime Value" instead of `lifetime_value`). |
-
-
-
-### Example
-
-
-
-
-```console title="cURL" "2eb2na2w54c3"
-$ curl \
---header 'Authorization: Token token={your_api_token}'
--L -X GET 'http://api.adjust.com/kpis/v1/2eb2na2w54c3/skadnetwork?start_date=2022-05-01&end_date=2022-05-31&kpis=valid_conversions,impression_conversion_rate,conversion_6&countries=de,gb&human_readable_kpis=true'
-```
-
-```json title="Success response"
-{
- "result_parameters": {
- "kpis": [
- "valid_conversions",
- "impression_conversion_rate",
- "conversion_6"
- ],
- "start_date": "2022-05-01",
- "end_date": "2022-05-31",
- "sandbox": false,
- "countries": ["de", "gb"],
- "trackers": [
- {
- "token": "12djsk",
- "name": "Network 1",
- "has_subtrackers": true
- },
- {
- "token": "15jvui",
- "name": "Network 2",
- "has_subtrackers": true
- }
- ],
- "grouping": ["trackers"]
- },
- "result_set": {
- "token": "2eb2na2w54c3",
- "name": "app name",
- "currency": "USD",
- "trackers": [
- {
- "token": "12djsk",
- "kpi_values": [1, 500, 31]
- },
- {
- "token": "15jvui",
- "kpi_values": [557, 880, 21]
- }
- ]
- }
-}
-```
-
-
-
-
-
-```console title="cURL" "2eb2na2w54c3"
-$ curl \
---header 'Authorization: Token token={your_api_token}' \
---header 'Accept: text/csv' \
--L -X GET 'http://api.adjust.com/kpis/v1/2eb2na2w54c3/skadnetwork?start_date=2022-05-01&end_date=2022-05-31&kpis=valid_conversions,impression_conversion_rate,conversion_6&countries=de,gb&human_readable_kpis=true'
-```
-
-```text title="Success response"
-tracker_token,tracker_name,valid_conversions,impression_conversion_rate,conversion_6
-12djsk,Network 1,1,500,31
-15jvui,Network 1,557,880,21
-```
-
-
-
-
-## Response format
-
-
-
-
-```json title="Response format"
-{
- "result_parameters": {
- "kpis": ["string", "string"],
- "start_date": "2022-01-01",
- "end_date": "2022-01-31",
- "sandbox": false,
- "countries": ["string"],
- "trackers": [
- {
- "token": "string",
- "name": "string",
- "has_subtrackers": true
- },
- {
- "token": "string",
- "name": "string",
- "has_subtrackers": true
- }
- ],
- "grouping": ["string"]
- },
- "result_set": {
- "token": "string",
- "name": "string",
- "currency": "string",
- "apps": [
- {
- "token": "string",
- "name": "string",
- "currency": "string",
- "kpi_values": [3]
- }
- ],
- "trackers": [
- {
- "token": "string",
- "kpi_values": [100, 130.24]
- },
- {
- "token": "string",
- "kpi_values": [557, 0.802]
- }
- ]
- }
-}
-```
-
-
-
-
-
-```text title="Success response"
-tracker_token,tracker_name,kpi1,kpi2
-string,string,39623,39623
-```
-
-
-
-
-### Response codes
-
-
-
-| Error code | Description |
-| --------------------------- | -------------------------------------------------------------------------------------------------------------- |
-| `400 Bad Request` | Malformed request passed by the client. |
-| `401 Unauthorized` | Authentication failed. |
-| `403 Forbidden` | Client doesn't have access to information such as KPIs, selected time period, or cohort period in the request. |
-| `404 Not Found` | Request data not found. |
-| `499 Client closed request` | The transaction closed before all information was returned by the server. |
-
-
-
-## Parameter values
-
-
-
-- `android`
-- `bada`
-- `blackberry`
-- `ios`
-- `linux`
-- `macos`
-- `server`
-- `symbian`
-- `unknown`
-- `webos`
-- `windows`
-- `windows-phone`
-- `android-tv`
-- `apple-tv`
-- `fire-tv`
-- `roku-os`
-- `smart-cast`
-- `tizen`
-
-
-
-
-
-- `bot`
-- `console`
-- `ipod`
-- `mac`
-- `pc`
-- `phone`
-- `server`
-- `simulator`
-- `tablet`
-- `tv`
-- `unknown`
-
-
diff --git a/src/content/docs/api/rs-api/csv.mdx b/src/content/docs/api/rs-api/csv.mdx
index a9dfa4777..807ca5e29 100644
--- a/src/content/docs/api/rs-api/csv.mdx
+++ b/src/content/docs/api/rs-api/csv.mdx
@@ -28,186 +28,45 @@ Human-readable names can change depending on upstream requirements. Use slugs fo
### Filters
-
-
-- - Filter
- - Type
- - Description
- - Example
-- - `dimensions`\*
- - String
- - Comma-separated values used to group parameters. See the dimensions table below for more information.
- - `dimensions=app,os_name,week,campaign_id_network`
-- - `metrics`\*
- - String
- - Comma-separated KPIs. See the metrics table below for more information.
- - `metrics=cost,installs,ecpi_network`
-- - `date_period`\*
- - String
- - Start and end dates for the report with 3 supported formats:
- - Logical dates
- - Absolute dates
- - Relative dates
- - **Logical dates**:
-
- - `this_month_until_yesterday`
- - `today`
- - `yesterday`
- - `this_week`
- - `last_week`
- - `this_month`
- - `last_month`
-
- **Absolute dates**:
-
- - `2020-12-31:2021-01-01`
-
- **Relative dates**:
-
- - `-10d:-3d` (from 10 days ago to 3 days ago)
-
-- - `readable_names`
- - Boolean
- - Whether to return columns with their human-readable names. Defaults to `false`
- - `readable_names=true`
-- - `cohort_maturity`
- - String
- - - `immature`: displays current values of cumulative metrics for all cohorts, including immature cohorts
- - `mature`: displays the values of cumulative metrics only for mature cohorts and zeros for immature cohorts.
- - `cohort_maturity=immature`
-- - `utc_offset`
- - String
- - The timezone used in the report. `utc_offset=+01:00`
- -
-- - `timezone_id`
- - String
- - The ID of the timezone used in the report. `timezone_id=1`
- -
-- - `hour__between`
- - String
- - Filter results between given hours of the day. `hour__between=-10h:-0h`
- -
-- - `attribution_type`
- - String
- - The type of engagement the attribution awards.
- - `click` (default)
- - `impression`
- - `all`
- - `attribution_type=click`
-- - `attribution_source`
- - String
- - Whether in-app activity is assigned to the user’s install source (`first`) or divided among the install source and subsequent sources of reattribution (`dynamic`). Defaults to `dynamic`.
- - `attribution_source=first`
-- - `reattributed`
- - String
- - Filter for reattributed users only. Reattribution is when a user who has already installed your app returns to it through a new Adjust-tracked source.
- - `all` (default)
- - `false`
- - `true`
- - `reattributed=false`
-- - `ad_revenue_mode`
- - String
- - The percentage of gross ad revenue returned by the endpoint. Available options are:
- - `GROSS_100`
- - `GROSS_85`
- - `GROSS_70`
- - `GROSS_60`
- - `ad_revenue_mode=GROSS_70`
-- - `ad_revenue_sources`
- - String
- - Comma-separated list of ad revenue sources.
- - `ad_revenue_sources=unknown`
-- - `os_names`
- - String
- - Comma-separated list of operating system names.
- - `os_names=ios,android`
-- - `ad_spend_mode`
- - String
- - Determines the ad spend source applied in calculations. See How ad spend source affects your data for more information.
- - `adjust`
- - `network`
- - `mixed`
- - `ad_spend_mode=network`
-- - `sandbox`
- - Boolean
- - Whether to use sandbox data or production data. Defaults to `false`.
- - `sandbox=true`
-- - `sort`
- - String
- - Comma-separated list of metrics/dimensions to sort the report by. Use`-` to order descending.
- - `sort=-clicks,installs`
-- - `index`
- - String
- - Comma-separated list of dimensions used to index the report.
- - `index=network,campaign,adgroup`
-- - `format_dates`
- - Boolean
- - If set to false, all date dimensions are returned in ISO format.
- - `format_dates=false`
-- - `period_over_period`
- - String
- - The period for comparing report data.
- - `period_over_period=previous_week`
-- - `currency`
- - String
- - Currency used for conversion of money related metrics.
- - `currency=USD`
-- - `[dimension]__in`
- - String
- - Comma-separated list of values to filter dimension's values (exact match) for any dimension.
- - `campaign__in=abc,def`
-- - `[dimension]__not_in`
- - String
- - Comma-separated list of values to filter dimension's values (exclude exact match) for any dimension.
- - `campaign__not_in=abc,def`
-- - `[dimension]__contains`
- - String
- - Substring search in dimension's values (case insensitive) for any dimension.
- - `campaign__contains=ios`
-- - `[dimension]__exclude`
- - String
- - Excluding substring search in dimension's values (case insensitive) for any dimension.
- - `campaign__exclude=ios`
-- - `[dimension]__starts_with`
- - String
- - Substring search matching dimensions starting with specified prefix (case insensitive).
- - `campaign__starts_with=ios`
-- - `[dimension]__not_starts_with`
- - String
- - Substring search matching dimensions not starting with specified prefix (case insensitive).
- - `campaign__not_starts_with=ios`
-- - `[dimension]__ends_with`
- - String
- - Substring search matching dimensions ending with specified suffix (case insensitive).
- - `campaign__ends_with=ios`
-- - `[dimension]__not_ends_with`
- - String
- - Substring search matching dimensions not ending with specified suffix (case insensitive).
- - `campaign__not_ends_with=ios`
-- - `[metric]__lt`
- - String
- - "Less than" filter for metric's values any metric.
- - `skad_installs__lt=100`
-- - `[metric]__lte`
- - String
- - "Less than or equal" filter for metric's values for any metric.
- - `skad_installs__lte=100`
-- - `[metric]__gt`
- - String
- - "Greater than" filter for metric's values for any metric.
- - `skad_installs__gt=100`
-- - `[metric]__gte`
- - String
- - "Greater than or equal" filter for metric's values for any metric.
- - `skad_installs__gte=100`
-- - `[metric]__eq`
- - String
- - "Equal" filter for metric's values for any metric.
- - `skad_installs__eq=100`
-- - `[metric]__ne`
- - String
- - "Not equal" filter for values relating to any metric.
- - `skad_installs__ne=100`
+
+
+| Filter | Type | Description | Example |
+| ------------------------------ | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `dimensions`\* | String | Comma-separated values used to group parameters. See the dimensions table below for more information. | `dimensions=app,os_name,week,campaign_id_network` |
+| `metrics`\* | String | Comma-separated KPIs. See the metrics table below for more information. | `metrics=cost,installs,ecpi_network` |
+| `date_period`\* | String | Start and end dates for the report with 3 supported formats:- Logical dates
- Absolute dates
- Relative dates
| - **Logical dates:**
- `this_month_until_yesterday`
- `today`
- `yesterday`
- `this_week`
- `last_week`
- `this_month`
- `last_month`
- **Absolute dates:**
- **Relative dates:**
- `-10d:-3d (from 10 days ago to 3 days ago)`
|
+| `cohort_maturity` | String | - `immature`: displays current values of cumulative metrics for all cohorts, including immature cohorts.
- `mature`: displays the values of cumulative metrics only for mature cohorts and zeros for immature cohorts.
| `cohort_maturity=immature` |
+| `readable_names` | Boolean | Whether to return columns with their human-readable names. Defaults to `false` | `readable_names=true` |
+| `utc_offset` | String | The timezone used in the report. | `utc_offset=+01:00` |
+| `timezone_id` | String | The ID of the timezone used in the report. `timezone_id=1` | |
+| `hour__between` | String | Filter results between given hours of the day. `hour__between=-10h:-0h` | |
+| `attribution_type` | String | The type of engagement the attribution awards.- `click` (default)
- `impression`
- `all`
| `attribution_type=click` |
+| `attribution_source` | String | Whether in-app activity is assigned to the user’s install source (`first`) or divided among the install source and subsequent sources of reattribution (`dynamic`). Defaults to `dynamic`. | `attribution_source=first` |
+| `reattributed` | String | Filter for reattributed users only. Reattribution is when a user who has already installed your app returns to it through a new Adjust-tracked source.- `all` (default)
- `false`
- `true`
| `reattributed=false` |
+| `ad_revenue_mode` | String | The percentage of gross ad revenue returned by the endpoint. Available options are:- `GROSS_100`
- `GROSS_85`
- `GROSS_70`
- `GROSS_60`
| `ad_revenue_mode=GROSS_70` |
+| `ad_revenue_sources` | String | Comma-separated list of ad revenue sources. | `ad_revenue_sources=unknown` |
+| `os_names` | String | Comma-separated list of operating system names. | `os_names=ios,android` |
+| `ad_spend_mode` | String | Determines the ad spend source applied in calculations. See How ad spend source affects your data for more information. | `ad_spend_mode=network` |
+| `sandbox` | Boolean | Whether to use sandbox data or production data. Defaults to `false`. | `sandbox=true` |
+| `sort` | String | Comma-separated list of metrics/dimensions to sort the report by. Use `-` to order descending. | `sort=-clicks,installs` |
+| `index` | String | Comma-separated list of dimensions used to index the report. | `index=network,campaign,adgroup` |
+| `format_dates` | Boolean | If set to `false`, all date dimensions are returned in ISO format. | `format_dates=false` |
+| `period_over_period` | String | The period for comparing report data. | `period_over_period=previous_week` |
+| `currency` | String | Currency used for conversion of money related metrics. | `currency=USD` |
+| `[dimension]__in` | String | Comma-separated list of values to filter dimension's values (exact match) for any dimension. | `campaign__in=abc,def` |
+| `[dimension]__not_in` | String | Comma-separated list of values to filter dimension's values (exclude exact match) for any dimension | `campaign__not_in=abc,def` |
+| `[dimension]__contains` | String | Substring search in dimension's values (case insensitive) for any dimension. | `campaign__contains=ios` |
+| `[dimension]__exclude` | String | Excluding substring search in dimension's values (case insensitive) for any dimension. | `campaign__exclude=ios` |
+| `[dimension]__starts_with` | String | Substring search matching dimensions starting with specified prefix (case insensitive). | `campaign__starts_with=ios` |
+| `[dimension]__not_starts_with` | String | Substring search matching dimensions not starting with specified prefix (case insensitive). | `campaign__not_starts_with=ios` |
+| `[dimension]__ends_with` | String | Substring search matching dimensions ending with specified suffix (case insensitive). | `campaign__ends_with=ios` |
+| `[dimension]__not_ends_with` | String | Substring search matching dimensions not ending with specified suffix (case insensitive). | `campaign__not_ends_with=ios` |
+| `[metric]__lt` | String | "Less than" filter for metric's values any metric. | `skad_installs__lt=100` |
+| `[metric]__lte` | String | "Less than or equal" filter for metric's values for any metric. | `skad_installs__lte=100` |
+| `[metric]__gt` | String | "Greater than" filter for metric's values for any metric. | `skad_installs__gt=100` |
+| `[metric]__gte` | String | "Greater than or equal" filter for metric's values for any metric. | `skad_installs__gte=100` |
+| `[metric]__eq` | String | "Equal" filter for metric's values for any metric. | `skad_installs__eq=100` |
+| `[metric]__ne` | String | "Not equal" filter for values relating to any metric. | `skad_installs__ne=100` |
@@ -215,170 +74,44 @@ Human-readable names can change depending on upstream requirements. Use slugs fo
Dimensions allow a user to break down metrics into groups using one or several parameters. For example, the number of installs by date, country and network.
-
-
-- - Dimension
- - Data type
- - Description
- - Example
-- - `hour`
- - Date
- - Date value in `YYYY-MM-DDTHH:MM:SS` format. Use `format_dates=false` to return the value in ISO format.
- - `2021-05-11T17:00:45`
-- - `day`
- - Date
- - Date value in `YYYY-MM-DD` format. Use `format_dates=false` to return the value in ISO format.
- - `2021-05-11`
-- - `week`
- - Date
- - Date value in `YYYY-MM-DD - YYYY-MM-DD` format. Use `format_dates=false` to return the value in ISO format.
- - `2021-05-09 - 2021-05-15`
-- - `month`
- - Date
- - Date value in `YYYY-MM` format. Use `format_dates=false` to return the value in ISO format.
- - `2021-05`
-- - `year`
- - Date
- - Date value in `YYYY` format. Use `format_dates=false` to return the value in ISO format.
- - `2021`
-- - `quarter`
- - String
- - Date value in `Q YYYY` format. Use `format_dates=false` to return the value in ISO format.
- - `Q2 2021`
-- - `os_name`
- - String
- - Possible values:
- - `android`
- - `bada`
- - `blackberry`
- - `ios`
- - `linux`
- - `macos`
- - `server`
- - `symbian`
- - `unknown`
- - `webos`
- - `windows`
- - `windows-phone`
- - `os_name=ios`
-- - `device_type`
- - String
- - Possible values:
- - `bot`
- - `console`
- - `ipod`
- - `mac`
- - `pc`
- - `phone`
- - `server`
- - `simulator`
- - `tablet`
- - `tv`
- - `unknown`
- - `device_type=phone`
-- - `app`
- - String
- - Name of the app.
- -
-- - `app_token`
- - String
- - App ID in the Adjust system.
- -
-- - `store_id`
- - String
- - Store App ID.
- - `com.random.app`
-- - `store_type`
- - String
- - Store from where the app was installed.
- - `google_play`
-- - `currency`
- - String
- - Currency name.
- - `Euro`
-- - `currency_code`
- - String
- - 3-character value ISO 4217.
- - `EUR`
-- - `campaign`
- - String
- - Tracker sub-level 1.
- String value usually contains campaign name and id.
- -
-- - `campaign_network`
- - String
- - Campaign name from the network.
- -
-- - `campaign_id_network`
- - String
- - Campaign ID from the network.
- -
-- - `adgroup`
- - String
- - Tracker sub-level 2.
- String value usually contains adgroup name and id.
- -
-- - `adgroup_network`
- - String
- - Adgroup name from the network.
- -
-- - `adgroup_id_network`
- - String
- - Adgroup ID from the network.
- -
-- - `source_network`
- - String
- - Name of the source network. Optional value dependent on the network.
- -
-- - `source_id_network`
- - String
- - ID of the source network.
- -
-- - `creative`
- - String
- - Tracker sub-level 3.
- String value usually contains creative name and id.
- -
-- - `creative_network`
- - String
- - Creative name from the network.
- -
-- - `creative_id_network`
- - String
- - Creative ID from the network
- -
-- - `country`
- - String
- - Country name.
- - `United States of America`
-- - `country_code`
- - String
- - 2-character value ISO 3166.
- - `US`
-- - `region`
- - String
- - Business region.
- - `APAC`
-- - `partner_name`
- - String
- - Partner's name in the Adjust system.
- - `AppLovin`
-- - `partner_id`
- - Integer
- - Partner’s id in the Adjust system.
- - `34`
-- - `partner`
- - String
- - The unique slug of the partner.
- - `applovin`
-- - `channel`
- - String
- - A combination of `partner_name` and `network`.
- -
-- - `platform`
- - String
- - The device operating system/platform. See list of supported platforms below.
- - `android`
+
+
+| Dimension | Data type | Description | Example |
+| --------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- |
+| `hour` | Date | Use `format_dates=false` to return the value in ISO format.
`YYYY-MM-DDTHH:MM:SS` | `2021-05-11T17:00:45` |
+| `day` | Date | Use `format_dates=false` to return the value in ISO format.
`YYYY-MM-DD` | `2021-05-11` |
+| `week` | Date | Use `format_dates=false` to return the value in ISO format.
`YYYY-MM-DD - YYYY-MM-DD` | `2021-05-09 - 2021-05-15` |
+| `month` | Date | Use `format_dates=false` to return the value in ISO format.
`YYYY-MM` | `2021-05` |
+| `year` | Date | Use `format_dates=false` to return the value in ISO format.
`YYYY` | `2021` |
+| `quarter` | String | Use `format_dates=false` to return the value in ISO format.
`Q YYYY` | `Q2 2021` |
+| `os_name` | String | Possible values:- `android`
- `bada`
- `blackberry`
- `ios`
- `linux`
- `macos`
- `server`
- `symbian`
- `unknown`
- `webos`
- `windows`
- `windows-phone`
| |
+| `device_type` | String | Possible values:- `bot`
- `console`
- `ipod`
- `mac`
- `pc`
- `phone`
- `server`
- `simulator`
- `tablet`
- `tv`
- `unknown`
| |
+| `app` | String | Name of the app. | |
+| `app_token` | String | App ID in the Adjust system. | |
+| `store_id` | String | Store App ID. | `com.random.app` |
+| `store_type` | String | Store from where the app was installed. | `google_play` |
+| `currency` | String | Currency name. | `Euro` |
+| `currency_code` | String | 3-character value ISO 4217. | `EUR` |
+| `network` | String | The name of the advertising network. | Organic, AppLovin, Facebook Installs, Instagram Installs. |
+| `campaign` | String | Tracker sub-level 1.
String value usually contains campaign name and id. | |
+| `campaign_network` | String | Campaign name from the network. | |
+| `campaign_id_network` | String | Campaign ID from the network. | |
+| `adgroup` | String | Tracker sub-level 2.
String value usually contains adgroup name and id. | |
+| `adgroup_network` | String | Adgroup name from the network. | |
+| `adgroup_id_network` | String | Adgroup ID from the network. | |
+| `source_network` | String | Name of the source network. Optional value dependent on the network. | |
+| `source_id_network` | String | ID of the source network. | |
+| `creative` | String | Tracker sub-level 3.
String value usually contains creative name and id. | |
+| `creative_network` | String | Creative name from the network. | |
+| `creative_id_network` | String | Creative ID from the network. | |
+| `country` | String | Country name. | `United States of America` |
+| `country_code` | String | 2-character value ISO 3166. | `US` |
+| `region` | String | Business region. | `APAC` |
+| `partner_name` | String | Partner's name in the Adjust system. | `AppLovin` |
+| `partner_id` | String | Partner’s id in the Adjust system. | `34` |
+| `partner` | String | The unique slug of the partner. | `applovin` |
+| `channel` | String | A combination of `partner_name` and `network`. | |
+| `platform` | String | The device operating system/platform. See list of supported platforms below. | `android` |
diff --git a/src/content/docs/api/rs-api/pivot.mdx b/src/content/docs/api/rs-api/pivot.mdx
index 4ec398b0b..ee15c618a 100644
--- a/src/content/docs/api/rs-api/pivot.mdx
+++ b/src/content/docs/api/rs-api/pivot.mdx
@@ -19,180 +19,44 @@ The `GET` method returns filtered data from the report service in JSON format.
### Filters
-
-
-- - Filter
- - Type
- - Description
- - Example
-- - `dimensions`\*
- - String
- - Comma-separated values used to group parameters. See the dimensions table below for more information.
- - `dimensions=app,os_name,week,campaign_id_network`
-- - `metrics`\*
- - String
- - Comma-separated KPIs. See the metrics table below for more information.
- - `metrics=cost,installs,ecpi_network`
-- - `date_period`\*
- - String
- - Start and end dates for the report with 3 supported formats:
- - Logical dates
- - Absolute dates
- - Relative dates
- - **Logical dates**:
- - `this_month_until_yesterday`
- - `today`
- - `yesterday`
- - `this_week`
- - `last_week`
- - `this_month`
- - `last_month`
- **Absolute dates**:
- - `2020-12-31:2021-01-01`
- **Relative dates**:
- - `-10d:-3d` (from 10 days ago to 3 days ago)
-- - `index`\*
- - String
- - Comma-separated list of dimensions used to index the report.
- - `index=network,campaign,adgroup`
-- - `cohort_maturity`
- - String
- - - `immature`: displays current values of cumulative metrics for all cohorts, including immature cohorts.
- - `mature`: displays the values of cumulative metrics only for mature cohorts and zeros for immature cohorts.
- - `cohort_maturity=immature`
-- - `utc_offset`
- - String
- - The timezone used in the report.
- - `utc_offset=+01:00`
-- - `attribution_type`
- - String
- - The type of engagement the attribution awards.
- - `click` (default)
- - `impression`
- - `all`
- - `attribution_type=click`
-- - `attribution_source`
- - String
- - Whether in-app activity is assigned to the user’s install source (`first`) or divided among the install source and subsequent sources of reattribution (`dynamic`). Defaults to `dynamic`.
- - `attribution_source=first`
-- - `reattributed`
- - String
- - Filter for reattributed users only. Reattribution is when a user who has already installed your app returns to it through a new Adjust-tracked source.
- - `all` (default)
- - `false`
- - `true`
- - `reattributed=false`
-- - `ad_revenue_mode`
- - String
- - The percentage of gross ad revenue returned by the endpoint. Available options are:
- - `GROSS_100`
- - `GROSS_85`
- - `GROSS_70`
- - `GROSS_60`
- - `ad_revenue_mode=GROSS_70`
-- - `ad_revenue_sources`
- - String
- - Comma-separated list of ad revenue sources.
- - `ad_revenue_sources=unknown`
-- - `os_names`
- - String
- - Comma-separated list of operating system names.
- - `os_names=ios,android`
-- - `ad_spend_mode`
- - String
- - Determines the ad spend source applied in calculations. See How ad spend source affects your data for more information.
- - `adjust`
- - `network`
- - `mixed`
- - `ad_spend_mode=network`
-- - `skad_time_adjustment`
- - String
- - The time adjustment for SKAdNetwork postbacks. Formatted as `{format}{period}`
- - `skad_time_adjustment=H24`
-- - `sandbox`
- - Boolean
- - Whether to use sandbox data or production data. Defaults to false.
- - `sandbox=true`
-- - `sort`
- - String
- - Comma-separated list of metrics/dimensions to sort the report by. Use `-` to order descending.
- - `sort=-clicks,installs`
-- - `drilldown`
- - String
- - List of parameters to drill down into. Formatted as pipe-separated tuples.
- - `drilldown=campaign:123|adgroup:234`
-- - `focus`
- - String
- - List of parameters to focus on. Formatted as pipe-separated tuples. Differs from drilldown as it doesn't add extra dimensions to the results.
- - `focus=campaign:123|adgroup:234`
-- - `format_dates`
- - Boolean
- - If set to false, all date dimensions are returned in ISO format.
- - `format_dates=false`
-- - `period_over_period`
- - String
- - The period for comparing report data.
- - `period_over_period=previous_week`
-- - `currency`
- - String
- - Currency used for conversion of money related metrics.
- - `currency=USD`
-- - `[dimension]__in`
- - String
- - Comma-separated list of values to filter dimension's values (exact match) for any dimension.
- - `campaign__in=abc,def`
-- - `[dimension]__not_in`
- - String
- - Comma-separated list of values to filter dimension's values (exclude exact match) for any dimension.
- - `campaign__not_in=abc,def`
-- - `[dimension]__contains`
- - String
- - Substring search in dimension's values (case insensitive) for any dimension.
- - `campaign__contains=ios`
-- - `[dimension]__exclude`
- - String
- - Excluding substring search in dimension's values (case insensitive) for any dimension.
- - `campaign__exclude=ios`
-- - `[dimension]__starts_with`
- - String
- - Substring search matching dimensions starting with specified prefix (case insensitive).
- - `campaign__starts_with=ios`
-- - `[dimension]__not_starts_with`
- - String
- - Substring search matching dimensions not starting with specified prefix (case insensitive).
- - `campaign__not_starts_with=ios`
-- - `[dimension]__ends_with`
- - String
- - Substring search matching dimensions ending with specified suffix (case insensitive).
- - `campaign__ends_with=ios`
-- - `[dimension]__not_ends_with`
- - String
- - Substring search matching dimensions not ending with specified suffix (case insensitive).
- - `campaign__not_ends_with=ios`
-- - `[metric]__lt`
- - String
- - "Less than" filter for metric's values any metric.
- - `skad_installs__lt=100`
-- - `[metric]__lte`
- - String
- - "Less than or equal" filter for metric's values for any metric.
- - `skad_installs__lte=100`
-- - `[metric]__gt`
- - String
- - "Greater than" filter for metric's values for any metric.
- - `skad_installs__gt=100`
-- - `[metric]__gte`
- - String
- - "Greater than or equal" filter for metric's values for any metric.
- - `skad_installs__gte=100`
-- - `[metric]__eq`
- - String
- - "Equal" filter for metric's values for any metric.
- - `skad_installs__eq=100`
-- - `[metric]__ne`
- - String
- - "Not equal" filter for values relating to any metric.
- - `skad_installs__ne=100`
+
+
+| Filter | Type | Description | Example |
+| ------------------------------ | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `dimensions`\* | String | Comma-separated values used to group parameters. See the dimensions table below for more information. | `dimensions=app,os_name,week,campaign_id_network` |
+| `metrics`\* | String | Comma-separated KPIs. See the metrics table below for more information. | `metrics=cost,installs,ecpi_network` |
+| `date_period`\* | String | Start and end dates for the report with 3 supported formats:- Logical dates
- Absolute dates
- Relative dates
| - **Logical dates:**
- `this_month_until_yesterday`
- `today`
- `yesterday`
- `this_week`
- `last_week`
- `this_month`
- `last_month`
- **Absolute dates:**
- **Relative dates:**
- `-10d:-3d (from 10 days ago to 3 days ago)`
|
+| `cohort_maturity` | String | - `immature`: displays current values of cumulative metrics for all cohorts, including immature cohorts.
- `mature`: displays the values of cumulative metrics only for mature cohorts and zeros for immature cohorts.
| `cohort_maturity=immature` |
+| `utc_offset` | String | The timezone used in the report. | `utc_offset=+01:00` |
+| `attribution_type` | String | The type of engagement the attribution awards.- `click` (default)
- `impression`
- `all`
| `attribution_type=click` |
+| `attribution_source` | String | Whether in-app activity is assigned to the user’s install source (`first`) or divided among the install source and subsequent sources of reattribution (`dynamic`). Defaults to `dynamic`. | `attribution_source=first` |
+| `reattributed` | String | Filter for reattributed users only. Reattribution is when a user who has already installed your app returns to it through a new Adjust-tracked source.- `all` (default)
- `false`
- `true`
| `reattributed=false` |
+| `ad_revenue_mode` | String | The percentage of gross ad revenue returned by the endpoint. Available options are:- `GROSS_100`
- `GROSS_85`
- `GROSS_70`
- `GROSS_60`
| `ad_revenue_mode=GROSS_70` |
+| `ad_revenue_sources` | String | Comma-separated list of ad revenue sources. | `ad_revenue_sources=unknown` |
+| `os_names` | String | Comma-separated list of operating system names. | `os_names=ios,android` |
+| `ad_spend_mode` | String | Determines the ad spend source applied in calculations. See How ad spend source affects your data for more information. | `ad_spend_mode=network` |
+| `sandbox` | Boolean | Whether to use sandbox data or production data. Defaults to `false`. | `sandbox=true` |
+| `sort` | String | Comma-separated list of metrics/dimensions to sort the report by. Use `-` to order descending. | `sort=-clicks,installs` |
+| `drilldown` | String | List of parameters to drill down into. Formatted as pipe-separated tuples. | `drilldown=campaign:123\|adgroup:234` |
+| `focus` | String | List of parameters to focus on. Formatted as pipe-separated tuples. Differs from drilldown as it doesn't add extra dimensions to the results. | `focus=campaign:123\|adgroup:234` |
+| `index` | String | Comma-separated list of dimensions used to index the report. | `index=network,campaign,adgroup` |
+| `format_dates` | Boolean | If set to `false`, all date dimensions are returned in ISO format. | `format_dates=false` |
+| `period_over_period` | String | The period for comparing report data. | `period_over_period=previous_week` |
+| `currency` | String | Currency used for conversion of money related metrics. | `currency=USD` |
+| `[dimension]__in` | String | Comma-separated list of values to filter dimension's values (exact match) for any dimension. | `campaign__in=abc,def` |
+| `[dimension]__not_in` | String | Comma-separated list of values to filter dimension's values (exclude exact match) for any dimension | `campaign__not_in=abc,def` |
+| `[dimension]__contains` | String | Substring search in dimension's values (case insensitive) for any dimension. | `campaign__contains=ios` |
+| `[dimension]__exclude` | String | Excluding substring search in dimension's values (case insensitive) for any dimension. | `campaign__exclude=ios` |
+| `[dimension]__starts_with` | String | Substring search matching dimensions starting with specified prefix (case insensitive). | `campaign__starts_with=ios` |
+| `[dimension]__not_starts_with` | String | Substring search matching dimensions not starting with specified prefix (case insensitive). | `campaign__not_starts_with=ios` |
+| `[dimension]__ends_with` | String | Substring search matching dimensions ending with specified suffix (case insensitive). | `campaign__ends_with=ios` |
+| `[dimension]__not_ends_with` | String | Substring search matching dimensions not ending with specified suffix (case insensitive). | `campaign__not_ends_with=ios` |
+| `[metric]__lt` | String | "Less than" filter for metric's values any metric. | `skad_installs__lt=100` |
+| `[metric]__lte` | String | "Less than or equal" filter for metric's values for any metric. | `skad_installs__lte=100` |
+| `[metric]__gt` | String | "Greater than" filter for metric's values for any metric. | `skad_installs__gt=100` |
+| `[metric]__gte` | String | "Greater than or equal" filter for metric's values for any metric. | `skad_installs__gte=100` |
+| `[metric]__eq` | String | "Equal" filter for metric's values for any metric. | `skad_installs__eq=100` |
+| `[metric]__ne` | String | "Not equal" filter for values relating to any metric. | `skad_installs__ne=100` |
@@ -200,184 +64,44 @@ The `GET` method returns filtered data from the report service in JSON format.
Dimensions allow a user to break down metrics into groups using one or several parameters. For example, the number of installs by date, country and network.
-
-
-- - Dimension
- - Type
- - Description
- - Example
-- - Dimension
- - Data type
- - Description
- - Example
-- - `hour`
- - Date
- - Date value. Use `format_dates=false` to return the value in ISO format.
- `YYYY-MM-DDTHH:MM:SS`
- - `2021-05-11T17:00:45`
-- - `day`
- - Date
- - Date value. Use `format_dates=false` to return the value in ISO format.
- `YYYY-MM-DD`
- - `2021-05-11`
-- - `week`
- - Date
- - Date value. Use `format_dates=false` to return the value in ISO format.
- `YYYY-MM-DD - YYYY-MM-DD`
- - `2021-05-09 - 2021-05-15`
-- - `month`
- - Date
- - Date value. Use `format_dates=false` to return the value in ISO format.
- `YYYY-MM`
- - `2021-05`
-- - `year`
- - Date
- - Date value. Use `format_dates=false` to return the value in ISO format.
- `YYYY`
- - `2021`
-- - `quarter`
- - String
- - Date value. Use `format_dates=false` to return the value in ISO format.
- `Q YYYY`
- - `Q2 2021`
-- - `os_name`
- - String
- - Possible values:
- - `android`
- - `bada`
- - `blackberry`
- - `ios`
- - `linux`
- - `macos`
- - `server`
- - `symbian`
- - `unknown`
- - `webos`
- - `windows`
- - `windows-phone`
- -
-- - `device_type`
- - String
- - Possible values:
- - `bot`
- - `console`
- - `ipod`
- - `mac`
- - `pc`
- - `phone`
- - `server`
- - `simulator`
- - `tablet`
- - `tv`
- - `unknown`
- -
-- - `app`
- - String
- - Name of the app.
- -
-- - `app_token`
- - String
- - App ID in the Adjust system.
- -
-- - `store_id`
- - String
- - Store App ID.
- - `com.random.app`
-- - `store_type`
- - String
- - Store from where the app was installed.
- - `google_play`
-- - `currency`
- - String
- - Currency name.
- - `Euro`
-- - `currency_code
- - String
- - 3-character value ISO 4217.
- - `EUR`
-- - `network`
- - String
- - The name of the advertising network.
- - Organic, AppLovin, Facebook Installs, Instagram Installs.
-- - `campaign`
- - String
- - Tracker sub-level 1.
- String value usually contains campaign name and id.
- -
-- - `campaign_network`
- - String
- - Campaign name from the network.
- -
-- - `campaign_id_network`
- - String
- - Campaign ID from the network.
- -
-- - `adgroup`
- - String
- - Tracker sub-level 2.
- String value usually contains adgroup name and id.
- -
-- - `adgroup_network`
- - String
- - Adgroup name from the network.
- -
-- - `adgroup_id_network`
- - String
- - Adgroup ID from the network.
- -
-- - `source_network`
- - String
- - Name of the source network. Optional value dependent on the network.
- -
-- - `source_id_network`
- - String
- - ID of the source network.
- -
-- - `creative`
- - String
- - Tracker sub-level 3.
- String value usually contains creative name and id.
- -
-- - `creative_network`
- - String
- - Creative name from the network.
- -
-- - `creative_id_network`
- - String
- - Creative ID from the network.
- -
-- - `country`
- - String
- - Country name.
- - `United States of America`
-- - `country_code`
- - String
- - 2-character value ISO 3166.
- - `US`
-- - `region`
- - String
- - Business region.
- - `APAC`
-- - `partner_name`
- - String
- - Partner's name in the Adjust system.
- - `AppLovin`
-- - `partner_id`
- - String
- - Partner’s id in the Adjust system.
- - `34`
-- - `partner`
- - String
- - The unique slug of the partner.
- - `applovin`
-- - `channel`
- - String
- - A combination of `partner_name` and `network`.
- -
-- - `platform`
- - String
- - The device operating system/platform. See list of supported platforms below.
- - `android`
+
+
+| Dimension | Data type | Description | Example |
+| --------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- |
+| `hour` | Date | Use `format_dates=false` to return the value in ISO format.
`YYYY-MM-DDTHH:MM:SS` | `2021-05-11T17:00:45` |
+| `day` | Date | Use `format_dates=false` to return the value in ISO format.
`YYYY-MM-DD` | `2021-05-11` |
+| `week` | Date | Use `format_dates=false` to return the value in ISO format.
`YYYY-MM-DD - YYYY-MM-DD` | `2021-05-09 - 2021-05-15` |
+| `month` | Date | Use `format_dates=false` to return the value in ISO format.
`YYYY-MM` | `2021-05` |
+| `year` | Date | Use `format_dates=false` to return the value in ISO format.
`YYYY` | `2021` |
+| `quarter` | String | Use `format_dates=false` to return the value in ISO format.
`Q YYYY` | `Q2 2021` |
+| `os_name` | String | Possible values:- `android`
- `bada`
- `blackberry`
- `ios`
- `linux`
- `macos`
- `server`
- `symbian`
- `unknown`
- `webos`
- `windows`
- `windows-phone`
| |
+| `device_type` | String | Possible values:- `bot`
- `console`
- `ipod`
- `mac`
- `pc`
- `phone`
- `server`
- `simulator`
- `tablet`
- `tv`
- `unknown`
| |
+| `app` | String | Name of the app. | |
+| `app_token` | String | App ID in the Adjust system. | |
+| `store_id` | String | Store App ID. | `com.random.app` |
+| `store_type` | String | Store from where the app was installed. | `google_play` |
+| `currency` | String | Currency name. | `Euro` |
+| `currency_code` | String | 3-character value ISO 4217. | `EUR` |
+| `network` | String | The name of the advertising network. | Organic, AppLovin, Facebook Installs, Instagram Installs. |
+| `campaign` | String | Tracker sub-level 1.
String value usually contains campaign name and id. | |
+| `campaign_network` | String | Campaign name from the network. | |
+| `campaign_id_network` | String | Campaign ID from the network. | |
+| `adgroup` | String | Tracker sub-level 2.
String value usually contains adgroup name and id. | |
+| `adgroup_network` | String | Adgroup name from the network. | |
+| `adgroup_id_network` | String | Adgroup ID from the network. | |
+| `source_network` | String | Name of the source network. Optional value dependent on the network. | |
+| `source_id_network` | String | ID of the source network. | |
+| `creative` | String | Tracker sub-level 3.
String value usually contains creative name and id. | |
+| `creative_network` | String | Creative name from the network. | |
+| `creative_id_network` | String | Creative ID from the network. | |
+| `country` | String | Country name. | `United States of America` |
+| `country_code` | String | 2-character value ISO 3166. | `US` |
+| `region` | String | Business region. | `APAC` |
+| `partner_name` | String | Partner's name in the Adjust system. | `AppLovin` |
+| `partner_id` | String | Partner’s id in the Adjust system. | `34` |
+| `partner` | String | The unique slug of the partner. | `applovin` |
+| `channel` | String | A combination of `partner_name` and `network`. | |
+| `platform` | String | The device operating system/platform. See list of supported platforms below. | `android` |
diff --git a/src/content/docs/api/rs-api/reports.mdx b/src/content/docs/api/rs-api/reports.mdx
index 3ba844b56..842751257 100644
--- a/src/content/docs/api/rs-api/reports.mdx
+++ b/src/content/docs/api/rs-api/reports.mdx
@@ -17,168 +17,42 @@ Returns filtered data from the report service in JSON format.
### Filters
-
-
-- - Filter
- - Type
- - Description
- - Example
-- - `dimensions`\*
- - String
- - Comma-separated values used to group parameters. See the dimensions table below for more information.
- - `dimensions=app,os_name,week,campaign_id_network`
-- - `metrics`\*
- - String
- - Comma-separated KPIs. See the metrics table below for more information.
- - `metrics=cost,installs,ecpi_network`
-- - `date_period`\*
- - String
- - Start and end dates for the report with 3 supported formats:
- - Logical dates
- - Absolute dates
- - Relative dates
- - **Logical dates:**
- - `this_month_until_yesterday`
- - `today`
- - `yesterday`
- - `this_week`
- - `last_week`
- - `this_month`
- - `last_month`
- **Absolute dates:**
- - `2020-12-31:2021-01-01`
- **Relative dates:**
- - `-10d:-3d (from 10 days ago to 3 days ago)`
-- - `cohort_maturity`
- - String
- - - `immature`: displays current values of cumulative metrics for all cohorts, including immature cohorts.
- - `mature`: displays the values of cumulative metrics only for mature cohorts and zeros for immature cohorts.
- - `cohort_maturity=immature`
-- - `utc_offset`
- - String
- - The timezone used in the report.
- - `utc_offset=+01:00`
-- - `attribution_type`
- - String
- - The type of engagement the attribution awards.
- - `click` (default)
- - `impression`
- - `all`
- - `attribution_type=click`
-- - `attribution_source`
- - String
- - Whether in-app activity is assigned to the user’s install source (`first`) or divided among the install source and subsequent sources of reattribution (`dynamic`). Defaults to `dynamic`.
- - `attribution_source=first`
-- - `reattributed`
- - String
- - Filter for reattributed users only. Reattribution is when a user who has already installed your app returns to it through a new Adjust-tracked source.
- - `all` (default)
- - `false`
- - `true`
- - `reattributed=false`
-- - `ad_revenue_mode`
- - String
- - The percentage of gross ad revenue returned by the endpoint. Available options are:
- - `GROSS_100`
- - `GROSS_85`
- - `GROSS_70`
- - `GROSS_60`
- - `ad_revenue_mode=GROSS_70`
-- - `ad_revenue_sources`
- - String
- - Comma-separated list of ad revenue sources.
- - `ad_revenue_sources=unknown`
-- - `os_names`
- - String
- - Comma-separated list of operating system names.
- - `os_names=ios,android`
-- - `ad_spend_mode`
- - String
- - Determines the ad spend source applied in calculations. See How ad spend source affects your data for more information.
- - `adjust`
- - `network`
- - `mixed`
- - `ad_spend_mode=network`
-- - `sandbox`
- - Boolean
- - Whether to use sandbox data or production data. Defaults to `false`.
- - `sandbox=true`
-- - `sort`
- - String
- - Comma-separated list of metrics/dimensions to sort the report by. Use `-` to order descending.
- - `sort=-clicks,installs`
-- - `index`
- - String
- - Comma-separated list of dimensions used to index the report.
- - `index=network,campaign,adgroup`
-- - `format_dates`
- - Boolean
- - If set to `false`, all date dimensions are returned in ISO format.
- - `format_dates=false`
-- - `period_over_period`
- - String
- - The period for comparing report data.
- - `period_over_period=previous_week`
-- - `currency`
- - String
- - Currency used for conversion of money related metrics.
- - `currency=USD`
-- - `[dimension]__in`
- - String
- - Comma-separated list of values to filter dimension's values (exact match) for any dimension.
- - `campaign__in=abc,def`
-- - `[dimension]__not_in`
- - String
- - Comma-separated list of values to filter dimension's values (exclude exact match) for any dimension
- - `campaign__not_in=abc,def`
-- - `[dimension]__contains`
- - String
- - Substring search in dimension's values (case insensitive) for any dimension.
- - `campaign__contains=ios`
-- - `[dimension]__exclude`
- - String
- - Excluding substring search in dimension's values (case insensitive) for any dimension.
- - `campaign__exclude=ios`
-- - `[dimension]__starts_with`
- - String
- - Substring search matching dimensions starting with specified prefix (case insensitive).
- - `campaign__starts_with=ios`
-- - `[dimension]__not_starts_with`
- - String
- - Substring search matching dimensions not starting with specified prefix (case insensitive).
- - `campaign__not_starts_with=ios`
-- - `[dimension]__ends_with`
- - String
- - Substring search matching dimensions ending with specified suffix (case insensitive).
- - `campaign__ends_with=ios`
-- - `[dimension]__not_ends_with`
- - String
- - Substring search matching dimensions not ending with specified suffix (case insensitive).
- - `campaign__not_ends_with=ios`
-- - `[metric]__lt`
- - String
- - "Less than" filter for metric's values any metric.
- - `skad_installs__lt=100`
-- - `[metric]__lte`
- - String
- - "Less than or equal" filter for metric's values for any metric.
- - `skad_installs__lte=100`
-- - `[metric]__gt`
- - String
- - "Greater than" filter for metric's values for any metric.
- - `skad_installs__gt=100`
-- - `[metric]__gte`
- - String
- - "Greater than or equal" filter for metric's values for any metric.
- - `skad_installs__gte=100`
-- - `[metric]__eq`
- - String
- - "Equal" filter for metric's values for any metric.
- - `skad_installs__eq=100`
-- - `[metric]__ne`
- - String
- - "Not equal" filter for values relating to any metric.
- - `skad_installs__ne=100`
+
+
+| Filter | Type | Description | Example |
+| ------------------------------ | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `dimensions`\* | String | Comma-separated values used to group parameters. See the dimensions table below for more information. | `dimensions=app,os_name,week,campaign_id_network` |
+| `metrics`\* | String | Comma-separated KPIs. See the metrics table below for more information. | `metrics=cost,installs,ecpi_network` |
+| `date_period`\* | String | Start and end dates for the report with 3 supported formats:- Logical dates
- Absolute dates
- Relative dates
| - **Logical dates:**
- `this_month_until_yesterday`
- `today`
- `yesterday`
- `this_week`
- `last_week`
- `this_month`
- `last_month`
- **Absolute dates:**
- **Relative dates:**
- `-10d:-3d (from 10 days ago to 3 days ago)`
|
+| `cohort_maturity` | String | - `immature`: displays current values of cumulative metrics for all cohorts, including immature cohorts.
- `mature`: displays the values of cumulative metrics only for mature cohorts and zeros for immature cohorts.
| `cohort_maturity=immature` |
+| `utc_offset` | String | The timezone used in the report. | `utc_offset=+01:00` |
+| `attribution_type` | String | The type of engagement the attribution awards.- `click` (default)
- `impression`
- `all`
| `attribution_type=click` |
+| `attribution_source` | String | Whether in-app activity is assigned to the user’s install source (`first`) or divided among the install source and subsequent sources of reattribution (`dynamic`). Defaults to `dynamic`. | `attribution_source=first` |
+| `reattributed` | String | Filter for reattributed users only. Reattribution is when a user who has already installed your app returns to it through a new Adjust-tracked source.- `all` (default)
- `false`
- `true`
| `reattributed=false` |
+| `ad_revenue_mode` | String | The percentage of gross ad revenue returned by the endpoint. Available options are:- `GROSS_100`
- `GROSS_85`
- `GROSS_70`
- `GROSS_60`
| `ad_revenue_mode=GROSS_70` |
+| `ad_revenue_sources` | String | Comma-separated list of ad revenue sources. | `ad_revenue_sources=unknown` |
+| `os_names` | String | Comma-separated list of operating system names. | `os_names=ios,android` |
+| `ad_spend_mode` | String | Determines the ad spend source applied in calculations. See How ad spend source affects your data for more information. | `ad_spend_mode=network` |
+| `sandbox` | Boolean | Whether to use sandbox data or production data. Defaults to `false`. | `sandbox=true` |
+| `sort` | String | Comma-separated list of metrics/dimensions to sort the report by. Use `-` to order descending. | `sort=-clicks,installs` |
+| `index` | String | Comma-separated list of dimensions used to index the report. | `index=network,campaign,adgroup` |
+| `format_dates` | Boolean | If set to `false`, all date dimensions are returned in ISO format. | `format_dates=false` |
+| `period_over_period` | String | The period for comparing report data. | `period_over_period=previous_week` |
+| `currency` | String | Currency used for conversion of money related metrics. | `currency=USD` |
+| `[dimension]__in` | String | Comma-separated list of values to filter dimension's values (exact match) for any dimension. | `campaign__in=abc,def` |
+| `[dimension]__not_in` | String | Comma-separated list of values to filter dimension's values (exclude exact match) for any dimension | `campaign__not_in=abc,def` |
+| `[dimension]__contains` | String | Substring search in dimension's values (case insensitive) for any dimension. | `campaign__contains=ios` |
+| `[dimension]__exclude` | String | Excluding substring search in dimension's values (case insensitive) for any dimension. | `campaign__exclude=ios` |
+| `[dimension]__starts_with` | String | Substring search matching dimensions starting with specified prefix (case insensitive). | `campaign__starts_with=ios` |
+| `[dimension]__not_starts_with` | String | Substring search matching dimensions not starting with specified prefix (case insensitive). | `campaign__not_starts_with=ios` |
+| `[dimension]__ends_with` | String | Substring search matching dimensions ending with specified suffix (case insensitive). | `campaign__ends_with=ios` |
+| `[dimension]__not_ends_with` | String | Substring search matching dimensions not ending with specified suffix (case insensitive). | `campaign__not_ends_with=ios` |
+| `[metric]__lt` | String | "Less than" filter for metric's values any metric. | `skad_installs__lt=100` |
+| `[metric]__lte` | String | "Less than or equal" filter for metric's values for any metric. | `skad_installs__lte=100` |
+| `[metric]__gt` | String | "Greater than" filter for metric's values for any metric. | `skad_installs__gt=100` |
+| `[metric]__gte` | String | "Greater than or equal" filter for metric's values for any metric. | `skad_installs__gte=100` |
+| `[metric]__eq` | String | "Equal" filter for metric's values for any metric. | `skad_installs__eq=100` |
+| `[metric]__ne` | String | "Not equal" filter for values relating to any metric. | `skad_installs__ne=100` |
@@ -186,180 +60,44 @@ Returns filtered data from the report service in JSON format.
Dimensions allow a user to break down metrics into groups using one or several parameters. For example, the number of installs by date, country and network.
-
-
-- - Dimension
- - Data type
- - Description
- - Example
-- - `hour`
- - Date
- - Date value. Use `format_dates=false` to return the value in ISO format.
- `YYYY-MM-DDTHH:MM:SS`
- - `2021-05-11T17:00:45`
-- - `day`
- - Date
- - Date value. Use `format_dates=false` to return the value in ISO format.
- `YYYY-MM-DD`
- - `2021-05-11`
-- - `week`
- - Date
- - Date value. Use `format_dates=false` to return the value in ISO format.
- `YYYY-MM-DD - YYYY-MM-DD`
- - `2021-05-09 - 2021-05-15`
-- - `month`
- - Date
- - Date value. Use `format_dates=false` to return the value in ISO format.
- `YYYY-MM`
- - `2021-05`
-- - `year`
- - Date
- - Date value. Use `format_dates=false` to return the value in ISO format.
- `YYYY`
- - `2021`
-- - `quarter`
- - String
- - Date value. Use `format_dates=false` to return the value in ISO format.
- `Q YYYY`
- - `Q2 2021`
-- - `os_name`
- - String
- - Possible values:
- - `android`
- - `bada`
- - `blackberry`
- - `ios`
- - `linux`
- - `macos`
- - `server`
- - `symbian`
- - `unknown`
- - `webos`
- - `windows`
- - `windows-phone`
- -
-- - `device_type`
- - String
- - Possible values:
- - `bot`
- - `console`
- - `ipod`
- - `mac`
- - `pc`
- - `phone`
- - `server`
- - `simulator`
- - `tablet`
- - `tv`
- - `unknown`
- -
-- - `app`
- - String
- - Name of the app.
- -
-- - `app_token`
- - String
- - App ID in the Adjust system.
- -
-- - `store_id`
- - String
- - Store App ID.
- - `com.random.app`
-- - `store_type`
- - String
- - Store from where the app was installed.
- - `google_play`
-- - `currency`
- - String
- - Currency name.
- - `Euro`
-- - `currency_code
- - String
- - 3-character value ISO 4217.
- - `EUR`
-- - `network`
- - String
- - The name of the advertising network.
- - Organic, AppLovin, Facebook Installs, Instagram Installs.
-- - `campaign`
- - String
- - Tracker sub-level 1.
- String value usually contains campaign name and id.
- -
-- - `campaign_network`
- - String
- - Campaign name from the network.
- -
-- - `campaign_id_network`
- - String
- - Campaign ID from the network.
- -
-- - `adgroup`
- - String
- - Tracker sub-level 2.
- String value usually contains adgroup name and id.
- -
-- - `adgroup_network`
- - String
- - Adgroup name from the network.
- -
-- - `adgroup_id_network`
- - String
- - Adgroup ID from the network.
- -
-- - `source_network`
- - String
- - Name of the source network. Optional value dependent on the network.
- -
-- - `source_id_network`
- - String
- - ID of the source network.
- -
-- - `creative`
- - String
- - Tracker sub-level 3.
- String value usually contains creative name and id.
- -
-- - `creative_network`
- - String
- - Creative name from the network.
- -
-- - `creative_id_network`
- - String
- - Creative ID from the network.
- -
-- - `country`
- - String
- - Country name.
- - `United States of America`
-- - `country_code`
- - String
- - 2-character value ISO 3166.
- - `US`
-- - `region`
- - String
- - Business region.
- - `APAC`
-- - `partner_name`
- - String
- - Partner's name in the Adjust system.
- - `AppLovin`
-- - `partner_id`
- - String
- - Partner’s id in the Adjust system.
- - `34`
-- - `partner`
- - String
- - The unique slug of the partner.
- - `applovin`
-- - `channel`
- - String
- - A combination of `partner_name` and `network`.
- -
-- - `platform`
- - String
- - The device operating system/platform. See list of supported platforms below.
- - `android`
+
+
+| Dimension | Data type | Description | Example |
+| --------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- |
+| `hour` | Date | Use `format_dates=false` to return the value in ISO format.
`YYYY-MM-DDTHH:MM:SS` | `2021-05-11T17:00:45` |
+| `day` | Date | Use `format_dates=false` to return the value in ISO format.
`YYYY-MM-DD` | `2021-05-11` |
+| `week` | Date | Use `format_dates=false` to return the value in ISO format.
`YYYY-MM-DD - YYYY-MM-DD` | `2021-05-09 - 2021-05-15` |
+| `month` | Date | Use `format_dates=false` to return the value in ISO format.
`YYYY-MM` | `2021-05` |
+| `year` | Date | Use `format_dates=false` to return the value in ISO format.
`YYYY` | `2021` |
+| `quarter` | String | Use `format_dates=false` to return the value in ISO format.
`Q YYYY` | `Q2 2021` |
+| `os_name` | String | Possible values:- `android`
- `bada`
- `blackberry`
- `ios`
- `linux`
- `macos`
- `server`
- `symbian`
- `unknown`
- `webos`
- `windows`
- `windows-phone`
| |
+| `device_type` | String | Possible values:- `bot`
- `console`
- `ipod`
- `mac`
- `pc`
- `phone`
- `server`
- `simulator`
- `tablet`
- `tv`
- `unknown`
| |
+| `app` | String | Name of the app. | |
+| `app_token` | String | App ID in the Adjust system. | |
+| `store_id` | String | Store App ID. | `com.random.app` |
+| `store_type` | String | Store from where the app was installed. | `google_play` |
+| `currency` | String | Currency name. | `Euro` |
+| `currency_code` | String | 3-character value ISO 4217. | `EUR` |
+| `network` | String | The name of the advertising network. | Organic, AppLovin, Facebook Installs, Instagram Installs. |
+| `campaign` | String | Tracker sub-level 1.
String value usually contains campaign name and id. | |
+| `campaign_network` | String | Campaign name from the network. | |
+| `campaign_id_network` | String | Campaign ID from the network. | |
+| `adgroup` | String | Tracker sub-level 2.
String value usually contains adgroup name and id. | |
+| `adgroup_network` | String | Adgroup name from the network. | |
+| `adgroup_id_network` | String | Adgroup ID from the network. | |
+| `source_network` | String | Name of the source network. Optional value dependent on the network. | |
+| `source_id_network` | String | ID of the source network. | |
+| `creative` | String | Tracker sub-level 3.
String value usually contains creative name and id. | |
+| `creative_network` | String | Creative name from the network. | |
+| `creative_id_network` | String | Creative ID from the network. | |
+| `country` | String | Country name. | `United States of America` |
+| `country_code` | String | 2-character value ISO 3166. | `US` |
+| `region` | String | Business region. | `APAC` |
+| `partner_name` | String | Partner's name in the Adjust system. | `AppLovin` |
+| `partner_id` | String | Partner’s id in the Adjust system. | `34` |
+| `partner` | String | The unique slug of the partner. | `applovin` |
+| `channel` | String | A combination of `partner_name` and `network`. | |
+| `platform` | String | The device operating system/platform. See list of supported platforms below. | `android` |
diff --git a/src/content/docs/kitchen-sink/tables.mdx b/src/content/docs/kitchen-sink/tables.mdx
index b0f87ca70..27740a80c 100644
--- a/src/content/docs/kitchen-sink/tables.mdx
+++ b/src/content/docs/kitchen-sink/tables.mdx
@@ -142,7 +142,7 @@ You can explicitly set the height of a table in pixels. This allows you to contr
| `countries` | String | Query | Comma-separated list of ISO 3166 alpha-2 country names. |
| `os_names` | String | Query | Comma-separated list of OS names. |
| `device_types` | String | Query | Comma-separated list of device types. |
-| `grouping` | String | Query | Grouping parameters. [See Result grouping](/en/api/kpi-service/grouping) for more information. |
+| `grouping` | String | Query | Grouping parameters. [See Result grouping](/en/index) for more information. |
| `tracker_filter` | String | Query | The tracker tokens of any trackers you want to include in your results. Only metrics relating to these trackers are returned. |
| `human_readable_kpis` | Boolean | Query | Replace metrics with human readable alternatives (for example: "Lifetime Value" instead of `lifetime_value`). |
@@ -162,7 +162,7 @@ You can explicitly set the height of a table in pixels. This allows you to contr
| `countries` | String | Query | Comma-separated list of ISO 3166 alpha-2 country names. |
| `os_names` | String | Query | Comma-separated list of OS names. |
| `device_types` | String | Query | Comma-separated list of device types. |
-| `grouping` | String | Query | Grouping parameters. [See Result grouping](/en/api/kpi-service/grouping) for more information. |
+| `grouping` | String | Query | Grouping parameters. [See Result grouping](/en/index) for more information. |
| `tracker_filter` | String | Query | The tracker tokens of any trackers you want to include in your results. Only metrics relating to these trackers are returned. |
| `human_readable_kpis` | Boolean | Query | Replace metrics with human readable alternatives (for example: "Lifetime Value" instead of `lifetime_value`). |
diff --git a/src/content/docs/kitchen-sink/test-page.mdx b/src/content/docs/kitchen-sink/test-page.mdx
index e591a965d..0768038b2 100644
--- a/src/content/docs/kitchen-sink/test-page.mdx
+++ b/src/content/docs/kitchen-sink/test-page.mdx
@@ -286,7 +286,7 @@ _It_ **contains** [Markdown](https://www.markdownguide.org/).
| `countries` | String | Query | Comma-separated list of ISO 3166 alpha-2 country names. |
| `os_names` | String | Query | Comma-separated list of OS names. |
| `device_types` | String | Query | Comma-separated list of device types. |
-| `grouping` | String | Query | Grouping parameters. [See Result grouping](/en/api/kpi-service/grouping) for more information. |
+| `grouping` | String | Query | Grouping parameters. [See Result grouping](/en/index) for more information. |
| `tracker_filter` | String | Query | The tracker tokens of any trackers you want to include in your results. Only metrics relating to these trackers are returned. |
| `human_readable_kpis` | Boolean | Query | Replace metrics with human readable alternatives (for example: "Lifetime Value" instead of `lifetime_value`). |
diff --git a/src/content/docs/sdk/android/configuration/background.mdx b/src/content/docs/sdk/android/configuration/background.mdx
index 8ac09bfad..5f835d5ba 100644
--- a/src/content/docs/sdk/android/configuration/background.mdx
+++ b/src/content/docs/sdk/android/configuration/background.mdx
@@ -9,7 +9,7 @@ import SetSendInBackground from "@android-examples/ADJConfig/setSendInBackground
By default, the Adjust SDK pauses the sending of requests when your app is running in the background. You can configure the SDK to send requests in the background by enabling the background recording feature.
-Your config object contains a boolean `sendInBackground` property that controls this behavior. You can set this property by calling the `setSendInBackground` method || on your config instance with a boolean value.
+Your config object contains a boolean `sendInBackground` property that controls this behavior. You can set this property by calling the `setSendInBackground` method on your config instance with a boolean value.
diff --git a/src/content/docs/sdk/android/configuration/deep-linking.mdx b/src/content/docs/sdk/android/configuration/deep-linking.mdx
index 14c465653..c146d233c 100644
--- a/src/content/docs/sdk/android/configuration/deep-linking.mdx
+++ b/src/content/docs/sdk/android/configuration/deep-linking.mdx
@@ -11,11 +11,9 @@ import AppWillOpenUrl from "@android-examples/Adjust/appWillOpenUrl.mdx"
You can create deep links to take users to specific pages in your app. The Adjust SDK uses different logic depending on if the user already has your app installed on their device:
-Direct deep linking
-: Occurs if the user already has your app installed. The link takes the user to the page specified in the link
+Direct deep linking: Occurs if the user already has your app installed. The link takes the user to the page specified in the link
-Deferred deep linking
-: Occurs if the user doesn't have your app installed. The link takes the user to a storefront to install your app first. After the user installs the app, it opens to the page specified in the link.
+Deferred deep linking: Occurs if the user doesn't have your app installed. The link takes the user to a storefront to install your app first. After the user installs the app, it opens to the page specified in the link.
The SDK can read deep link data after a user opens your app from a link.
@@ -135,7 +133,7 @@ protected void onNewIntent(Intent intent) {
## Deferred deep linking
-The Adjust SDK opens deferred deep links by default. No additional setup is required. If you want to disable this behavior, you need to set up a deferred deep link callback using the `setOnDeeplinkResponseListener` method || .
+The Adjust SDK opens deferred deep links by default. No additional setup is required. If you want to disable this behavior, you need to set up a deferred deep link callback using the `setOnDeeplinkResponseListener` method .
### Set up a deferred deep link callback
@@ -177,13 +175,13 @@ config.setOnDeeplinkResponseListener(new OnDeeplinkResponseListener() {
Adjust enables you to run re-engagement campaigns with usage of deep links. For more information, see the [guide to appending attribution data to a deep link](https://help.adjust.com/en/article/deeplink-generator#manage-your-deeplinks).
-To reattribute your user, you need to call the `appWillOpenUrl` method || when the app receives deep link content. The Adjust SDK then looks for new attribution data within the deep link. If the SDK finds new information, it forwards the information to Adjust's servers for reattribution.
+To reattribute your user, you need to call the `appWillOpenUrl` method when the app receives deep link content. The Adjust SDK then looks for new attribution data within the deep link. If the SDK finds new information, it forwards the information to Adjust's servers for reattribution.
## Link resolution
-Some ESPs (Email Service Providers) use their own custom tracking domains for marketing campaigns. If you need to track clicks through a custom domain, you need to set the SDK up to resolve the link. To do this, call the `resolveLink` method of the `AdjustLinkResolution` class. The Adjust SDK will then follow the custom link and resolve it when opening the deep link. This ensures that you record the interaction with your email tracking campaign.
+Some ESPs (Email Service Providers) use their own custom tracking domains for marketing campaigns. If you need to track clicks through a custom domain, you need to set the SDK up to resolve the link. To do this, call the `resolveLink` method of the `AdjustLinkResolution` class. The Adjust SDK will then follow the custom link and resolve it when opening the deep link. This ensures that you record the interaction with your email tracking campaign.
The `resolveLinkWithUrl` method takes the following parameters:
diff --git a/src/content/docs/sdk/android/configuration/delay.mdx b/src/content/docs/sdk/android/configuration/delay.mdx
index fc6c188f1..8f0839e9f 100644
--- a/src/content/docs/sdk/android/configuration/delay.mdx
+++ b/src/content/docs/sdk/android/configuration/delay.mdx
@@ -17,7 +17,7 @@ The offline mode setting isn't remembered between sessions. Offline mode is disa
The Adjust SDK sends event and session data to Adjust's servers in real time. You can pause the sending of information by putting the SDK in offline mode. In offline mode the SDK stores all data in a local file on the device. The SDK sends this information to Adjust's servers when you disable offline mode.
-Your config object contains a boolean `isOffline` property that controls this behavior. You can update this property at any time by calling the `setOfflineMode` method || with a boolean argument. The SDK sends all saved information to Adjust's servers when you deactivate offline mode.
+Your config object contains a boolean `isOffline` property that controls this behavior. You can update this property at any time by calling the `setOfflineMode` method with a boolean argument. The SDK sends all saved information to Adjust's servers when you deactivate offline mode.
@@ -25,6 +25,6 @@ Your config object contains a boolean `isOffline` property that controls this be
The Adjust SDK sends event information as soon as a user triggers an event in your app. You can send event information on a schedule by enabling event buffering. Event buffering stores events in a local buffer on the device and sends all requests once per minute.
-Your config object contains a boolean `eventBufferingEnabled` property that controls this behavior. You can set this property by calling the `setEventBufferingEnabled` method || on your config object with a boolean argument.
+Your config object contains a boolean `eventBufferingEnabled` property that controls this behavior. You can set this property by calling the `setEventBufferingEnabled` method on your config object with a boolean argument.
diff --git a/src/content/docs/sdk/android/configuration/disable.mdx b/src/content/docs/sdk/android/configuration/disable.mdx
index a248f1fc2..0d212edb0 100644
--- a/src/content/docs/sdk/android/configuration/disable.mdx
+++ b/src/content/docs/sdk/android/configuration/disable.mdx
@@ -11,7 +11,7 @@ import IsEnabledSig from "@android-signatures/Adjust/isEnabled.mdx"
The Adjust SDK runs by default when your app is open. You can disable and re-enable the Adjust SDK to pause and resume recording. When you disable the Adjust SDK, it doesn't send any data to Adjust's servers.
-You can enable or disable the SDK at any time by calling the `setEnabled` method || with a boolean argument.
+You can enable or disable the SDK at any time by calling the `setEnabled` method with a boolean argument.
@@ -23,6 +23,6 @@ You can only call this method after the first session. This setting persists bet
## Check enabled status
-You can check if the Adjust SDK is enabled at any time by calling the `isEnabled` method || . This method returns a boolean value.
+You can check if the Adjust SDK is enabled at any time by calling the `isEnabled` method. This method returns a boolean value.
diff --git a/src/content/docs/sdk/android/configuration/external-device-id.mdx b/src/content/docs/sdk/android/configuration/external-device-id.mdx
index 0d60e8c90..e29724d96 100644
--- a/src/content/docs/sdk/android/configuration/external-device-id.mdx
+++ b/src/content/docs/sdk/android/configuration/external-device-id.mdx
@@ -17,7 +17,7 @@ See the [External device identifiers article](https://help.adjust.com/en/article
-Your config object contains a **string** `externalDeviceId` property that you can use to store your external device ID. You can set property calling the `setExternalDeviceId` method || with your ID as an argument.
+Your config object contains a **string** `externalDeviceId` property that you can use to store your external device ID. You can set property calling the `setExternalDeviceId` method with your ID as an argument.
diff --git a/src/content/docs/sdk/android/configuration/log-level.mdx b/src/content/docs/sdk/android/configuration/log-level.mdx
index e3b010fb9..b5d18f3cc 100644
--- a/src/content/docs/sdk/android/configuration/log-level.mdx
+++ b/src/content/docs/sdk/android/configuration/log-level.mdx
@@ -23,6 +23,6 @@ The Adjust SDK provides configurable log levels to return different amounts of i
-You can set your log level by calling the `setLogLevel` method || on your `AdjustConfig` instance.
+You can set your log level by calling the `setLogLevel` method on your `AdjustConfig` instance.
diff --git a/src/content/docs/sdk/android/configuration/preinstalled.mdx b/src/content/docs/sdk/android/configuration/preinstalled.mdx
index eaf0a0b3d..9c3e99383 100644
--- a/src/content/docs/sdk/android/configuration/preinstalled.mdx
+++ b/src/content/docs/sdk/android/configuration/preinstalled.mdx
@@ -13,7 +13,7 @@ import SetPreinstallFilePath from "@android-examples/ADJConfig/setPreinstallFile
You can use the Adjust SDK to record activity from apps that came preinstalled on a user's device. This enables you to send information from users who didn't download your app from a campaign.
-Your config object contains a **boolean** `preinstallTrackingEnabled` property that controls this feature. To enable preinstall measurement, call the `setPreinstallTrackingEnabled` || with a `true` argument.
+Your config object contains a **boolean** `preinstallTrackingEnabled` property that controls this feature. To enable preinstall measurement, call the `setPreinstallTrackingEnabled` with a `true` argument.
@@ -26,7 +26,7 @@ The Adjust SDK provides 5 methods for measuring preinstalled apps:
## System properties
-OEM (Original Equipment Manufacturer) partners can leverage Android system properties to attribute preinstalled apps. The OEM writes attribution information to a file and adds its path to the system properties. The Adjust SDK reads this file on initialization to attribute the install.
+OEM (Original Equipment Manufacturer) partners can leverage Android system properties to attribute preinstalled apps. The OEM writes attribution information to a file and adds its path to the system properties. The Adjust SDK reads this file on initialization to attribute the install.
## Content provider
@@ -69,7 +69,7 @@ To set up the receiver, add the following to your `AndroidManifest.xml` file.
Save attribution information for your preinstalled app in a world-readable directory. The SDK reads the information from this file at install to attribute the user. The system encryption protocol protects app data.
-Pass the file path at which your preinstall information can be found to the setPreinstallFilePath || method to give the Adjust SDK access to the information.
+Pass the file path at which your preinstall information can be found to the setPreinstallFilePath method to give the Adjust SDK access to the information.
@@ -83,7 +83,7 @@ Configuring a default campaign enables you to attribute all preinstalls to a pre
https://app.adjust.com/{token}
```
-2. Copy this token and pass it to the `setDefaultTracker` || method.
+2. Copy this token and pass it to the `setDefaultTracker` method.
diff --git a/src/content/docs/sdk/android/configuration/privacy.mdx b/src/content/docs/sdk/android/configuration/privacy.mdx
index 53ec5a56d..609fa8011 100644
--- a/src/content/docs/sdk/android/configuration/privacy.mdx
+++ b/src/content/docs/sdk/android/configuration/privacy.mdx
@@ -29,9 +29,9 @@ The Adjust SDK contains features that you can use to handle user privacy in your
## GDPR right to be forgotten
-Article 17 of the European Union's GDPR (General Data Protection Regulation) grants users the right to be forgotten. When Adjust's servers receive an RTBF (Right to be Forgotten) request, Adjust erases the user's data. The SDK also stops sending requests from the device for the app in question.
+Article 17 of the European Union's GDPR (General Data Protection Regulation) grants users the right to be forgotten. When Adjust's servers receive an RTBF (Right to be Forgotten) request, Adjust erases the user's data. The SDK also stops sending requests from the device for the app in question.
-You can send the user's RTBF request to Adjust by calling the `gdprForgetMe` method || .
+You can send the user's RTBF request to Adjust by calling the `gdprForgetMe` method.
@@ -41,25 +41,25 @@ You can use the Adjust SDK to record when a user changes their third-party shari
### Disable third-party sharing
-Some users may want to opt-out of sharing their data with third-parties. To communicate this to Adjust, call the `trackThirdPartySharing` method || with an [`AdjustThirdPartySharing` object](/en/sdk/android/reference/adjthirdpartysharing) initialized with a `false` value. When Adjust's servers receive this information, Adjust stops sharing the user's data with third-parties. The Adjust SDK continues to work as expected.
+Some users may want to opt-out of sharing their data with third-parties. To communicate this to Adjust, call the `trackThirdPartySharing` method with an [`AdjustThirdPartySharing` object](/en/sdk/android/reference/adjthirdpartysharing) initialized with a `false` value. When Adjust's servers receive this information, Adjust stops sharing the user's data with third-parties. The Adjust SDK continues to work as expected.
### Enable third-party sharing
-If a user opts into sharing with third-parties, call the `trackThirdPartySharing` method || method with an [`AdjustThirdPartySharing` object](/en/sdk/android/reference/adjthirdpartysharing) initialized with a `true` value. This updates the user's preferences.
+If a user opts into sharing with third-parties, call the `trackThirdPartySharing` method method with an [`AdjustThirdPartySharing` object](/en/sdk/android/reference/adjthirdpartysharing) initialized with a `true` value. This updates the user's preferences.
### Send granular information
-You can attach granular information when a user updates their third-party sharing preferences. Use this information to communicate more detail about a user's decision. To do this, call the `addGranularOption` method || with your partner name and your options.
+You can attach granular information when a user updates their third-party sharing preferences. Use this information to communicate more detail about a user's decision. To do this, call the `addGranularOption` method with your partner name and your options.
### Update partner settings
-You can use the Adjust SDK to update your third party sharing settings on a per-partner basis. To do this, call the `addPartnerSharingSetting` method || with your partner name and your options.
+You can use the Adjust SDK to update your third party sharing settings on a per-partner basis. To do this, call the `addPartnerSharingSetting` method with your partner name and your options.
@@ -88,9 +88,9 @@ The Adjust SDK sends information to Facebook as soon as the app is installed. Yo
-Facebook provides a feature called LDU (Limited Data Use) to comply with the CCPA (California Consumer Privacy Act). This feature enables you to notify Facebook when a California-based user is opted out of the sale of data. You can also use it if you want to opt all users out by default.
+Facebook provides a feature called LDU (Limited Data Use) to comply with the CCPA (California Consumer Privacy Act). This feature enables you to notify Facebook when a California-based user is opted out of the sale of data. You can also use it if you want to opt all users out by default.
-You can update the Facebook LDU status by passing arguments to the `addGranularOption` method || .
+You can update the Facebook LDU status by passing arguments to the `addGranularOption` method.
@@ -166,7 +166,7 @@ Adjust.trackThirdPartySharing(adjustThirdPartySharing);
## Disable third-party sharing
-To disable third-party sharing for all users, call the `disableThirdPartySharing` method || . When Adjust's servers receive this information, Adjust stops sharing the user's data with third-parties. The Adjust SDK continues to work as expected.
+To disable third-party sharing for all users, call the `disableThirdPartySharing` method. When Adjust's servers receive this information, Adjust stops sharing the user's data with third-parties. The Adjust SDK continues to work as expected.
@@ -174,7 +174,7 @@ To disable third-party sharing for all users, call the `disableThirdPar
The data residency feature allows you to choose the country in which Adjust stores your data. This is useful if you're operating in a country with strict privacy requirements. When you set up data residency, Adjust stores your data in a data center located in the region your have chosen.
-To set your country of data residency, call the `setUrlStrategy` method || on your `AdjustConfig` instance.
+To set your country of data residency, call the `setUrlStrategy` method on your `AdjustConfig` instance.
@@ -182,13 +182,13 @@ To set your country of data residency, call the `setUrlStrategy` method
If you are using [Data Privacy settings](https://help.adjust.com/en/article/manage-data-collection-and-retention) in your Adjust dashboard, you need to set up the Adjust SDK to work with them. This includes settings such as consent expiry period and user data retention period.
-To toggle this feature, call the `trackMeasurementConsent` method || . When enabled, the SDK communicates the data privacy settings to Adjust's servers. Adjust's servers then applies your data privacy rules to the user. The Adjust SDK continues to work as expected.
+To toggle this feature, call the `trackMeasurementConsent` method. When enabled, the SDK communicates the data privacy settings to Adjust's servers. Adjust's servers then applies your data privacy rules to the user. The Adjust SDK continues to work as expected.
## COPPA compliance
-If you need your app to be COPPA compliant, call the `setCoppaCompliantEnabled` || method. This method performs the following actions:
+If you need your app to be COPPA compliant, call the `setCoppaCompliantEnabled` method. This method performs the following actions:
1. Disables third-party sharing **before** the user launches their first `session`.
2. Prevents the SDK from reading device and advertising IDs (for example: `gps_adid` and `android_id`).
@@ -205,6 +205,6 @@ Disabling the `setCoppaCompliantEnabled` method doesn't re-enable third-party sh
## Play Store Kids Apps
-If your app targets users under the age of 13, and the install region **isn't** the USA, you need to mark it as a Kids App. This prevents the SDK from reading device and advertising IDs (for example: `gps_adid` and `android_id`). To do this, call the `setPlayStoreKidsAppEnabled` || method with a `true` argument.
+If your app targets users under the age of 13, and the install region **isn't** the USA, you need to mark it as a Kids App. This prevents the SDK from reading device and advertising IDs (for example: `gps_adid` and `android_id`). To do this, call the `setPlayStoreKidsAppEnabled` method with a `true` argument.
diff --git a/src/content/docs/sdk/android/configuration/push-tokens.mdx b/src/content/docs/sdk/android/configuration/push-tokens.mdx
index a18593a9f..f1e1bb063 100644
--- a/src/content/docs/sdk/android/configuration/push-tokens.mdx
+++ b/src/content/docs/sdk/android/configuration/push-tokens.mdx
@@ -10,7 +10,7 @@ import SetPushTokenExample from "@android-examples/Adjust/setPushTokenExample.md
Push tokens are used for [Audience Builder](https://help.adjust.com/en/article/audience-builder) and client callbacks. They're also required for [Uninstall and reinstall tracking](https://help.adjust.com/en/article/uninstalls-reinstalls).
-Your config object contains a string `pushToken` property that you can use to store your push token. You can update this property at any time by calling the `setPushToken` method || and passing your token as an argument.
+Your config object contains a string `pushToken` property that you can use to store your push token. You can update this property at any time by calling the `setPushToken` method and passing your token as an argument.
@@ -22,7 +22,7 @@ If you have access to the push token from the web view, you can call the `setPus
## Example
-This example shows how to set a new push token with the value *`HrFmrcq96tj723aWFfrw`* to track your app's retention rates. You can update this value at any time by passing a new token to the `setPushToken` method || as an argument:
+This example shows how to set a new push token with the value *`HrFmrcq96tj723aWFfrw`* to track your app's retention rates. You can update this value at any time by passing a new token to the `setPushToken` method as an argument:
diff --git a/src/content/docs/sdk/android/features/ad-revenue.mdx b/src/content/docs/sdk/android/features/ad-revenue.mdx
index 55d2ffe60..54d8b81f7 100644
--- a/src/content/docs/sdk/android/features/ad-revenue.mdx
+++ b/src/content/docs/sdk/android/features/ad-revenue.mdx
@@ -32,7 +32,7 @@ You need to perform some extra setup steps in your Adjust dashboard to measure a
To send ad revenue to Adjust:
1. Create a new Adjust ad revenue instance and pass your ad revenue source as an argument.
-2. Call the `trackAdRevenue` method || with your ad revenue instance as an argument.
+2. Call the `trackAdRevenue` method with your ad revenue instance as an argument.
@@ -58,13 +58,11 @@ To send ad revenue to Adjust:
You can record ad revenue by setting the `revenue` and `currency` properties on your ad revenue instance.
-To set these properties, call the `setRevenue` method || and pass the following arguments:
+To set these properties, call the `setRevenue` method and pass the following arguments:
-`revenue` **number**
-: The amount of revenue
+`revenue` **number**: The amount of revenue
-`currency` **string**
-: The 3 character [ISO 4217 code](https://www.iban.com/currency-codes) of your reporting currency
+`currency` **string**: The 3 character [ISO 4217 code](https://www.iban.com/currency-codes) of your reporting currency
@@ -80,25 +78,25 @@ The ad revenue object contains properties you can use to report on your ad campa
### Ad impressions
-Record the number of ad impressions by passing an **integer** value to the `setAdImpressionsCount` method || .
+Record the number of ad impressions by passing an **integer** value to the `setAdImpressionsCount` method.
### Ad revenue network
-Record which network generated the revenue by passing a **string** value to the `setAdRevenueNetwork` method || .
+Record which network generated the revenue by passing a **string** value to the `setAdRevenueNetwork` method.
### Ad revenue unit
-Record which ad revenue unit generated the revenue by passing a **string** value to the `setAdRevenueUnit` method || .
+Record which ad revenue unit generated the revenue by passing a **string** value to the `setAdRevenueUnit` method.
### Ad revenue placement
-Record the placement of your ad by passing a **string** value to the `setAdRevenuePlacement` method || .
+Record the placement of your ad by passing a **string** value to the `setAdRevenuePlacement` method.
@@ -108,7 +106,7 @@ If you [register a callback URL](https://help.adjust.com/en/article/recommended-
You can configure callback parameters to your servers. Once you configure parameters on an event, the SDK appends them to your [callback URL](https://help.adjust.com/en/article/raw-data-exports). You can use this information to analyze your users' in-app behavior with your BI system.
-Add callback parameters to your event by calling the `addCallbackParameter` method || with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
+Add callback parameters to your event by calling the `addCallbackParameter` method with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
The Adjust SDK measures the event and sends a request to your URL with the callback parameters. For example, if you register the URL `https://www.mydomain.com/callback`, your callback looks like this:
@@ -146,7 +144,7 @@ Partner parameters don't appear in raw data by default. You can add the `{partne
-Add partner parameters to your event by calling the `addPartnerParameter` method || with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
+Add partner parameters to your event by calling the `addPartnerParameter` method with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
diff --git a/src/content/docs/sdk/android/features/attribution.mdx b/src/content/docs/sdk/android/features/attribution.mdx
index 97af47939..562f58e36 100644
--- a/src/content/docs/sdk/android/features/attribution.mdx
+++ b/src/content/docs/sdk/android/features/attribution.mdx
@@ -12,7 +12,7 @@ import SetOnAttributionChangedListenerFacebook from "@android-examples/ADJConfig
When a user interacts with a campaign link, their attribution information updates. This can happen if the user interacts with a [deep link](https://help.adjust.com/en/article/deep-links). The SDK can listen for attribution changes and call a function when it detects an update.
-To configure your callback function, call the `setOnAttributionChangedListener` method || with your function name as an argument.
+To configure your callback function, call the `setOnAttributionChangedListener` method with your function name as an argument.
@@ -30,7 +30,7 @@ The Adjust SDK receives Facebook install referrer information as a **string** pr
## Get current attribution information
-When a user installs your app, Adjust attributes the install to a campaign. The Adjust SDK gives you access to campaign attribution details for your install. To return this information, call the `attribution` method || .
+When a user installs your app, Adjust attributes the install to a campaign. The Adjust SDK gives you access to campaign attribution details for your install. To return this information, call the `attribution` method.
This method returns an Attribution object. See the [`AdjustAttribution` class reference](/en/sdk/android/reference/adjattribution) for a list of available properties.
diff --git a/src/content/docs/sdk/android/features/device-info.mdx b/src/content/docs/sdk/android/features/device-info.mdx
index 25eba10f8..a7bc46da5 100644
--- a/src/content/docs/sdk/android/features/device-info.mdx
+++ b/src/content/docs/sdk/android/features/device-info.mdx
@@ -16,22 +16,22 @@ The Adjust SDK contains helper methods that return device information. Use these
## Adjust device identifier
-Adjust generates a unique ADID (Adjust Device ID) for each device. Call the `adid` method || to return this ID as a **string**.
+Adjust generates a unique ADID (Adjust Device ID) for each device. Call the `adid` method to return this ID as a **string**.
## Google Play Services Advertising ID
-The GPS ADID (Google Play Services Advertising ID) is a device-specific identifier for Android devices.
+The GPS ADID (Google Play Services Advertising ID) is a device-specific identifier for Android devices.
Users can opt out of sharing their GPS ADID by toggling the "Opt out of Ads Personalization" setting on their device. When a user enables this setting, the Adjust SDK returns a string of zeros when trying to read the GPS ADID.
-You can access this value by calling the `getGoogleAdId` method || in a background thread. Assign a delegate function to access the GPS ADID value.
+You can access this value by calling the `getGoogleAdId` method in a background thread. Assign a delegate function to access the GPS ADID value.
## Amazon Advertiser ID
-The Amazon Ad ID (Amazon Advertising ID) is a device-specific identifier for Android devices. Call the `getAmazonAdId` method || to return this ID as a **string**.
+The Amazon Ad ID (Amazon Advertising ID) is a device-specific identifier for Android devices. Call the `getAmazonAdId` method to return this ID as a **string**.
diff --git a/src/content/docs/sdk/android/features/events.mdx b/src/content/docs/sdk/android/features/events.mdx
index 828b9086d..0dabe4550 100644
--- a/src/content/docs/sdk/android/features/events.mdx
+++ b/src/content/docs/sdk/android/features/events.mdx
@@ -26,7 +26,7 @@ import AddPartnerParameterExample from "@android-examples/ADJEvent/addPartnerPar
You can associate your [Adjust event tokens](https://help.adjust.com/en/article/add-events#add-event) to actions in your app to record them. To record an event:
- Create a new Adjust event instance and pass your event token as a string argument.
-- Call the `trackEvent` method || with your event instance as an argument.
+- Call the `trackEvent` method with your event instance as an argument.
@@ -87,13 +87,11 @@ Parameters:
You can record revenue associated with an event by setting the revenue and currency properties on your event instance. Use this feature to record revenue-generating actions in your app.
-To set these properties, call the `setRevenue` method || and pass the following arguments:
+To set these properties, call the `setRevenue` method and pass the following arguments:
-`revenue` (**number**)
-: The amount of revenue generated by the event
+`revenue` (**number**): The amount of revenue generated by the event
-`currency` (**string**)
-: The [ISO 4217 code](https://www.iban.com/currency-codes) of the event currency.
+`currency` (**string**): The [ISO 4217 code](https://www.iban.com/currency-codes) of the event currency.
@@ -128,11 +126,9 @@ If you've enabled [purchase verification](https://help.adjust.com/en/article/pur
-`productId` (String)
-: The product identifier of the item that was successfully purchased
+`productId` (String): The product identifier of the item that was successfully purchased
-`purchaseToken` (String)
-: The purchase token generated for your successfully completed in-app purchase
+`purchaseToken` (String): The purchase token generated for your successfully completed in-app purchase
@@ -163,13 +159,13 @@ Adjust.trackEvent(adjustEvent);
You can pass an optional identifier to avoid recording duplicate events. The SDK stores the last ten identifiers and skips revenue events with duplicate transaction IDs.
-To set the identifier, call the `setOrderId` method || and pass your transaction ID as a **string** argument.
+To set the identifier, call the `setOrderId` method and pass your transaction ID as a **string** argument.
### Example
-This example shows how to record an event with the token `g3mfiw` whenever a user interacts with a button. The function sets the `orderId` to `5e85484b-1ebc-4141-aab7-25b869e54c49` using the `setOrderId` method || .
+This example shows how to record an event with the token `g3mfiw` whenever a user interacts with a button. The function sets the `orderId` to `5e85484b-1ebc-4141-aab7-25b869e54c49` using the `setOrderId` method.
@@ -189,7 +185,7 @@ If you [register a callback URL](https://help.adjust.com/en/article/set-up-callb
You can configure callback parameters to send to your servers. Once you configure parameters on an event, the SDK appends them to your [callback URL](https://help.adjust.com/en/article/raw-data-exports). You can use this information to analyze your users' in-app behavior with your BI system.
-Add callback parameters to your event by calling the `addCallbackParameter` method || with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
+Add callback parameters to your event by calling the `addCallbackParameter` method with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
@@ -254,7 +250,7 @@ Partner parameters don't appear in raw data by default. You can add the `{partne
-Add partner parameters to your event by calling the `addPartnerParameter` method || with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
+Add partner parameters to your event by calling the `addPartnerParameter` method with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
@@ -283,7 +279,7 @@ Parameters:
You can add a custom string identifier to each event you want to measure. Adjust's servers can report on this identifier in event callbacks. This enables you to keep track of which events have been successfully measured.
-Set up this identifier by calling the `setCallbackId` method || with your ID as a **string** argument.
+Set up this identifier by calling the `setCallbackId` method with your ID as a **string** argument.
diff --git a/src/content/docs/sdk/android/features/session-parameters.mdx b/src/content/docs/sdk/android/features/session-parameters.mdx
index 762f7d44e..45c8f528b 100644
--- a/src/content/docs/sdk/android/features/session-parameters.mdx
+++ b/src/content/docs/sdk/android/features/session-parameters.mdx
@@ -31,15 +31,15 @@ The Adjust SDK merges session callback parameters with event callback parameters
-Add callback parameters to your event by calling the `addSessionCallbackParameter` method || with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
+Add callback parameters to your event by calling the `addSessionCallbackParameter` method with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
-You can remove specific session callback parameters if they're no longer required. To do this, pass the parameter key to the `removeSessionCallbackParameter` method || .
+You can remove specific session callback parameters if they're no longer required. To do this, pass the parameter key to the `removeSessionCallbackParameter` method.
-You can remove all session parameters if they're no longer required. To do this, call the `resetSessionCallbackParameters` method || .
+You can remove all session parameters if they're no longer required. To do this, call the `resetSessionCallbackParameters` method.
@@ -55,15 +55,15 @@ Partner parameters don't appear in raw data by default. You can add the `{partne
-Add partner parameters to your event by calling the `addSessionPartnerParameter` method || with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
+Add partner parameters to your event by calling the `addSessionPartnerParameter` method with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
-You can remove specific session partner parameters if they're no longer required. To do this, pass the parameter key to the `removeSessionPartnerParameter` method || .
+You can remove specific session partner parameters if they're no longer required. To do this, pass the parameter key to the `removeSessionPartnerParameter` method.
-You can remove all session partner parameters if they're no longer required. To do this, call the `resetSessionPartnerParameters` method || .
+You can remove all session partner parameters if they're no longer required. To do this, call the `resetSessionPartnerParameters` method.
@@ -75,10 +75,10 @@ You can delay the startup of the SDK by up to **10 seconds**.
-The Adjust SDK starts as soon as your app opens. If you want to send data that's not available at launch in session parameters, you can delay the start of the SDK. To do this, pass the delay time in seconds to the `setDelayStart` method || on your config object.
+The Adjust SDK starts as soon as your app opens. If you want to send data that's not available at launch in session parameters, you can delay the start of the SDK. To do this, pass the delay time in seconds to the `setDelayStart` method on your config object.
-After this time has elapsed, the SDK sends the information to Adjust's servers. You can send the information before the timeout by calling the `sendFirstPackages` method || .
+After this time has elapsed, the SDK sends the information to Adjust's servers. You can send the information before the timeout by calling the `sendFirstPackages` method.
diff --git a/src/content/docs/sdk/android/features/subscriptions.mdx b/src/content/docs/sdk/android/features/subscriptions.mdx
index c09a63b74..820cfc153 100644
--- a/src/content/docs/sdk/android/features/subscriptions.mdx
+++ b/src/content/docs/sdk/android/features/subscriptions.mdx
@@ -27,7 +27,7 @@ You can record Play Store subscriptions and verify their validity with the Adjus
To get started, you need to create a subscription object containing details of the subscription purchase.
-Create an `AdjustPlayStoreSubscription` object || with the following properties:
+Create an `AdjustPlayStoreSubscription` object with the following properties:
@@ -46,24 +46,24 @@ Create an `AdjustPlayStoreSubscription` object || `setPurchaseTime` method || with a timestamp to record this information.
+You can record the date on which the user purchased a subscription. The SDK returns this data for you to report on. Call the `setPurchaseTime` method with a timestamp to record this information.
### Add callback parameters
-You can add callback parameters to your subscription object. The SDK appends these parameters to your callback URL. To add callback parameters, call the `addCallbackParameter` method || on your subscription object. You can add multiple callback parameters by calling this method multiple times.
+You can add callback parameters to your subscription object. The SDK appends these parameters to your callback URL. To add callback parameters, call the `addCallbackParameter` method on your subscription object. You can add multiple callback parameters by calling this method multiple times.
### Add partner parameters
-You can add partner parameters to your subscription object. The SDK sends these to Adjust's servers when the user purchases a subscription. Adjust's servers forward the information on to your network partner. To add partner parameters, call the `addPartnerParameter` method || on your subscription object. You can add multiple partner parameters by calling this method multiple times.
+You can add partner parameters to your subscription object. The SDK sends these to Adjust's servers when the user purchases a subscription. Adjust's servers forward the information on to your network partner. To add partner parameters, call the `addPartnerParameter` method on your subscription object. You can add multiple partner parameters by calling this method multiple times.
## 2. Send subscription information
-Once you have set up your subscription object, you can send it to Adjust using the Adjust SDK. Pass your completed object to the `trackPlayStoreSubscription` method || to record the user's subscription purchase.
+Once you have set up your subscription object, you can send it to Adjust using the Adjust SDK. Pass your completed object to the `trackPlayStoreSubscription` method to record the user's subscription purchase.
diff --git a/src/content/docs/sdk/android/index.mdx b/src/content/docs/sdk/android/index.mdx
index 74af248f9..e0321a329 100644
--- a/src/content/docs/sdk/android/index.mdx
+++ b/src/content/docs/sdk/android/index.mdx
@@ -38,7 +38,7 @@ dependencies {
## 2. Add Google Play Services
-Apps that target the Google Play Store must use the gps_adid (Google Advertising ID) to identify devices. You need to add the `play-services-ads-identifier` AAR to your project to access the `gps_adid`.
+Apps that target the Google Play Store must use the gps_adid (Google Advertising ID) to identify devices. You need to add the `play-services-ads-identifier` AAR to your project to access the `gps_adid`.
If you're using Maven, add the following to your `build.gradle` file:
@@ -77,7 +77,7 @@ If your app doesn't target the Google Play Store, add the following permission t
```
-The Adjust SDK includes the `com.google.android.gms.AD_ID` permission by default. If you need to make your app COPPA (Children's Online Privacy Protection Act) compliant or if your app doesn't target the Google Play Store, you must remove this permission using a `remove` directive.
+The Adjust SDK includes the `com.google.android.gms.AD_ID` permission by default. If you need to make your app COPPA (Children's Online Privacy Protection Act) compliant or if your app doesn't target the Google Play Store, you must remove this permission using a `remove` directive.
```xml "tools:node="remove""
@@ -146,11 +146,9 @@ The Samsung referrer plugin enables you to record install referrer values for ap
The following information is required to initialize the Adjust SDK:
-`appToken`
-: Your [Adjust app token](https://help.adjust.com/en/article/app-settings#view-your-app-token).
+`appToken`: Your [Adjust app token](https://help.adjust.com/en/article/app-settings#view-your-app-token).
-`environment`
-: The environment your app is running in. Set this to `AdjustConfig.ENVIRONMENT_SANDBOX` to test your app locally.
+`environment`: The environment your app is running in. Set this to `AdjustConfig.ENVIRONMENT_SANDBOX` to test your app locally.
The recommended way to initialize the Adjust SDK is inside a global Android [Application class](http://developer.android.com/reference/android/app/Application.html). If you haven't already set this up for your app, follow these steps:
diff --git a/src/content/docs/sdk/android/plugins/facebook-pixel.mdx b/src/content/docs/sdk/android/plugins/facebook-pixel.mdx
index cdfef98e6..8da155067 100644
--- a/src/content/docs/sdk/android/plugins/facebook-pixel.mdx
+++ b/src/content/docs/sdk/android/plugins/facebook-pixel.mdx
@@ -53,7 +53,7 @@ Follow Facebook's guide on how to integrate the Facebook pixel. The Javascript c
```
-Next, update your Facebook pixel code. You can find the instructions in the [Hybrid Mobile App Events guide](https://developers.facebook.com/docs/app-events/hybrid-app-events) under Update Your Pixel.
+Next, update your Facebook pixel code. You can find the instructions in the [Hybrid Mobile App Events guide](https://developers.facebook.com/docs/app-events/hybrid-app-events) under **Update Your Pixel**.
```js
fbq('init', );
diff --git a/src/content/docs/sdk/android/plugins/imei-plugin.mdx b/src/content/docs/sdk/android/plugins/imei-plugin.mdx
index 08e00da7d..865f17314 100644
--- a/src/content/docs/sdk/android/plugins/imei-plugin.mdx
+++ b/src/content/docs/sdk/android/plugins/imei-plugin.mdx
@@ -11,7 +11,7 @@ This plugin is only meant for apps that aren't targeting the Google Play Store.
-Mobile devices come with an IMEI (International Mobile Equipment Identity) and a MEID (Mobile Equipment Identifier). You can use an Android device's IMEI and MEID for attribution in certain markets. To use this feature, you first need to complete the required steps in your Adjust dashboard. Once you have completed the steps, you can use this plugin.
+Mobile devices come with an IMEI (International Mobile Equipment Identity) and a MEID (Mobile Equipment Identifier). You can use an Android device's IMEI and MEID for attribution in certain markets. To use this feature, you first need to complete the required steps in your Adjust dashboard. Once you have completed the steps, you can use this plugin.
The IMEI plugin provides the IMEI and MEID values of a device. The SDK will continue to use other identifiers as well as the IMEI and MEID.
diff --git a/src/content/docs/sdk/android/plugins/oaid-plugin.mdx b/src/content/docs/sdk/android/plugins/oaid-plugin.mdx
index 24dc3cb2b..2bf022657 100644
--- a/src/content/docs/sdk/android/plugins/oaid-plugin.mdx
+++ b/src/content/docs/sdk/android/plugins/oaid-plugin.mdx
@@ -4,9 +4,9 @@ description: Use the OAID plugin to pass OAID information to Adjust.
slug: en/sdk/android/plugins/oaid-plugin
---
-The OAID (Open Anonymous Device Identifier) is a unique identifier for Android devices. The MSA (Mobile Security Alliance) recommends all Chinese-manufactured devices provide an OAID. You can use the OAID to attribute and track devices where Google Play Services isn't available.
+The OAID (Open Anonymous Device Identifier) is a unique identifier for Android devices. The MSA (Mobile Security Alliance) recommends all Chinese-manufactured devices provide an OAID. You can use the OAID to attribute and track devices where Google Play Services isn't available.
-The OAID plugin provides the OAID of a device. The SDK will continue to use other identifiers as well as the OAID. The OAID is readable on all devices using the MSA SDK or HMS (Huawei Mobile Service) Core SDK on Huawei devices.
+The OAID plugin provides the OAID of a device. The SDK will continue to use other identifiers as well as the OAID. The OAID is readable on all devices using the MSA SDK or HMS (Huawei Mobile Service) Core SDK on Huawei devices.
## Add the OAID plugin to your app
diff --git a/src/content/docs/sdk/android/reference/adjadrevenue.mdx b/src/content/docs/sdk/android/reference/adjadrevenue.mdx
index 049f52ac3..eead262c5 100644
--- a/src/content/docs/sdk/android/reference/adjadrevenue.mdx
+++ b/src/content/docs/sdk/android/reference/adjadrevenue.mdx
@@ -31,8 +31,7 @@ import Constructor from "@android-examples/ADJAdRevenue/constructor.mdx";
-`source` (String)
-: The source of the ad revenue.
+`source` (String): The source of the ad revenue.
@@ -77,11 +76,9 @@ import SetRevenue from "@android-examples/ADJAdRevenue/setRevenue.mdx"
-`revenue` (Double)
-: The amount of currency units associated with the ad
+`revenue` (Double): The amount of currency units associated with the ad
-`currency` (String)
-: The 3 character [ISO 4217 code](https://www.iban.com/currency-codes) of the currency unit
+`currency` (String): The 3 character [ISO 4217 code](https://www.iban.com/currency-codes) of the currency unit
@@ -111,8 +108,7 @@ import SetAdImpressionsCount from "@android-examples/ADJAdRevenue/setAdImpressio
-`adImpressionsCount` (Integer)
-: The number of impressions associated with the ad
+`adImpressionsCount` (Integer): The number of impressions associated with the ad
@@ -142,8 +138,7 @@ import SetAdRevenueNetwork from "@android-examples/ADJAdRevenue/setAdRevenueNetw
-`adRevenueNetwork` (String)
-: The network associated with the ad revenue.
+`adRevenueNetwork` (String): The network associated with the ad revenue.
@@ -173,8 +168,7 @@ import SetAdRevenueUnit from "@android-examples/ADJAdRevenue/setAdRevenueUnit.md
-`adRevenueUnit` (String)
-: The ad unit ID associated with the ad revenue
+`adRevenueUnit` (String): The ad unit ID associated with the ad revenue
@@ -204,8 +198,7 @@ import SetAdRevenuePlacement from "@android-examples/ADJAdRevenue/setAdRevenuePl
-`adRevenuePlacement` (String)
-: The placement of the ad associated with the revenue
+`adRevenuePlacement` (String): The placement of the ad associated with the revenue
@@ -235,11 +228,9 @@ import AddCallbackParameter from "@android-examples/ADJAdRevenue/addCallbackPara
-`key` (String)
-: The data key
+`key` (String): The data key
-`value` (String)
-: The data value
+`value` (String): The data value
@@ -269,11 +260,9 @@ import AddPartnerParameter from "@android-examples/ADJAdRevenue/addPartnerParame
-`key` (String)
-: The data key
+`key` (String): The data key
-`value` (String)
-: The data value
+`value` (String): The data value
diff --git a/src/content/docs/sdk/android/reference/adjattribution.mdx b/src/content/docs/sdk/android/reference/adjattribution.mdx
index 6c1841795..e0baa7a1b 100644
--- a/src/content/docs/sdk/android/reference/adjattribution.mdx
+++ b/src/content/docs/sdk/android/reference/adjattribution.mdx
@@ -12,11 +12,11 @@ The `AdjustAttribution` class contains details about the current attribution sta
## Properties
-The following properties can be accessed by calling the `attribution` method || . Any values that aren't populated for the user are returned as a null value.
+The following properties can be accessed by calling the `attribution` method. Any values that aren't populated for the user are returned as a null value.
-The following values can only be accessed if the `needsCost` property || on your `AdjustConfig` instance is `true`:
+The following values can only be accessed if the `needsCost` property on your `AdjustConfig` instance is `true`:
- `costType`
- `costAmount`
diff --git a/src/content/docs/sdk/android/reference/adjconfig/index.mdx b/src/content/docs/sdk/android/reference/adjconfig/index.mdx
index a1ce9467e..d0dad1a11 100644
--- a/src/content/docs/sdk/android/reference/adjconfig/index.mdx
+++ b/src/content/docs/sdk/android/reference/adjconfig/index.mdx
@@ -36,21 +36,17 @@ import Constructor from "@android-examples/ADJConfig/constructor.mdx"
-`appToken` (String)
-: Your Adjust app token.
+`appToken` (String): Your Adjust app token.
-`environment` (String)
-: The environment your app is running in.
+`environment` (String): The environment your app is running in.
-`allowSuppressLogLevel` (Boolean)
-: Whether to allow all logging to be suppressed.
+`allowSuppressLogLevel` (Boolean): Whether to allow all logging to be suppressed.
-`config` (AdjustConfig)
-: A config object initialized with the provided params.
+`config` (AdjustConfig): A config object initialized with the provided params.
diff --git a/src/content/docs/sdk/android/reference/adjconfig/privacy.mdx b/src/content/docs/sdk/android/reference/adjconfig/privacy.mdx
index c85f8d9aa..791d4f35a 100644
--- a/src/content/docs/sdk/android/reference/adjconfig/privacy.mdx
+++ b/src/content/docs/sdk/android/reference/adjconfig/privacy.mdx
@@ -31,8 +31,7 @@ import SetUrlStrategy from "@android-examples/ADJConfig/setUrlStrategy.mdx";
-`urlStrategy` (String)
-: The data residency target
+`urlStrategy` (String): The data residency target
@@ -56,7 +55,7 @@ import SetUrlStrategy from "@android-examples/ADJConfig/setUrlStrategy.mdx";
## setCoppaCompliantEnabled
-Enable COPPA (Children's Online Privacy Protection Act) compliance in your app.
+Enable COPPA (Children's Online Privacy Protection Act) compliance in your app.
@@ -76,8 +75,7 @@ import SetCoppaCompliantEnabled from "@android-examples/ADJConfig/setCoppaCompli
-`coppaCompliantEnabled` (boolean)
-: Whether the app should be COPPA compliant
+`coppaCompliantEnabled` (boolean): Whether the app should be COPPA compliant
@@ -107,8 +105,7 @@ import SetPlayStoreKidsAppEnabled from "@android-examples/ADJConfig/setPlayStore
-`playStoreKidsAppEnabled` (boolean)
-: Whether the app is a Kids app
+`playStoreKidsAppEnabled` (boolean): Whether the app is a Kids app
diff --git a/src/content/docs/sdk/android/reference/adjconfig/setup.mdx b/src/content/docs/sdk/android/reference/adjconfig/setup.mdx
index 1606b4f10..2389344d2 100644
--- a/src/content/docs/sdk/android/reference/adjconfig/setup.mdx
+++ b/src/content/docs/sdk/android/reference/adjconfig/setup.mdx
@@ -31,8 +31,7 @@ import SetLogLevel from "@android-examples/ADJConfig/setLogLevel.mdx";
-`logLevel` (LogLevel)
-: The level of logging output by the SDK.
+`logLevel` (LogLevel): The level of logging output by the SDK.
@@ -76,8 +75,7 @@ import SetDefaultTracker from "@android-examples/ADJConfig/setDefaultTracker.mdx
-`defaultTracker` (String)
-: The token to which all preinstalled sessions are attributed.
+`defaultTracker` (String): The token to which all preinstalled sessions are attributed.
@@ -113,8 +111,7 @@ import SetDelayStart from "@android-examples/ADJConfig/setDelayStart.mdx"
-`delayStart` (double)
-: The time (in seconds) to delay the start of the SDK by.
+`delayStart` (double): The time (in seconds) to delay the start of the SDK by.
@@ -144,8 +141,7 @@ import SetExternalDeviceId from "@android-examples/ADJConfig/setExternalDeviceId
-`externalDeviceId` (String)
-: The external device ID associated with the device.
+`externalDeviceId` (String): The external device ID associated with the device.
@@ -175,8 +171,7 @@ import SetEventBufferingEnabled from "@android-examples/ADJConfig/setEventBuffer
-`eventBufferingEnabled` (Boolean)
-: Whether event buffering is enabled.
+`eventBufferingEnabled` (Boolean): Whether event buffering is enabled.
@@ -206,8 +201,7 @@ import SetSendInBackground from "@android-examples/ADJConfig/setSendInBackground
-`sendInBackground` (boolean)
-: Whether the SDK should send information to Adjust when the app is running in the background.
+`sendInBackground` (boolean): Whether the SDK should send information to Adjust when the app is running in the background.
@@ -237,8 +231,7 @@ import SetPreinstallTrackingEnabled from "@android-examples/ADJConfig/setPreinst
-`preinstallTrackingEnabled` (boolean)
-: Whether preinstall tracking is enabled.
+`preinstallTrackingEnabled` (boolean): Whether preinstall tracking is enabled.
@@ -268,8 +261,7 @@ import SetPreinstallFilePath from "@android-examples/ADJConfig/setPreinstallFile
-`preinstallFilePath` (String)
-: The path where the preinstall information is written.
+`preinstallFilePath` (String): The path where the preinstall information is written.
@@ -299,8 +291,7 @@ import SetOnAttributionChangedListener from "@android-examples/ADJConfig/setOnAt
-`onAttributionChangedListener` (OnAttributionChangedListener)
-: The delegate function that the SDK calls when a the user's attribution information changes.
+`onAttributionChangedListener` (OnAttributionChangedListener): The delegate function that the SDK calls when a the user's attribution information changes.
@@ -336,8 +327,7 @@ import SetNeedsCost from "@android-examples/ADJConfig/setNeedsCost.mdx"
-`needsCost` (boolean)
-: Whether the SDK should gather cost data
+`needsCost` (boolean): Whether the SDK should gather cost data
@@ -367,8 +357,7 @@ import SetOnSessionTrackingSucceededListener from "@android-examples/ADJConfig/s
-`onSessionTrackingSucceededListener` (OnSessionTrackingSucceededListener)
-: The function to launch when the SDK successfully records a session
+`onSessionTrackingSucceededListener` (OnSessionTrackingSucceededListener): The function to launch when the SDK successfully records a session
@@ -398,8 +387,7 @@ import SetOnSessionTrackingFailedListener from "@android-examples/ADJConfig/setO
-`onSessionTrackingFailedListener` (OnSessionTrackingFailedListener)
-: The function to launch when the SDK fails to record a session
+`onSessionTrackingFailedListener` (OnSessionTrackingFailedListener): The function to launch when the SDK fails to record a session
@@ -429,8 +417,7 @@ import SetOnEventTrackingSucceededListener from "@android-examples/ADJConfig/set
-`onEventTrackingSucceededListener` (OnEventTrackingSucceededListener)
-: The function to launch when the SDK successfully records an event
+`onEventTrackingSucceededListener` (OnEventTrackingSucceededListener): The function to launch when the SDK successfully records an event
@@ -460,8 +447,7 @@ import SetOnEventTrackingFailedListener from "@android-examples/ADJConfig/setOnE
-`onEventTrackingFailedListener` (OnEventTrackingFailedListener)
-: The function to launch when the SDK fails to record an event
+`onEventTrackingFailedListener` (OnEventTrackingFailedListener): The function to launch when the SDK fails to record an event
@@ -491,8 +477,7 @@ import SetOnDeeplinkResponseListener from "@android-examples/ADJConfig/setOnDeep
-`onDeeplinkResponseListener` (OnDeeplinkResponseListener)
-: The function to launch when the SDK receives a deferred deep link
+`onDeeplinkResponseListener` (OnDeeplinkResponseListener): The function to launch when the SDK receives a deferred deep link
diff --git a/src/content/docs/sdk/android/reference/adjevent.mdx b/src/content/docs/sdk/android/reference/adjevent.mdx
index a9998d8fd..d7e85cb04 100644
--- a/src/content/docs/sdk/android/reference/adjevent.mdx
+++ b/src/content/docs/sdk/android/reference/adjevent.mdx
@@ -7,7 +7,7 @@ slug: en/sdk/android/reference/adjevent
import TrackEvent from "@android-signatures/Adjust/trackEvent.mdx"
-This class contains information about events triggered in your application. You can send this information to Adjust's servers by passing an `AdjustEvent` object to the `trackEvent` method || .
+This class contains information about events triggered in your application. You can send this information to Adjust's servers by passing an `AdjustEvent` object to the `trackEvent` method.
@@ -33,8 +33,7 @@ import Constructor from "@android-examples/ADJEvent/constructor.mdx"
-`eventToken` (String)
-: A six-character Adjust event token.
+`eventToken` (String): A six-character Adjust event token.
@@ -64,11 +63,9 @@ import SetRevenue from "@android-examples/ADJEvent/setRevenue.mdx"
-`amount` (double)
-: The amount of currency units associated with the event.
+`amount` (double): The amount of currency units associated with the event.
-`currency` (String)
-: The 3 character [ISO 4217 code](https://www.iban.com/currency-codes) of the currency unit.
+`currency` (String): The 3 character [ISO 4217 code](https://www.iban.com/currency-codes) of the currency unit.
@@ -98,8 +95,7 @@ import SetCallbackId from "@android-examples/ADJEvent/setCallbackId.mdx"
-`callbackId` (String)
-: A custom identifier for your event object
+`callbackId` (String): A custom identifier for your event object
@@ -131,11 +127,9 @@ import AddCallbackParameter from "@android-examples/ADJEvent/addCallbackParamete
-`key` (String)
-: The data key
+`key` (String): The data key
-`value` (String)
-: The data value
+`value` (String): The data value
@@ -165,11 +159,9 @@ import AddPartnerParameter from "@android-examples/ADJEvent/addPartnerParameter.
-`key` (String)
-: The data key
+`key` (String): The data key
-`value` (String)
-: The data value
+`value` (String): The data value
@@ -199,8 +191,7 @@ import SetOrderId from "@android-examples/ADJEvent/setOrderId.mdx"
-`orderId` (String)
-: A unique identifier used to deduplicate events
+`orderId` (String): A unique identifier used to deduplicate events
diff --git a/src/content/docs/sdk/android/reference/adjplaystoresubscription.mdx b/src/content/docs/sdk/android/reference/adjplaystoresubscription.mdx
index c8c4d9a35..d902bd93c 100644
--- a/src/content/docs/sdk/android/reference/adjplaystoresubscription.mdx
+++ b/src/content/docs/sdk/android/reference/adjplaystoresubscription.mdx
@@ -7,7 +7,7 @@ slug: en/sdk/android/reference/adjplaystoresubscription
import TrackPlayStoreSubscription from "@android-signatures/Adjust/trackPlayStoreSubscription.mdx"
-Use this class to store Play Store subscription information. You can pass this to Adjust's servers using the `trackPlayStoreSubscription` method || .
+Use this class to store Play Store subscription information. You can pass this to Adjust's servers using the `trackPlayStoreSubscription` method.
@@ -33,23 +33,17 @@ import Constructor from "@android-examples/ADJPlayStoreSubscription/constructor.
-`price` (long)
-: The price of the subscription
+`price` (long): The price of the subscription
-`currency` (String)
-: The 3 character [ISO 4217 code](https://www.iban.com/currency-codes) of the currency unit.
+`currency` (String): The 3 character [ISO 4217 code](https://www.iban.com/currency-codes) of the currency unit.
-`sku` (String)
-: The ID of the product
+`sku` (String): The ID of the product
-`orderId` (String)
-: The ID of the transaction
+`orderId` (String): The ID of the transaction
-`signature` (String)
-: The signature of the purchase data
+`signature` (String): The signature of the purchase data
-`purchaseToken` (String)
-: The unique token of the transaction. See [Google's documentation](https://developer.android.com/reference/com/android/billingclient/api/Purchase#getPurchaseToken()) for more information
+`purchaseToken` (String): The unique token of the transaction. See [Google's documentation](https://developer.android.com/reference/com/android/billingclient/api/Purchase#getPurchaseToken()) for more information
:type purchaseToken: String
@@ -80,8 +74,7 @@ import SetPurchaseTime from "@android-examples/ADJPlayStoreSubscription/setPurch
-`purchaseTime` (long)
-: The date on which the subscription was purchased.
+`purchaseTime` (long): The date on which the subscription was purchased.
@@ -111,11 +104,9 @@ import AddCallbackParameter from "@android-examples/ADJPlayStoreSubscription/add
-`key` (String)
-: The data key
+`key` (String): The data key
-`value` (String)
-: The data value
+`value` (String): The data value
@@ -145,11 +136,9 @@ import AddPartnerParameter from "@android-examples/ADJPlayStoreSubscription/addP
-`key` (String)
-: The data key
+`key` (String): The data key
-`value` (String)
-: The data value
+`value` (String): The data value
diff --git a/src/content/docs/sdk/android/reference/adjthirdpartysharing.mdx b/src/content/docs/sdk/android/reference/adjthirdpartysharing.mdx
index 9b1483311..58ffc5c9e 100644
--- a/src/content/docs/sdk/android/reference/adjthirdpartysharing.mdx
+++ b/src/content/docs/sdk/android/reference/adjthirdpartysharing.mdx
@@ -7,7 +7,7 @@ slug: en/sdk/android/reference/adjthirdpartysharing
import TrackThirdPartySharing from "@android-signatures/Adjust/trackThirdPartySharing.mdx"
-Use this class to communicate a user's third party sharing preferences. Send this information to Adjust's servers using the `trackThirdPartySharing` method || .
+Use this class to communicate a user's third party sharing preferences. Send this information to Adjust's servers using the `trackThirdPartySharing` method.
@@ -41,8 +41,7 @@ import AdjustThirdPartySharingFalse from "@android-examples/ADJThirdPartySharing
-`isEnabled` (Boolean)
-: A nullable boolean value
+`isEnabled` (Boolean): A nullable boolean value
@@ -74,22 +73,13 @@ import Facebook from "@android-examples/ADJThirdPartySharing/addGranularOptionFa
-
-
-- - Parameter
- - Description
-- - `partner_name`
- - Use `facebook` to toggle LDU
-- - `data_processing_options_country`
- - The user is located in:
- - `0`: Request that Facebook use geolocation
- - `1`: United States of America
-- - `data_processing_options_state`
- - Notifies Facebook which state the user is located in:
- - `0`: Request that Facebook use geolocation
- - `1000`: California
- - `1001`: Colorado
- - `1002`: Connecticut
+
+
+| Parameter | Description |
+| --------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
+| `partner_name` | Use `facebook` to toggle LDU. |
+| `data_processing_options_country` | The country in which the user is located.- `0`: Request that Facebook use geolocation.
- `1`: United States of America.
|
+| `data_processing_options_state` | Notifies Facebook in which state the user is located.- `0`: Request that Facebook use geolocation.
- `1000`: California.
|
@@ -97,14 +87,11 @@ import Facebook from "@android-examples/ADJThirdPartySharing/addGranularOptionFa
-`partnerName` (String)
-: The name of the partner you want to share information with
+`partnerName` (String): The name of the partner you want to share information with
-`key` (String)
-: The data key
+`key` (String): The data key
-`value` (String)
-: The data value
+`value` (String): The data value
@@ -134,12 +121,9 @@ import AddPartnerSharingSetting from "@android-examples/ADJThirdPartySharing/add
-`partnerName` (String)
-: The name of the partner whose settings you want to update. See the table of available partners below
-`key` (String)
-: The setting you want to update
-`value` (boolean)
-: Whether the setting is enabled
+`partnerName` (String): The name of the partner whose settings you want to update. See the table of available partners below
+`key` (String): The setting you want to update
+`value` (boolean): Whether the setting is enabled
diff --git a/src/content/docs/sdk/android/reference/adjust/config.mdx b/src/content/docs/sdk/android/reference/adjust/config.mdx
index 58ae70e91..e8dfb47e3 100644
--- a/src/content/docs/sdk/android/reference/adjust/config.mdx
+++ b/src/content/docs/sdk/android/reference/adjust/config.mdx
@@ -31,8 +31,7 @@ import SetEnabled from "@android-examples/Adjust/setEnabled.mdx"
-`enabled` (boolean)
-: Whether the SDK is enabled
+`enabled` (boolean): Whether the SDK is enabled
@@ -62,8 +61,7 @@ import IsEnabled from "@android-examples/Adjust/isEnabled.mdx"
-`enabled` (boolean)
-: Whether the SDK is enabled
+`enabled` (boolean): Whether the SDK is enabled
@@ -93,8 +91,7 @@ import SetOfflineMode from "@android-examples/Adjust/setOfflineMode.mdx"
-`enabled` (boolean)
-: Whether the SDK is in offline mode
+`enabled` (boolean): Whether the SDK is in offline mode
@@ -124,11 +121,9 @@ import SetPushToken from "@android-examples/Adjust/setPushToken.mdx"
-`pushToken` (String)
-: Your push token
+`pushToken` (String): Your push token
-`context` (Context)
-: The [context](https://developer.android.com/reference/android/content/Context) the method is being called in
+`context` (Context): The [context](https://developer.android.com/reference/android/content/Context) the method is being called in
@@ -189,11 +184,9 @@ import AppWillOpenUrl from "@android-examples/Adjust/appWillOpenUrl.mdx"
-`url` (Uri)
-: The URL to extract deep link information
+`url` (Uri): The URL to extract deep link information
-`context` (Context)
-: The [context](https://developer.android.com/reference/android/content/Context) the method is being called in
+`context` (Context): The [context](https://developer.android.com/reference/android/content/Context) the method is being called in
diff --git a/src/content/docs/sdk/android/reference/adjust/device-info.mdx b/src/content/docs/sdk/android/reference/adjust/device-info.mdx
index 4e4d67d3f..a7d0b6d9d 100644
--- a/src/content/docs/sdk/android/reference/adjust/device-info.mdx
+++ b/src/content/docs/sdk/android/reference/adjust/device-info.mdx
@@ -17,7 +17,7 @@ The ADID is available only after the install has been recorded.
-Returns the ADID (Adjust Device ID) associated with the device.
+Returns the ADID (Adjust Device ID) associated with the device.
@@ -37,8 +37,7 @@ import Adid from "@android-examples/Adjust/adid.mdx"
-`adid` (String)
-: The Adjust identifier associated with the device
+`adid` (String): The Adjust identifier associated with the device
@@ -48,7 +47,7 @@ import Adid from "@android-examples/Adjust/adid.mdx"
## getAmazonAdId
-Returns the Amazon Ad ID (Amazon Advertising ID) associated with the device.
+Returns the Amazon Ad ID (Amazon Advertising ID) associated with the device.
@@ -68,15 +67,13 @@ import GetAmazonAdId from "@android-examples/Adjust/getAmazonAdId.mdx"
-`context` (Context)
-: The [context](https://developer.android.com/reference/android/content/Context) the method is being called in.
+`context` (Context): The [context](https://developer.android.com/reference/android/content/Context) the method is being called in.
-`amazonAdId` (String)
-: The device Amazon Ad ID
+`amazonAdId` (String): The device Amazon Ad ID
@@ -86,7 +83,7 @@ import GetAmazonAdId from "@android-examples/Adjust/getAmazonAdId.mdx"
## getGoogleAdId
-Returns the GPS ADID (Google Play Services Advertising ID) associated with the device. Must be called in a background thread.
+Returns the GPS ADID (Google Play Services Advertising ID) associated with the device. Must be called in a background thread.
@@ -106,11 +103,9 @@ import GetGoogleAdId from "@android-examples/Adjust/getGoogleAdId.mdx"
-`context` (Context)
-: The [context](https://developer.android.com/reference/android/content/Context) the method is being called in.
+`context` (Context): The [context](https://developer.android.com/reference/android/content/Context) the method is being called in.
-`onDeviceIdsRead` (OnDeviceIdsRead)
-: The function called when the SDK receives the ID from the device
+`onDeviceIdsRead` (OnDeviceIdsRead): The function called when the SDK receives the ID from the device
diff --git a/src/content/docs/sdk/android/reference/adjust/privacy.mdx b/src/content/docs/sdk/android/reference/adjust/privacy.mdx
index 08f5fbbd1..fe92f37fe 100644
--- a/src/content/docs/sdk/android/reference/adjust/privacy.mdx
+++ b/src/content/docs/sdk/android/reference/adjust/privacy.mdx
@@ -31,8 +31,7 @@ import DisableThirdPartySharing from "@android-examples/Adjust/disableThirdParty
-`context` (Context)
-: An optional parameter to pass the app context. Defaults to the extracted app context.
+`context` (Context): An optional parameter to pass the app context. Defaults to the extracted app context.
@@ -62,8 +61,7 @@ import TrackThirdPartySharing from "@android-examples/Adjust/trackThirdPartyShar
-`adjustThirdPartySharing` (AdjustThirdPartySharing)
-: The third party sharing object
+`adjustThirdPartySharing` (AdjustThirdPartySharing): The third party sharing object
@@ -93,8 +91,7 @@ import TrackMeasurementConsent from "@android-examples/Adjust/trackMeasurementCo
-`consentMeasurement` (boolean)
-: Whether data collection and retention rules apply for the user
+`consentMeasurement` (boolean): Whether data collection and retention rules apply for the user
@@ -104,7 +101,7 @@ import TrackMeasurementConsent from "@android-examples/Adjust/trackMeasurementCo
## gdprForgetMe
-Send an RTBF (Right To Be Forgotten) request to Adjust's servers. This erases all information about the user the source app. The SDK stops sending requests for the user.
+Send an RTBF (Right To Be Forgotten) request to Adjust's servers. This erases all information about the user the source app. The SDK stops sending requests for the user.
@@ -124,8 +121,7 @@ import GdprForgetMe from "@android-examples/Adjust/gdprForgetMe.mdx"
-`context` (Context)
-: An optional parameter to pass the app context. Defaults to the extracted app context.
+`context` (Context): An optional parameter to pass the app context. Defaults to the extracted app context.
diff --git a/src/content/docs/sdk/android/reference/adjust/recording.mdx b/src/content/docs/sdk/android/reference/adjust/recording.mdx
index 6f26f446b..435ec63f2 100644
--- a/src/content/docs/sdk/android/reference/adjust/recording.mdx
+++ b/src/content/docs/sdk/android/reference/adjust/recording.mdx
@@ -31,8 +31,7 @@ import TrackEvent from "@android-examples/Adjust/trackEvent.mdx"
-`event` (AdjustEvent)
-: An event object containing the information you want to send to Adjust
+`event` (AdjustEvent): An event object containing the information you want to send to Adjust
@@ -62,11 +61,9 @@ import AddSessionCallbackParameter from "@android-examples/Adjust/addSessionCall
-`key` (String)
-: The data key
+`key` (String): The data key
-`value` (String)
-: The data value
+`value` (String): The data value
@@ -96,8 +93,7 @@ import RemoveSessionCallbackParameter from "@android-examples/Adjust/removeSessi
-`key` (String)
-: The data key of the parameter you want to remove
+`key` (String): The data key of the parameter you want to remove
@@ -151,11 +147,9 @@ import AddSessionPartnerParameter from "@android-examples/Adjust/addSessionPartn
-`key` (String)
-: The data key
+`key` (String): The data key
-`value` (String)
-: The data value
+`value` (String): The data value
@@ -185,8 +179,7 @@ import RemoveSessionPartnerParameter from "@android-examples/Adjust/removeSessio
-`key` (String)
-: The data key of the parameter you want to remove
+`key` (String): The data key of the parameter you want to remove
@@ -240,8 +233,7 @@ import TrackAdRevenue from "@android-examples/Adjust/trackAdRevenue.mdx"
-`adRevenue` (AdjustAdRevenue)
-: The ad revenue object containing the revenue details
+`adRevenue` (AdjustAdRevenue): The ad revenue object containing the revenue details
@@ -271,8 +263,7 @@ import TrackPlayStoreSubscription from "@android-examples/Adjust/trackPlayStoreS
-`subscription` (AdjustPlayStoreSubscription)
-: The subscription object containing the purchase details
+`subscription` (AdjustPlayStoreSubscription): The subscription object containing the purchase details
@@ -302,8 +293,7 @@ import Attribution from "@android-examples/Adjust/attribution.mdx"
-`attribution` (AdjustAttribution)
-: An attribution object containing attribution data associated with the device
+`attribution` (AdjustAttribution): An attribution object containing attribution data associated with the device
diff --git a/src/content/docs/sdk/flutter/configuration/att.mdx b/src/content/docs/sdk/flutter/configuration/att.mdx
index f3eae6ea1..ab73f78a1 100644
--- a/src/content/docs/sdk/flutter/configuration/att.mdx
+++ b/src/content/docs/sdk/flutter/configuration/att.mdx
@@ -4,7 +4,7 @@ description: Configure your app to use Apple's App Tracking Transparency framewo
slug: en/sdk/flutter/configuration/att
---
-If you want to record the device's IDFA (ID for Advertisers), you must display a prompt to get your user's authorization. To do this, you need to include Apple's ATT (App Tracking Transparency) framework in your app. The Adjust SDK stores the user's authorization status and sends it to Adjust's servers with each request.
+If you want to record the device's IDFA (ID for Advertisers), you must display a prompt to get your user's authorization. To do this, you need to include Apple's ATT (App Tracking Transparency) framework in your app. The Adjust SDK stores the user's authorization status and sends it to Adjust's servers with each request.
## Authorization statuses
@@ -21,7 +21,7 @@ If you want to record the device's IDFA (ID for Advertisers), you m
-You might receive a status code of `-1` if the SDK is unable to retrieve the ATT (App Tracking Transparency) status.
+You might receive a status code of `-1` if the SDK is unable to retrieve the ATT (App Tracking Transparency) status.
@@ -89,7 +89,7 @@ Adjust.requestTrackingAuthorizationWithCompletionHandler().then((status) {
import GetAppTrackingAuthorizationStatusSig from "@flutter-signatures/Adjust/getAppTrackingAuthorizationStatus.mdx"
-You can retrieve a user's current authorization status at any time. Call the `getAppTrackingAuthorizationStatus` method || to return the authorization status code as an **integer**.
+You can retrieve a user's current authorization status at any time. Call the `getAppTrackingAuthorizationStatus` method to return the authorization status code as an **integer**.
import GetAppTrackingAuthorizationStatus from "@flutter-examples/Adjust/getAppTrackingAuthorizationStatus.mdx"
@@ -108,7 +108,7 @@ Adjust.addSessionPartnerParameter("status", authorizationStatus);
import CheckForNewAttStatusSig from "@flutter-signatures/Adjust/checkForNewAttStatus.mdx"
-If you use a custom ATT prompt, you need to inform the Adjust SDK of changes to the user's authorization status. Call the `checkForNewAttStatus` method || to send the authorization status to Adjust's servers.
+If you use a custom ATT prompt, you need to inform the Adjust SDK of changes to the user's authorization status. Call the `checkForNewAttStatus` method to send the authorization status to Adjust's servers.
import CheckForNewAttStatus from "@flutter-examples/Adjust/checkForNewAttStatus.mdx"
diff --git a/src/content/docs/sdk/flutter/configuration/background.mdx b/src/content/docs/sdk/flutter/configuration/background.mdx
index d42925a50..3c4a4f0af 100644
--- a/src/content/docs/sdk/flutter/configuration/background.mdx
+++ b/src/content/docs/sdk/flutter/configuration/background.mdx
@@ -8,7 +8,7 @@ By default, the Adjust SDK pauses the sending of requests when your app is runni
import SetSendInBackgroundSig from "@flutter-signatures/AdjustConfig/sendInBackground.mdx"
-Your config object contains a boolean `sendInBackground` property || that controls this behavior. When set to `true`, the SDK sends data to Adjust while the app is running in the background.
+Your config object contains a boolean `sendInBackground` property that controls this behavior. When set to `true`, the SDK sends data to Adjust while the app is running in the background.
diff --git a/src/content/docs/sdk/flutter/configuration/deep-links.mdx b/src/content/docs/sdk/flutter/configuration/deep-links.mdx
index 8770947d0..8b9e7eddb 100644
--- a/src/content/docs/sdk/flutter/configuration/deep-links.mdx
+++ b/src/content/docs/sdk/flutter/configuration/deep-links.mdx
@@ -5,15 +5,13 @@ category-title: Deep linking
slug: en/sdk/flutter/configuration/deep-links
---
-Deep links are URIs (Uniform Resource Identifiers) that direct users to a specific page in your app without any additional navigation. You can use them throughout your marketing funnel to improve user acquisition, engagement, and retention.
+Deep links are URIs (Uniform Resource Identifiers) that direct users to a specific page in your app without any additional navigation. You can use them throughout your marketing funnel to improve user acquisition, engagement, and retention.
The Adjust SDK uses different logic depending on whether the user already has your app installed on their device:
-Direct deep linking
-: Occurs if the user already has your app installed. The link takes the user to the page specified in the link
+Direct deep linking: Occurs if the user already has your app installed. The link takes the user to the page specified in the link
-Deferred deep linking
-: Occurs if the user doesn't have your app installed. The link takes the user to a storefront to install your app first. After the user installs the app, it opens to the page specified in the link.
+Deferred deep linking: Occurs if the user doesn't have your app installed. The link takes the user to a storefront to install your app first. After the user installs the app, it opens to the page specified in the link.
To get started, follow these steps.
@@ -176,7 +174,7 @@ public class MainActivity extends FlutterActivity {
import LaunchDeferredDeeplinkSig from "@flutter-signatures/AdjustConfig/launchDeferredDeeplink.mdx"
-The SDK opens deferred deep links by default. You can configure this by setting the `launchDeferredDeeplink` property || on your config instance to **true**.
+The SDK opens deferred deep links by default. You can configure this by setting the `launchDeferredDeeplink` property on your config instance to **true**.
import LaunchDeferredDeeplink from "@flutter-examples/AdjustConfig/launchDeferredDeeplink.mdx"
@@ -186,7 +184,7 @@ import LaunchDeferredDeeplink from "@flutter-examples/AdjustConfig/launchDeferre
import DeferredDeeplinkCallbackSig from "@flutter-signatures/AdjustConfig/deferredDeeplinkCallback.mdx"
-You can configure the Adjust SDK to call a function when it receives a deferred deep link by adding a function to the `deferredDeeplinkCallback` property || on your config instance. This function receives the deep link as a **string** argument.
+You can configure the Adjust SDK to call a function when it receives a deferred deep link by adding a function to the `deferredDeeplinkCallback` property on your config instance. This function receives the deep link as a **string** argument.
import DeferredDeeplinkCallback from "@flutter-examples/AdjustConfig/deferredDeeplinkCallback.mdx"
@@ -227,7 +225,7 @@ When a user clicks on a LinkMe URL they have the option to copy the link informa
import LinkMeEnabledSig from "@flutter-signatures/AdjustConfig/linkMeEnabled.mdx";
-To enable pasteboard checking in your app, set the `linkMeEnabled` property || to `true` on your config object:
+To enable pasteboard checking in your app, set the `linkMeEnabled` property to `true` on your config object:
import LinkMeEnabled from "@flutter-examples/AdjustConfig/linkMeEnabled.mdx";
diff --git a/src/content/docs/sdk/flutter/configuration/delay.mdx b/src/content/docs/sdk/flutter/configuration/delay.mdx
index 06ea8dc97..4f729604c 100644
--- a/src/content/docs/sdk/flutter/configuration/delay.mdx
+++ b/src/content/docs/sdk/flutter/configuration/delay.mdx
@@ -14,7 +14,7 @@ The Adjust SDK sends event and session data to Adjust's servers in real time. Yo
import SetOfflineModeSig from "@flutter-signatures/Adjust/setOfflineMode.mdx"
-Your config object contains a boolean `isOffline` property that controls this behavior. You can update this property at any time by calling the `setOfflineMode` method || with a boolean argument. The SDK sends all saved information to Adjust's servers when you deactivate offline mode.
+Your config object contains a boolean `isOffline` property that controls this behavior. You can update this property at any time by calling the `setOfflineMode` method with a boolean argument. The SDK sends all saved information to Adjust's servers when you deactivate offline mode.
import SetOfflineMode from "@flutter-examples/Adjust/setOfflineMode.mdx"
@@ -26,7 +26,7 @@ The Adjust SDK sends event information as soon as a user triggers an event in yo
import EventBufferingEnabledSig from "@flutter-signatures/AdjustConfig/eventBufferingEnabled.mdx"
-Your config object contains a boolean `eventBufferingEnabled` property || that controls this behavior. Set this property to `true` to enable event buffering.
+Your config object contains a boolean `eventBufferingEnabled` property that controls this behavior. Set this property to `true` to enable event buffering.
import EventBufferingEnabled from "@flutter-examples/AdjustConfig/eventBufferingEnabled.mdx"
diff --git a/src/content/docs/sdk/flutter/configuration/disable.mdx b/src/content/docs/sdk/flutter/configuration/disable.mdx
index dd256d5a9..277ffed96 100644
--- a/src/content/docs/sdk/flutter/configuration/disable.mdx
+++ b/src/content/docs/sdk/flutter/configuration/disable.mdx
@@ -8,7 +8,7 @@ The Adjust SDK runs by default when your app is open. You can disable and re-ena
import SetEnabledSig from "@flutter-signatures/Adjust/setEnabled.mdx"
-You can enable or disable the SDK at any time by calling the `setEnabled` method || with a boolean argument.
+You can enable or disable the SDK at any time by calling the `setEnabled` method with a boolean argument.
@@ -24,7 +24,7 @@ import SetEnabled from "@flutter-examples/Adjust/setEnabled.mdx"
import IsEnabledSig from "@flutter-signatures/Adjust/isEnabled.mdx"
-You can check if the Adjust SDK is enabled at any time by calling the `isEnabled` method || . This method returns a boolean value.
+You can check if the Adjust SDK is enabled at any time by calling the `isEnabled` method. This method returns a boolean value.
import IsEnabled from "@flutter-examples/Adjust/isEnabled.mdx"
diff --git a/src/content/docs/sdk/flutter/configuration/external-device-id.mdx b/src/content/docs/sdk/flutter/configuration/external-device-id.mdx
index 66d1afe72..723bfb77b 100644
--- a/src/content/docs/sdk/flutter/configuration/external-device-id.mdx
+++ b/src/content/docs/sdk/flutter/configuration/external-device-id.mdx
@@ -16,7 +16,7 @@ See the [External device identifiers article](https://help.adjust.com/en/article
import ExternalDeviceIdSig from "@flutter-signatures/AdjustConfig/externalDeviceId.mdx";
-Your config object contains a **string** `externalDeviceId` property || that you can use to store your external device ID.
+Your config object contains a **string** `externalDeviceId` property that you can use to store your external device ID.
diff --git a/src/content/docs/sdk/flutter/configuration/preinstalled.mdx b/src/content/docs/sdk/flutter/configuration/preinstalled.mdx
index e511e1e8e..ea0ce365e 100644
--- a/src/content/docs/sdk/flutter/configuration/preinstalled.mdx
+++ b/src/content/docs/sdk/flutter/configuration/preinstalled.mdx
@@ -13,7 +13,7 @@ You can use the Adjust SDK to record activity from apps that came preinstalled o
## Enable preinstall recording
-Your config object contains a **boolean** `preinstallTrackingEnabled` property || that controls this feature. Set it to `true` to enable preinstall recording.
+Your config object contains a **boolean** `preinstallTrackingEnabled` property that controls this feature. Set it to `true` to enable preinstall recording.
@@ -27,7 +27,7 @@ Configuring a default campaign enables you to attribute all preinstalls to a pre
https://app.adjust.com/{token}
```
-2. Copy this token and assign it to the `defaultTracker` property || in your app delegate file.
+2. Copy this token and assign it to the `defaultTracker` property in your app delegate file.
diff --git a/src/content/docs/sdk/flutter/configuration/privacy.mdx b/src/content/docs/sdk/flutter/configuration/privacy.mdx
index fa55e04c8..01ac8b03e 100644
--- a/src/content/docs/sdk/flutter/configuration/privacy.mdx
+++ b/src/content/docs/sdk/flutter/configuration/privacy.mdx
@@ -10,11 +10,11 @@ The Adjust SDK contains features that you can use to handle user privacy in your
import GdprForgetMeSig from "@flutter-signatures/Adjust/gdprForgetMe.mdx";
-Article 17 of the European Union's GDPR (General Data Protection Regulation) grants users the right to be forgotten. When Adjust's servers receive an RTBF (Right to be Forgotten) request, Adjust erases the user's data. The SDK also stops sending requests from the device for the app in question.
+Article 17 of the European Union's GDPR (General Data Protection Regulation) grants users the right to be forgotten. When Adjust's servers receive an RTBF (Right to be Forgotten) request, Adjust erases the user's data. The SDK also stops sending requests from the device for the app in question.
import GdprForgetMe from "@flutter-examples/Adjust/gdprForgetMe.mdx";
-You can send the user's RTBF request to Adjust by calling the `gdprForgetMe` method || .
+You can send the user's RTBF request to Adjust by calling the `gdprForgetMe` method.
@@ -26,7 +26,7 @@ You can use the Adjust SDK to record when a user changes their third-party shari
import TrackThirdPartySharing from "@flutter-signatures/Adjust/trackThirdPartySharing.mdx";
-Some users may want to opt-out of sharing their data with third-parties. To communicate this to Adjust, call the `trackThirdPartySharing` method || with an [`ADJThirdPartySharing` object](/en/sdk/ios/reference/adjthirdpartysharing) initialized with a `false` value. When Adjust's servers receive this information, Adjust stops sharing the user's data with third-parties. The Adjust SDK continues to work as expected.
+Some users may want to opt-out of sharing their data with third-parties. To communicate this to Adjust, call the `trackThirdPartySharing` method with an [`ADJThirdPartySharing` object](/en/sdk/ios/reference/adjthirdpartysharing) initialized with a `false` value. When Adjust's servers receive this information, Adjust stops sharing the user's data with third-parties. The Adjust SDK continues to work as expected.
import ConstructorTrue from "@flutter-examples/AdjustThirdPartySharing/constructor_true.mdx";
@@ -44,7 +44,7 @@ import ConstructorFalse from "@flutter-examples/AdjustThirdPartySharing/construc
import AddGranularOptionSig from "@flutter-signatures/AdjustThirdPartySharing/addGranularOption.mdx";
-You can attach granular information when a user updates their third-party sharing preferences. Use this information to communicate more detail about a user's decision. To do this, call the `addGranularOption` method || with your partner name and your options.
+You can attach granular information when a user updates their third-party sharing preferences. Use this information to communicate more detail about a user's decision. To do this, call the `addGranularOption` method with your partner name and your options.
import AddGranularOption from "@flutter-examples/AdjustThirdPartySharing/addGranularOption.mdx";
@@ -54,7 +54,7 @@ import AddGranularOption from "@flutter-examples/AdjustThirdPartySharing/addGran
import AddPartnerSharingSettingSig from "@flutter-signatures/AdjustThirdPartySharing/addPartnerSharingSetting.mdx";
-You can use the Adjust SDK to update your third party sharing settings on a per-partner basis. To do this, call the `addPartnerSharingSetting` method || with your partner name and your options.
+You can use the Adjust SDK to update your third party sharing settings on a per-partner basis. To do this, call the `addPartnerSharingSetting` method with your partner name and your options.
import AddPartnerSharingSetting from "@flutter-examples/AdjustThirdPartySharing/addPartnerSharingSetting.mdx";
@@ -85,28 +85,21 @@ The Adjust SDK sends information to Facebook as soon as the app is installed. Yo
-Facebook provides a feature called LDU (Limited Data Use) to comply with the CCPA (California Consumer Privacy Act). This feature enables you to notify Facebook when a California-based user is opted out of the sale of data. You can also use it if you want to opt all users out by default.
+Facebook provides a feature called LDU (Limited Data Use) to comply with the CCPA (California Consumer Privacy Act). This feature enables you to notify Facebook when a California-based user is opted out of the sale of data. You can also use it if you want to opt all users out by default.
-You can update the Facebook LDU status by passing arguments to the `addGranularOption` method || .
+You can update the Facebook LDU status by passing arguments to the `addGranularOption` method.
import AddGranularOptionFacebook from "@flutter-examples/AdjustThirdPartySharing/addGranularOptionFacebook.mdx";
-
-
-- - Parameter
- - Description
-- - `partner_name`
- - Use `facebook` to toggle LDU.
-- - `data_processing_options_country`
- - The country the user is located in.
- - `0`: Request that Facebook use geolocation.
- - `1`: United States of America.
-- - `data_processing_options_state`
- - Notifies Facebook which state the user is located in.
- - `0`: Request that Facebook use geolocation.
- - `1000`: California.
+
+
+| Parameter | Description |
+| --------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
+| `partner_name` | Use `facebook` to toggle LDU. |
+| `data_processing_options_country` | The country in which the user is located.- `0`: Request that Facebook use geolocation.
- `1`: United States of America.
|
+| `data_processing_options_state` | Notifies Facebook in which state the user is located.- `0`: Request that Facebook use geolocation.
- `1000`: California.
|
@@ -152,7 +145,7 @@ Adjust.trackThirdPartySharing(adjustThirdPartySharing);
import DisableThirdPartySharingSig from "@flutter-signatures/Adjust/disableThirdPartySharing.mdx";
-To disable third-party sharing for all users, call the `disableThirdPartySharing` method || . When Adjust's servers receive this information, Adjust stops sharing the user's data with third-parties. The Adjust SDK continues to work as expected.
+To disable third-party sharing for all users, call the `disableThirdPartySharing` method. When Adjust's servers receive this information, Adjust stops sharing the user's data with third-parties. The Adjust SDK continues to work as expected.
import DisableThirdPartySharing from "@flutter-examples/Adjust/disableThirdPartySharing.mdx";
@@ -164,7 +157,7 @@ The data residency feature allows you to choose the country in which Adjust stor
import UrlStrategySig from "@flutter-signatures/AdjustConfig/urlStrategy.mdx";
-To set your country of data residency, set the `urlStrategy` property || on your `AdjustConfig` instance.
+To set your country of data residency, set the `urlStrategy` property on your `AdjustConfig` instance.
import UrlStrategy from "@flutter-examples/AdjustConfig/urlStrategy.mdx";
@@ -187,7 +180,7 @@ import UrlStrategy from "@flutter-examples/AdjustConfig/urlStrategy.mdx";
import TrackMeasurementConsentSig from "@unity-signatures/Adjust/trackMeasurementConsent.mdx";
-If you are using [Data Privacy settings](https://help.adjust.com/en/article/manage-data-collection-and-retention) in your Adjust dashboard, you need to set up the Adjust SDK to work with them. This includes settings such as consent expiry period and user data retention period. To toggle this feature, call the `trackMeasurementConsent` method || . When enabled, the SDK communicates the data privacy settings to Adjust's servers. Adjust's servers then applies your data privacy rules to the user. The Adjust SDK continues to work as expected.
+If you are using [Data Privacy settings](https://help.adjust.com/en/article/manage-data-collection-and-retention) in your Adjust dashboard, you need to set up the Adjust SDK to work with them. This includes settings such as consent expiry period and user data retention period. To toggle this feature, call the `trackMeasurementConsent` method. When enabled, the SDK communicates the data privacy settings to Adjust's servers. Adjust's servers then applies your data privacy rules to the user. The Adjust SDK continues to work as expected.
import TrackMeasurementConsent from "@unity-examples/Adjust/trackMeasurementConsent.mdx";
@@ -207,7 +200,7 @@ See Google's [`AdvertisingIdClient.Info documentation`](https://developers.googl
import CoppaCompliantEnabledSig from "@flutter-signatures/AdjustConfig/coppaCompliantEnabled.mdx";
-If you need your app to be COPPA compliant, call the `coppaCompliantEnabled` method || . This method performs the following actions:
+If you need your app to be COPPA compliant, call the `coppaCompliantEnabled` method. This method performs the following actions:
1. Disables third-party sharing **before** the user launches their first session.
2. Prevents the SDK from reading device and advertising IDs (For example: `gps_adid` and `android_id`).
@@ -236,7 +229,7 @@ Adjust.start(adjustConfig);
import PlayStoreKidsAppEnabledSig from "@flutter-signatures/AdjustConfig/playStoreKidsAppEnabled.mdx";
-If your app targets users under the age of 13, and the install region **isn't** the USA, you need to mark it as a Kids App. This prevents the SDK from reading device and advertising IDs, that's, `gps_adid` and `android_id`. To do this, set the `playStoreKidsAppEnabled` property || on your config instance with a `true` parameter.
+If your app targets users under the age of 13, and the install region **isn't** the USA, you need to mark it as a Kids App. This prevents the SDK from reading device and advertising IDs, that's, `gps_adid` and `android_id`. To do this, set the `playStoreKidsAppEnabled` property on your config instance with a `true` parameter.
import PlayStoreKidsAppEnabled from "@flutter-examples/AdjustConfig/playStoreKidsAppEnabled.mdx";
diff --git a/src/content/docs/sdk/flutter/configuration/push-tokens.mdx b/src/content/docs/sdk/flutter/configuration/push-tokens.mdx
index d9abc06e5..bc684d3ce 100644
--- a/src/content/docs/sdk/flutter/configuration/push-tokens.mdx
+++ b/src/content/docs/sdk/flutter/configuration/push-tokens.mdx
@@ -9,7 +9,7 @@ import SetPushTokenSig from "@flutter-signatures/Adjust/setPushToken.mdx"
Push tokens are used for [Audience Builder](https://help.adjust.com/en/article/audience-builder) and client callbacks. They're also required for [Uninstall and reinstall tracking](https://help.adjust.com/en/article/uninstalls-reinstalls).
-Your config object contains a string `pushToken` property that you can use to store your push token. You can update this property at any time by calling the `setPushToken` method || and passing your token as an argument.
+Your config object contains a string `pushToken` property that you can use to store your push token. You can update this property at any time by calling the `setPushToken` method and passing your token as an argument.
diff --git a/src/content/docs/sdk/flutter/configuration/skad.mdx b/src/content/docs/sdk/flutter/configuration/skad.mdx
index c7ab9b867..3f4c8756a 100644
--- a/src/content/docs/sdk/flutter/configuration/skad.mdx
+++ b/src/content/docs/sdk/flutter/configuration/skad.mdx
@@ -10,7 +10,7 @@ This feature is only available on devices running iOS 14 and above.
-SKAdNetwork (StoreKit Ad Network) is Apple's attribution framework for
+SKAdNetwork (StoreKit Ad Network) is Apple's attribution framework for
app install and reinstall attribution. The SKAdNetwork workflow goes like this:
1. Apple gathers attribution information and notifies the relevant ad network.
@@ -23,7 +23,7 @@ The Adjust SDK communicates with SKAdNetwork by default on v4.23.0 and above. Th
import DeactivateSKAdNetworkHandlingSig from "@flutter-signatures/AdjustConfig/deactivateSKAdNetworkHandling.mdx";
-Your config object contains a boolean `isSKAdNetworkHandlingActive` property that controls this behavior. You can disable SKAdNetwork communication by calling the `deactivateSKAdNetworkHandling` method || with no argument.
+Your config object contains a boolean `isSKAdNetworkHandlingActive` property that controls this behavior. You can disable SKAdNetwork communication by calling the `deactivateSKAdNetworkHandling` method with no argument.
@@ -41,7 +41,7 @@ Conversion values are a mechanism used to track user behavior in SKAdNetwork. Yo
import UpdateConversionValueSig from "@flutter-signatures/Adjust/updateConversionValue.mdx";
-If you manage your conversion values with Adjust, the servers update this value in the SDK. You can also update this value by using the `updateConversionValue` method || . This method wraps [Apple's `updateConversionValue` method](https://developer.apple.com/documentation/storekit/skadnetwork/3566697-updateconversionvalue). It accepts an integer argument representing your updated conversion value.
+If you manage your conversion values with Adjust, the servers update this value in the SDK. You can also update this value by using the `updateConversionValue` method. This method wraps [Apple's `updateConversionValue` method](https://developer.apple.com/documentation/storekit/skadnetwork/3566697-updateconversionvalue). It accepts an integer argument representing your updated conversion value.
import UpdateConversionValue from "@flutter-examples/Adjust/updateConversionValue.mdx";
diff --git a/src/content/docs/sdk/flutter/features/ad-revenue.mdx b/src/content/docs/sdk/flutter/features/ad-revenue.mdx
index e97ebf8b8..340169e36 100644
--- a/src/content/docs/sdk/flutter/features/ad-revenue.mdx
+++ b/src/content/docs/sdk/flutter/features/ad-revenue.mdx
@@ -32,7 +32,7 @@ You need to perform some extra setup steps in your Adjust dashboard to measure a
To send ad revenue to Adjust:
1. Create a new Adjust ad revenue instance and pass your ad revenue source as an argument.
-2. Call the `trackAdRevenue` method || with your ad revenue instance as an argument.
+2. Call the `trackAdRevenue` method with your ad revenue instance as an argument.
@@ -57,13 +57,11 @@ To send ad revenue to Adjust:
You can record ad revenue by setting the `revenue` and `currency` properties on your ad revenue instance.
-To set these properties, call the `setRevenue` method || and pass the following arguments:
+To set these properties, call the `setRevenue` method and pass the following arguments:
-`revenue` **number**
-: The amount of revenue
+`revenue` **number**: The amount of revenue
-`currency` **string**
-: The 3 character [ISO 4217 code](https://www.iban.com/currency-codes) of your reporting currency
+`currency` **string**: The 3 character [ISO 4217 code](https://www.iban.com/currency-codes) of your reporting currency
@@ -79,25 +77,25 @@ The ad revenue object contains properties you can use to report on your ad campa
### Ad impressions
-Record the number of ad impressions by passing an **integer** value to the `setAdImpressionsCount` method || .
+Record the number of ad impressions by passing an **integer** value to the `setAdImpressionsCount` method.
### Ad revenue network
-Record which network generated the revenue by passing a **string** value to the `setAdRevenueNetwork` method || .
+Record which network generated the revenue by passing a **string** value to the `setAdRevenueNetwork` method.
### Ad revenue unit
-Record which ad revenue unit generated the revenue by passing a **string** value to the `setAdRevenueUnit` method || .
+Record which ad revenue unit generated the revenue by passing a **string** value to the `setAdRevenueUnit` method.
### Ad revenue placement
-Record the placement of your ad by passing a **string** value to the `setAdRevenuePlacement` method || .
+Record the placement of your ad by passing a **string** value to the `setAdRevenuePlacement` method.
@@ -107,7 +105,7 @@ If you [register a callback URL](https://help.adjust.com/en/article/recommended-
You can configure callback parameters to your servers. Once you configure parameters on an event, the SDK appends them to your [callback URL](https://help.adjust.com/en/article/raw-data-exports). You can use this information to analyze your users' in-app behavior with your BI system.
-Add callback parameters to your event by calling the `addCallbackParameter` method || with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
+Add callback parameters to your event by calling the `addCallbackParameter` method with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
The Adjust SDK measures the event and sends a request to your URL with the callback parameters. For example, if you register the URL `https://www.mydomain.com/callback`, your callback looks like this:
@@ -145,7 +143,7 @@ Partner parameters don't appear in raw data by default. You can add the `{partne
-Add partner parameters to your event by calling the `addPartnerParameter` method || with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
+Add partner parameters to your event by calling the `addPartnerParameter` method with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
diff --git a/src/content/docs/sdk/flutter/features/attribution.mdx b/src/content/docs/sdk/flutter/features/attribution.mdx
index fd256a965..7c718964e 100644
--- a/src/content/docs/sdk/flutter/features/attribution.mdx
+++ b/src/content/docs/sdk/flutter/features/attribution.mdx
@@ -8,7 +8,7 @@ When a user interacts with a campaign link, their attribution information update
import AttributionCallbackSig from "@flutter-signatures/AdjustConfig/attributionCallback.mdx"
-To configure your callback function, add it to the `attributionCallback` property || on your config object.
+To configure your callback function, add it to the `attributionCallback` property on your config object.
@@ -26,7 +26,7 @@ Within your delegate function, you have access to the user's `Attribution` infor
import GetAttributionSig from "@flutter-signatures/Adjust/getAttribution.mdx";
-When a user installs your app, Adjust attributes the install to a campaign. The Adjust SDK gives you access to campaign attribution details for your install. To return this information, call the `getAttribution` method || .
+When a user installs your app, Adjust attributes the install to a campaign. The Adjust SDK gives you access to campaign attribution details for your install. To return this information, call the `getAttribution` method.
This method returns an Attribution object. See the [`AdjustAttribution` class reference](/en/sdk/flutter/reference/adjustattribution) for a list of available properties.
diff --git a/src/content/docs/sdk/flutter/features/device-info.mdx b/src/content/docs/sdk/flutter/features/device-info.mdx
index 4c22dfe88..bab79e6c4 100644
--- a/src/content/docs/sdk/flutter/features/device-info.mdx
+++ b/src/content/docs/sdk/flutter/features/device-info.mdx
@@ -11,7 +11,7 @@ The Adjust SDK contains helper methods that return device information. Use these
import GetAdid from "@flutter-examples/Adjust/getAdid.mdx"
import GetAdidSig from "@flutter-signatures/Adjust/getAdid.mdx"
-Adjust generates a unique ADID (Adjust Device ID) for each device. Call the `getAdid` method || to return this ID as a **string**.
+Adjust generates a unique ADID (Adjust Device ID) for each device. Call the `getAdid` method to return this ID as a **string**.
@@ -20,7 +20,7 @@ Adjust generates a unique ADID (Adjust Device ID) for each device.
import GetIdfa from "@flutter-examples/Adjust/getIdfa.mdx"
import GetIdfaSig from "@flutter-signatures/Adjust/getIdfa.mdx"
-The IDFA (ID for Advertisers) is a device-specific identifier for Apple devices. Call the `getIdfa` method || to return this ID as a **string**.
+The IDFA (ID for Advertisers) is a device-specific identifier for Apple devices. Call the `getIdfa` method to return this ID as a **string**.
@@ -29,11 +29,11 @@ The IDFA (ID for Advertisers) is a device-specific identifier for A
import GetGoogleAdId from "@flutter-examples/Adjust/getGoogleAdId.mdx"
import GetGoogleAdIdSig from "@flutter-signatures/Adjust/getGoogleAdId.mdx"
-The GPS ADID (Google Play Services Advertising ID) is a device-specific identifier for Android devices.
+The GPS ADID (Google Play Services Advertising ID) is a device-specific identifier for Android devices.
Users can opt out of sharing their GPS ADID by toggling the "Opt out of Ads Personalization" setting on their device. When a user enables this setting, the Adjust SDK returns a string of zeros when trying to read the GPS ADID.
-You can access this value by calling the `getGoogleAdId` method || in a background thread. Assign a delegate function to access the GPS ADID value.
+You can access this value by calling the `getGoogleAdId` method in a background thread. Assign a delegate function to access the GPS ADID value.
@@ -42,6 +42,6 @@ You can access this value by calling the `getGoogleAdId` method || Amazon Ad ID (Amazon Advertising ID) is a device-specific identifier for Android devices. Call the `getAmazonAdId` method || to return this ID as a **string**.
+The Amazon Ad ID (Amazon Advertising ID) is a device-specific identifier for Android devices. Call the `getAmazonAdId` method to return this ID as a **string**.
diff --git a/src/content/docs/sdk/flutter/features/events.mdx b/src/content/docs/sdk/flutter/features/events.mdx
index b24e5878d..c956820de 100644
--- a/src/content/docs/sdk/flutter/features/events.mdx
+++ b/src/content/docs/sdk/flutter/features/events.mdx
@@ -20,7 +20,7 @@ import AddPartnerParameterSig from "@flutter-signatures/AdjustEvent/addPartnerPa
You can associate your [Adjust event tokens](https://help.adjust.com/en/article/add-events#add-event) to actions in your app to record them. To record an event:
* Create a new Adjust event instance and pass your event token as a string argument.
-* Call the `trackEvent` method || with your event instance as an argument.
+* Call the `trackEvent` method with your event instance as an argument.
@@ -111,13 +111,11 @@ Parameters:
You can record revenue associated with an event by setting the revenue and currency properties on your event instance. Use this feature to record revenue-generating actions in your app.
-To set these properties, call the `setRevenue` method || and pass the following arguments:
+To set these properties, call the `setRevenue` method and pass the following arguments:
-`revenue` (**number**)
-: The amount of revenue generated by the event
+`revenue` (**number**): The amount of revenue generated by the event
-`currency` (**string**)
-: The [ISO 4217 code](https://www.iban.com/currency-codes) of the event currency.
+`currency` (**string**): The [ISO 4217 code](https://www.iban.com/currency-codes) of the event currency.
@@ -180,13 +178,13 @@ Parameters:
You can pass an optional identifier to avoid recording duplicate events. The SDK stores the last ten identifiers and skips revenue events with duplicate transaction IDs.
-To set the identifier, assign your transaction ID to the `setTransactionId` property || .
+To set the identifier, assign your transaction ID to the `setTransactionId` property.
### Example
-This example shows how to record an event with the token `g3mfiw` whenever a user interacts with a button. The function sets the `uniqueId` to `5e85484b-1ebc-4141-aab7-25b869e54c49` using the `setTransactionId` method || .
+This example shows how to record an event with the token `g3mfiw` whenever a user interacts with a button. The function sets the `uniqueId` to `5e85484b-1ebc-4141-aab7-25b869e54c49` using the `setTransactionId` method.
```dart title="util.dart"
import 'package:adjust_sdk/adjust_event.dart';
@@ -239,7 +237,7 @@ If you [register a callback URL](https://help.adjust.com/en/article/set-up-callb
You can configure callback parameters to send to your servers. Once you configure parameters on an event, the SDK appends them to your [callback URL](https://help.adjust.com/en/article/raw-data-exports). You can use this information to analyze your users' in-app behavior with your BI system.
-Add callback parameters to your event by calling the `addCallbackParameter` method || with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
+Add callback parameters to your event by calling the `addCallbackParameter` method with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
@@ -335,7 +333,7 @@ Partner parameters don't appear in raw data by default. You can add the `{partne
-Add partner parameters to your event by calling the `addPartnerParameter` method || with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
+Add partner parameters to your event by calling the `addPartnerParameter` method with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
@@ -395,7 +393,7 @@ Parameters:
You can add a custom string identifier to each event you want to measure. Adjust's servers can report on this identifier in event callbacks. This enables you to keep track of which events have been successfully measured.
-Set up this identifier by assigning your ID to the `callbackId` property || .
+Set up this identifier by assigning your ID to the `callbackId` property.
diff --git a/src/content/docs/sdk/flutter/features/session-parameters.mdx b/src/content/docs/sdk/flutter/features/session-parameters.mdx
index e7531fa7f..9568ccf34 100644
--- a/src/content/docs/sdk/flutter/features/session-parameters.mdx
+++ b/src/content/docs/sdk/flutter/features/session-parameters.mdx
@@ -31,15 +31,15 @@ The Adjust SDK merges session callback parameters with event callback parameters
-Add callback parameters to your event by calling the `addSessionCallbackParameter` method || with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
+Add callback parameters to your event by calling the `addSessionCallbackParameter` method with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
-You can remove specific session callback parameters if they're no longer required. To do this, pass the parameter key to the `removeSessionCallbackParameter` method || .
+You can remove specific session callback parameters if they're no longer required. To do this, pass the parameter key to the `removeSessionCallbackParameter` method.
-You can remove all session parameters if they're no longer required. To do this, call the `resetSessionCallbackParameters` method || .
+You can remove all session parameters if they're no longer required. To do this, call the `resetSessionCallbackParameters` method.
@@ -55,15 +55,15 @@ Partner parameters don't appear in raw data by default. You can add the `{partne
-Add partner parameters to your event by calling the `addSessionPartnerParameter` method || with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
+Add partner parameters to your event by calling the `addSessionPartnerParameter` method with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
-You can remove specific session partner parameters if they're no longer required. To do this, pass the parameter key to the `removeSessionPartnerParameter` method || .
+You can remove specific session partner parameters if they're no longer required. To do this, pass the parameter key to the `removeSessionPartnerParameter` method.
-You can remove all session partner parameters if they're no longer required. To do this, call the `resetSessionPartnerParameters` method || .
+You can remove all session partner parameters if they're no longer required. To do this, call the `resetSessionPartnerParameters` method.
@@ -75,10 +75,10 @@ You can delay the startup of the SDK by up to **10 seconds**.
-The Adjust SDK starts as soon as your app opens. If you want to send data that's not available at launch in session parameters, you can delay the start of the SDK. To do this, pass the delay time in seconds to the `setDelayStart` method || on your config object.
+The Adjust SDK starts as soon as your app opens. If you want to send data that's not available at launch in session parameters, you can delay the start of the SDK. To do this, pass the delay time in seconds to the `setDelayStart` method on your config object.
-After this time has elapsed, the SDK sends the information to Adjust's servers. You can send the information before the timeout by calling the `sendFirstPackages` method || .
+After this time has elapsed, the SDK sends the information to Adjust's servers. You can send the information before the timeout by calling the `sendFirstPackages` method.
diff --git a/src/content/docs/sdk/flutter/features/subscriptions.mdx b/src/content/docs/sdk/flutter/features/subscriptions.mdx
index a837cd63f..4abf0ef0f 100644
--- a/src/content/docs/sdk/flutter/features/subscriptions.mdx
+++ b/src/content/docs/sdk/flutter/features/subscriptions.mdx
@@ -81,14 +81,14 @@ You can record the date on which the user purchased a subscription. The SDK retu
-Call the `setTransactionDate` method || on your subscription object to record the timestamp of the subscription.
+Call the `setTransactionDate` method on your subscription object to record the timestamp of the subscription.
-Call the `setPurchaseTime` method || on your subscription object to record the timestamp of the subscription.
+Call the `setPurchaseTime` method on your subscription object to record the timestamp of the subscription.
@@ -97,7 +97,7 @@ Call the `setPurchaseTime` method || o
### Record the purchase region (iOS only)
-You can record the region in which the user purchased a subscription. To do this, call the `setSalesRegion` method || on your subscription object and pass the country code as a **string**. This needs to be formatted as the [`countryCode`](https://developer.apple.com/documentation/foundation/nslocale/1643060-countrycode?language=swift) of the [`priceLocale`](https://developer.apple.com/documentation/storekit/skproduct/1506145-pricelocale?language=swift) object.
+You can record the region in which the user purchased a subscription. To do this, call the `setSalesRegion` method on your subscription object and pass the country code as a **string**. This needs to be formatted as the [`countryCode`](https://developer.apple.com/documentation/foundation/nslocale/1643060-countrycode?language=swift) of the [`priceLocale`](https://developer.apple.com/documentation/storekit/skproduct/1506145-pricelocale?language=swift) object.
@@ -142,14 +142,14 @@ Once you have set up your subscription object, you can record it using the Adjus
-Pass your subscription object to the `trackAppStoreSubscription` method || to record the user's subscription purchase.
+Pass your subscription object to the `trackAppStoreSubscription` method to record the user's subscription purchase.
-Pass your subscription object to the `trackPlayStoreSubscription` method || to record the user's subscription purchase.
+Pass your subscription object to the `trackPlayStoreSubscription` method to record the user's subscription purchase.
diff --git a/src/content/docs/sdk/flutter/index.mdx b/src/content/docs/sdk/flutter/index.mdx
index b9888678d..6ab4122af 100644
--- a/src/content/docs/sdk/flutter/index.mdx
+++ b/src/content/docs/sdk/flutter/index.mdx
@@ -138,7 +138,7 @@ As of v4.22.0, the Adjust SDK supports install tracking on Huawei devices using
## 3. Add iOS frameworks
-The Adjust SDK is able to get extra information when you include certain iOS frameworks in your app. These frameworks enable certain SDK features, but they're not mandatory for the SDK to work normally. You can add the frameworks and then mark them as optional in Project Settings --> Build Phases --> Link Binary With Libraries.
+The Adjust SDK is able to get extra information when you include certain iOS frameworks in your app. These frameworks enable certain SDK features, but they're not mandatory for the SDK to work normally. You can add the frameworks and then mark them as optional in **Project Settings --> Build Phases --> Link Binary With Libraries**.
@@ -228,7 +228,7 @@ class MainScreenState extends State with WidgetsBindingObserver {
## 6. Build your app
-Well done! You should now be able to build and run your Flutter app. Enable logging || to check for any issues. Check your logs to see the `Install tracked` message.
+Well done! You should now be able to build and run your Flutter app. Enable logging to check for any issues. Check your logs to see the `Install tracked` message.
You are ready to start attributing your users with the Adjust SDK.
@@ -244,7 +244,7 @@ The Adjust SDK provides tools for testing and troubleshooting issues with your i
- Set your environment to **Sandbox**.
- Add a sandbox filter to your Adjust dashboard results.
-- Set your log level || to **verbose**.
+- Set your log level to **verbose**.
@@ -254,6 +254,6 @@ If you encounter any issues, email support@adjust.com with all details and logs.
### Test Google Play Services integration
-To test that the Adjust SDK can receive a device's Google Advertising ID, set the log level || to **verbose** and the environment to **Sandbox**. Start your app and measure a session or an event. The SDK logs the `gps_adid` (Google Play Services Advertiser ID) parameter if it has read the advertising ID.
+To test that the Adjust SDK can receive a device's Google Advertising ID, set the log level to **verbose** and the environment to **Sandbox**. Start your app and measure a session or an event. The SDK logs the `gps_adid` (Google Play Services Advertiser ID) parameter if it has read the advertising ID.
If you're experiencing issues retrieving the Google Advertising ID, open an issue in the SDK [GitHub repository](https://github.com/adjust/flutter_sdk) or contact support@adjust.com.
diff --git a/src/content/docs/sdk/flutter/reference/adjust/config.mdx b/src/content/docs/sdk/flutter/reference/adjust/config.mdx
index 6da278bec..428f653db 100644
--- a/src/content/docs/sdk/flutter/reference/adjust/config.mdx
+++ b/src/content/docs/sdk/flutter/reference/adjust/config.mdx
@@ -30,8 +30,7 @@ import SetEnabled from "@flutter-examples/Adjust/setEnabled.mdx"
-`enabled` (bool)
-: Whether the SDK is enabled.
+`enabled` (bool): Whether the SDK is enabled.
@@ -61,8 +60,7 @@ import IsEnabled from "@flutter-examples/Adjust/isEnabled.mdx"
-`enabled` (bool)
-: Whether the SDK is enabled.
+`enabled` (bool): Whether the SDK is enabled.
@@ -122,8 +120,7 @@ import SetOfflineMode from "@flutter-examples/Adjust/setOfflineMode.mdx"
-`enabled` (bool)
-: Whether the SDK is in offline mode.
+`enabled` (bool): Whether the SDK is in offline mode.
@@ -153,8 +150,7 @@ import SetPushToken from "@flutter-examples/Adjust/setPushToken.mdx"
-`pushToken` (String)
-: Your push token.
+`pushToken` (String): Your push token.
diff --git a/src/content/docs/sdk/flutter/reference/adjust/device-info.mdx b/src/content/docs/sdk/flutter/reference/adjust/device-info.mdx
index 407d83dc2..5341dcb55 100644
--- a/src/content/docs/sdk/flutter/reference/adjust/device-info.mdx
+++ b/src/content/docs/sdk/flutter/reference/adjust/device-info.mdx
@@ -17,7 +17,7 @@ The ADID is available only after the install has been recorded.
-Returns the ADID (Adjust Device ID) associated with the device.
+Returns the ADID (Adjust Device ID) associated with the device.
@@ -37,8 +37,7 @@ import GetAdid from "@flutter-examples/Adjust/getAdid.mdx"
-`adid` (String)
-: The Adjust identifier associated with the device
+`adid` (String): The Adjust identifier associated with the device
@@ -48,7 +47,7 @@ import GetAdid from "@flutter-examples/Adjust/getAdid.mdx"
## getIdfa
-Returns the IDFA (ID for advertisers) associated with the device.
+Returns the IDFA (ID for advertisers) associated with the device.
@@ -68,8 +67,7 @@ import GetIdfa from "@flutter-examples/Adjust/getIdfa.mdx"
-`idfa` (String)
-: The IDFA associated with the device
+`idfa` (String): The IDFA associated with the device
@@ -79,7 +77,7 @@ import GetIdfa from "@flutter-examples/Adjust/getIdfa.mdx"
## getGoogleAdid
-Returns the Google ADID (Google advertiser ID) associated with the device.
+Returns the Google ADID (Google advertiser ID) associated with the device.
@@ -99,8 +97,7 @@ import GetGoogleAdid from "@flutter-examples/Adjust/getGoogleAdId.mdx"
-`googleAdid` (String)
-: The Google ADID associated with the device
+`googleAdid` (String): The Google ADID associated with the device
@@ -110,7 +107,7 @@ import GetGoogleAdid from "@flutter-examples/Adjust/getGoogleAdId.mdx"
## getAmazonAdid
-Returns the Amazon ADID (Amazon advertiser ID) associated with the device.
+Returns the Amazon ADID (Amazon advertiser ID) associated with the device.
@@ -130,8 +127,7 @@ import GetAmazonAdid from "@flutter-examples/Adjust/getAmazonAdId.mdx"
-`amazonAdId` (String)
-: The Amazon ADID associated with the device
+`amazonAdId` (String): The Amazon ADID associated with the device
diff --git a/src/content/docs/sdk/flutter/reference/adjust/privacy.mdx b/src/content/docs/sdk/flutter/reference/adjust/privacy.mdx
index d131c23e4..6ed904dd3 100644
--- a/src/content/docs/sdk/flutter/reference/adjust/privacy.mdx
+++ b/src/content/docs/sdk/flutter/reference/adjust/privacy.mdx
@@ -55,8 +55,7 @@ import TrackThirdPartySharing from "@flutter-examples/Adjust/trackThirdPartyShar
-`thirdPartySharing` (AdjustThirdPartySharing)
-: The third party sharing object
+`thirdPartySharing` (AdjustThirdPartySharing): The third party sharing object
@@ -86,8 +85,7 @@ import TrackMeasurementConsent from "@flutter-examples/Adjust/trackMeasurementCo
-`enabled` (bool)
-: Whether data collection and retention rules apply for the user.
+`enabled` (bool): Whether data collection and retention rules apply for the user.
@@ -97,7 +95,7 @@ import TrackMeasurementConsent from "@flutter-examples/Adjust/trackMeasurementCo
## gdprForgetMe
-Send an RTBF (Right To Be Forgotten) request to Adjust's servers. This erases all information about the user the source app. The SDK stops sending requests for the user.
+Send an RTBF (Right To Be Forgotten) request to Adjust's servers. This erases all information about the user the source app. The SDK stops sending requests for the user.
diff --git a/src/content/docs/sdk/flutter/reference/adjust/recording.mdx b/src/content/docs/sdk/flutter/reference/adjust/recording.mdx
index 751ebfdbc..f025d52af 100644
--- a/src/content/docs/sdk/flutter/reference/adjust/recording.mdx
+++ b/src/content/docs/sdk/flutter/reference/adjust/recording.mdx
@@ -31,8 +31,7 @@ import TrackEvent from "@flutter-examples/Adjust/trackEvent.mdx"
-`event` (AdjustEvent)
-: An event object containing the information you want to send to Adjust.
+`event` (AdjustEvent): An event object containing the information you want to send to Adjust.
@@ -62,11 +61,9 @@ import AddSessionCallbackParameter from "@flutter-examples/Adjust/addSessionCall
-`key` (String)
-: The data key
+`key` (String): The data key
-`value` (String)
-: The data value
+`value` (String): The data value
@@ -96,8 +93,7 @@ import RemoveSessionCallbackParameter from "@flutter-examples/Adjust/removeSessi
-`key` (String)
-: The data key of the parameter you want to remove.
+`key` (String): The data key of the parameter you want to remove.
@@ -151,11 +147,9 @@ import AddSessionPartnerParameter from "@flutter-examples/Adjust/addSessionPartn
-`key` (String)
-: The data key
+`key` (String): The data key
-`value` (String)
-: The data value
+`value` (String): The data value
@@ -185,8 +179,7 @@ import RemoveSessionPartnerParameter from "@flutter-examples/Adjust/removeSessio
-`key` (String)
-: The data key of the parameter you want to remove.
+`key` (String): The data key of the parameter you want to remove.
@@ -240,8 +233,7 @@ import TrackAdRevenue from "@flutter-examples/Adjust/trackAdRevenue.mdx"
-`adRevenue` (AdjustAdRevenue)
-: The ad revenue object containing the revenue details.
+`adRevenue` (AdjustAdRevenue): The ad revenue object containing the revenue details.
@@ -271,8 +263,7 @@ import TrackPlayStoreSubscription from "@flutter-examples/Adjust/trackPlayStoreS
-`subscription` (AdjustPlayStoreSubscription)
-: The subscription object containing the purchase details.
+`subscription` (AdjustPlayStoreSubscription): The subscription object containing the purchase details.
@@ -302,8 +293,7 @@ import TrackAppStoreSubscription from "@flutter-examples/Adjust/trackAppStoreSub
-`subscription` (AdjustAppStoreSubscription)
-: The subscription object containing the purchase details.
+`subscription` (AdjustAppStoreSubscription): The subscription object containing the purchase details.
@@ -333,8 +323,7 @@ import GetAttribution from "@flutter-examples/Adjust/getAttribution.mdx"
-`attribution` (AdjustAttribution)
-: An attribution object containing attribution data associated with the device.
+`attribution` (AdjustAttribution): An attribution object containing attribution data associated with the device.
diff --git a/src/content/docs/sdk/flutter/reference/adjust/skan-att.mdx b/src/content/docs/sdk/flutter/reference/adjust/skan-att.mdx
index 1fe36d40a..7ccbf5884 100644
--- a/src/content/docs/sdk/flutter/reference/adjust/skan-att.mdx
+++ b/src/content/docs/sdk/flutter/reference/adjust/skan-att.mdx
@@ -31,8 +31,7 @@ import RequestTrackingAuthorization from "@flutter-examples/Adjust/requestTracki
-`statusCallback` (function)
-: Completion handler to which the status is passed.
+`statusCallback` (function): Completion handler to which the status is passed.
@@ -62,8 +61,7 @@ import GetAppTrackingAuthorizationStatus from "@flutter-examples/Adjust/getAppTr
-`status` (num)
-: The user's authorization status.
+`status` (num): The user's authorization status.
@@ -117,8 +115,7 @@ import UpdateConversionValue from "@flutter-examples/Adjust/updateConversionValu
-conversionValue (num)
-: The new conversion value.
+conversionValue (num): The new conversion value.
diff --git a/src/content/docs/sdk/flutter/reference/adjustadrevenue.mdx b/src/content/docs/sdk/flutter/reference/adjustadrevenue.mdx
index 9998ff735..9d7593f7c 100644
--- a/src/content/docs/sdk/flutter/reference/adjustadrevenue.mdx
+++ b/src/content/docs/sdk/flutter/reference/adjustadrevenue.mdx
@@ -31,8 +31,7 @@ import Constructor from "@flutter-examples/AdjustAdRevenue/constructor.mdx";
-`source` (String)
-: The source of the ad revenue.
+`source` (String): The source of the ad revenue.
@@ -77,11 +76,9 @@ import SetRevenue from "@flutter-examples/AdjustAdRevenue/setRevenue.mdx";
-`amount` (num)
-: The amount of currency units associated with the ad.
+`amount` (num): The amount of currency units associated with the ad.
-`currency` (String)
-: The 3 character [ISO 4217 code](https://www.iban.com/currency-codes) of the currency unit.
+`currency` (String): The 3 character [ISO 4217 code](https://www.iban.com/currency-codes) of the currency unit.
@@ -111,8 +108,7 @@ import AdImpressionsCount from "@flutter-examples/AdjustAdRevenue/adImpressionsC
-`adImpressionsCaount` (num)
-: The number of impressions associated with the ad.
+`adImpressionsCaount` (num): The number of impressions associated with the ad.
@@ -142,8 +138,7 @@ import AdRevenueNetwork from "@flutter-examples/AdjustAdRevenue/adRevenueNetwork
-`adRevenueNetwork` (String)
-: The network associated with the ad revenue.
+`adRevenueNetwork` (String): The network associated with the ad revenue.
@@ -173,8 +168,7 @@ import AdRevenueUnit from "@flutter-examples/AdjustAdRevenue/adRevenueUnit.mdx";
-`unit` (String)
-: The ad unit ID associated with the ad revenue.
+`unit` (String): The ad unit ID associated with the ad revenue.
@@ -204,8 +198,7 @@ import AdRevenuePlacement from "@flutter-examples/AdjustAdRevenue/adRevenuePlace
-`adRevenuePlacement` (String)
-: The placement of the ad associated with the revenue.
+`adRevenuePlacement` (String): The placement of the ad associated with the revenue.
@@ -235,11 +228,9 @@ import AddCallbackParameter from "@flutter-examples/AdjustAdRevenue/addCallbackP
-`key` (String)
-: The data key.
+`key` (String): The data key.
-`value` (String)
-: The data value.
+`value` (String): The data value.
@@ -269,11 +260,9 @@ import AddPartnerParameter from "@flutter-examples/AdjustAdRevenue/addPartnerPar
-`key` (String)
-: The data key.
+`key` (String): The data key.
-`value` (String)
-: The data value.
+`value` (String): The data value.
diff --git a/src/content/docs/sdk/flutter/reference/adjustappstoresubscription.mdx b/src/content/docs/sdk/flutter/reference/adjustappstoresubscription.mdx
index 54a9818ba..b97cad816 100644
--- a/src/content/docs/sdk/flutter/reference/adjustappstoresubscription.mdx
+++ b/src/content/docs/sdk/flutter/reference/adjustappstoresubscription.mdx
@@ -7,7 +7,7 @@ slug: en/sdk/flutter/reference/adjustappstoresubscription
import TrackAppStoreSubscription from "@flutter-signatures/Adjust/trackAppStoreSubscription.mdx"
-Use this class to store App Store subscription information. You can pass this to Adjust's servers using the `trackAppStoreSubscription` method || .
+Use this class to store App Store subscription information. You can pass this to Adjust's servers using the `trackAppStoreSubscription` method.
@@ -33,17 +33,13 @@ import Constructor from "@flutter-examples/AdjustAppStoreSubscription/constructo
-`price` (String)
-: The price of the subscription.
+`price` (String): The price of the subscription.
-`currency` (String)
-: The currency of the subscription. Formatted as the [`currencyCode`](https://developer.apple.com/documentation/foundation/nslocale/1642836-currencycode?language=objc) of the [`priceLocale`](https://developer.apple.com/documentation/storekit/skproduct/1506145-pricelocale?language=objc) object
+`currency` (String): The currency of the subscription. Formatted as the [`currencyCode`](https://developer.apple.com/documentation/foundation/nslocale/1642836-currencycode?language=objc) of the [`priceLocale`](https://developer.apple.com/documentation/storekit/skproduct/1506145-pricelocale?language=objc) object
-`transactionId` (String)
-: Your ID for the transaction.
+`transactionId` (String): Your ID for the transaction.
-`receipt` (String)
-: The receipt information.
+`receipt` (String): The receipt information.
@@ -73,8 +69,7 @@ import SetTransactionDate from "@flutter-examples/AdjustAppStoreSubscription/set
-`transactionDate` (String)
-: The date on which the subscription was purchased.
+`transactionDate` (String): The date on which the subscription was purchased.
@@ -104,8 +99,7 @@ import SetSalesRegion from "@flutter-examples/AdjustAppStoreSubscription/setSale
-`salesRegion` (String)
-: The region in which the subscription was purchased.
+`salesRegion` (String): The region in which the subscription was purchased.
@@ -135,11 +129,9 @@ import AddCallbackParameter from "@flutter-examples/AdjustAppStoreSubscription/a
-`key` (String)
-: The data key.
+`key` (String): The data key.
-`value` (String)
-: The data value.
+`value` (String): The data value.
@@ -169,11 +161,9 @@ import AddPartnerParameter from "@flutter-examples/AdjustAppStoreSubscription/ad
-`key` (String)
-: The data key.
+`key` (String): The data key.
-`value` (String)
-: The data value.
+`value` (String): The data value.
diff --git a/src/content/docs/sdk/flutter/reference/adjustattribution.mdx b/src/content/docs/sdk/flutter/reference/adjustattribution.mdx
index 87fece01c..28c0e1e8f 100644
--- a/src/content/docs/sdk/flutter/reference/adjustattribution.mdx
+++ b/src/content/docs/sdk/flutter/reference/adjustattribution.mdx
@@ -12,11 +12,11 @@ The `AdjustAttribution` class contains details about the current attribution sta
## Properties
-The following properties can be accessed by calling the `getAttribution` method || . Any values that aren't populated for the user are returned as a null value.
+The following properties can be accessed by calling the `getAttribution` method. Any values that aren't populated for the user are returned as a null value.
-The following values can only be accessed if the `needsCost` property || on your `ADJConfig` instance is `true`:
+The following values can only be accessed if the `needsCost` property on your `ADJConfig` instance is `true`:
- `costType`
- `costAmount`
diff --git a/src/content/docs/sdk/flutter/reference/adjustconfig/index.mdx b/src/content/docs/sdk/flutter/reference/adjustconfig/index.mdx
index 330a2fab5..967b38710 100644
--- a/src/content/docs/sdk/flutter/reference/adjustconfig/index.mdx
+++ b/src/content/docs/sdk/flutter/reference/adjustconfig/index.mdx
@@ -38,18 +38,15 @@ import ConfigWithAppToken from "@flutter-examples/AdjustConfig/constructor.mdx"
-`appToken` (string)
-: Your Adjust app token.
+`appToken` (string): Your Adjust app token.
-`environment` (AdjustEnvironment)
-: The environment your app is running in.
+`environment` (AdjustEnvironment): The environment your app is running in.
-`config` (AdjustConfig)
-: A config object initialized with the provided params.
+`config` (AdjustConfig): A config object initialized with the provided params.
diff --git a/src/content/docs/sdk/flutter/reference/adjustconfig/privacy.mdx b/src/content/docs/sdk/flutter/reference/adjustconfig/privacy.mdx
index 56a7326d3..c54724cf5 100644
--- a/src/content/docs/sdk/flutter/reference/adjustconfig/privacy.mdx
+++ b/src/content/docs/sdk/flutter/reference/adjustconfig/privacy.mdx
@@ -29,8 +29,7 @@ import UrlStrategy from "@flutter-examples/AdjustConfig/urlStrategy.mdx";
-`urlStrategy` (String)
-: The data residency target (see available values below)
+`urlStrategy` (String): The data residency target (see available values below)
@@ -53,7 +52,7 @@ import UrlStrategy from "@flutter-examples/AdjustConfig/urlStrategy.mdx";
## coppaCompliantEnabled
-Enable COPPA (Children's Online Privacy Protection Act) compliance in your app.
+Enable COPPA (Children's Online Privacy Protection Act) compliance in your app.
@@ -73,8 +72,7 @@ import CoppaCompliantEnabled from "@flutter-examples/AdjustConfig/coppaCompliant
-`coppaCompliantEnabled` (bool)
-: Whether the app should be COPPA compliant.
+`coppaCompliantEnabled` (bool): Whether the app should be COPPA compliant.
diff --git a/src/content/docs/sdk/flutter/reference/adjustconfig/setup.mdx b/src/content/docs/sdk/flutter/reference/adjustconfig/setup.mdx
index b6d5c521d..d0a092107 100644
--- a/src/content/docs/sdk/flutter/reference/adjustconfig/setup.mdx
+++ b/src/content/docs/sdk/flutter/reference/adjustconfig/setup.mdx
@@ -31,8 +31,7 @@ import LogLevel from "@flutter-examples/AdjustConfig/logLevel.mdx";
-`logLevel` (AdjustLogLevel)
-: The level of logging output by the SDK.
+`logLevel` (AdjustLogLevel): The level of logging output by the SDK.
@@ -76,8 +75,7 @@ import DefaultTracker from "@flutter-examples/AdjustConfig/defaultTracker.mdx"
-`defaultTracker` (String)
-: The token to which all preinstalled sessions are attributed.
+`defaultTracker` (String): The token to which all preinstalled sessions are attributed.
@@ -107,8 +105,7 @@ import SendInBackground from "@flutter-examples/AdjustConfig/sendInBackground.md
-`sendInBackground` (bool)
-: Whether the SDK should send information to Adjust when the app is running in the background.
+`sendInBackground` (bool): Whether the SDK should send information to Adjust when the app is running in the background.
@@ -138,8 +135,7 @@ import SessionSuccessCallback from "@flutter-examples/AdjustConfig/sessionSucces
-`sessionSuccessCallback` (function)
-: The function to launch when the SDK successfully records a session.
+`sessionSuccessCallback` (function): The function to launch when the SDK successfully records a session.
@@ -169,8 +165,7 @@ import SessionFailureCallback from "@flutter-examples/AdjustConfig/sessionFailur
-`sessionFailureCallback` (function)
-: The function to launch when the SDK fails to record a session.
+`sessionFailureCallback` (function): The function to launch when the SDK fails to record a session.
@@ -200,8 +195,7 @@ import EventSuccessCallback from "@flutter-examples/AdjustConfig/eventSuccessCal
-`eventSuccessCallback` (function)
-: The function to launch when the SDK successfully records an event.
+`eventSuccessCallback` (function): The function to launch when the SDK successfully records an event.
@@ -231,8 +225,7 @@ import EventFailureCallback from "@flutter-examples/AdjustConfig/eventFailureCal
-`eventFailureCallback` (function)
-: The function to launch when the SDK fails to record an event.
+`eventFailureCallback` (function): The function to launch when the SDK fails to record an event.
@@ -268,8 +261,7 @@ import DelayStart from "@flutter-examples/AdjustConfig/delayStart.mdx"
-`delayStart` (num)
-: The time (in seconds) to delay the start of the SDK by.
+`delayStart` (num): The time (in seconds) to delay the start of the SDK by.
@@ -299,8 +291,7 @@ import ExternalDeviceId from "@flutter-examples/AdjustConfig/externalDeviceId.md
-`externalDeviceId` (String)
-: The external device ID associated with the device.
+`externalDeviceId` (String): The external device ID associated with the device.
@@ -330,8 +321,7 @@ import EventBufferingEnabled from "@flutter-examples/AdjustConfig/eventBuffering
-`eventBufferingEnabled` (bool)
-: Whether event buffering is enabled.
+`eventBufferingEnabled` (bool): Whether event buffering is enabled.
@@ -361,8 +351,7 @@ import NeedsCost from "@flutter-examples/AdjustConfig/needsCost.mdx"
-`needsCost` (bool)
-: Whether the SDK should gather cost data
+`needsCost` (bool): Whether the SDK should gather cost data
@@ -392,8 +381,7 @@ import AttributionCallback from "@flutter-examples/AdjustConfig/attributionCallb
-`attributionCallback` (function)
-: The delegate function that the SDK calls when the user's attribution information changes.
+`attributionCallback` (function): The delegate function that the SDK calls when the user's attribution information changes.
@@ -423,8 +411,7 @@ import PreinstallTrackingEnabled from "@flutter-examples/AdjustConfig/preinstall
-`preinstallTrackingEnabled` (bool)
-: Whether preinstall tracking is enabled.
+`preinstallTrackingEnabled` (bool): Whether preinstall tracking is enabled.
@@ -484,8 +471,7 @@ import DeferredDeeplinkCallback from "@flutter-examples/AdjustConfig/deferredDee
-`launchDeferredDeepLink` (bool)
-: Whether to enable launching deferred deep links.
+`launchDeferredDeepLink` (bool): Whether to enable launching deferred deep links.
@@ -515,8 +501,7 @@ import LinkMeEnabled from "@flutter-examples/AdjustConfig/linkMeEnabled.mdx"
-`linkMeEnabled` (bool)
-: Whether to enable LinkMe.
+`linkMeEnabled` (bool): Whether to enable LinkMe.
@@ -546,8 +531,7 @@ import ConversionValueUpdatedCallback from "@flutter-examples/AdjustConfig/conve
-`conversionValueUpdatedCallback` (function)
-: The delegate function the SDK launches when the conversion value updates
+`conversionValueUpdatedCallback` (function): The delegate function the SDK launches when the conversion value updates
diff --git a/src/content/docs/sdk/flutter/reference/adjustevent.mdx b/src/content/docs/sdk/flutter/reference/adjustevent.mdx
index 77f4631d8..ed3f0352b 100644
--- a/src/content/docs/sdk/flutter/reference/adjustevent.mdx
+++ b/src/content/docs/sdk/flutter/reference/adjustevent.mdx
@@ -7,7 +7,7 @@ slug: en/sdk/flutter/reference/adjustevent
import TrackEvent from "@flutter-signatures/Adjust/trackEvent.mdx"
-This class contains information about events triggered in your application. You can send this information to Adjust's servers by passing an `AdjustEvent` object to the `trackEvent` method || .
+This class contains information about events triggered in your application. You can send this information to Adjust's servers by passing an `AdjustEvent` object to the `trackEvent` method.
@@ -33,8 +33,7 @@ import Constructor from "@flutter-examples/AdjustEvent/constructor.mdx"
-`eventToken` (String)
-: A 6 character Adjust event token.
+`eventToken` (String): A 6 character Adjust event token.
@@ -64,11 +63,9 @@ import SetRevenue from "@flutter-examples/AdjustEvent/setRevenue.mdx"
-`amount` (double)
-: The amount of currency units associated with the event.
+`amount` (double): The amount of currency units associated with the event.
-`currency` (String)
-: The 3 character [ISO 4217 code](https://www.iban.com/currency-codes) of the currency unit.
+`currency` (String): The 3 character [ISO 4217 code](https://www.iban.com/currency-codes) of the currency unit.
@@ -98,8 +95,7 @@ import TransactionId from "@flutter-examples/AdjustEvent/transactionId.mdx"
-`transactionId` (String)
-: A unique identifier used to deduplicate events.
+`transactionId` (String): A unique identifier used to deduplicate events.
@@ -129,8 +125,7 @@ import CallbackId from "@flutter-examples/AdjustEvent/callbackId.mdx"
-`callbackId` (String)
-: A custom identifier for your event object.
+`callbackId` (String): A custom identifier for your event object.
@@ -160,11 +155,9 @@ import AddCallbackParameter from "@flutter-examples/AdjustEvent/addCallbackParam
-`key` (String)
-: The data key.
+`key` (String): The data key.
-`value` (String)
-: The data value.
+`value` (String): The data value.
@@ -194,11 +187,9 @@ import AddPartnerParameter from "@flutter-examples/AdjustEvent/addPartnerParamet
-`key` (String)
-: The data key.
+`key` (String): The data key.
-`value` (String)
-: The data value.
+`value` (String): The data value.
diff --git a/src/content/docs/sdk/flutter/reference/adjustplaystoresubscription.mdx b/src/content/docs/sdk/flutter/reference/adjustplaystoresubscription.mdx
index a56daa1d0..c7ebe51fe 100644
--- a/src/content/docs/sdk/flutter/reference/adjustplaystoresubscription.mdx
+++ b/src/content/docs/sdk/flutter/reference/adjustplaystoresubscription.mdx
@@ -7,7 +7,7 @@ slug: en/sdk/flutter/reference/adjustplaystoresubscription
import TrackPlayStoreSubscription from "@flutter-signatures/Adjust/trackPlayStoreSubscription.mdx"
-Use this class to store Play Store subscription information. You can pass this to Adjust's servers using the `trackPlayStoreSubscription` method || .
+Use this class to store Play Store subscription information. You can pass this to Adjust's servers using the `trackPlayStoreSubscription` method.
@@ -33,23 +33,17 @@ import Constructor from "@flutter-examples/AdjustPlayStoreSubscription/construct
-`price` (String)
-: The price of the subscription.
+`price` (String): The price of the subscription.
-`currency` (String)
-: The currency of the subscription. Formatted as the [`currencyCode`](https://developer.apple.com/documentation/foundation/nslocale/1642836-currencycode?language=objc) of the [`priceLocale`](https://developer.apple.com/documentation/storekit/skproduct/1506145-pricelocale?language=objc) object
+`currency` (String): The currency of the subscription. Formatted as the [`currencyCode`](https://developer.apple.com/documentation/foundation/nslocale/1642836-currencycode?language=objc) of the [`priceLocale`](https://developer.apple.com/documentation/storekit/skproduct/1506145-pricelocale?language=objc) object
-`sku` (String)
-: The ID of the product.
+`sku` (String): The ID of the product.
-`orderId` (String)
-: Your ID for the transaction.
+`orderId` (String): Your ID for the transaction.
-`signature` (String)
-: The signature of the purchase data.
+`signature` (String): The signature of the purchase data.
-`purchaseToken` (String)
-: The unique token of the transaction. See [Google's documentation](https://developer.android.com/reference/com/android/billingclient/api/Purchase#getPurchaseToken()) for more information.
+`purchaseToken` (String): The unique token of the transaction. See [Google's documentation](https://developer.android.com/reference/com/android/billingclient/api/Purchase#getPurchaseToken()) for more information.
@@ -79,8 +73,7 @@ import SetPurchaseTime from "@flutter-examples/AdjustPlayStoreSubscription/setPu
-`purchaseTime` (String)
-: The date on which the subscription was purchased.
+`purchaseTime` (String): The date on which the subscription was purchased.
@@ -111,11 +104,9 @@ import AddCallbackParameter from "@flutter-examples/AdjustPlayStoreSubscription/
-`key` (String)
-: The data key.
+`key` (String): The data key.
-`value` (String)
-: The data value.
+`value` (String): The data value.
@@ -145,11 +136,9 @@ import AddPartnerParameter from "@flutter-examples/AdjustPlayStoreSubscription/a
-`key` (String)
-: The data key.
+`key` (String): The data key.
-`value` (String)
-: The data value.
+`value` (String): The data value.
diff --git a/src/content/docs/sdk/flutter/reference/adjustthirdpartysharing.mdx b/src/content/docs/sdk/flutter/reference/adjustthirdpartysharing.mdx
index 2949c5806..02e0b2c9b 100644
--- a/src/content/docs/sdk/flutter/reference/adjustthirdpartysharing.mdx
+++ b/src/content/docs/sdk/flutter/reference/adjustthirdpartysharing.mdx
@@ -7,7 +7,7 @@ slug: en/sdk/flutter/reference/adjustthirdpartysharing
import TrackThirdPartySharing from "@flutter-signatures/Adjust/trackThirdPartySharing.mdx"
-Use this class to communicate a user's third party sharing preferences. Send this information to Adjust's servers using the `trackThirdPartySharing` method || .
+Use this class to communicate a user's third party sharing preferences. Send this information to Adjust's servers using the `trackThirdPartySharing` method.
@@ -33,8 +33,7 @@ import InitTrue from "@flutter-examples/AdjustThirdPartySharing/constructor_true
-`isEnabled` (bool)
-: Whether third party sharing is enabled.
+`isEnabled` (bool): Whether third party sharing is enabled.
@@ -66,20 +65,13 @@ import Facebook from "@flutter-examples/AdjustThirdPartySharing/addGranularOptio
-
-
-- - Parameter
- - Description
-- - `partner_name`
- - Use `facebook` to toggle LDU.
-- - `data_processing_options_country`
- - The user is located in.
- - `0`: Request that Facebook use geolocation.
- - `1`: United States of America.
-- - `data_processing_options_state`
- - Notifies Facebook which state the user is located in.
- - `0`: Request that Facebook use geolocation.
- - `1000`: California.
+
+
+| Parameter | Description |
+| --------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
+| `partner_name` | Use `facebook` to toggle LDU. |
+| `data_processing_options_country` | The country in which the user is located.- `0`: Request that Facebook use geolocation.
- `1`: United States of America.
|
+| `data_processing_options_state` | Notifies Facebook in which state the user is located.- `0`: Request that Facebook use geolocation.
- `1000`: California.
|
@@ -87,14 +79,11 @@ import Facebook from "@flutter-examples/AdjustThirdPartySharing/addGranularOptio
-`partnerName` (String)
-: The name of the partner you want to share information with.
+`partnerName` (String): The name of the partner you want to share information with.
-`key` (String)
-: The data key.
+`key` (String): The data key.
-`value` (String)
-: The data value.
+`value` (String): The data value.
@@ -124,14 +113,11 @@ import AddPartnerSharingSetting from "@flutter-examples/AdjustThirdPartySharing/
-`partnerName` (String)
-: The name of the partner whose settings you want to update. See the table of available partners below.
+`partnerName` (String): The name of the partner whose settings you want to update. See the table of available partners below.
-`key` (String)
-: The setting you want to update.
+`key` (String): The setting you want to update.
-`value` (bool)
-: Whether the setting is enabled.
+`value` (bool): Whether the setting is enabled.
diff --git a/src/content/docs/sdk/ios/configuration/att.mdx b/src/content/docs/sdk/ios/configuration/att.mdx
index 61ebce46f..a2efc4a6a 100644
--- a/src/content/docs/sdk/ios/configuration/att.mdx
+++ b/src/content/docs/sdk/ios/configuration/att.mdx
@@ -10,7 +10,7 @@ import AppTrackingAuthorizationStatusSig from "@ios-signatures/Adjust/appTrackin
import CheckForNewAttStatus from "@ios-examples/Adjust/checkForNewAttStatus.mdx"
import CheckForNewAttStatusSig from "@ios-signatures/Adjust/checkForNewAttStatus.mdx"
-If you want to record the device's IDFA (ID for Advertisers), you must display a prompt to get your user's authorization. To do this, you need to include Apple's ATT (App Tracking Transparency) framework in your app. The Adjust SDK stores the user's authorization status and sends it to Adjust's servers with each request.
+If you want to record the device's IDFA (ID for Advertisers), you must display a prompt to get your user's authorization. To do this, you need to include Apple's ATT (App Tracking Transparency) framework in your app. The Adjust SDK stores the user's authorization status and sends it to Adjust's servers with each request.
## Authorization statuses
@@ -27,7 +27,7 @@ If you want to record the device's IDFA (ID for Advertisers), you m
-You might receive a status code of `-1` if the SDK is unable to retrieve the ATT (App Tracking Transparency) status.
+You might receive a status code of `-1` if the SDK is unable to retrieve the ATT (App Tracking Transparency) status.
@@ -49,12 +49,12 @@ The Adjust SDK also records the consent status if you use a custom prompt. If yo
## Get current authorization status
-You can retrieve a user's current authorization status at any time. Call the `appTrackingAuthorizationStatus` method || to return the authorization status code as an **integer**.
+You can retrieve a user's current authorization status at any time. Call the `appTrackingAuthorizationStatus` method to return the authorization status code as an **integer**.
## Check for authorization status changes
-If you use a custom ATT prompt, you need to inform the Adjust SDK of changes to the user's authorization status. Call the `checkForNewAttStatus` method || to send the authorization status to Adjust's servers.
+If you use a custom ATT prompt, you need to inform the Adjust SDK of changes to the user's authorization status. Call the `checkForNewAttStatus` method to send the authorization status to Adjust's servers.
diff --git a/src/content/docs/sdk/ios/configuration/background.mdx b/src/content/docs/sdk/ios/configuration/background.mdx
index 74ad6ec94..74ab62859 100644
--- a/src/content/docs/sdk/ios/configuration/background.mdx
+++ b/src/content/docs/sdk/ios/configuration/background.mdx
@@ -9,7 +9,7 @@ import SetSendInBackground from "@ios-examples/ADJConfig/sendInBackground.mdx"
By default, the Adjust SDK pauses the sending of requests when your app is running in the background. You can configure the SDK to send requests in the background by enabling the background recording feature.
-Your config object contains a boolean `sendInBackground` property that controls this behavior. You can set this property by calling the `setSendInBackground` method || on your config instance with a boolean value.
+Your config object contains a boolean `sendInBackground` property that controls this behavior. You can set this property by calling the `setSendInBackground` method on your config instance with a boolean value.
diff --git a/src/content/docs/sdk/ios/configuration/deep-links/data-points.mdx b/src/content/docs/sdk/ios/configuration/deep-links/data-points.mdx
index ca7f59e8b..24122fffb 100644
--- a/src/content/docs/sdk/ios/configuration/deep-links/data-points.mdx
+++ b/src/content/docs/sdk/ios/configuration/deep-links/data-points.mdx
@@ -30,8 +30,8 @@ The ID is formatted as `.`. For example: `ABC1234567.c
To find your App ID Prefix and Bundle ID, follow these steps:
1. Log in to the [Apple Developer portal](https://developer.apple.com/account/).
-2. Select Certificates, IDs & Profiles from the left-hand menu.
-3. Select Identifiers from the left-hand menu.
+2. Select **Certificates, IDs & Profiles** from the left-hand menu.
+3. Select **Identifiers** from the left-hand menu.
4. Find your app and select it to open the edit page.
5. Your App ID Prefix and Bundle ID are displayed at the top of the page. Copy the relevant information and store it somewhere for later use.
@@ -41,9 +41,9 @@ If you're using a different bundle ID for your debug build, you can find its ID
1. Open your app project in Xcode.
2. Select your project from the left-hand menu.
-3. Select your app under Targets.
-4. Select Signing & Capabilities from the top menu.
-5. Select Debug from the sub menu that appears.
+3. Select your app under **Targets**.
+4. Select **Signing & Capabilities** from the top menu.
+5. Select **Debug** from the sub menu that appears.
6. Your Bundle ID is shown. Copy this information and store it somewhere for later use.
### Custom URL schemes
@@ -58,24 +58,24 @@ To retrieve your Custom URL Scheme, follow these steps:
1. Open your app project in Xcode.
2. Select your project from the left-hand menu.
-3. Select your app under Targets.
-4. Select Info from the top menu.
-5. Expand the URL Types section and get the custom URL scheme. If the URL Schemes field contains a build setting (for example: `$(CUSTOM_URL_SCHEME)`), go to the build settings to retrieve the custom URL scheme values:
- 1. Select Build Settings from the menu at the top.
+3. Select your app under **Targets**.
+4. Select **Info** from the top menu.
+5. Expand the **URL Types** section and get the custom URL scheme. If the URL Schemes field contains a build setting (for example: `$(CUSTOM_URL_SCHEME)`), go to the build settings to retrieve the custom URL scheme values:
+ 1. Select **Build Settings** from the menu at the top.
2. Find the setting named in the URL Schemes field and retrieve both the release and debug values.
If your iOS app doesn't have a custom URL scheme yet, follow these steps to set a custom URL scheme:
1. Open your app project in Xcode.
2. Select your project from the left-hand menu.
-3. Select your app under Targets.
-4. Select Info from the top menu.
-5. Expand the URL Types section.
-6. Select the Add option () to add a new URL type.
+3. Select your app under **Targets**.
+4. Select **Info** from the top menu.
+5. Expand the **URL Types** section.
+6. Select the Add option to add a new URL type.
7. Fill in the following information to create a URL scheme:
- * Identifier: `$(PRODUCT_BUNDLE_IDENTIFIER)`
- * URL Schemes: your custom URL scheme. This must be unique. Don't use protected schemes such as `http`, `https`, or `mailto`
- * Role: Editor
+ * **Identifier**: `$(PRODUCT_BUNDLE_IDENTIFIER)`
+ * **URL Schemes**: your custom URL scheme. This must be unique. Don't use protected schemes such as `http`, `https`, or `mailto`
+ * **Role**: Editor
This scheme will work for your production **and** debug builds.
diff --git a/src/content/docs/sdk/ios/configuration/deep-links/deep-link.mdx b/src/content/docs/sdk/ios/configuration/deep-links/deep-link.mdx
index 17bd91dc0..b196c0fde 100644
--- a/src/content/docs/sdk/ios/configuration/deep-links/deep-link.mdx
+++ b/src/content/docs/sdk/ios/configuration/deep-links/deep-link.mdx
@@ -22,18 +22,18 @@ You can enter only one Bundle ID per app. If you are testing an app with a Debug
Once you have gathered your setup data, you can add this to your app in Adjust. Adding the information to your app enables you to add deep links to your campaigns. To set up universal links, follow these steps:
-1. Go to AppView and select your app.
-2. Ensure the iOS bundle ID is present.
-3. Under Device type, choose your app's default device:
+1. Go to **AppView** and select your app.
+2. Ensure the **iOS bundle ID** is present.
+3. Under **Device type**, choose your app's default device:
* Universal - iPhone and iPad
* iPhone
* iPad
-4. Under Universal linking, turn on Enable universal linking to enable universal links for your app.
- * Enter the App ID prefix.
- * Enter the App scheme.
-5. (Optional) Turn on Redirect all clicks to a custom URL and enter a Custom URL, if you want your users to go to a custom website instead of the App Store. This is recommended if your app doesn't have an App ID.
-6. (Optional) Turn on Send data to App Store Connect and enter the Apple provider ID to send data to App Store Connect App Analytics.
-7. Select Save.
+4. Under **Universal linking**, turn on Enable universal linking to enable universal links for your app.
+ * Enter the **App ID prefix**.
+ * Enter the **App scheme**.
+5. (Optional) Turn on **Redirect all clicks to a custom URL** and enter a **Custom URL**, if you want your users to go to a custom website instead of the App Store. This is recommended if your app doesn't have an App ID.
+6. (Optional) Turn on **Send data to App Store Connect** and enter the **Apple provider ID** to send data to App Store Connect App Analytics.
+7. Select **Save**.
## Set up deep links with a custom URL scheme
diff --git a/src/content/docs/sdk/ios/configuration/deep-links/deferred.mdx b/src/content/docs/sdk/ios/configuration/deep-links/deferred.mdx
index ca1d4ef0f..0441e225e 100644
--- a/src/content/docs/sdk/ios/configuration/deep-links/deferred.mdx
+++ b/src/content/docs/sdk/ios/configuration/deep-links/deferred.mdx
@@ -147,6 +147,6 @@ The Adjust SDK checks the pasteboard when a user opens the app for the first tim
When a user clicks on a LinkMe URL they have the option to copy the link information to their system pasteboard. You can use the Adjust SDK to read the system pasteboard for deep link information. If deep link information is present, the Adjust SDK forwards the user to the correct page in your app.
-To enable pasteboard checking in your app, pass a **true** value to the `setLinkMeEnabled` method || on your `ADJConfig` object:
+To enable pasteboard checking in your app, pass a **true** value to the `setLinkMeEnabled` method on your `ADJConfig` object:
diff --git a/src/content/docs/sdk/ios/configuration/deep-links/direct.mdx b/src/content/docs/sdk/ios/configuration/deep-links/direct.mdx
index c0b4b18aa..a47f81cae 100644
--- a/src/content/docs/sdk/ios/configuration/deep-links/direct.mdx
+++ b/src/content/docs/sdk/ios/configuration/deep-links/direct.mdx
@@ -17,11 +17,11 @@ To enable deep linking, you need to do the following:
To get started, you need to enable Associated Domains in your Apple Developer account. This allows you to set universal link domains in your app. To do this, follow these steps:
1. Log in to your [Apple Developer account](https://developer.apple.com/account/).
-2. Select Certificates, IDs & Profiles in the left-hand menu.
-3. Select Identifiers in the left-hand menu.
+2. Select **Certificates, IDs & Profiles** in the left-hand menu.
+3. Select **Identifiers** in the left-hand menu.
4. Find your app and select it to open the edit page.
-5. Ensure that Associated Domains is checked under Capabilities.
-6. Select Save to save your changes.
+5. Ensure that **Associated Domains** is checked under **Capabilities**.
+6. Select **Save** to save your changes.
## Configure deep links in Xcode
@@ -31,11 +31,11 @@ Follow these steps to add your deep link configuration to your Xcode project.
1. Open your app project in Xcode.
2. Select your project from the left-hand menu.
-3. Select your app under Targets.
-4. Select Signing & Capabilities from the top menu.
-5. Ensure that All is selected in the submenu below.
-6. Select the Add option (+) to add a capability.
-7. Select Associated Domains.
+3. Select your app under **Targets**.
+4. Select **Signing & Capabilities** from the top menu.
+5. Ensure that **All** is selected in the submenu below.
+6. Select the Add option (**+**) to add a capability.
+7. Select **Associated Domains**.
8. Enter the Adjust Universal Link domain with the prefix `applinks:`
- Here is an example using the `example.adj.st` domain: `applinks:example.adj.st`.
@@ -49,15 +49,15 @@ Check with your marketing team to see if a custom URL scheme is needed for the a
1. Open your app project in Xcode.
2. Select your project from the left-hand menu.
-3. Select your app under Targets.
-4. Select Info from the top menu.
-5. Expand the URL Types section.
-6. Select the Add option (+) to add a URL type.
+3. Select your app under **Targets**.
+4. Select **Info** from the top menu.
+5. Expand the **URL Types** section.
+6. Select the Add option (**+**) to add a URL type.
7. Fill in the following information to create a URL scheme:
- - Identifier: `$(PRODUCT_BUNDLE_IDENTIFIER)`
- - URL Schemes: Your custom URL scheme. This must be
+ - **Identifier**: `$(PRODUCT_BUNDLE_IDENTIFIER)`
+ - **URL Schemes**: Your custom URL scheme. This must be
unique. Don't use protected schemes such as `http`, `https`, or `mailto`.
- - Role: Editor
+ - **Role**: Editor
This scheme will work for your production **and** debug builds.
diff --git a/src/content/docs/sdk/ios/configuration/deep-links/index.mdx b/src/content/docs/sdk/ios/configuration/deep-links/index.mdx
index 2b8ee5ed6..4816a88da 100644
--- a/src/content/docs/sdk/ios/configuration/deep-links/index.mdx
+++ b/src/content/docs/sdk/ios/configuration/deep-links/index.mdx
@@ -5,14 +5,12 @@ category-title: Deep linking
slug: en/sdk/ios/configuration/deep-links
---
-Deep links are URIs (Uniform Resource Identifiers) that direct users to a specific page in your app without any additional navigation. You can use them throughout your marketing funnel to improve user acquisition, engagement, and retention.
+Deep links are URIs (Uniform Resource Identifiers) that direct users to a specific page in your app without any additional navigation. You can use them throughout your marketing funnel to improve user acquisition, engagement, and retention.
The Adjust SDK uses different logic depending on whether the user already has your app installed on their device:
-Direct deep linking
-: Occurs if the user already has your app installed. The link takes the user to the page specified in the link
+Direct deep linking: Occurs if the user already has your app installed. The link takes the user to the page specified in the link
-Deferred deep linking
-: Occurs if the user doesn't have your app installed. The link takes the user to a storefront to install your app first. After the user installs the app, it opens to the page specified in the link.
+Deferred deep linking: Occurs if the user doesn't have your app installed. The link takes the user to a storefront to install your app first. After the user installs the app, it opens to the page specified in the link.
To get started, follow these steps.
diff --git a/src/content/docs/sdk/ios/configuration/deep-links/resolution.mdx b/src/content/docs/sdk/ios/configuration/deep-links/resolution.mdx
index 0fa4fa70a..a6cf5513b 100644
--- a/src/content/docs/sdk/ios/configuration/deep-links/resolution.mdx
+++ b/src/content/docs/sdk/ios/configuration/deep-links/resolution.mdx
@@ -23,7 +23,7 @@ Link resolution is only applicable when users that have your app installed click
This is how link resolution works:
1. When an existing user clicks a redirect link, iOS opens your app.
-2. Your app passes the redirect URL to the `resolveLinkWithUrl` link resolution method || in the Adjust SDK.
+2. Your app passes the redirect URL to the `resolveLinkWithUrl` link resolution method in the Adjust SDK.
3. The link resolution method in the Adjust SDK compares the domain in the redirect URL against the link resolution domain that the developer has set in the Adjust SDK, and one of the following happens:
- Domains don't match - The method forwards the deep link URL as is.
@@ -31,7 +31,7 @@ This is how link resolution works:
The Adjust SDK will follow up to ten redirects when attempting to resolve a URL. If there are more than ten redirects, the SDK will return the tenth redirect URL.
-4. Your app receives the returned URL and opens deep link content and displays it to the user. Your app also calls the `appWillOpenUrl` method || in the Adjust SDK with the returned URL. This sends the resolved URL to Adjust's servers to be recorded.
+4. Your app receives the returned URL and opens deep link content and displays it to the user. Your app also calls the `appWillOpenUrl` method in the Adjust SDK with the returned URL. This sends the resolved URL to Adjust's servers to be recorded.
@@ -50,20 +50,11 @@ Link resolution is applicable for the following cases:
When email marketers run campaigns, the email marketing platform typically wraps all links in the emails with its own click tracking redirect URL. This lets email marketers view click-through statistics in the email marketing platform. However, if the emails contain universal links, the redirect URL causes iOS to not resolve the universal links.
-Email marketing platform
-: The software that email marketers use to build their campaigns. This includes functionality such as email templates and audience targeting.
-: **Examples:** Braze, Iterable, SendGrid
+Email marketing platform: The software that email marketers use to build their campaigns. This includes functionality such as email templates and audience targeting.: **Examples:** Braze, Iterable, SendGrid
-Email service provider (ESP)
-: The underlying infrastructure that sends emails, and manages deliverability to ISP (Internet service provider) emails servers.
-: **Examples:** SendGrid, SparkPost.
+Email service provider (ESP): The underlying infrastructure that sends emails, and manages deliverability to ISP (Internet service provider) emails servers.: **Examples:** SendGrid, SparkPost.
-Email partner
-: A general term that refers to either an email marketing platform or an email service provider (ESP).
-: An email partner can be an email marketing platform or an ESP, or both.
-: **Example:** SendGrid is an email marketing platform and an ESP.
-: An email marketing may use another partner as an ESP.
-: **Example:** Braze and Iterable both use SendGrid and SparkPost as their ESPs.
+Email partner: A general term that refers to either an email marketing platform or an email service provider (ESP).: An email partner can be an email marketing platform or an ESP, or both.: **Example:** SendGrid is an email marketing platform and an ESP.: An email marketing may use another partner as an ESP.: **Example:** Braze and Iterable both use SendGrid and SparkPost as their ESPs.
#### Setup
@@ -71,12 +62,12 @@ Email partner
**Example:** `email.example.com`
-2. Add the email redirect domain to your Associated Domains configuration in Xcode.
+2. Add the email redirect domain to your **Associated Domains** configuration in Xcode.
**Example:** `applinks:email.example.com`
3. Set up your universal links.
-4. Ensure that you've added your email redirect domain to `resolveUrlSuffixArray` of the `resolveLinkWithUrl` link resolution method || .
+4. Ensure that you've added your email redirect domain to `resolveUrlSuffixArray` of the `resolveLinkWithUrl` link resolution method.
5. Configure your email redirect domain as a custom tracking domain with your email marketing platform / ESP.
6. Set up a content delivery network (CDN), such as Amazon CloudFront, CloudFlare, or Fastly, to handle incoming requests to your email redirect domain. On the CDN, you need to set up the following:
@@ -126,7 +117,7 @@ To use link resolution, your email partner needs to let you to set up the redire
7. The link resolution method returns the resolved URL.
8. Your app handles the returned URL. In this case, your app would display the `summer-clothes` page in your app with a `beach promo` modal to the user.
-9. Your app calls the `appWillOpenUrl` method || in the Adjust SDK with the returned URL.
+9. Your app calls the `appWillOpenUrl` method in the Adjust SDK with the returned URL.
### URL shorteners
@@ -137,12 +128,12 @@ When marketers run certain types of campaigns, sometimes a short URL is required
1. Create a domain or subdomain on your domain dedicated as a URL shortener.
If you already have a domain or subdomain as a URL shortener, you should create a new one so that you can complete this implementation without disrupting existing campaigns. After you complete and test this implementation, you can switch this implementation to your existing URL shortener domain.
-2. Add the URL shortener domain to your Associated Domains configuration in Xcode.
+2. Add the URL shortener domain to your **Associated Domains** configuration in Xcode.
**Example:** `applinks:short.example.com`
3. Set up your universal links.
-4. Ensure that you have added your email redirect domain to `resolveUrlSuffixArray` of the `resolveLinkWithUrl` link resolution method || .
+4. Ensure that you have added your email redirect domain to `resolveUrlSuffixArray` of the `resolveLinkWithUrl` link resolution method.
5. Set up a URL shortener service that supports universal links. Adjust doesn't provide any URL shortening services.
**Example:** [`short.io`](http://short.io)
@@ -170,4 +161,4 @@ When marketers run certain types of campaigns, sometimes a short URL is required
8. The link resolution method returns the resolved URL.
9. Your app handles the returned URL. In this case, your app would display the `summer-clothes` page in your app with a `beach promo` modal to the user.
-10. Your app calls the `appWillOpenUrl` method || in the Adjust SDK with the returned URL.
+10. Your app calls the `appWillOpenUrl` method in the Adjust SDK with the returned URL.
diff --git a/src/content/docs/sdk/ios/configuration/deep-links/testing.mdx b/src/content/docs/sdk/ios/configuration/deep-links/testing.mdx
index 5adf64f41..f15511e8a 100644
--- a/src/content/docs/sdk/ios/configuration/deep-links/testing.mdx
+++ b/src/content/docs/sdk/ios/configuration/deep-links/testing.mdx
@@ -29,16 +29,16 @@ To test your deep link implementation, you need to create a test link. To do thi
1. Log in to the Adjust dashboard.
2. Locate your app in the app overview page.
-3. Select the caret () at the bottom of the app card.
-4. Select All Settings. A sidebar menu opens.
-5. Select Trackers in the sidebar menu.
-6. Select NEW TRACKER.
-7. Enter a TRACKER NAME of your choice.
-8. Select --none-- in the NETWORK menu.
-9. Select CUSTOMIZE to open the customization menu.
-10. Select Attribution Settings.
-11. Set Probabilistic Matching to ON under the Click-based Attribution section.
-12. Select APPLY.
+3. Select the caret at the bottom of the app card.
+4. Select **All Settings**. A sidebar menu opens.
+5. Select **Trackers** in the sidebar menu.
+6. Select **NEW TRACKER**.
+7. Enter a **TRACKER NAME** of your choice.
+8. Select **--none--** in the **NETWORK** menu.
+9. Select **CUSTOMIZE** to open the customization menu.
+10. Select **Attribution Settings**.
+11. Set **Probabilistic Matching** to **ON** under the **Click-based Attribution** section.
+12. Select **APPLY**.
You need to append the link token to the deep link that you received from your marketing team.
@@ -62,29 +62,29 @@ iOS doesn't open universal links as deep links if you enter them directly into y
To check your universal link domain configuration, follow these steps.
1. On your iOS test device, paste your universal link in Apple Notes.
-2. In Apple Notes, long press on the universal link to open an iOS menu. If you see the Open in your app option, iOS was able to make the connection between your app and the domain.
+2. In Apple Notes, long press on the universal link to open an iOS menu. If you see the **Open in your app** option, iOS was able to make the connection between your app and the domain.
If this option doesn't appear, check the following issues.
### Adjust universal links
* Check your marketing team has enabled Adjust universal links in the Adjust dashboard.
-* Check the Associated Domains configuration in Xcode.
+* Check the **Associated Domains** configuration in Xcode.
* The `applinks: prefix` must be present.
The domain in Xcode must match the Adjust Universal Link domain that your marketing team created in the Adjust dashboard.
* Check if the following values in your app match with the values in the Adjust dashboard:
- * App ID prefix
- * Bundle ID: Verify whether you are using the bundle ID of the debug build or release build.
- * Universal link domain: Verify whether you are using the universal link domain of the debug build or release build. The universal link domain in the app needs to match with the branded link in the Adjust dashboard.
+ * **App ID prefix**
+ * **Bundle ID**: Verify whether you are using the bundle ID of the debug build or release build.
+ * **Universal link domain**: Verify whether you are using the universal link domain of the debug build or release build. The universal link domain in the app needs to match with the branded link in the Adjust dashboard.
### Email redirect and URL shortener universal links
* Check the Associated Domains configuration in Xcode.
* The `applinks: prefix` must be present.
* The domain in Xcode must match the email redirect domain or URL shortener domain configured in the partner’s system.
-* Check if the following values in your app match with the values in the AASA (Apple-App-Site-Association) file for the email redirect domain or URL shortener domain in the partner’s system:
- * App ID prefix
- * Bundle ID: Verify whether you are using the bundle ID of the debug build or release build.
+* Check if the following values in your app match with the values in the AASA (Apple-App-Site-Association) file for the email redirect domain or URL shortener domain in the partner’s system:
+ * **App ID prefix**
+ * **Bundle ID**: Verify whether you are using the bundle ID of the debug build or release build.
* Email redirect domain / URL shortener domain - Verify whether you have configured the domain as a custom domain in the email partner's system.
### Test direct deep linking in the app
@@ -123,7 +123,7 @@ If you don't see these entries in your Xcode logs, ensure the following:
* You have set the environment to `sandbox` and logging to `verbose` in the Adjust SDK.
* Verbose logging is indicated by `[Adjust]v` in your Xcode logs.
-* Your app calls the `appWillOpenUrl` method || in the method that receives the deep link.
+* Your app calls the `appWillOpenUrl` method in the method that receives the deep link.
#### App running in background
@@ -139,7 +139,7 @@ The app should display the deep link content. If you don't see the correct page
* **App doesn't use scenes**: `application(_:continue:restorationHandler:)` method
* **App uses scenes**: `scene(_:continue:)` method
-After selecting the deep link, your app calls the `appWillOpenUrl` method || in the Adjust SDK, and you should see entries similar to the following in your Xcode logs:
+After selecting the deep link, your app calls the `appWillOpenUrl` method in the Adjust SDK, and you should see entries similar to the following in your Xcode logs:
```text
2022-09-28 09:19:30.873598+0900 example[1619:241845] [Adjust]d: Added sdk_click 1
@@ -154,7 +154,7 @@ If you don't see these entries in your Xcode logs, ensure the following:
* You have set the environment to `sandbox` and logging to `verbose` in the Adjust SDK.
* Verbose logging is indicated by `[Adjust]v` in your Xcode logs.
-* Your app calls the `appWillOpenUrl` method || in the method that receives the deep link.
+* Your app calls the `appWillOpenUrl` method in the method that receives the deep link.
## Test direct deep linking with a custom URL scheme
@@ -175,7 +175,7 @@ If you don't see the correct page in the app, check the following:
* **App uses scenes**: `scene(_:continue:)` method
* Check if other content in your code is interfering with the deep link.
-After selecting the deep link, your app calls the `appWillOpenUrl` method || in the Adjust SDK, and you should see entries similar to the following in your Xcode logs:
+After selecting the deep link, your app calls the `appWillOpenUrl` method in the Adjust SDK, and you should see entries similar to the following in your Xcode logs:
```text
2022-09-28 09:19:30.873598+0900 example[1619:241845] [Adjust]d: Added sdk_click 1
@@ -190,21 +190,21 @@ If you don't see these entries in your Xcode logs, ensure the following:
* You have set the environment to `sandbox` and `logging` to verbose in the Adjust SDK.
* Verbose logging is indicated by `[Adjust]v` in your Xcode logs.
-* Your app calls the `appWillOpenUrl` method || in the method that receives the deep link.
+* Your app calls the `appWillOpenUrl` method in the method that receives the deep link.
## Test deferred deep linking
To test deferred deep linking on the test device, follow these steps.
1. Install your app.
-2. Retrieve the ADID (Adjust device identifier) from your Xcode logs. Example:
+2. Retrieve the ADID (Adjust device identifier) from your Xcode logs. Example:
```text '"adid":"4446ab34861b99b78ee374c3bd38a350"'
2022-09-28 09:19:35.609913+0900 example[1619:241847] [Adjust]v: Response: {"app_token":"2eb2na2w54c3","adid":"4446ab34861b99b78ee374c3bd38a350","timestamp":"2022-09-28T00:19:35.841Z+0000","message":"Attribution found","attribution":{"tracker_token":"abc123","tracker_name":"Organic","network":"Organic"}}
```
3. Uninstall your app.
-4. Open the [Testing Console](https://help.adjust.com/en/article/testing-console), enter the Adjust ADID and select View Device Data. You should see the `TrackerName` as `Organic`.
+4. Open the [Testing Console](https://help.adjust.com/en/article/testing-console), enter the Adjust ADID and select **View Device Data**. You should see the `TrackerName` as `Organic`.
5. Forget your device in the testing console.
6. Paste your universal link or custom URL scheme deep link in Apple Notes.
7. Select the deep link. This should redirect you to the App Store.
@@ -215,6 +215,6 @@ If you don't see the correct page in the app, check the following:
* Check if other content in your code is interfering with the deep link. For example: If your app has onboarding screens or requires user login, but your app doesn't already handle this before opening the deep link. You might have to implement the `adjustDeeplinkResponse` method to handle onboarding screens or user login before handling the deep link.
* Your app code isn't handling the incoming deep link in the `adjustDeeplinkResponse` method.
-* Adjust didn't attribute your install to the click. In the Testing Console, select View Device Data. The `TrackerName` field should display your test link. Before you start your test, ensure the following:
+* Adjust didn't attribute your install to the click. In the Testing Console, select **View Device Data**. The `TrackerName` field should display your test link. Before you start your test, ensure the following:
* Probabilistic matching was enabled on your test link.
* In the Testing Console, the `TrackerName` was set to `Organic`.
diff --git a/src/content/docs/sdk/ios/configuration/delay.mdx b/src/content/docs/sdk/ios/configuration/delay.mdx
index 25e8775d3..0381177f5 100644
--- a/src/content/docs/sdk/ios/configuration/delay.mdx
+++ b/src/content/docs/sdk/ios/configuration/delay.mdx
@@ -17,7 +17,7 @@ The offline mode setting isn't remembered between sessions. Offline mode is disa
The Adjust SDK sends event and session data to Adjust's servers in real time. You can pause the sending of information by putting the SDK in offline mode. In offline mode the SDK stores all data in a local file on the device. The SDK sends this information to Adjust's servers when you disable offline mode.
-Your config object contains a boolean `isOffline` property that controls this behavior. You can update this property at any time by calling the `setOfflineMode` method || with a boolean argument. The SDK sends all saved information to Adjust's servers when you deactivate offline mode.
+Your config object contains a boolean `isOffline` property that controls this behavior. You can update this property at any time by calling the `setOfflineMode` method with a boolean argument. The SDK sends all saved information to Adjust's servers when you deactivate offline mode.
@@ -25,6 +25,6 @@ Your config object contains a boolean `isOffline` property that controls this be
The Adjust SDK sends event information as soon as a user triggers an event in your app. You can send event information on a schedule by enabling event buffering. Event buffering stores events in a local buffer on the device and sends all requests once per minute.
-Your config object contains a boolean `eventBufferingEnabled` property that controls this behavior. You can set this property by calling the `setEventBufferingEnabled` method || on your config object with a boolean argument.
+Your config object contains a boolean `eventBufferingEnabled` property that controls this behavior. You can set this property by calling the `setEventBufferingEnabled` method on your config object with a boolean argument.
diff --git a/src/content/docs/sdk/ios/configuration/disable.mdx b/src/content/docs/sdk/ios/configuration/disable.mdx
index 9078461df..8d0393783 100644
--- a/src/content/docs/sdk/ios/configuration/disable.mdx
+++ b/src/content/docs/sdk/ios/configuration/disable.mdx
@@ -11,7 +11,7 @@ import IsEnabledSig from "@ios-signatures/Adjust/isEnabled.mdx"
The Adjust SDK runs by default when your app is open. You can disable and re-enable the Adjust SDK to pause and resume recording. When you disable the Adjust SDK, it doesn't send any data to Adjust's servers.
-You can enable or disable the SDK at any time by calling the `setEnabled` method || with a boolean argument.
+You can enable or disable the SDK at any time by calling the `setEnabled` method with a boolean argument.
@@ -23,7 +23,7 @@ You can only call this method after the first session. This setting persists bet
## Check enabled status
-You can check if the Adjust SDK is enabled at any time by calling the `isEnabled` method || . This method returns a boolean value.
+You can check if the Adjust SDK is enabled at any time by calling the `isEnabled` method. This method returns a boolean value.
diff --git a/src/content/docs/sdk/ios/configuration/external-device-id.mdx b/src/content/docs/sdk/ios/configuration/external-device-id.mdx
index 5a3e4f5de..8e8e3668f 100644
--- a/src/content/docs/sdk/ios/configuration/external-device-id.mdx
+++ b/src/content/docs/sdk/ios/configuration/external-device-id.mdx
@@ -17,7 +17,7 @@ See the [External device identifiers article](https://help.adjust.com/en/article
-Your config object contains a **string** `externalDeviceId` property that you can use to store your external device ID. You can set property calling the `setExternalDeviceId` method || with your ID as an argument.
+Your config object contains a **string** `externalDeviceId` property that you can use to store your external device ID. You can set property calling the `setExternalDeviceId` method with your ID as an argument.
diff --git a/src/content/docs/sdk/ios/configuration/log-level.mdx b/src/content/docs/sdk/ios/configuration/log-level.mdx
index 746511304..3b0eac4bb 100644
--- a/src/content/docs/sdk/ios/configuration/log-level.mdx
+++ b/src/content/docs/sdk/ios/configuration/log-level.mdx
@@ -23,6 +23,6 @@ The Adjust SDK provides configurable log levels to return different amounts of i
-You can set your log level by calling the `setLogLevel` method || on your `ADJConfig` instance.
+You can set your log level by calling the `setLogLevel` method on your `ADJConfig` instance.
diff --git a/src/content/docs/sdk/ios/configuration/preinstalled.mdx b/src/content/docs/sdk/ios/configuration/preinstalled.mdx
index bf6c8316c..7840b41e0 100644
--- a/src/content/docs/sdk/ios/configuration/preinstalled.mdx
+++ b/src/content/docs/sdk/ios/configuration/preinstalled.mdx
@@ -17,7 +17,7 @@ Configuring a default campaign enables you to attribute all preinstalls to a pre
https://app.adjust.com/{token}
```
-2. Copy this token and pass it to the `setDefaultTracker` method || in your app delegate file.
+2. Copy this token and pass it to the `setDefaultTracker` method in your app delegate file.
diff --git a/src/content/docs/sdk/ios/configuration/privacy.mdx b/src/content/docs/sdk/ios/configuration/privacy.mdx
index ea576fa99..7fa4e8e8f 100644
--- a/src/content/docs/sdk/ios/configuration/privacy.mdx
+++ b/src/content/docs/sdk/ios/configuration/privacy.mdx
@@ -25,9 +25,9 @@ The Adjust SDK contains features that you can use to handle user privacy in your
## GDPR right to be forgotten
-Article 17 of the European Union's GDPR (General Data Protection Regulation) grants users the right to be forgotten. When Adjust's servers receive an RTBF (Right to be Forgotten) request, Adjust erases the user's data. The SDK also stops sending requests from the device for the app in question.
+Article 17 of the European Union's GDPR (General Data Protection Regulation) grants users the right to be forgotten. When Adjust's servers receive an RTBF (Right to be Forgotten) request, Adjust erases the user's data. The SDK also stops sending requests from the device for the app in question.
-You can send the user's RTBF request to Adjust by calling the `gdprForgetMe` method || .
+You can send the user's RTBF request to Adjust by calling the `gdprForgetMe` method.
@@ -37,7 +37,7 @@ You can use the Adjust SDK to record when a user changes their third-party shari
### Disable third-party sharing
-Some users may want to opt-out of sharing their data with third-parties. To communicate this to Adjust, call the `trackThirdPartySharing` method || with an [`ADJThirdPartySharing` object](/en/sdk/ios/reference/adjthirdpartysharing) initialized with a `false` value. When Adjust's servers receive this information, Adjust stops sharing the user's data with third-parties. The Adjust SDK continues to work as expected.
+Some users may want to opt-out of sharing their data with third-parties. To communicate this to Adjust, call the `trackThirdPartySharing` method with an [`ADJThirdPartySharing` object](/en/sdk/ios/reference/adjthirdpartysharing) initialized with a `false` value. When Adjust's servers receive this information, Adjust stops sharing the user's data with third-parties. The Adjust SDK continues to work as expected.
@@ -47,13 +47,13 @@ Some users may want to opt-out of sharing their data with third-parties. To comm
### Send granular information
-You can attach granular information when a user updates their third-party sharing preferences. Use this information to communicate more detail about a user's decision. To do this, call the `addGranularOption` method || with your partner name and your options.
+You can attach granular information when a user updates their third-party sharing preferences. Use this information to communicate more detail about a user's decision. To do this, call the `addGranularOption` method with your partner name and your options.
### Update partner settings
-You can use the Adjust SDK to update your third party sharing settings on a per-partner basis. To do this, call the `addPartnerSharingSetting` method || with your partner name and your options.
+You can use the Adjust SDK to update your third party sharing settings on a per-partner basis. To do this, call the `addPartnerSharingSetting` method with your partner name and your options.
@@ -65,9 +65,9 @@ The Adjust SDK sends information to Facebook as soon as the app is installed. Yo
-Facebook provides a feature called LDU (Limited Data Use) to comply with the CCPA (California Consumer Privacy Act). This feature enables you to notify Facebook when a California-based user is opted out of the sale of data. You can also use it if you want to opt all users out by default.
+Facebook provides a feature called LDU (Limited Data Use) to comply with the CCPA (California Consumer Privacy Act). This feature enables you to notify Facebook when a California-based user is opted out of the sale of data. You can also use it if you want to opt all users out by default.
-You can update the Facebook LDU status by passing arguments to the `addGranularOption` method || .
+You can update the Facebook LDU status by passing arguments to the `addGranularOption` method.
@@ -128,7 +128,7 @@ ADJThirdPartySharing *adjustThirdPartySharing = [[ADJThirdPartySharing alloc] in
## Disable third-party sharing
-To disable third-party sharing for all users, call the `disableThirdPartySharing` method || . When Adjust's servers receive this information, Adjust stops sharing the user's data with third-parties. The Adjust SDK continues to work as expected.
+To disable third-party sharing for all users, call the `disableThirdPartySharing` method. When Adjust's servers receive this information, Adjust stops sharing the user's data with third-parties. The Adjust SDK continues to work as expected.
@@ -136,7 +136,7 @@ To disable third-party sharing for all users, call the `disableThirdPar
The data residency feature allows you to choose the country in which Adjust stores your data. This is useful if you're operating in a country with strict privacy requirements. When you set up data residency, Adjust stores your data in a data center located in the region your have chosen.
-To set your country of data residency, call the `setUrlStrategy` method || on your `ADJConfig` instance.
+To set your country of data residency, call the `setUrlStrategy` method on your `ADJConfig` instance.
@@ -144,6 +144,6 @@ To set your country of data residency, call the `setUrlStrategy` method
If you are using [Data Privacy settings](https://help.adjust.com/en/article/manage-data-collection-and-retention) in your Adjust dashboard, you need to set up the Adjust SDK to work with them. This includes settings such as consent expiry period and user data retention period.
-To toggle this feature, call the `trackMeasurementConsent` method || . When enabled, the SDK communicates the data privacy settings to Adjust's servers. Adjust's servers then applies your data privacy rules to the user. The Adjust SDK continues to work as expected.
+To toggle this feature, call the `trackMeasurementConsent` method. When enabled, the SDK communicates the data privacy settings to Adjust's servers. Adjust's servers then applies your data privacy rules to the user. The Adjust SDK continues to work as expected.
diff --git a/src/content/docs/sdk/ios/configuration/push-tokens.mdx b/src/content/docs/sdk/ios/configuration/push-tokens.mdx
index 512e63107..4ad63b3f2 100644
--- a/src/content/docs/sdk/ios/configuration/push-tokens.mdx
+++ b/src/content/docs/sdk/ios/configuration/push-tokens.mdx
@@ -9,7 +9,7 @@ import SetDeviceTokenSig from "@ios-signatures/Adjust/setDeviceToken.mdx"
Push tokens are used for [Audience Builder](https://help.adjust.com/en/article/audience-builder) and client callbacks. They're also required for [Uninstall and reinstall tracking](https://help.adjust.com/en/article/uninstalls-reinstalls).
-Your config object contains a string `pushToken` property that you can use to store your push token. You can update this property at any time by calling the `setDeviceToken` method || inside the `didRegisterForRemoveNotificationsWithDeviceToken` method and passing your token as an argument.
+Your config object contains a string `pushToken` property that you can use to store your push token. You can update this property at any time by calling the `setDeviceToken` method inside the `didRegisterForRemoveNotificationsWithDeviceToken` method and passing your token as an argument.
diff --git a/src/content/docs/sdk/ios/configuration/skad.mdx b/src/content/docs/sdk/ios/configuration/skad.mdx
index 59b3e6800..0bf3b821c 100644
--- a/src/content/docs/sdk/ios/configuration/skad.mdx
+++ b/src/content/docs/sdk/ios/configuration/skad.mdx
@@ -4,10 +4,10 @@ description: Configure SKAdNetwork features for your iOS apps.
slug: en/sdk/ios/configuration/skad
---
-import DeactivateSKAdNetworkHandling from "@ios-examples/ADJConfig/deactivateSKAdNetworkHandling.mdx"
-import DeactivateSKAdNetworkHandlingSig from "@ios-signatures/ADJConfig/deactivateSKAdNetworkHandling.mdx"
-import UpdateConversionValue from "@ios-examples/Adjust/updateConversionValue.mdx"
-import UpdateConversionValueSig from "@ios-signatures/Adjust/updateConversionValue.mdx"
+import DeactivateSKAdNetworkHandling from "@ios-examples/ADJConfig/deactivateSKAdNetworkHandling.mdx";
+import DeactivateSKAdNetworkHandlingSig from "@ios-signatures/ADJConfig/deactivateSKAdNetworkHandling.mdx";
+import UpdateConversionValue from "@ios-examples/Adjust/updateConversionValue.mdx";
+import UpdateConversionValueSig from "@ios-signatures/Adjust/updateConversionValue.mdx";
@@ -15,7 +15,7 @@ This feature is only available on devices running iOS 14 and above.
-SKAdNetwork (StoreKit Ad Network) is Apple's attribution framework for app install and reinstall attribution. The SKAdNetwork workflow goes like this:
+SKAdNetwork (StoreKit Ad Network) is Apple's attribution framework for app install and reinstall attribution. The SKAdNetwork workflow goes like this:
1. Apple gathers attribution information and notifies the relevant ad network.
2. The network sends a postback with this information to Adjust.
@@ -25,11 +25,11 @@ This feature is only available on devices running iOS 14 and above.
The Adjust SDK communicates with SKAdNetwork by default on v4.23.0 and above. The SDK registers for SKAdNetwork attribution upon initialization.
-Your config object contains a boolean `isSKAdNetworkHandlingActive` property that controls this behavior. You can disable SKAdNetwork communication by calling the `deactivateSKAdNetworkHandling` method || with no argument.
+Your config object contains a boolean `isSKAdNetworkHandlingActive` property that controls this behavior. You can disable SKAdNetwork communication by calling the `deactivateSKAdNetworkHandling` method with no argument.
-You must call the `deactivateSKAdNetworkHandling` method *before* initializing the Adjust SDK.
+You must call the `deactivateSKAdNetworkHandling` method _before_ initializing the Adjust SDK.
@@ -39,7 +39,7 @@ You must call the `deactivateSKAdNetworkHandling` method *before* initializing t
Conversion values are a mechanism used to track user behavior in SKAdNetwork. You can map 64 conditions to values from 0 through 63 and send this integer value to SKAdNetwork on user install. This gives you insight into how your users interact with your app in the first few days.
-If you manage your conversion values with Adjust, the servers update this value in the SDK. You can also update this value by using the `updateConversionValue` method || . This method wraps [Apple's `updateConversionValue` method](https://developer.apple.com/documentation/storekit/skadnetwork/3566697-updateconversionvalue). It accepts an integer argument representing your updated conversion value.
+If you manage your conversion values with Adjust, the servers update this value in the SDK. You can also update this value by using the `updateConversionValue` method. This method wraps [Apple's `updateConversionValue` method](https://developer.apple.com/documentation/storekit/skadnetwork/3566697-updateconversionvalue). It accepts an integer argument representing your updated conversion value.
@@ -74,31 +74,19 @@ The Adjust SDK contains wrappers for Apple's `updatePostbackConversionValue` met
The following methods are supported:
-* [`updatePostbackConversionValue(_:completionHandler:)`](https://developer.apple.com/documentation/storekit/skadnetwork/3919928-updatepostbackconversionvalue): update conversion values and handle failures.
-* [`updatePostbackConversionValue(_:completionHandler:coarseValue:)`](https://developer.apple.com/documentation/storekit/skadnetwork/4090669-updatepostbackconversionvalue/) : update both fine and coarse conversion values and handle failures.
-updatePostbackConversionValue
-* [`updatePostbackConversionValue(_:coarseValue:lockWindow:completionHandler:)`](https://developer.apple.com/documentation/storekit/skadnetwork/4097267-updatepostbackconversionvalue): update both fine and coarse conversion values, determine whether to send the postback before the end of the conversion value window, and handle errors.
-
-
-
-* - Argument
- - Data type
- - Description
-* - `fineValue`
- - Integer
- - Your conversion value. Must be between 0 and 63
-* - `coarseValue`
- - [`SKAdNetwork.CoarseConversionValue`](https://developer.apple.com/documentation/storekit/skadnetwork/coarseconversionvalue)
- - The coarse conversion value. This value is used if your app doesn't have sufficient installs to reach the privacy threshold.
- * `SKAdNetworkCoarseConversionValueLow`
- * `SKAdNetworkCoarseConversionValueMedium`
- * `SKAdNetworkCoarseConversionValueHigh`
-* - `lockWindow`
- - Boolean
- - Whether to send the postback before the conversion window ends. Use `true` to tell the system to send the postback without waiting for the end of the conversion window. Defaults to `false`.
-* - `completion`
- - Function
- - An optional completion handler you provide to catch and handle any errors this method encounters when you update a conversion value. Set this value to `nil` if you don’t provide a handler.
+- [`updatePostbackConversionValue(_:completionHandler:)`](https://developer.apple.com/documentation/storekit/skadnetwork/3919928-updatepostbackconversionvalue): update conversion values and handle failures.
+- [`updatePostbackConversionValue(_:completionHandler:coarseValue:)`](https://developer.apple.com/documentation/storekit/skadnetwork/4090669-updatepostbackconversionvalue/) : update both fine and coarse conversion values and handle failures.
+ updatePostbackConversionValue
+- [`updatePostbackConversionValue(_:coarseValue:lockWindow:completionHandler:)`](https://developer.apple.com/documentation/storekit/skadnetwork/4097267-updatepostbackconversionvalue): update both fine and coarse conversion values, determine whether to send the postback before the end of the conversion value window, and handle errors.
+
+
+
+| Argument | Data type | Description |
+| ------------- | --------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `fineValue` | Integer | Your conversion value. Must be between `0` and `63`. |
+| `coarseValue` | [`SKAdNetwork.CoarseConversionValue`](https://developer.apple.com/documentation/storekit/skadnetwork/coarseconversionvalue) | The coarse conversion value. This value is used if your app doesn't have sufficient installs to reach the privacy threshold.- `SKAdNetworkCoarseConversionValueLow`
- `SKAdNetworkCoarseConversionValueMedium`
- `SKAdNetworkCoarseConversionValueHigh`
|
+| `lockWindow` | Boolean | Whether to send the postback before the conversion window ends.
Use `true` to tell the system to send the postback without waiting for the end of the conversion window. Defaults to `false`. |
+| `completion` | Function | An optional completion handler you provide to catch and handle any errors this method encounters when you update a conversion value.
Set this value to `nil` if you don’t provide a handler. |
@@ -145,8 +133,8 @@ If you use Adjust to manage conversion values, the Adjust's servers send convers
This example shows how to log the following when the conversion value updates:
-* A message confirming the conversion value update
-* The new conversion value
+- A message confirming the conversion value update
+- The new conversion value
@@ -173,23 +161,13 @@ func adjustConversionValueUpdated(_ conversionValue: NSNumber?) {
SKAdNetwork 4.0 postbacks contain some additional information to give advertisers more insight into their users. When Adjust's servers update conversion values, this additional information is sent in a payload. You can access this information with the `adjustConversionValueUpdated` callback method.
-
-
-* - Arguments
- - Data type
- - Description
-* - `fineValue`
- - Integer
- - The conversion value sent by Adjust's servers
-* - `coarseValue`
- - String
- - The coarse conversion value. This value is used if your app doesn't have sufficient installs to reach the privacy threshold. Accepted values:
- * `low`
- * `medium`
- * `high`
-* - `lockWindow`
- - Integer
- - Whether to send the postback before the conversion window ends. `1` indicates the postback will be sent before the conversion window ends. Defaults to `0` in SKAdNetwork 4.0 postbacks and `nil` in older SKAdNetwork versions
+
+
+| Arguments | Data type | Description |
+| ------------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `fineValue` | Integer | The conversion value sent by Adjust's servers |
+| `coarseValue` | String | The coarse conversion value. This value is used if your app doesn't have sufficient installs to reach the privacy threshold. |
+| `lockWindow` | Integer | Whether to send the postback before the conversion window ends. `1` indicates the postback will be sent before the conversion window ends.
Defaults to `0` in SKAdNetwork 4.0 postbacks and `nil` in older SKAdNetwork versions |
@@ -234,10 +212,10 @@ You can configure your app to send a copy of winning SKAdNetwork callbacks to Ad
To set up direct install postbacks, you need to add the Adjust callback URL to your `Info.plist` file:
-1. Select Info.plist in the Project navigator in Xcode.
-2. Select the Add button () beside a key in the property list editor and press `Return`.
+1. Select **Info.plist** in the Project navigator in Xcode.
+2. Select the Add button beside a key in the property list editor and press `Return`.
3. Enter _`NSAdvertisingAttributionReportEndpoint`_ as the key name.
-4. Set the Type to **String** in the pop up menu.
+4. Set the **Type** to **String** in the pop up menu.
5. Enter the address _`https://adjust-skadnetwork.com`_.
diff --git a/src/content/docs/sdk/ios/features/ad-revenue.mdx b/src/content/docs/sdk/ios/features/ad-revenue.mdx
index dbc620a0e..0a1178bc1 100644
--- a/src/content/docs/sdk/ios/features/ad-revenue.mdx
+++ b/src/content/docs/sdk/ios/features/ad-revenue.mdx
@@ -32,7 +32,7 @@ You need to perform some extra setup steps in your Adjust dashboard to measure a
To send ad revenue to Adjust:
1. Create a new Adjust ad revenue instance and pass your ad revenue source as an argument.
-2. Call the `trackAdRevenue` method || with your ad revenue instance as an argument.
+2. Call the `trackAdRevenue` method with your ad revenue instance as an argument.
@@ -58,13 +58,11 @@ To send ad revenue to Adjust:
You can record ad revenue by setting the `revenue` and `currency` properties on your ad revenue instance.
-To set these properties, call the `setRevenue` method || and pass the following arguments:
+To set these properties, call the `setRevenue` method and pass the following arguments:
-`revenue` **number**
-: The amount of revenue
+`revenue` **number**: The amount of revenue
-`currency` **string**
-: The 3 character [ISO 4217 code](https://www.iban.com/currency-codes) of your reporting currency
+`currency` **string**: The 3 character [ISO 4217 code](https://www.iban.com/currency-codes) of your reporting currency
@@ -80,25 +78,25 @@ The ad revenue object contains properties you can use to report on your ad campa
### Ad impressions
-Record the number of ad impressions by passing an **integer** value to the `setAdImpressionsCount` method || .
+Record the number of ad impressions by passing an **integer** value to the `setAdImpressionsCount` method.
### Ad revenue network
-Record which network generated the revenue by passing a **string** value to the `setAdRevenueNetwork` method || .
+Record which network generated the revenue by passing a **string** value to the `setAdRevenueNetwork` method.
### Ad revenue unit
-Record which ad revenue unit generated the revenue by passing a **string** value to the `setAdRevenueUnit` method || .
+Record which ad revenue unit generated the revenue by passing a **string** value to the `setAdRevenueUnit` method.
### Ad revenue placement
-Record the placement of your ad by passing a **string** value to the `setAdRevenuePlacement` method || .
+Record the placement of your ad by passing a **string** value to the `setAdRevenuePlacement` method.
@@ -108,7 +106,7 @@ If you [register a callback URL](https://help.adjust.com/en/article/recommended-
You can configure callback parameters to your servers. Once you configure parameters on an event, the SDK appends them to your [callback URL](https://help.adjust.com/en/article/raw-data-exports). You can use this information to analyze your users' in-app behavior with your BI system.
-Add callback parameters to your event by calling the `addCallbackParameter` method || with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
+Add callback parameters to your event by calling the `addCallbackParameter` method with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
The Adjust SDK measures the event and sends a request to your URL with the callback parameters. For example, if you register the URL `https://www.mydomain.com/callback`, your callback looks like this:
@@ -146,7 +144,7 @@ Partner parameters don't appear in raw data by default. You can add the `{partne
-Add partner parameters to your event by calling the `addPartnerParameter` method || with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
+Add partner parameters to your event by calling the `addPartnerParameter` method with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
diff --git a/src/content/docs/sdk/ios/features/attribution.mdx b/src/content/docs/sdk/ios/features/attribution.mdx
index 26c9eb9ce..9c3b26b42 100644
--- a/src/content/docs/sdk/ios/features/attribution.mdx
+++ b/src/content/docs/sdk/ios/features/attribution.mdx
@@ -63,7 +63,7 @@ Within your delegate function, you have access to the user's `Attribution` infor
## Get current attribution information
-When a user installs your app, Adjust attributes the install to a campaign. The Adjust SDK gives you access to campaign attribution details for your install. To return this information, call the `attribution` method || .
+When a user installs your app, Adjust attributes the install to a campaign. The Adjust SDK gives you access to campaign attribution details for your install. To return this information, call the `attribution` method.
This method returns an Attribution object. See the [`ADJAttribution` class reference](/en/sdk/ios/reference/adjattribution) for a list of available properties.
diff --git a/src/content/docs/sdk/ios/features/device-info.mdx b/src/content/docs/sdk/ios/features/device-info.mdx
index e30746827..9d1072422 100644
--- a/src/content/docs/sdk/ios/features/device-info.mdx
+++ b/src/content/docs/sdk/ios/features/device-info.mdx
@@ -13,12 +13,12 @@ The Adjust SDK contains helper methods that return device information. Use these
## ID For Advertisers
-The IDFA (ID for Advertisers) is a device-specific identifier for Apple devices. Call the `idfa` method || to return this ID as a **string**.
+The IDFA (ID for Advertisers) is a device-specific identifier for Apple devices. Call the `idfa` method to return this ID as a **string**.
## Adjust device identifier
-Adjust generates a unique ADID (Adjust Device ID) for each device. Call the `adid` method || to return this ID as a **string**.
+Adjust generates a unique ADID (Adjust Device ID) for each device. Call the `adid` method to return this ID as a **string**.
diff --git a/src/content/docs/sdk/ios/features/events.mdx b/src/content/docs/sdk/ios/features/events.mdx
index c1114257a..0c2a0bfcb 100644
--- a/src/content/docs/sdk/ios/features/events.mdx
+++ b/src/content/docs/sdk/ios/features/events.mdx
@@ -18,7 +18,7 @@ import AddPartnerParameterSig from "@ios-signatures/ADJEvent/addPartnerParameter
You can associate your [Adjust event tokens](https://help.adjust.com/en/article/add-events#add-event) to actions in your app to record them. To record an event:
* Create a new Adjust event instance and pass your event token as a string argument.
-* Call the `trackEvent` method || with your event instance as an argument.
+* Call the `trackEvent` method with your event instance as an argument.
@@ -146,13 +146,11 @@ Parameters:
You can record revenue associated with an event by setting the revenue and currency properties on your event instance. Use this feature to record revenue-generating actions in your app.
-To set these properties, call the `setRevenue` method || and pass the following arguments:
+To set these properties, call the `setRevenue` method and pass the following arguments:
-`revenue` (**number**)
-: The amount of revenue generated by the event
+`revenue` (**number**): The amount of revenue generated by the event
-`currency` (**string**)
-: The [ISO 4217 code](https://www.iban.com/currency-codes) of the event currency.
+`currency` (**string**): The [ISO 4217 code](https://www.iban.com/currency-codes) of the event currency.
@@ -262,14 +260,11 @@ If you've enabled [purchase verification](https://help.adjust.com/en/article/pur
-`transactionId` (NSString)
-: The [`transactionIdentifier` value](https://developer.apple.com/documentation/storekit/skpaymenttransaction/1411288-transactionidentifier) of the successfully completed purchase
+`transactionId` (NSString): The [`transactionIdentifier` value](https://developer.apple.com/documentation/storekit/skpaymenttransaction/1411288-transactionidentifier) of the successfully completed purchase
-`productId` (NSString)
-: The product identifier of the item that was successfully purchased
+`productId` (NSString): The product identifier of the item that was successfully purchased
-`receipt` (NSData)
-: The [signed receipt](https://developer.apple.com/documentation/foundation/bundle/1407276-appstorereceipturl) containing the information about the successfully completed purchase
+`receipt` (NSData): The [signed receipt](https://developer.apple.com/documentation/foundation/bundle/1407276-appstorereceipturl) containing the information about the successfully completed purchase
@@ -309,7 +304,7 @@ If you [register a callback URL](https://help.adjust.com/en/article/set-up-callb
You can configure callback parameters to send to your servers. Once you configure parameters on an event, the SDK appends them to your [callback URL](https://help.adjust.com/en/article/raw-data-exports). You can use this information to analyze your users' in-app behavior with your BI system.
-Add callback parameters to your event by calling the `addCallbackParameter` method || with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
+Add callback parameters to your event by calling the `addCallbackParameter` method with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
@@ -451,7 +446,7 @@ Partner parameters don't appear in raw data by default. You can add the `{partne
-Add partner parameters to your event by calling the `addPartnerParameter` method || with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
+Add partner parameters to your event by calling the `addPartnerParameter` method with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
@@ -556,7 +551,7 @@ Parameters:
You can add a custom string identifier to each event you want to measure. Adjust's servers can report on this identifier in event callbacks. This enables you to keep track of which events have been successfully measured.
-Set up this identifier by calling the `setCallbackId` method || with your ID as a **string** argument.
+Set up this identifier by calling the `setCallbackId` method with your ID as a **string** argument.
diff --git a/src/content/docs/sdk/ios/features/session-parameters.mdx b/src/content/docs/sdk/ios/features/session-parameters.mdx
index a2de6ed06..05ce365c1 100644
--- a/src/content/docs/sdk/ios/features/session-parameters.mdx
+++ b/src/content/docs/sdk/ios/features/session-parameters.mdx
@@ -31,15 +31,15 @@ The Adjust SDK merges session callback parameters with event callback parameters
-Add callback parameters to your event by calling the `addSessionCallbackParameter` method || with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
+Add callback parameters to your event by calling the `addSessionCallbackParameter` method with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
-You can remove specific session callback parameters if they're no longer required. To do this, pass the parameter key to the `removeSessionCallbackParameter` method || .
+You can remove specific session callback parameters if they're no longer required. To do this, pass the parameter key to the `removeSessionCallbackParameter` method.
-You can remove all session parameters if they're no longer required. To do this, call the `resetSessionCallbackParameters` method || .
+You can remove all session parameters if they're no longer required. To do this, call the `resetSessionCallbackParameters` method.
@@ -55,15 +55,15 @@ Partner parameters don't appear in raw data by default. You can add the `{partne
-Add partner parameters to your event by calling the `addSessionPartnerParameter` method || with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
+Add partner parameters to your event by calling the `addSessionPartnerParameter` method with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
-You can remove specific session partner parameters if they're no longer required. To do this, pass the parameter key to the `removeSessionPartnerParameter` method || .
+You can remove specific session partner parameters if they're no longer required. To do this, pass the parameter key to the `removeSessionPartnerParameter` method.
-You can remove all session partner parameters if they're no longer required. To do this, call the `resetSessionPartnerParameters` method || .
+You can remove all session partner parameters if they're no longer required. To do this, call the `resetSessionPartnerParameters` method.
@@ -75,10 +75,10 @@ You can delay the startup of the SDK by up to **10 seconds**.
-The Adjust SDK starts as soon as your app opens. If you want to send data that's not available at launch in session parameters, you can delay the start of the SDK. To do this, pass the delay time in seconds to the `setDelayStart` method || on your config object.
+The Adjust SDK starts as soon as your app opens. If you want to send data that's not available at launch in session parameters, you can delay the start of the SDK. To do this, pass the delay time in seconds to the `setDelayStart` method on your config object.
-After this time has elapsed, the SDK sends the information to Adjust's servers. You can send the information before the timeout by calling the `sendFirstPackages` method || .
+After this time has elapsed, the SDK sends the information to Adjust's servers. You can send the information before the timeout by calling the `sendFirstPackages` method.
diff --git a/src/content/docs/sdk/ios/features/subscriptions.mdx b/src/content/docs/sdk/ios/features/subscriptions.mdx
index 1c5e34d8d..157abb3d1 100644
--- a/src/content/docs/sdk/ios/features/subscriptions.mdx
+++ b/src/content/docs/sdk/ios/features/subscriptions.mdx
@@ -27,36 +27,36 @@ You can record App Store subscriptions and verify their validity with the Adjust
## 1. Set up your subscription object
-To get started, you need to create a subscription object containing details of the subscription purchase. To do this, initialize an `ADJSubscription` object using the `initWithPrice` method || .
+To get started, you need to create a subscription object containing details of the subscription purchase. To do this, initialize an `ADJSubscription` object using the `initWithPrice` method.
### Record the purchase date
-You can record the date on which the user purchased a subscription. The SDK returns this data for you to report on. Call the `setTransactionDate` method || with a timestamp to record this information.
+You can record the date on which the user purchased a subscription. The SDK returns this data for you to report on. Call the `setTransactionDate` method with a timestamp to record this information.
### Record the purchase region
-You can record the region in which the user purchased a subscription. To do this, call the `setSalesRegion` method || on your subscription object and pass the country code as a **string**. This needs to be formatted as the [`countryCode`](https://developer.apple.com/documentation/foundation/nslocale/1643060-countrycode?language=swift) of the [`priceLocale`](https://developer.apple.com/documentation/storekit/skproduct/1506145-pricelocale?language=swift) object.
+You can record the region in which the user purchased a subscription. To do this, call the `setSalesRegion` method on your subscription object and pass the country code as a **string**. This needs to be formatted as the [`countryCode`](https://developer.apple.com/documentation/foundation/nslocale/1643060-countrycode?language=swift) of the [`priceLocale`](https://developer.apple.com/documentation/storekit/skproduct/1506145-pricelocale?language=swift) object.
### Add callback parameters
-You can add callback parameters to your subscription object. The SDK appends these parameters to your callback URL. To add callback parameters, call the `addCallbackParameter` method || on your subscription object. You can add multiple callback parameters by calling this method multiple times.
+You can add callback parameters to your subscription object. The SDK appends these parameters to your callback URL. To add callback parameters, call the `addCallbackParameter` method on your subscription object. You can add multiple callback parameters by calling this method multiple times.
### Add partner parameters
-You can add partner parameters to your subscription object. The SDK sends these to Adjust's servers when the user purchases a subscription. Adjust's servers forward the information on to your network partner. To add partner parameters, call the `addPartnerParameter` method || on your subscription object. You can add multiple partner parameters by calling this method multiple times.
+You can add partner parameters to your subscription object. The SDK sends these to Adjust's servers when the user purchases a subscription. Adjust's servers forward the information on to your network partner. To add partner parameters, call the `addPartnerParameter` method on your subscription object. You can add multiple partner parameters by calling this method multiple times.
## 2. Send subscription information
-Once you have set up your subscription object, you can send it to Adjust using the Adjust SDK. Pass your completed object to the `trackSubscription` method || to record the user's subscription purchase.
+Once you have set up your subscription object, you can send it to Adjust using the Adjust SDK. Pass your completed object to the `trackSubscription` method to record the user's subscription purchase.
diff --git a/src/content/docs/sdk/ios/index.mdx b/src/content/docs/sdk/ios/index.mdx
index 08bb0353a..80056d18b 100644
--- a/src/content/docs/sdk/ios/index.mdx
+++ b/src/content/docs/sdk/ios/index.mdx
@@ -13,9 +13,9 @@ To use the Adjust SDK in your iOS app, you need to add it to your Xcode project.
To add the SDK using Swift's package manager:
-1. Select File --> Swift Packages --> Add Package Dependency
+1. Select **File --> Swift Packages --> Add Package Dependency**
2. In the box that appears, enter the SDK's GitHub address: `https://github.com/adjust/ios_sdk`
-3. Select the version of the Adjust SDK you want to use in the Version dropdown. Check the [releases page](https://github.com/adjust/ios_sdk/releases) for the latest version.
+3. Select the version of the Adjust SDK you want to use in the **Version** dropdown. Check the [releases page](https://github.com/adjust/ios_sdk/releases) for the latest version.
### Alternative installation methods
@@ -257,11 +257,9 @@ The Adjust SDK depends on frameworks to access certain device information. To en
To initialize the Adjust SDK, you need to create a config object. This object contains configuration options that control how the Adjust SDK behaves. Pass the following arguments for a minimal setup:
-`appToken`
-: Your [app's token](https://help.adjust.com/en/article/app-settings#view-your-app-token).
+`appToken`: Your [app's token](https://help.adjust.com/en/article/app-settings#view-your-app-token).
-`environment`
-: The environment you want to run the SDK in. Set this to `ADJEnvironmentSandbox`.
+`environment`: The environment you want to run the SDK in. Set this to `ADJEnvironmentSandbox`.
To initialize the Adjust SDK with this config object:
diff --git a/src/content/docs/sdk/ios/plugins/criteo.mdx b/src/content/docs/sdk/ios/plugins/criteo.mdx
index fb96e16b2..420584427 100644
--- a/src/content/docs/sdk/ios/plugins/criteo.mdx
+++ b/src/content/docs/sdk/ios/plugins/criteo.mdx
@@ -39,7 +39,7 @@ You can also integrate adjust with Criteo events by following these steps:
1. Locate the plugin/Criteo folder inside the downloaded archive from the releases page.
2. Drag the `ADJCriteo.h` and `ADJCriteo.m` files into the Adjust folder inside your project.
-3. In the dialog choose options for adding these files. Make sure to check the checkbox to Copy items if needed and select the radio button to Create groups.
+3. In the dialog choose options for adding these files. Make sure to check the checkbox to **Copy items** if needed and select the radio button to **Create groups**.
## Work with Criteo events
diff --git a/src/content/docs/sdk/ios/plugins/facebook-pixel.mdx b/src/content/docs/sdk/ios/plugins/facebook-pixel.mdx
index f4066551d..0ed0dd193 100644
--- a/src/content/docs/sdk/ios/plugins/facebook-pixel.mdx
+++ b/src/content/docs/sdk/ios/plugins/facebook-pixel.mdx
@@ -20,7 +20,7 @@ To start working with Facebook pixels, follow the steps below:
As described in [Facebook's iOS SDK guide](https://developers.facebook.com/docs/ios/getting-started/#xcode) you will need to add your Facebook App ID to the app by doing the following:
-1. In Xcode, right click on your project's `Info.plist` file and select Open As --> Source Code.
+1. In Xcode, right click on your project's `Info.plist` file and select **Open As --> Source Code**.
2. Insert the following XML snippet into the body of your file just before the final `` element:
```xml
@@ -46,7 +46,7 @@ Follow Facebook's guide on how to integrate the Facebook pixel. The Javascript c
```
-Next, update your Facebook pixel code. You can find the instructions in the [Hybrid Mobile App Events guide](https://developers.facebook.com/docs/app-events/hybrid-app-events) under Update Your Pixel.
+Next, update your Facebook pixel code. You can find the instructions in the [Hybrid Mobile App Events guide](https://developers.facebook.com/docs/app-events/hybrid-app-events) under **Update Your Pixel**.
```js
fbq('init', );
diff --git a/src/content/docs/sdk/ios/plugins/sociomatic.mdx b/src/content/docs/sdk/ios/plugins/sociomatic.mdx
index d59b362fa..fc7a1c16a 100644
--- a/src/content/docs/sdk/ios/plugins/sociomatic.mdx
+++ b/src/content/docs/sdk/ios/plugins/sociomatic.mdx
@@ -39,7 +39,7 @@ You can add the Adjust Sociomantic plugin to your project manually by doing the
1. Locate the `plugin/Sociomantic` folder inside the archive you downloaded from the [release page](https://github.com/adjust/ios_sdk/releases).
2. Drag the `ADJSociomantic.h` and `ADJSociomantic.m` files into the Adjust folder inside your project.
-3. When the Choose options for adding these files dialog appears, check the Copy items if needed checkbox and select the radio button to Create groups.
+3. When the **Choose options for adding these files** dialog appears, check the **Copy items if needed** checkbox and select the radio button to **Create groups**.
## Sociomantic events
diff --git a/src/content/docs/sdk/ios/plugins/trademob.mdx b/src/content/docs/sdk/ios/plugins/trademob.mdx
index ba63aca62..9d356efc9 100644
--- a/src/content/docs/sdk/ios/plugins/trademob.mdx
+++ b/src/content/docs/sdk/ios/plugins/trademob.mdx
@@ -45,7 +45,7 @@ You can add the Adjust Trademob plugin to your project manually by doing the fol
1. Locate the `plugin/Trademob` folder inside the archive you downloaded from the [release page](https://github.com/adjust/ios_sdk/releases).
2. Drag the {file}`ADJTrademob.h` and `ADJTrademob.m` files into the Adjust folder inside your project.
-3. When the Choose options for adding these files dialog appears, check the Copy items if needed checkbox and select the radio button to Create groups.
+3. When the **Choose options for adding these files** dialog appears, check the **Copy items if needed** checkbox and select the radio button to **Create groups**.
## Trademob events
diff --git a/src/content/docs/sdk/ios/reference/adjadrevenue.mdx b/src/content/docs/sdk/ios/reference/adjadrevenue.mdx
index 9611691a6..ebd404a33 100644
--- a/src/content/docs/sdk/ios/reference/adjadrevenue.mdx
+++ b/src/content/docs/sdk/ios/reference/adjadrevenue.mdx
@@ -31,8 +31,7 @@ import Constructor from "@ios-examples/ADJAdRevenue/constructor.mdx";
-`source` (NSString)
-: The source of the ad revenue.
+`source` (NSString): The source of the ad revenue.
@@ -77,11 +76,9 @@ import SetRevenue from "@ios-examples/ADJAdRevenue/setRevenue.mdx"
-`amount` (double)
-: The amount of currency units associated with the ad.
+`amount` (double): The amount of currency units associated with the ad.
-`currency` (NSString)
-: The 3 character [ISO 4217 code](https://www.iban.com/currency-codes) of the currency unit.
+`currency` (NSString): The 3 character [ISO 4217 code](https://www.iban.com/currency-codes) of the currency unit.
@@ -111,8 +108,7 @@ import SetAdImpressionsCount from "@ios-examples/ADJAdRevenue/setAdImpressionsCo
-`adImpressionsCaount`
-: The number of impressions associated with the ad.
+`adImpressionsCaount`: The number of impressions associated with the ad.
@@ -142,8 +138,7 @@ import SetAdRevenueNetwork from "@ios-examples/ADJAdRevenue/setAdRevenueNetwork.
-`adRevenueNetwork` (NSString)
-: The network associated with the ad revenue.
+`adRevenueNetwork` (NSString): The network associated with the ad revenue.
@@ -173,8 +168,7 @@ import SetAdRevenueUnit from "@ios-examples/ADJAdRevenue/setAdRevenueUnit.mdx"
-`unit` (NSString)
-: The ad unit ID associated with the ad revenue.
+`unit` (NSString): The ad unit ID associated with the ad revenue.
@@ -204,8 +198,7 @@ import SetAdRevenuePlacement from "@ios-examples/ADJAdRevenue/setAdRevenuePlacem
-`adRevenuePlacement` (NSString)
-: The placement of the ad associated with the revenue.
+`adRevenuePlacement` (NSString): The placement of the ad associated with the revenue.
@@ -235,11 +228,9 @@ import AddCallbackParameter from "@ios-examples/ADJAdRevenue/addCallbackParamete
-`key` (NSString)
-: The data key.
+`key` (NSString): The data key.
-`value` (NSString)
-: The data value.
+`value` (NSString): The data value.
@@ -269,11 +260,9 @@ import AddPartnerParameter from "@ios-examples/ADJAdRevenue/addPartnerParameter.
-`key` (NSString)
-: The data key.
+`key` (NSString): The data key.
-`value` (NSString)
-: The data value.
+`value` (NSString): The data value.
diff --git a/src/content/docs/sdk/ios/reference/adjattribution.mdx b/src/content/docs/sdk/ios/reference/adjattribution.mdx
index 39257c206..1df41f7a5 100644
--- a/src/content/docs/sdk/ios/reference/adjattribution.mdx
+++ b/src/content/docs/sdk/ios/reference/adjattribution.mdx
@@ -12,11 +12,11 @@ The `ADJAttribution` class contains details about the current attribution status
## Properties
-The following properties can be accessed by calling the `attribution` method || . Any values that aren't populated for the user are returned as a null value.
+The following properties can be accessed by calling the `attribution` method. Any values that aren't populated for the user are returned as a null value.
-The following values can only be accessed if the `needsCost` property || on your `ADJConfig` instance is `true`:
+The following values can only be accessed if the `needsCost` property on your `ADJConfig` instance is `true`:
- `costType`
- `costAmount`
diff --git a/src/content/docs/sdk/ios/reference/adjconfig/index.mdx b/src/content/docs/sdk/ios/reference/adjconfig/index.mdx
index 2811037c4..1550a4111 100644
--- a/src/content/docs/sdk/ios/reference/adjconfig/index.mdx
+++ b/src/content/docs/sdk/ios/reference/adjconfig/index.mdx
@@ -37,23 +37,17 @@ import Constructor from "@ios-examples/ADJConfig/constructor.mdx"
-`appToken` (NSString)
-: Your Adjust app token.
+`appToken` (NSString): Your Adjust app token.
-`environment` (NSString)
-: The environment your app is running in. Available options:
-: - `ADJEnvironmentSandbox`
-: - `ADJEnvironmentProduction`
+`environment` (NSString): The environment your app is running in. Available options:: - `ADJEnvironmentSandbox`: - `ADJEnvironmentProduction`
-`allowSuppressLogLevel` (BOOL)
-: Whether to allow all logging to be suppressed.
+`allowSuppressLogLevel` (BOOL): Whether to allow all logging to be suppressed.
-`config` (ADJConfig)
-: A config object initialized with the provided params.
+`config` (ADJConfig): A config object initialized with the provided params.
diff --git a/src/content/docs/sdk/ios/reference/adjconfig/setup.mdx b/src/content/docs/sdk/ios/reference/adjconfig/setup.mdx
index d52fd513d..4b593e083 100644
--- a/src/content/docs/sdk/ios/reference/adjconfig/setup.mdx
+++ b/src/content/docs/sdk/ios/reference/adjconfig/setup.mdx
@@ -31,8 +31,7 @@ import SetLogLevel from "@ios-examples/ADJConfig/setLogLevel.mdx";
-`logLevel` (ADJLogLevel)
-: The level of logging output by the SDK.
+`logLevel` (ADJLogLevel): The level of logging output by the SDK.
@@ -76,8 +75,7 @@ import SetDefaultTracker from "@ios-examples/ADJConfig/setDefaultTracker.mdx";
-`defaultTracker` (NSString)
-: The token to which all preinstalled sessions are attributed.
+`defaultTracker` (NSString): The token to which all preinstalled sessions are attributed.
@@ -107,8 +105,7 @@ import SetDelegate from "@ios-examples/ADJConfig/setDelegate.mdx";
-`delegate` (NSObject)
-: The delegate function that's called when attribution changes.
+`delegate` (NSObject): The delegate function that's called when attribution changes.
@@ -144,8 +141,7 @@ import SetDelayStart from "@ios-examples/ADJConfig/setDelayStart.mdx";
-`delayStart` (double)
-: The time (in seconds) to delay the start of the SDK by.
+`delayStart` (double): The time (in seconds) to delay the start of the SDK by.
@@ -175,8 +171,7 @@ import SetExternalDeviceId from "@ios-examples/ADJConfig/setExternalDeviceId.mdx
-`externalDeviceId` (NSString)
-: The external device ID associated with the device.
+`externalDeviceId` (NSString): The external device ID associated with the device.
@@ -206,8 +201,7 @@ import SetEventBufferingEnabled from "@ios-examples/ADJConfig/setEventBufferingE
-`eventBufferingEnabled` (BOOL)
-: Whether event buffering is enabled.
+`eventBufferingEnabled` (BOOL): Whether event buffering is enabled.
@@ -237,8 +231,7 @@ import SetSendInBackground from "@ios-examples/ADJConfig/sendInBackground.mdx";
-`sendInBackground` (BOOL)
-: Whether the SDK should send information to Adjust when the app is running in the background.
+`sendInBackground` (BOOL): Whether the SDK should send information to Adjust when the app is running in the background.
@@ -268,8 +261,7 @@ import SetNeedsCost from "@ios-examples/ADJConfig/setNeedsCost.mdx";
-`needsCost` (BOOL)
-: Whether the SDK should gather cost data
+`needsCost` (BOOL): Whether the SDK should gather cost data
@@ -305,8 +297,7 @@ import SetLinkMeEnabled from "@ios-examples/ADJConfig/setLinkMeEnabled.mdx";
-`linkMeEnabled` (BOOL)
-: Whether to enable LinkMe.
+`linkMeEnabled` (BOOL): Whether to enable LinkMe.
@@ -346,7 +337,7 @@ import DeactivateSKAdNetworkHandling from "@ios-examples/ADJConfig/deactivateSKA
## setAllowIdfaReading
-Sets whether the Adjust SDK can read the device IDFA (ID for Advertisers).
+Sets whether the Adjust SDK can read the device IDFA (ID for Advertisers).
@@ -366,8 +357,7 @@ import SetAllowIdfaReading from "@ios-examples/ADJConfig/setAllowIdfaReading.mdx
-`allowIdfaReading` (BOOL)
-: Whether to allow the SDK to read the device's IDFA.
+`allowIdfaReading` (BOOL): Whether to allow the SDK to read the device's IDFA.
@@ -397,8 +387,7 @@ import SetAllowAdServicesInfoReading from "@ios-examples/ADJConfig/setAllowAdSer
-`allowAdServicesInfoReading` (BOOL)
-: Whether to allow the SDK to read AdServices information.
+`allowAdServicesInfoReading` (BOOL): Whether to allow the SDK to read AdServices information.
@@ -428,8 +417,7 @@ import SetUrlStrategy from "@ios-examples/ADJConfig/setUrlStrategy.mdx";
-`urlStrategy` (String)
-: The data residency target
+`urlStrategy` (String): The data residency target
diff --git a/src/content/docs/sdk/ios/reference/adjevent.mdx b/src/content/docs/sdk/ios/reference/adjevent.mdx
index ec4d8387b..c441f9d39 100644
--- a/src/content/docs/sdk/ios/reference/adjevent.mdx
+++ b/src/content/docs/sdk/ios/reference/adjevent.mdx
@@ -7,7 +7,7 @@ slug: en/sdk/ios/reference/adjevent
import TrackEvent from "@ios-signatures/Adjust/trackEvent.mdx"
-This class contains information about events triggered in your application. You can send this information to Adjust's servers by passing an `ADJEvent` object to the `trackEvent` method || .
+This class contains information about events triggered in your application. You can send this information to Adjust's servers by passing an `ADJEvent` object to the `trackEvent` method.
@@ -33,8 +33,7 @@ import Constructor from "@ios-examples/ADJEvent/constructor.mdx"
-`eventToken` (NSString)
-: A 6 character Adjust event token.
+`eventToken` (NSString): A 6 character Adjust event token.
@@ -64,11 +63,9 @@ import SetRevenue from "@ios-examples/ADJEvent/setRevenue.mdx"
-`amount` (double)
-: The amount of currency units associated with the event.
+`amount` (double): The amount of currency units associated with the event.
-`currency` (NSString)
-: The 3 character [ISO 4217 code](https://www.iban.com/currency-codes) of the currency unit.
+`currency` (NSString): The 3 character [ISO 4217 code](https://www.iban.com/currency-codes) of the currency unit.
@@ -98,8 +95,7 @@ import SetTransactionId from "@ios-examples/ADJEvent/setTransactionId.mdx"
-`transactionId` (NSString)
-: A unique identifier used to deduplicate events.
+`transactionId` (NSString): A unique identifier used to deduplicate events.
@@ -129,8 +125,7 @@ import SetCallbackId from "@ios-examples/ADJEvent/setCallbackId.mdx"
-`callbackId` (NSString)
-: A custom identifier for your event object.
+`callbackId` (NSString): A custom identifier for your event object.
@@ -160,11 +155,9 @@ import AddCallbackParameter from "@ios-examples/ADJEvent/addCallbackParameter.md
-`key` (NSString)
-: The data key.
+`key` (NSString): The data key.
-`value` (NSString)
-: The data value.
+`value` (NSString): The data value.
@@ -194,11 +187,9 @@ import AddPartnerParameter from "@ios-examples/ADJEvent/addPartnerParameter.mdx"
-`key` (NSString)
-: The data key.
+`key` (NSString): The data key.
-`value` (NSString)
-: The data value.
+`value` (NSString): The data value.
diff --git a/src/content/docs/sdk/ios/reference/adjlinkresolution.mdx b/src/content/docs/sdk/ios/reference/adjlinkresolution.mdx
index c09e4cd45..ded9beb8a 100644
--- a/src/content/docs/sdk/ios/reference/adjlinkresolution.mdx
+++ b/src/content/docs/sdk/ios/reference/adjlinkresolution.mdx
@@ -31,14 +31,11 @@ import ResolveLinkWithUrl from "@ios-examples/ADJLinkResolution/resolveLinkWithU
-`url` (NSURL)
-: A URL containing deep link information.
+`url` (NSURL): A URL containing deep link information.
-`resolveUrlSuffixArray` (NSArray\)
-: The custom domains of the configured campaigns that need to be resolved.
+`resolveUrlSuffixArray` (NSArray\): The custom domains of the configured campaigns that need to be resolved.
-`callback` (void function)
-: The callback that will contain the final URL.
+`callback` (void function): The callback that will contain the final URL.
diff --git a/src/content/docs/sdk/ios/reference/adjsubscription.mdx b/src/content/docs/sdk/ios/reference/adjsubscription.mdx
index 6625afc81..6af899cc5 100644
--- a/src/content/docs/sdk/ios/reference/adjsubscription.mdx
+++ b/src/content/docs/sdk/ios/reference/adjsubscription.mdx
@@ -7,7 +7,7 @@ slug: en/sdk/ios/reference/adjsubscription
import TrackSusbcription from "@ios-signatures/Adjust/trackSubscription.mdx"
-Use this class to store subscription information. You can pass this to Adjust's servers using the `trackSubscription` method || .
+Use this class to store subscription information. You can pass this to Adjust's servers using the `trackSubscription` method.
@@ -33,17 +33,13 @@ import Constructor from "@ios-examples/ADJSubscription/constructor.mdx"
-`price` (NSDecimalNumber)
-: The price of the subscription.
+`price` (NSDecimalNumber): The price of the subscription.
-`currency` (NSString)
-: The 3 character [ISO 4217 code](https://www.iban.com/currency-codes) of the currency unit.
+`currency` (NSString): The 3 character [ISO 4217 code](https://www.iban.com/currency-codes) of the currency unit.
-`transactionId` (NSString)
-: The unique ID of the purchase transaction.
+`transactionId` (NSString): The unique ID of the purchase transaction.
-`receipt` (NSData)
-: A data object containing receipt information.
+`receipt` (NSData): A data object containing receipt information.
@@ -71,8 +67,7 @@ import SetTransactionDate from "@ios-examples/ADJSubscription/setTransactionDate
-`transactionDate` (NSDate)
-: The date on which the subscription was purchased.
+`transactionDate` (NSDate): The date on which the subscription was purchased.
@@ -102,8 +97,7 @@ import SetSalesRegion from "@ios-examples/ADJSubscription/setSalesRegion.mdx"
-`salesRegion` (NSString)
-: The region in which the subscription was purchased.
+`salesRegion` (NSString): The region in which the subscription was purchased.
@@ -133,11 +127,9 @@ import AddCallbackParameter from "@ios-examples/ADJSubscription/addCallbackParam
-`key` (NSString)
-: The data key.
+`key` (NSString): The data key.
-`value` (NSString)
-: The data value.
+`value` (NSString): The data value.
@@ -167,11 +159,9 @@ import AddPartnerParameter from "@ios-examples/ADJSubscription/addPartnerParamet
-`key` (NSString)
-: The data key.
+`key` (NSString): The data key.
-`value` (NSString)
-: The data value.
+`value` (NSString): The data value.
diff --git a/src/content/docs/sdk/ios/reference/adjthirdpartysharing.mdx b/src/content/docs/sdk/ios/reference/adjthirdpartysharing.mdx
index 3e76ecee3..ef467f3bc 100644
--- a/src/content/docs/sdk/ios/reference/adjthirdpartysharing.mdx
+++ b/src/content/docs/sdk/ios/reference/adjthirdpartysharing.mdx
@@ -7,7 +7,7 @@ slug: en/sdk/ios/reference/adjthirdpartysharing
import TrackThirdPartySharing from "@ios-signatures/Adjust/trackThirdPartySharing.mdx"
-Use this class to communicate a user's third party sharing preferences. Send this information to Adjust's servers using the `trackThirdPartySharing` method || .
+Use this class to communicate a user's third party sharing preferences. Send this information to Adjust's servers using the `trackThirdPartySharing` method.
@@ -33,8 +33,7 @@ import InitWithIsEnabledNumberBool from "@ios-examples/ADJThirdPartySharing/init
-`isEnabledNumberBool` (NSNumber)
-: A number boolean value.
+`isEnabledNumberBool` (NSNumber): A number boolean value.
@@ -66,20 +65,13 @@ import Facebook from "@ios-examples/ADJThirdPartySharing/addGranularOptionFacebo
-
-
-- - Parameter
- - Description
-- - `partner_name`
- - Use `facebook` to toggle LDU.
-- - `data_processing_options_country`
- - The user is located in.
- - `0`: Request that Facebook use geolocation.
- - `1`: United States of America.
-- - `data_processing_options_state`
- - Notifies Facebook which state the user is located in.
- - `0`: Request that Facebook use geolocation.
- - `1000`: California.
+
+
+| Parameter | Description |
+| --------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
+| `partner_name` | Use `facebook` to toggle LDU. |
+| `data_processing_options_country` | The country in which the user is located.- `0`: Request that Facebook use geolocation.
- `1`: United States of America.
|
+| `data_processing_options_state` | Notifies Facebook in which state the user is located.- `0`: Request that Facebook use geolocation.
- `1000`: California.
|
@@ -87,14 +79,11 @@ import Facebook from "@ios-examples/ADJThirdPartySharing/addGranularOptionFacebo
-`partnerName` (NSString)
-: The name of the partner you want to share information with.
+`partnerName` (NSString): The name of the partner you want to share information with.
-`key` (NSString)
-: The data key.
+`key` (NSString): The data key.
-`value` (NSString)
-: The data value.
+`value` (NSString): The data value.
@@ -124,12 +113,9 @@ import AddPartnerSharingSetting from "@ios-examples/ADJThirdPartySharing/addPart
-`partnerName` (NSString)
-: The name of the partner whose settings you want to update. See the table of available partners below.
-`key` (NSString)
-: The setting you want to update.
-`value` (BOOL)
-: Whether the setting is enabled.
+`partnerName` (NSString): The name of the partner whose settings you want to update. See the table of available partners below.
+`key` (NSString): The setting you want to update.
+`value` (BOOL): Whether the setting is enabled.
diff --git a/src/content/docs/sdk/ios/reference/adjust/config.mdx b/src/content/docs/sdk/ios/reference/adjust/config.mdx
index b7d1e5fa0..81ff70204 100644
--- a/src/content/docs/sdk/ios/reference/adjust/config.mdx
+++ b/src/content/docs/sdk/ios/reference/adjust/config.mdx
@@ -31,8 +31,7 @@ import SetEnabled from "@ios-examples/Adjust/setEnabled.mdx"
-`enabled` (BOOL)
-: Whether the SDK is enabled
+`enabled` (BOOL): Whether the SDK is enabled
@@ -62,8 +61,7 @@ import IsEnabled from "@ios-examples/Adjust/isEnabled.mdx"
-`enabled` (BOOL)
-: Whether the SDK is enabled
+`enabled` (BOOL): Whether the SDK is enabled
@@ -123,8 +121,7 @@ import SetOfflineMode from "@ios-examples/Adjust/setOfflineMode.mdx"
-`enabled` (BOOL)
-: Whether the SDK is in offline mode
+`enabled` (BOOL): Whether the SDK is in offline mode
@@ -154,8 +151,7 @@ import SetDeviceToken from "@ios-examples/Adjust/setDeviceToken.mdx"
-`deviceToken` (NSData)
-: Your Apple push token
+`deviceToken` (NSData): Your Apple push token
diff --git a/src/content/docs/sdk/ios/reference/adjust/device-info.mdx b/src/content/docs/sdk/ios/reference/adjust/device-info.mdx
index ef1b70057..4b188ef03 100644
--- a/src/content/docs/sdk/ios/reference/adjust/device-info.mdx
+++ b/src/content/docs/sdk/ios/reference/adjust/device-info.mdx
@@ -17,7 +17,7 @@ The ADID is available only after the install has been recorded.
-Returns the ADID (Adjust Device ID) associated with the device.
+Returns the ADID (Adjust Device ID) associated with the device.
@@ -37,8 +37,7 @@ import Adid from "@ios-examples/Adjust/adid.mdx"
-`adid` (NSString)
-: The Adjust identifier associated with the device
+`adid` (NSString): The Adjust identifier associated with the device
@@ -48,7 +47,7 @@ import Adid from "@ios-examples/Adjust/adid.mdx"
## getIdfa
-Returns the IDFA (ID for advertisers) associated with the device.
+Returns the IDFA (ID for advertisers) associated with the device.
@@ -68,8 +67,7 @@ import Idfa from "@ios-examples/Adjust/idfa.mdx"
-`idfa` (NSString)
-: The IDFA associated with the device
+`idfa` (NSString): The IDFA associated with the device
diff --git a/src/content/docs/sdk/ios/reference/adjust/privacy.mdx b/src/content/docs/sdk/ios/reference/adjust/privacy.mdx
index 64b703ec3..c063b2b7f 100644
--- a/src/content/docs/sdk/ios/reference/adjust/privacy.mdx
+++ b/src/content/docs/sdk/ios/reference/adjust/privacy.mdx
@@ -55,8 +55,7 @@ import TrackThirdPartySharing from "@ios-examples/Adjust/trackThirdPartySharing.
-`thirdPartySharing` (ADJThirdPartySharing)
-: The third party sharing object
+`thirdPartySharing` (ADJThirdPartySharing): The third party sharing object
@@ -86,8 +85,7 @@ import TrackMeasurementConsent from "@ios-examples/Adjust/trackMeasurementConsen
-`enabled` (BOOL)
-: Whether data collection and retention rules apply for the user.
+`enabled` (BOOL): Whether data collection and retention rules apply for the user.
@@ -97,7 +95,7 @@ import TrackMeasurementConsent from "@ios-examples/Adjust/trackMeasurementConsen
## gdprForgetMe
-Send an RTBF (Right To Be Forgotten) request to Adjust's servers. This erases all information about the user the source app. The SDK stops sending requests for the user.
+Send an RTBF (Right To Be Forgotten) request to Adjust's servers. This erases all information about the user the source app. The SDK stops sending requests for the user.
diff --git a/src/content/docs/sdk/ios/reference/adjust/recording.mdx b/src/content/docs/sdk/ios/reference/adjust/recording.mdx
index 2aca51dc7..dbabe004b 100644
--- a/src/content/docs/sdk/ios/reference/adjust/recording.mdx
+++ b/src/content/docs/sdk/ios/reference/adjust/recording.mdx
@@ -31,8 +31,7 @@ import TrackEvent from "@ios-examples/Adjust/trackEvent.mdx"
-`event` (ADJEvent)
-: An event object containing the information you want to send to Adjust.
+`event` (ADJEvent): An event object containing the information you want to send to Adjust.
@@ -62,11 +61,9 @@ import AddSessionCallbackParameter from "@ios-examples/Adjust/addSessionCallback
-`key` (NSString)
-: The data key
+`key` (NSString): The data key
-`value` (NSString)
-: The data value
+`value` (NSString): The data value
@@ -96,8 +93,7 @@ import RemoveSessionCallbackParameter from "@ios-examples/Adjust/removeSessionCa
-`key` (NSString)
-: The data key of the parameter you want to remove.
+`key` (NSString): The data key of the parameter you want to remove.
@@ -151,11 +147,9 @@ import AddSessionPartnerParameter from "@ios-examples/Adjust/addSessionPartnerPa
-`key` (NSString)
-: The data key
+`key` (NSString): The data key
-`value` (NSString)
-: The data value
+`value` (NSString): The data value
@@ -185,8 +179,7 @@ import RemoveSessionPartnerParameter from "@ios-examples/Adjust/removeSessionPar
-`key` (NSString)
-: The data key of the parameter you want to remove.
+`key` (NSString): The data key of the parameter you want to remove.
@@ -240,8 +233,7 @@ import AppWillOpenUrl from "@ios-examples/Adjust/appWillOpenUrl.mdx"
-`url` (NSURL)
-: A URL containing deep link information.
+`url` (NSURL): A URL containing deep link information.
@@ -271,8 +263,7 @@ import Attribution from "@ios-examples/Adjust/attribution.mdx"
-`attribution` (ADJAttribution)
-: An attribution object containing attribution data associated with the device.
+`attribution` (ADJAttribution): An attribution object containing attribution data associated with the device.
@@ -302,8 +293,7 @@ import TrackSubscription from "@ios-examples/Adjust/trackSubscription.mdx"
-`subscription` (ADJSubscription)
-: The subscription object containing the purchase details.
+`subscription` (ADJSubscription): The subscription object containing the purchase details.
@@ -333,8 +323,7 @@ import TrackAdRevenue from "@ios-examples/Adjust/trackAdRevenue.mdx"
-`adRevenue` (ADJAdRevenue)
-: The ad revenue object containing the revenue details.
+`adRevenue` (ADJAdRevenue): The ad revenue object containing the revenue details.
diff --git a/src/content/docs/sdk/ios/reference/adjust/skan-att.mdx b/src/content/docs/sdk/ios/reference/adjust/skan-att.mdx
index 3e0b2c546..7c9abbe14 100644
--- a/src/content/docs/sdk/ios/reference/adjust/skan-att.mdx
+++ b/src/content/docs/sdk/ios/reference/adjust/skan-att.mdx
@@ -31,8 +31,7 @@ import RequestTrackingAuthorization from "@ios-examples/Adjust/requestTrackingAu
-`completion` (void function)
-: Completion handler to which the status is passed.
+`completion` (void function): Completion handler to which the status is passed.
@@ -62,8 +61,7 @@ import AppTrackingAuthorizationStatus from "@ios-examples/Adjust/appTrackingAuth
-`status` (int)
-: The user's authorization status.
+`status` (int): The user's authorization status.
@@ -117,8 +115,7 @@ import UpdateConversionValue from "@ios-examples/Adjust/updateConversionValue.md
-conversionValue (NSInteger)
-: The new conversion value.
+conversionValue (NSInteger): The new conversion value.
diff --git a/src/content/docs/sdk/react-native/configuration/att.mdx b/src/content/docs/sdk/react-native/configuration/att.mdx
index 5212eaa40..f5ae89757 100644
--- a/src/content/docs/sdk/react-native/configuration/att.mdx
+++ b/src/content/docs/sdk/react-native/configuration/att.mdx
@@ -10,7 +10,7 @@ import AppTrackingAuthorizationStatusSig from "@react-native-signatures/Adjust/a
import CheckForNewAttStatus from "@react-native-examples/Adjust/checkForNewAttStatus.mdx"
import CheckForNewAttStatusSig from "@react-native-signatures/Adjust/checkForNewAttStatus.mdx"
-If you want to record the device's IDFA (ID for Advertisers), you must display a prompt to get your user's authorization. To do this, you need to include Apple's ATT (App Tracking Transparency) framework in your app. The Adjust SDK stores the user's authorization status and sends it to Adjust's servers with each request.
+If you want to record the device's IDFA (ID for Advertisers), you must display a prompt to get your user's authorization. To do this, you need to include Apple's ATT (App Tracking Transparency) framework in your app. The Adjust SDK stores the user's authorization status and sends it to Adjust's servers with each request.
## Authorization statuses
@@ -27,7 +27,7 @@ If you want to record the device's IDFA (ID for Advertisers), you m
-You might receive a status code of `-1` if the SDK is unable to retrieve the ATT (App Tracking Transparency) status.
+You might receive a status code of `-1` if the SDK is unable to retrieve the ATT (App Tracking Transparency) status.
@@ -39,7 +39,7 @@ The callback method triggers when your user responds to the consent dialog. This
You must specify text content for the tracking request dialog. You can add this to your project in two ways:
-1. Add your text to the User Tracking Description field in the Adjust prefab.
+1. Add your text to the **User Tracking Description** field in the Adjust prefab.
2. Add your text to the `NSUserTrackingUsageDescription` key in your `Info.plist` file.
@@ -81,7 +81,7 @@ Adjust.requestTrackingAuthorizationWithCompletionHandler(function (status) {
## Get current authorization status
-You can retrieve a user's current authorization status at any time. Call the `appTrackingAuthorizationStatus` method || to return the authorization status code as an **integer**.
+You can retrieve a user's current authorization status at any time. Call the `appTrackingAuthorizationStatus` method to return the authorization status code as an **integer**.
@@ -96,6 +96,6 @@ Adjust.addSessionPartnerParameter("status", authorizationStatus);
## Check for authorization status changes
-If you use a custom ATT prompt, you need to inform the Adjust SDK of changes to the user's authorization status. Call the `checkForNewAttStatus` method || to send the authorization status to Adjust's servers.
+If you use a custom ATT prompt, you need to inform the Adjust SDK of changes to the user's authorization status. Call the `checkForNewAttStatus` method to send the authorization status to Adjust's servers.
diff --git a/src/content/docs/sdk/react-native/configuration/background.mdx b/src/content/docs/sdk/react-native/configuration/background.mdx
index 519c1c1ca..02cf7a076 100644
--- a/src/content/docs/sdk/react-native/configuration/background.mdx
+++ b/src/content/docs/sdk/react-native/configuration/background.mdx
@@ -9,7 +9,7 @@ import SetSendInBackgroundSig from "@react-native-signatures/AdjustConfig/sendIn
By default, the Adjust SDK pauses the sending of requests when your app is running in the background. You can configure the SDK to send requests in the background by enabling the background recording feature.
-Your config object contains a boolean `sendInBackground` property that controls this behavior. You can set this property by calling the `setSendInBackground` method || on your config instance with a boolean value.
+Your config object contains a boolean `sendInBackground` property that controls this behavior. You can set this property by calling the `setSendInBackground` method on your config instance with a boolean value.
diff --git a/src/content/docs/sdk/react-native/configuration/deep-links.mdx b/src/content/docs/sdk/react-native/configuration/deep-links.mdx
index 43ed60960..a1154af84 100644
--- a/src/content/docs/sdk/react-native/configuration/deep-links.mdx
+++ b/src/content/docs/sdk/react-native/configuration/deep-links.mdx
@@ -12,15 +12,13 @@ import SetShouldLaunchDeeplinkSig from "@react-native-signatures/AdjustConfig/se
import SetDeferredDeeplinkCallbackListener from "@react-native-examples/AdjustConfig/setDeferredDeeplinkCallbackListener.mdx"
import SetDeferredDeeplinkCallbackListenerSig from "@react-native-signatures/AdjustConfig/setDeferredDeeplinkCallbackListener.mdx"
-Deep links are URIs (Uniform Resource Identifiers) that direct users to a specific page in your app without any additional navigation. You can use them throughout your marketing funnel to improve user acquisition, engagement, and retention.
+Deep links are URIs (Uniform Resource Identifiers) that direct users to a specific page in your app without any additional navigation. You can use them throughout your marketing funnel to improve user acquisition, engagement, and retention.
The Adjust SDK uses different logic depending on whether the user already has your app installed on their device:
-Direct deep linking
-: Occurs if the user already has your app installed. The link takes the user to the page specified in the link
+Direct deep linking: Occurs if the user already has your app installed. The link takes the user to the page specified in the link
-Deferred deep linking
-: Occurs if the user doesn't have your app installed. The link takes the user to a storefront to install your app first. After the user installs the app, it opens to the page specified in the link.
+Deferred deep linking: Occurs if the user doesn't have your app installed. The link takes the user to a storefront to install your app first. After the user installs the app, it opens to the page specified in the link.
To get started, follow these steps.
@@ -40,13 +38,13 @@ To set up deep linking on your React Native app:
### Disable deferred deep linking
-The SDK opens deferred deep links by default. You can configure this by passing a **boolean** argument to the `setDeferredDeeplinkCallbackListener` method || .
+The SDK opens deferred deep links by default. You can configure this by passing a **boolean** argument to the `setDeferredDeeplinkCallbackListener` method.
### Set up a deferred deep link delegate
-You can configure the Adjust SDK to call a delegate function when it receives a deferred deep link by calling the `SetDeferredDeeplinkCallbackListener` method || . This delegate function receives the deep link as a **string** argument.
+You can configure the Adjust SDK to call a delegate function when it receives a deferred deep link by calling the `SetDeferredDeeplinkCallbackListener` method. This delegate function receives the deep link as a **string** argument.
@@ -80,6 +78,6 @@ The Adjust SDK checks the pasteboard when a user opens the app for the first tim
When a user clicks on a LinkMe URL they have the option to copy the link information to their system pasteboard. You can use the Adjust SDK to read the system pasteboard for deep link information. If deep link information is present, the SDK forwards the user to the correct page in your app.
-To enable pasteboard checking in your app, pass a true value to the `setLinkMeEnabled` method || on your config object:
+To enable pasteboard checking in your app, pass a true value to the `setLinkMeEnabled` method on your config object:
diff --git a/src/content/docs/sdk/react-native/configuration/delay.mdx b/src/content/docs/sdk/react-native/configuration/delay.mdx
index 37972acc4..e81dcc596 100644
--- a/src/content/docs/sdk/react-native/configuration/delay.mdx
+++ b/src/content/docs/sdk/react-native/configuration/delay.mdx
@@ -17,7 +17,7 @@ The offline mode setting isn't remembered between sessions. Offline mode is disa
The Adjust SDK sends event and session data to Adjust's servers in real time. You can pause the sending of information by putting the SDK in offline mode. In offline mode the SDK stores all data in a local file on the device. The SDK sends this information to Adjust's servers when you disable offline mode.
-Your config object contains a boolean `isOffline` property that controls this behavior. You can update this property at any time by calling the `setOfflineMode` method || with a boolean argument. The SDK sends all saved information to Adjust's servers when you deactivate offline mode.
+Your config object contains a boolean `isOffline` property that controls this behavior. You can update this property at any time by calling the `setOfflineMode` method with a boolean argument. The SDK sends all saved information to Adjust's servers when you deactivate offline mode.
@@ -25,6 +25,6 @@ Your config object contains a boolean `isOffline` property that controls this be
The Adjust SDK sends event information as soon as a user triggers an event in your app. You can send event information on a schedule by enabling event buffering. Event buffering stores events in a local buffer on the device and sends all requests once per minute.
-Your config object contains a boolean `eventBufferingEnabled` property that controls this behavior. You can set this property by calling the `setEventBufferingEnabled` method || on your config object with a boolean argument.
+Your config object contains a boolean `eventBufferingEnabled` property that controls this behavior. You can set this property by calling the `setEventBufferingEnabled` method on your config object with a boolean argument.
diff --git a/src/content/docs/sdk/react-native/configuration/disable.mdx b/src/content/docs/sdk/react-native/configuration/disable.mdx
index 699905458..5b2aa75a6 100644
--- a/src/content/docs/sdk/react-native/configuration/disable.mdx
+++ b/src/content/docs/sdk/react-native/configuration/disable.mdx
@@ -11,7 +11,7 @@ import IsEnabledSig from "@react-native-signatures/Adjust/isEnabled.mdx";
The Adjust SDK runs by default when your app is open. You can disable and re-enable the Adjust SDK to pause and resume recording. When you disable the Adjust SDK, it doesn't send any data to Adjust's servers.
-You can enable or disable the SDK at any time by calling the `setEnabled` method || with a boolean argument.
+You can enable or disable the SDK at any time by calling the `setEnabled` method with a boolean argument.
@@ -23,7 +23,7 @@ You can only call this method after the first session. This setting persists bet
## Check enabled status
-You can check if the Adjust SDK is enabled at any time by calling the `isEnabled` method || . This method returns a boolean value.
+You can check if the Adjust SDK is enabled at any time by calling the `isEnabled` method. This method returns a boolean value.
diff --git a/src/content/docs/sdk/react-native/configuration/external-device-id.mdx b/src/content/docs/sdk/react-native/configuration/external-device-id.mdx
index fd3b747b6..af555ab25 100644
--- a/src/content/docs/sdk/react-native/configuration/external-device-id.mdx
+++ b/src/content/docs/sdk/react-native/configuration/external-device-id.mdx
@@ -17,7 +17,7 @@ See the [External device identifiers article](https://help.adjust.com/en/article
-Your config object contains a **string** `externalDeviceId` property that you can use to store your external device ID. You can set property calling the `setExternalDeviceId` method || with your ID as an argument.
+Your config object contains a **string** `externalDeviceId` property that you can use to store your external device ID. You can set property calling the `setExternalDeviceId` method with your ID as an argument.
diff --git a/src/content/docs/sdk/react-native/configuration/log-level.mdx b/src/content/docs/sdk/react-native/configuration/log-level.mdx
index 4da325085..9b270208c 100644
--- a/src/content/docs/sdk/react-native/configuration/log-level.mdx
+++ b/src/content/docs/sdk/react-native/configuration/log-level.mdx
@@ -23,7 +23,7 @@ The Adjust SDK provides configurable log levels to return different amounts of i
-You can set your log level by calling the `setLogLevel` method || on your `AdjustConfig` instance.
+You can set your log level by calling the `setLogLevel` method on your `AdjustConfig` instance.
diff --git a/src/content/docs/sdk/react-native/configuration/preinstalled.mdx b/src/content/docs/sdk/react-native/configuration/preinstalled.mdx
index 87abed9f6..61023e835 100644
--- a/src/content/docs/sdk/react-native/configuration/preinstalled.mdx
+++ b/src/content/docs/sdk/react-native/configuration/preinstalled.mdx
@@ -19,7 +19,7 @@ Configuring a default campaign enables you to attribute all preinstalls to a pre
https://app.adjust.com/{token}
```
-2. Copy this token and pass it to the `setDefaultTracker` method || in your app delegate file.
+2. Copy this token and pass it to the `setDefaultTracker` method in your app delegate file.
diff --git a/src/content/docs/sdk/react-native/configuration/privacy.mdx b/src/content/docs/sdk/react-native/configuration/privacy.mdx
index 05d490a5f..9fddc4899 100644
--- a/src/content/docs/sdk/react-native/configuration/privacy.mdx
+++ b/src/content/docs/sdk/react-native/configuration/privacy.mdx
@@ -25,9 +25,9 @@ The Adjust SDK contains features that you can use to handle user privacy in your
## GDPR right to be forgotten
-Article 17 of the European Union's GDPR (General Data Protection Regulation) grants users the right to be forgotten. When Adjust's servers receive an RTBF (Right to be Forgotten) request, Adjust erases the user's data. The SDK also stops sending requests from the device for the app in question.
+Article 17 of the European Union's GDPR (General Data Protection Regulation) grants users the right to be forgotten. When Adjust's servers receive an RTBF (Right to be Forgotten) request, Adjust erases the user's data. The SDK also stops sending requests from the device for the app in question.
-You can send the user's RTBF request to Adjust by calling the `gdprForgetMe` method || .
+You can send the user's RTBF request to Adjust by calling the `gdprForgetMe` method.
@@ -37,7 +37,7 @@ You can use the Adjust SDK to record when a user changes their third-party shari
### Disable third-party sharing
-Some users may want to opt-out of sharing their data with third-parties. To communicate this to Adjust, call the `trackThirdPartySharing` method || with an [`ADJThirdPartySharing` object](/en/sdk/ios/reference/adjthirdpartysharing) initialized with a `false` value. When Adjust's servers receive this information, Adjust stops sharing the user's data with third-parties. The Adjust SDK continues to work as expected.
+Some users may want to opt-out of sharing their data with third-parties. To communicate this to Adjust, call the `trackThirdPartySharing` method with an [`ADJThirdPartySharing` object](/en/sdk/ios/reference/adjthirdpartysharing) initialized with a `false` value. When Adjust's servers receive this information, Adjust stops sharing the user's data with third-parties. The Adjust SDK continues to work as expected.
@@ -47,13 +47,13 @@ Some users may want to opt-out of sharing their data with third-parties. To comm
### Send granular information
-You can attach granular information when a user updates their third-party sharing preferences. Use this information to communicate more detail about a user's decision. To do this, call the `addGranularOption` method || with your partner name and your options.
+You can attach granular information when a user updates their third-party sharing preferences. Use this information to communicate more detail about a user's decision. To do this, call the `addGranularOption` method with your partner name and your options.
### Update partner settings
-You can use the Adjust SDK to update your third party sharing settings on a per-partner basis. To do this, call the `addPartnerSharingSetting` method || with your partner name and your options.
+You can use the Adjust SDK to update your third party sharing settings on a per-partner basis. To do this, call the `addPartnerSharingSetting` method with your partner name and your options.
@@ -82,26 +82,19 @@ The Adjust SDK sends information to Facebook as soon as the app is installed. Yo
-Facebook provides a feature called LDU (Limited Data Use) to comply with the CCPA (California Consumer Privacy Act). This feature enables you to notify Facebook when a California-based user is opted out of the sale of data. You can also use it if you want to opt all users out by default.
+Facebook provides a feature called LDU (Limited Data Use) to comply with the CCPA (California Consumer Privacy Act). This feature enables you to notify Facebook when a California-based user is opted out of the sale of data. You can also use it if you want to opt all users out by default.
-You can update the Facebook LDU status by passing arguments to the `addGranularOption` method || .
+You can update the Facebook LDU status by passing arguments to the `addGranularOption` method.
-
-
-- - Parameter
- - Description
-- - `partner_name`
- - Use `facebook` to toggle LDU.
-- - `data_processing_options_country`
- - The country the user is located in.
- - `0`: Request that Facebook use geolocation.
- - `1`: United States of America.
-- - `data_processing_options_state`
- - Notifies Facebook which state the user is located in.
- - `0`: Request that Facebook use geolocation.
- - `1000`: California.
+
+
+| Parameter | Description |
+| --------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
+| `partner_name` | Use `facebook` to toggle LDU. |
+| `data_processing_options_country` | The country in which the user is located.- `0`: Request that Facebook use geolocation.
- `1`: United States of America.
|
+| `data_processing_options_state` | Notifies Facebook in which state the user is located.- `0`: Request that Facebook use geolocation.
- `1000`: California.
|
@@ -149,7 +142,7 @@ Adjust.trackThirdPartySharing(adjustThirdPartySharing);
## Disable third-party sharing
-To disable third-party sharing for all users, call the `disableThirdPartySharing` method || . When Adjust's servers receive this information, Adjust stops sharing the user's data with third-parties. The Adjust SDK continues to work as expected.
+To disable third-party sharing for all users, call the `disableThirdPartySharing` method. When Adjust's servers receive this information, Adjust stops sharing the user's data with third-parties. The Adjust SDK continues to work as expected.
@@ -157,7 +150,7 @@ To disable third-party sharing for all users, call the `disableThirdPar
The data residency feature allows you to choose the country in which Adjust stores your data. This is useful if you're operating in a country with strict privacy requirements. When you set up data residency, Adjust stores your data in a data center located in the region your have chosen.
-To set your country of data residency, call the `setUrlStrategy` method || on your `AdjustConfig` instance.
+To set your country of data residency, call the `setUrlStrategy` method on your `AdjustConfig` instance.
@@ -176,7 +169,7 @@ To set your country of data residency, call the `setUrlStrategy` method
## Consent measurement for specific users
-If you are using [Data Privacy settings](https://help.adjust.com/en/article/manage-data-collection-and-retention) in your Adjust dashboard, you need to set up the Adjust SDK to work with them. This includes settings such as consent expiry period and user data retention period. To toggle this feature, call the `trackMeasurementConsent` method || . When enabled, the SDK communicates the data privacy settings to Adjust's servers. Adjust's servers then applies your data privacy rules to the user. The Adjust SDK continues to work as expected.
+If you are using [Data Privacy settings](https://help.adjust.com/en/article/manage-data-collection-and-retention) in your Adjust dashboard, you need to set up the Adjust SDK to work with them. This includes settings such as consent expiry period and user data retention period. To toggle this feature, call the `trackMeasurementConsent` method. When enabled, the SDK communicates the data privacy settings to Adjust's servers. Adjust's servers then applies your data privacy rules to the user. The Adjust SDK continues to work as expected.
@@ -184,7 +177,7 @@ If you are using [Data Privacy settings](https://help.adjust.com/en/article/mana
import SetCoppaCompliantEnabledSig from "@react-native-signatures/AdjustConfig/setCoppaCompliantEnabled.mdx";
-If you need your app to be COPPA compliant, call the `setCoppaCompliantEnabled` method || . This method performs the following actions:
+If you need your app to be COPPA compliant, call the `setCoppaCompliantEnabled` method. This method performs the following actions:
1. Disables third-party sharing **before** the user launches their first session.
2. Prevents the SDK from reading device and advertising IDs (For example: `gps_adid` and `android_id`).
@@ -205,7 +198,7 @@ Disabling the `setCoppaCompliantEnabled` method _doesn't_ re-enable third-party
import SetPlayStoreKidsAppEnabledSig from "@react-native-signatures/AdjustConfig/setPlayStoreKidsAppEnabled.mdx";
-If your app targets users under the age of 13, and the install region **isn't** the USA, you need to mark it as a Kids App. This prevents the SDK from reading device and advertising IDs, that's, `gps_adid` and `android_id`. To do this, call the `setPlayStoreKidsAppEnabled` method || with a `true` parameter.
+If your app targets users under the age of 13, and the install region **isn't** the USA, you need to mark it as a Kids App. This prevents the SDK from reading device and advertising IDs, that's, `gps_adid` and `android_id`. To do this, call the `setPlayStoreKidsAppEnabled` method with a `true` parameter.
import SetPlayStoreKidsAppEnabled from "@react-native-examples/AdjustConfig/setPlayStoreKidsAppEnabled.mdx";
diff --git a/src/content/docs/sdk/react-native/configuration/push-tokens.mdx b/src/content/docs/sdk/react-native/configuration/push-tokens.mdx
index 16f9ca5bd..6c366f77c 100644
--- a/src/content/docs/sdk/react-native/configuration/push-tokens.mdx
+++ b/src/content/docs/sdk/react-native/configuration/push-tokens.mdx
@@ -9,13 +9,13 @@ import SetPushTokenSig from "@react-native-signatures/Adjust/setPushToken.mdx"
Push tokens are used for [Audience Builder](https://help.adjust.com/en/article/audience-builder) and client callbacks. They're also required for [Uninstall and reinstall tracking](https://help.adjust.com/en/article/uninstalls-reinstalls).
-Your config object contains a string `pushToken` property that you can use to store your push token. You can update this property at any time by calling the `setPushToken` method || and passing your token as an argument.
+Your config object contains a string `pushToken` property that you can use to store your push token. You can update this property at any time by calling the `setPushToken` method and passing your token as an argument.
## Example
-This example shows how to set a new push token with the value _`HrFmrcq96tj723aWFfrw`_ to track your app's retention rates. You can update this value at any time by passing a new token to the `setPushToken` method || as an argument:
+This example shows how to set a new push token with the value _`HrFmrcq96tj723aWFfrw`_ to track your app's retention rates. You can update this value at any time by passing a new token to the `setPushToken` method as an argument:
```jsx '"HrFmrcq96tj723aWFfrw"'
Adjust.setPushToken("HrFmrcq96tj723aWFfrw");
diff --git a/src/content/docs/sdk/react-native/configuration/skad.mdx b/src/content/docs/sdk/react-native/configuration/skad.mdx
index 926988b2e..16f615dc9 100644
--- a/src/content/docs/sdk/react-native/configuration/skad.mdx
+++ b/src/content/docs/sdk/react-native/configuration/skad.mdx
@@ -17,7 +17,7 @@ This feature is only available on devices running iOS 14 and above.
-SKAdNetwork (StoreKit Ad Network) is Apple's attribution framework for
+SKAdNetwork (StoreKit Ad Network) is Apple's attribution framework for
app install and reinstall attribution. The SKAdNetwork workflow goes like this:
1. Apple gathers attribution information and notifies the relevant ad network.
@@ -28,7 +28,7 @@ app install and reinstall attribution. The SKAdNetwork workflow goes like this:
The Adjust SDK communicates with SKAdNetwork by default on v4.23.0 and above. The SDK registers for SKAdNetwork attribution upon initialization.
-Your config object contains a boolean `isSKAdNetworkHandlingActive` property that controls this behavior. You can disable SKAdNetwork communication by calling the `deactivateSKAdNetworkHandling` method || with no argument.
+Your config object contains a boolean `isSKAdNetworkHandlingActive` property that controls this behavior. You can disable SKAdNetwork communication by calling the `deactivateSKAdNetworkHandling` method with no argument.
@@ -42,7 +42,7 @@ You must call the `deactivateSKAdNetworkHandling` method _before_ initializing t
Conversion values are a mechanism used to track user behavior in SKAdNetwork. You can map 64 conditions to values from 0 through 63 and send this integer value to SKAdNetwork on user install. This gives you insight into how your users interact with your app in the first few days.
-If you manage your conversion values with Adjust, the servers update this value in the SDK. You can also update this value by using the `updateConversionValue` method || . This method wraps [Apple's `updateConversionValue` method](https://developer.apple.com/documentation/storekit/skadnetwork/3566697-updateconversionvalue). It accepts an integer argument representing your updated conversion value.
+If you manage your conversion values with Adjust, the servers update this value in the SDK. You can also update this value by using the `updateConversionValue` method. This method wraps [Apple's `updateConversionValue` method](https://developer.apple.com/documentation/storekit/skadnetwork/3566697-updateconversionvalue). It accepts an integer argument representing your updated conversion value.
@@ -58,7 +58,7 @@ function _onPress_trackSimpleEvent() {
## Listen for changes to conversion values
-If you use Adjust to manage conversion values, the Adjust's servers send conversion value updates to the SDK. You can set up a delegate function to listen for these changes using the `setConversionValueUpdatedCallbackListener` method || . Pass your function as an argument.
+If you use Adjust to manage conversion values, the Adjust's servers send conversion value updates to the SDK. You can set up a delegate function to listen for these changes using the `setConversionValueUpdatedCallbackListener` method. Pass your function as an argument.
diff --git a/src/content/docs/sdk/react-native/features/ad-revenue.mdx b/src/content/docs/sdk/react-native/features/ad-revenue.mdx
index 4b7cea4c2..fd9cd78ca 100644
--- a/src/content/docs/sdk/react-native/features/ad-revenue.mdx
+++ b/src/content/docs/sdk/react-native/features/ad-revenue.mdx
@@ -32,7 +32,7 @@ You need to perform some extra setup steps in your Adjust dashboard to measure a
To send ad revenue to Adjust:
1. Create a new Adjust ad revenue instance and pass your ad revenue source as an argument.
-2. Call the `trackAdRevenue` method || with your ad revenue instance as an argument.
+2. Call the `trackAdRevenue` method with your ad revenue instance as an argument.
@@ -57,13 +57,11 @@ To send ad revenue to Adjust:
You can record ad revenue by setting the `revenue` and `currency` properties on your ad revenue instance.
-To set these properties, call the `setRevenue` method || and pass the following arguments:
+To set these properties, call the `setRevenue` method and pass the following arguments:
-`revenue` **number**
-: The amount of revenue
+`revenue` **number**: The amount of revenue
-`currency` **string**
-: The 3 character [ISO 4217 code](https://www.iban.com/currency-codes) of your reporting currency
+`currency` **string**: The 3 character [ISO 4217 code](https://www.iban.com/currency-codes) of your reporting currency
@@ -79,25 +77,25 @@ The ad revenue object contains properties you can use to report on your ad campa
### Ad impressions
-Record the number of ad impressions by passing an **integer** value to the `setAdImpressionsCount` method || .
+Record the number of ad impressions by passing an **integer** value to the `setAdImpressionsCount` method.
### Ad revenue network
-Record which network generated the revenue by passing a **string** value to the `setAdRevenueNetwork` method || .
+Record which network generated the revenue by passing a **string** value to the `setAdRevenueNetwork` method.
### Ad revenue unit
-Record which ad revenue unit generated the revenue by passing a **string** value to the `setAdRevenueUnit` method || .
+Record which ad revenue unit generated the revenue by passing a **string** value to the `setAdRevenueUnit` method.
### Ad revenue placement
-Record the placement of your ad by passing a **string** value to the `setAdRevenuePlacement` method || .
+Record the placement of your ad by passing a **string** value to the `setAdRevenuePlacement` method.
@@ -107,7 +105,7 @@ If you [register a callback URL](https://help.adjust.com/en/article/recommended-
You can configure callback parameters to your servers. Once you configure parameters on an event, the SDK appends them to your [callback URL](https://help.adjust.com/en/article/raw-data-exports). You can use this information to analyze your users' in-app behavior with your BI system.
-Add callback parameters to your event by calling the `addCallbackParameter` method || with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
+Add callback parameters to your event by calling the `addCallbackParameter` method with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
The Adjust SDK measures the event and sends a request to your URL with the callback parameters. For example, if you register the URL `https://www.mydomain.com/callback`, your callback looks like this:
@@ -145,7 +143,7 @@ Partner parameters don't appear in raw data by default. You can add the `{partne
-Add partner parameters to your event by calling the `addPartnerParameter` method || with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
+Add partner parameters to your event by calling the `addPartnerParameter` method with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
diff --git a/src/content/docs/sdk/react-native/features/attribution.mdx b/src/content/docs/sdk/react-native/features/attribution.mdx
index 0c0f6f84b..c668e90ee 100644
--- a/src/content/docs/sdk/react-native/features/attribution.mdx
+++ b/src/content/docs/sdk/react-native/features/attribution.mdx
@@ -11,7 +11,7 @@ import AttributionSig from "@react-native-signatures/Adjust/getAttribution.mdx";
When a user interacts with a campaign link, their attribution information updates. This can happen if the user interacts with a [deep link](https://help.adjust.com/en/article/deep-links). The SDK can listen for attribution changes and call a function when it detects an update.
-To configure your callback function, call the `setAttributionCallbackListener` method || with your function name as an argument.
+To configure your callback function, call the `setAttributionCallbackListener` method with your function name as an argument.
@@ -25,7 +25,7 @@ Within your delegate function, you have access to the user's `Attribution` infor
## Get current attribution information
-When a user installs your app, Adjust attributes the install to a campaign. The Adjust SDK gives you access to campaign attribution details for your install. To return this information, call the `getAttribution` method || .
+When a user installs your app, Adjust attributes the install to a campaign. The Adjust SDK gives you access to campaign attribution details for your install. To return this information, call the `getAttribution` method.
This method returns an Attribution object. See the [`AdjustAttribution` class reference](/en/sdk/react-native/reference/adjustattribution) for a list of available properties.
diff --git a/src/content/docs/sdk/react-native/features/device-info.mdx b/src/content/docs/sdk/react-native/features/device-info.mdx
index 50cc25749..340278354 100644
--- a/src/content/docs/sdk/react-native/features/device-info.mdx
+++ b/src/content/docs/sdk/react-native/features/device-info.mdx
@@ -17,28 +17,28 @@ The Adjust SDK contains helper methods that return device information. Use these
## Adjust device identifier
-Adjust generates a unique ADID (Adjust Device ID) for each device. Call the `getAdid` method || to return this ID as a **string**.
+Adjust generates a unique ADID (Adjust Device ID) for each device. Call the `getAdid` method to return this ID as a **string**.
## ID For Advertisers
-The IDFA (ID for Advertisers) is a device-specific identifier for Apple devices. Call the `getIdfa` method || to return this ID as a **string**.
+The IDFA (ID for Advertisers) is a device-specific identifier for Apple devices. Call the `getIdfa` method to return this ID as a **string**.
## Google Play Services Advertising ID
-The GPS ADID (Google Play Services Advertising ID) is a device-specific identifier for Android devices.
+The GPS ADID (Google Play Services Advertising ID) is a device-specific identifier for Android devices.
Users can opt out of sharing their GPS ADID by toggling the "Opt out of Ads Personalization" setting on their device. When a user enables this setting, the Adjust SDK returns a string of zeros when trying to read the GPS ADID.
-You can access this value by calling the `getGoogleAdId` method || in a background thread. Assign a delegate function to access the GPS ADID value.
+You can access this value by calling the `getGoogleAdId` method in a background thread. Assign a delegate function to access the GPS ADID value.
## Amazon Advertiser ID
-The Amazon Ad ID (Amazon Advertising ID) is a device-specific identifier for Android devices. Call the `getAmazonAdId` method || to return this ID as a **string**.
+The Amazon Ad ID (Amazon Advertising ID) is a device-specific identifier for Android devices. Call the `getAmazonAdId` method to return this ID as a **string**.
diff --git a/src/content/docs/sdk/react-native/features/events.mdx b/src/content/docs/sdk/react-native/features/events.mdx
index 7a03cca06..fa98b3e9e 100644
--- a/src/content/docs/sdk/react-native/features/events.mdx
+++ b/src/content/docs/sdk/react-native/features/events.mdx
@@ -20,7 +20,7 @@ import AddPartnerParameterSig from "@react-native-signatures/AdjustEvent/addPart
You can associate your [Adjust event tokens](https://help.adjust.com/en/article/add-events#add-event) to actions in your app to record them. To record an event:
- Create a new Adjust event instance and pass your event token as a string argument.
-- Call the `trackEvent` method || with your event instance as an argument.
+- Call the `trackEvent` method with your event instance as an argument.
@@ -48,13 +48,11 @@ function _onPress_trackSimpleEvent() {
You can record revenue associated with an event by setting the revenue and currency properties on your event instance. Use this feature to record revenue-generating actions in your app.
-To set these properties, call the `setRevenue` method || and pass the following arguments:
+To set these properties, call the `setRevenue` method and pass the following arguments:
-`revenue` (**number**)
-: The amount of revenue generated by the event
+`revenue` (**number**): The amount of revenue generated by the event
-`currency` (**string**)
-: The [ISO 4217 code](https://www.iban.com/currency-codes) of the event currency.
+`currency` (**string**): The [ISO 4217 code](https://www.iban.com/currency-codes) of the event currency.
@@ -140,13 +138,13 @@ Parameters:
You can pass an optional identifier to avoid recording duplicate events. The SDK stores the last ten identifiers and skips revenue events with duplicate transaction IDs.
-To set the identifier, call the `setTransactionId` method || and pass your transaction ID as a **string** argument.
+To set the identifier, call the `setTransactionId` method and pass your transaction ID as a **string** argument.
### Example
-This example shows how to record an event with the token `g3mfiw` whenever a user interacts with a button. The function sets the `uniqueId` to `5e85484b-1ebc-4141-aab7-25b869e54c49` using the `setTransactionId` method || .
+This example shows how to record an event with the token `g3mfiw` whenever a user interacts with a button. The function sets the `uniqueId` to `5e85484b-1ebc-4141-aab7-25b869e54c49` using the `setTransactionId` method.
```jsx {3}
function _onPress_trackRevenueEvent() {
@@ -184,7 +182,7 @@ If you [register a callback URL](https://help.adjust.com/en/article/set-up-callb
You can configure callback parameters to send to your servers. Once you configure parameters on an event, the SDK appends them to your [callback URL](https://help.adjust.com/en/article/raw-data-exports). You can use this information to analyze your users' in-app behavior with your BI system.
-Add callback parameters to your event by calling the `addCallbackParameter` method || with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
+Add callback parameters to your event by calling the `addCallbackParameter` method with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
@@ -265,7 +263,7 @@ Partner parameters don't appear in raw data by default. You can add the `{partne
-Add partner parameters to your event by calling the `addPartnerParameter` method || with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
+Add partner parameters to your event by calling the `addPartnerParameter` method with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
@@ -310,7 +308,7 @@ Parameters:
You can add a custom string identifier to each event you want to measure. Adjust's servers can report on this identifier in event callbacks. This enables you to keep track of which events have been successfully measured.
-Set up this identifier by calling the `setCallbackId` method || with your ID as a **string** argument.
+Set up this identifier by calling the `setCallbackId` method with your ID as a **string** argument.
diff --git a/src/content/docs/sdk/react-native/features/session-parameters.mdx b/src/content/docs/sdk/react-native/features/session-parameters.mdx
index 48653730e..d8b5096e5 100644
--- a/src/content/docs/sdk/react-native/features/session-parameters.mdx
+++ b/src/content/docs/sdk/react-native/features/session-parameters.mdx
@@ -31,15 +31,15 @@ The Adjust SDK merges session callback parameters with event callback parameters
-Add callback parameters to your event by calling the `addSessionCallbackParameter` method || with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
+Add callback parameters to your event by calling the `addSessionCallbackParameter` method with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
-You can remove specific session callback parameters if they're no longer required. To do this, pass the parameter key to the `removeSessionCallbackParameter` method || .
+You can remove specific session callback parameters if they're no longer required. To do this, pass the parameter key to the `removeSessionCallbackParameter` method.
-You can remove all session parameters if they're no longer required. To do this, call the `resetSessionCallbackParameters` method || .
+You can remove all session parameters if they're no longer required. To do this, call the `resetSessionCallbackParameters` method.
@@ -55,15 +55,15 @@ Partner parameters don't appear in raw data by default. You can add the `{partne
-Add partner parameters to your event by calling the `addSessionPartnerParameter` method || with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
+Add partner parameters to your event by calling the `addSessionPartnerParameter` method with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
-You can remove specific session partner parameters if they're no longer required. To do this, pass the parameter key to the `removeSessionPartnerParameter` method || .
+You can remove specific session partner parameters if they're no longer required. To do this, pass the parameter key to the `removeSessionPartnerParameter` method.
-You can remove all session partner parameters if they're no longer required. To do this, call the `resetSessionPartnerParameters` method || .
+You can remove all session partner parameters if they're no longer required. To do this, call the `resetSessionPartnerParameters` method.
@@ -75,10 +75,10 @@ You can delay the startup of the SDK by up to **10 seconds**.
-The Adjust SDK starts as soon as your app opens. If you want to send data that's not available at launch in session parameters, you can delay the start of the SDK. To do this, pass the delay time in seconds to the `setDelayStart` method || on your config object.
+The Adjust SDK starts as soon as your app opens. If you want to send data that's not available at launch in session parameters, you can delay the start of the SDK. To do this, pass the delay time in seconds to the `setDelayStart` method on your config object.
-After this time has elapsed, the SDK sends the information to Adjust's servers. You can send the information before the timeout by calling the `sendFirstPackages` method || .
+After this time has elapsed, the SDK sends the information to Adjust's servers. You can send the information before the timeout by calling the `sendFirstPackages` method.
diff --git a/src/content/docs/sdk/react-native/features/subscriptions.mdx b/src/content/docs/sdk/react-native/features/subscriptions.mdx
index 33b00528a..7e3a11c45 100644
--- a/src/content/docs/sdk/react-native/features/subscriptions.mdx
+++ b/src/content/docs/sdk/react-native/features/subscriptions.mdx
@@ -85,14 +85,14 @@ You can record the date on which the user purchased a subscription. The SDK retu
-Call the `setTransactionDate` method || method on your subscription object to record the timestamp of the subscription.
+Call the `setTransactionDate` method method on your subscription object to record the timestamp of the subscription.
-Call the `setPurchaseTime` method || on your subscription object to record the timestamp of the subscription.
+Call the `setPurchaseTime` method on your subscription object to record the timestamp of the subscription.
@@ -101,7 +101,7 @@ Call the `setPurchaseTime` method || o
### Record the purchase region (iOS only)
-You can record the region in which the user purchased a subscription. To do this, call the `setSalesRegion` method || on your subscription object and pass the country code as a **string**. This needs to be formatted as the [`countryCode`](https://developer.apple.com/documentation/foundation/nslocale/1643060-countrycode?language=swift) of the [`priceLocale`](https://developer.apple.com/documentation/storekit/skproduct/1506145-pricelocale?language=swift) object.
+You can record the region in which the user purchased a subscription. To do this, call the `setSalesRegion` method on your subscription object and pass the country code as a **string**. This needs to be formatted as the [`countryCode`](https://developer.apple.com/documentation/foundation/nslocale/1643060-countrycode?language=swift) of the [`priceLocale`](https://developer.apple.com/documentation/storekit/skproduct/1506145-pricelocale?language=swift) object.
@@ -146,14 +146,14 @@ Once you have set up your subscription object, you can record it using the Adjus
-Pass your subscription object to the `trackAppStoreSubscription` method || method to record the user's subscription purchase.
+Pass your subscription object to the `trackAppStoreSubscription` method method to record the user's subscription purchase.
-Pass your subscription object to the `trackPlayStoreSubscription` method || method to record the user's subscription purchase.
+Pass your subscription object to the `trackPlayStoreSubscription` method method to record the user's subscription purchase.
diff --git a/src/content/docs/sdk/react-native/index.mdx b/src/content/docs/sdk/react-native/index.mdx
index 50ac4ee77..95c46ca50 100644
--- a/src/content/docs/sdk/react-native/index.mdx
+++ b/src/content/docs/sdk/react-native/index.mdx
@@ -154,7 +154,7 @@ The install referrer is an attribution mechanism you can use to attribute an app
- [x] A set of APIs from these app stores that allow developers to retrieve referral content in their apps.
- [x] A `referrer` parameter that app stores, such as Google Play and Huawei App Gallery, accept in their app page URLs on their store websites. Here is how the referrer parameter is populated:
- When a user clicks on an Adjust Tracker, the Adjust server passes a unique identifier called `reftag`. This identifier is assigned to the click and into the referrer parameter. To know more about reftag, visit [Reftag](https://help.adjust.com/en/article/reftag).
- - When you run [Google Ads](https://support.google.com/google-ads/answer/6357635?hl=en) campaigns, Google passes a unique identifier called `gclid` into the referrer parameter. You must have Auto-tagging turned on in your Google Ads account.
+ - When you run [Google Ads](https://support.google.com/google-ads/answer/6357635?hl=en) campaigns, Google passes a unique identifier called `gclid` into the referrer parameter. You must have **Auto-tagging** turned on in your Google Ads account.
@@ -216,16 +216,16 @@ As of v4.22.0, the Adjust SDK supports install tracking on Huawei devices using
## 5. Add iOS frameworks
-The Adjust SDK is able to get extra information when you include certain iOS frameworks in your app. These frameworks enable certain SDK features, but they're not mandatory for the SDK to work normally. You can add the frameworks and then mark them as optional in Project Settings --> Build Phases --> Link Binary With Libraries.
+The Adjust SDK is able to get extra information when you include certain iOS frameworks in your app. These frameworks enable certain SDK features, but they're not mandatory for the SDK to work normally. You can add the frameworks and then mark them as optional in **Project Settings --> Build Phases --> Link Binary With Libraries**.
| Framework | Description | Notes |
| ------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
-| AdSupport.framework | This framework is needed so that the SDK can access the IDFA value and, before iOS 14, AT information. | If your app is targeting the "Kids" category, you shouldn't implement this framework. |
-| AdServices.framework | This framework is needed to handle Apple Search Ads attribution. | |
-| StoreKit.framework | This framework is needed to access the SKAdNetwork framework and for the Adjust SDK to andle communication with it automatically in iOS 14 or later. | |
-| AppTrackingTransparency.framework | This framework is needed in iOS 14 and later for the SDK to be able to wrap he user tracking consent dialog and access the user’s consent response. | If your app is targeting the "Kids" category, you shouldn't implement this framework. |
+| **AdSupport.framework** | This framework is needed so that the SDK can access the IDFA value and, before iOS 14, AT information. | If your app is targeting the "Kids" category, you shouldn't implement this framework. |
+| **AdServices.framework** | This framework is needed to handle Apple Search Ads attribution. | |
+| **StoreKit.framework** | This framework is needed to access the SKAdNetwork framework and for the Adjust SDK to andle communication with it automatically in iOS 14 or later. | |
+| **AppTrackingTransparency.framework** | This framework is needed in iOS 14 and later for the SDK to be able to wrap he user tracking consent dialog and access the user’s consent response. | If your app is targeting the "Kids" category, you shouldn't implement this framework. |
diff --git a/src/content/docs/sdk/react-native/plugins/oaid.mdx b/src/content/docs/sdk/react-native/plugins/oaid.mdx
index 56f5245e4..419131dff 100644
--- a/src/content/docs/sdk/react-native/plugins/oaid.mdx
+++ b/src/content/docs/sdk/react-native/plugins/oaid.mdx
@@ -4,7 +4,7 @@ description: Use the OAID plugin to read a device's OAID.
slug: en/sdk/react-native/plugins/oaid
---
-The OAID (Open Anonymous Device Identifier) is a unique identifier for Android devices. The MSA (Mobile Security Alliance) recommends all Chinese-manufactured devices provide an OAID. You can use the OAID to attribute and track devices where Google Play Services isn't available.
+The OAID (Open Anonymous Device Identifier) is a unique identifier for Android devices. The MSA (Mobile Security Alliance) recommends all Chinese-manufactured devices provide an OAID. You can use the OAID to attribute and track devices where Google Play Services isn't available.
The OAID plugin provides the OAID of a device. The SDK will continue to use other identifiers as well as the OAID.
diff --git a/src/content/docs/sdk/react-native/reference/adjust/config.mdx b/src/content/docs/sdk/react-native/reference/adjust/config.mdx
index 6890e6c21..3d78d2701 100644
--- a/src/content/docs/sdk/react-native/reference/adjust/config.mdx
+++ b/src/content/docs/sdk/react-native/reference/adjust/config.mdx
@@ -30,8 +30,7 @@ import SetEnabled from "@react-native-examples/Adjust/setEnabled.mdx"
-`enabled` (boolean)
-: Whether the SDK is enabled.
+`enabled` (boolean): Whether the SDK is enabled.
@@ -61,8 +60,7 @@ import IsEnabled from "@react-native-examples/Adjust/isEnabled.mdx"
-`enabled` (boolean)
-: Whether the SDK is enabled.
+`enabled` (boolean): Whether the SDK is enabled.
@@ -122,8 +120,7 @@ import SetOfflineMode from "@react-native-examples/Adjust/setOfflineMode.mdx"
-`enabled` (boolean)
-: Whether the SDK is in offline mode.
+`enabled` (boolean): Whether the SDK is in offline mode.
@@ -153,8 +150,7 @@ import SetPushToken from "@react-native-examples/Adjust/setPushToken.mdx"
-`token` (string)
-: Your push token.
+`token` (string): Your push token.
diff --git a/src/content/docs/sdk/react-native/reference/adjust/device-info.mdx b/src/content/docs/sdk/react-native/reference/adjust/device-info.mdx
index 2e914ad97..5ea3dc274 100644
--- a/src/content/docs/sdk/react-native/reference/adjust/device-info.mdx
+++ b/src/content/docs/sdk/react-native/reference/adjust/device-info.mdx
@@ -17,7 +17,7 @@ The ADID is available only after the install has been recorded.
-Returns the ADID (Adjust Device ID) associated with the device.
+Returns the ADID (Adjust Device ID) associated with the device.
@@ -37,8 +37,7 @@ import GetAdid from "@react-native-examples/Adjust/getAdid.mdx"
-`adid` (string)
-: The Adjust identifier associated with the device
+`adid` (string): The Adjust identifier associated with the device
@@ -48,7 +47,7 @@ import GetAdid from "@react-native-examples/Adjust/getAdid.mdx"
## getIdfa
-Returns the IDFA (ID for advertisers) associated with the device.
+Returns the IDFA (ID for advertisers) associated with the device.
@@ -68,8 +67,7 @@ import GetIdfa from "@react-native-examples/Adjust/getIdfa.mdx"
-`idfa` (string)
-: The IDFA associated with the device
+`idfa` (string): The IDFA associated with the device
@@ -79,7 +77,7 @@ import GetIdfa from "@react-native-examples/Adjust/getIdfa.mdx"
## getGoogleAdid
-Returns the Google ADID (Google advertiser ID) associated with the device.
+Returns the Google ADID (Google advertiser ID) associated with the device.
@@ -99,8 +97,7 @@ import GetGoogleAdid from "@react-native-examples/Adjust/getGoogleAdId.mdx"
-`googleAdid` (string)
-: The Google ADID associated with the device
+`googleAdid` (string): The Google ADID associated with the device
@@ -110,7 +107,7 @@ import GetGoogleAdid from "@react-native-examples/Adjust/getGoogleAdId.mdx"
## getAmazonAdid
-Returns the Amazon ADID (Amazon advertiser ID) associated with the device.
+Returns the Amazon ADID (Amazon advertiser ID) associated with the device.
@@ -130,8 +127,7 @@ import GetAmazonAdid from "@react-native-examples/Adjust/getAmazonAdId.mdx"
-`amazonAdId` (string)
-: The Amazon ADID associated with the device
+`amazonAdId` (string): The Amazon ADID associated with the device
diff --git a/src/content/docs/sdk/react-native/reference/adjust/privacy.mdx b/src/content/docs/sdk/react-native/reference/adjust/privacy.mdx
index 5cedfc542..e6f843cda 100644
--- a/src/content/docs/sdk/react-native/reference/adjust/privacy.mdx
+++ b/src/content/docs/sdk/react-native/reference/adjust/privacy.mdx
@@ -55,8 +55,7 @@ import TrackThirdPartySharing from "@react-native-examples/Adjust/trackThirdPart
-`thirdPartySharing` (AdjustThirdPartySharing)
-: The third party sharing object
+`thirdPartySharing` (AdjustThirdPartySharing): The third party sharing object
@@ -86,8 +85,7 @@ import TrackMeasurementConsent from "@react-native-examples/Adjust/trackMeasurem
-`enabled` (boolean)
-: Whether data collection and retention rules apply for the user.
+`enabled` (boolean): Whether data collection and retention rules apply for the user.
@@ -97,7 +95,7 @@ import TrackMeasurementConsent from "@react-native-examples/Adjust/trackMeasurem
## gdprForgetMe
-Send an RTBF (Right To Be Forgotten) request to Adjust's servers. This erases all information about the user the source app. The SDK stops sending requests for the user.
+Send an RTBF (Right To Be Forgotten) request to Adjust's servers. This erases all information about the user the source app. The SDK stops sending requests for the user.
diff --git a/src/content/docs/sdk/react-native/reference/adjust/recording.mdx b/src/content/docs/sdk/react-native/reference/adjust/recording.mdx
index fce5b0ae6..311463264 100644
--- a/src/content/docs/sdk/react-native/reference/adjust/recording.mdx
+++ b/src/content/docs/sdk/react-native/reference/adjust/recording.mdx
@@ -31,8 +31,7 @@ import TrackEvent from "@react-native-examples/Adjust/trackEvent.mdx"
-`event` (AdjustEvent)
-: An event object containing the information you want to send to Adjust.
+`event` (AdjustEvent): An event object containing the information you want to send to Adjust.
@@ -62,11 +61,9 @@ import AddSessionCallbackParameter from "@react-native-examples/Adjust/addSessio
-`key` (string)
-: The data key
+`key` (string): The data key
-`value` (string)
-: The data value
+`value` (string): The data value
@@ -96,8 +93,7 @@ import RemoveSessionCallbackParameter from "@react-native-examples/Adjust/remove
-`key` (string)
-: The data key of the parameter you want to remove.
+`key` (string): The data key of the parameter you want to remove.
@@ -151,11 +147,9 @@ import AddSessionPartnerParameter from "@react-native-examples/Adjust/addSession
-`key` (string)
-: The data key
+`key` (string): The data key
-`value` (string)
-: The data value
+`value` (string): The data value
@@ -185,8 +179,7 @@ import RemoveSessionPartnerParameter from "@react-native-examples/Adjust/removeS
-`key` (string)
-: The data key of the parameter you want to remove.
+`key` (string): The data key of the parameter you want to remove.
@@ -240,8 +233,7 @@ import TrackAdRevenue from "@react-native-examples/Adjust/trackAdRevenue.mdx"
-`adRevenue` (AdjustAdRevenue)
-: The ad revenue object containing the revenue details.
+`adRevenue` (AdjustAdRevenue): The ad revenue object containing the revenue details.
@@ -271,8 +263,7 @@ import TrackPlayStoreSubscription from "@react-native-examples/Adjust/trackPlayS
-`subscription` (AdjustPlayStoreSubscription)
-: The subscription object containing the purchase details.
+`subscription` (AdjustPlayStoreSubscription): The subscription object containing the purchase details.
@@ -302,8 +293,7 @@ import TrackAppStoreSubscription from "@react-native-examples/Adjust/trackAppSto
-`subscription` (AdjustAppStoreSubscription)
-: The subscription object containing the purchase details.
+`subscription` (AdjustAppStoreSubscription): The subscription object containing the purchase details.
@@ -333,8 +323,7 @@ import GetAttribution from "@react-native-examples/Adjust/getAttribution.mdx"
-`attribution` (AdjustAttribution)
-: An attribution object containing attribution data associated with the device.
+`attribution` (AdjustAttribution): An attribution object containing attribution data associated with the device.
diff --git a/src/content/docs/sdk/react-native/reference/adjust/skan-att.mdx b/src/content/docs/sdk/react-native/reference/adjust/skan-att.mdx
index d62d45229..c308a1121 100644
--- a/src/content/docs/sdk/react-native/reference/adjust/skan-att.mdx
+++ b/src/content/docs/sdk/react-native/reference/adjust/skan-att.mdx
@@ -31,8 +31,7 @@ import RequestTrackingAuthorization from "@react-native-examples/Adjust/requestT
-`statusCallback` (Action\)
-: Completion handler to which the status is passed.
+`statusCallback` (Action\): Completion handler to which the status is passed.
@@ -62,8 +61,7 @@ import GetAppTrackingAuthorizationStatus from "@react-native-examples/Adjust/app
-`status` (number)
-: The user's authorization status.
+`status` (number): The user's authorization status.
@@ -117,8 +115,7 @@ import UpdateConversionValue from "@react-native-examples/Adjust/updateConversio
-conversionValue (number)
-: The new conversion value.
+conversionValue (number): The new conversion value.
diff --git a/src/content/docs/sdk/react-native/reference/adjustadrevenue.mdx b/src/content/docs/sdk/react-native/reference/adjustadrevenue.mdx
index 59edf62a3..1cf7a81c2 100644
--- a/src/content/docs/sdk/react-native/reference/adjustadrevenue.mdx
+++ b/src/content/docs/sdk/react-native/reference/adjustadrevenue.mdx
@@ -31,8 +31,7 @@ import Constructor from "@react-native-examples/AdjustAdRevenue/constructor.mdx"
-`source` (string)
-: The source of the ad revenue.
+`source` (string): The source of the ad revenue.
@@ -77,11 +76,9 @@ import SetRevenue from "@react-native-examples/AdjustAdRevenue/setRevenue.mdx";
-`amount` (number)
-: The amount of currency units associated with the ad.
+`amount` (number): The amount of currency units associated with the ad.
-`currency` (string)
-: The 3 character [ISO 4217 code](https://www.iban.com/currency-codes) of the currency unit.
+`currency` (string): The 3 character [ISO 4217 code](https://www.iban.com/currency-codes) of the currency unit.
@@ -111,8 +108,7 @@ import SetAdImpressionsCount from "@react-native-examples/AdjustAdRevenue/setAdI
-`adImpressionsCaount` (number)
-: The number of impressions associated with the ad.
+`adImpressionsCaount` (number): The number of impressions associated with the ad.
@@ -142,8 +138,7 @@ import SetAdRevenueNetwork from "@react-native-examples/AdjustAdRevenue/setAdRev
-`adRevenueNetwork` (string)
-: The network associated with the ad revenue.
+`adRevenueNetwork` (string): The network associated with the ad revenue.
@@ -173,8 +168,7 @@ import SetAdRevenueUnit from "@react-native-examples/AdjustAdRevenue/setAdRevenu
-`unit` (string)
-: The ad unit ID associated with the ad revenue.
+`unit` (string): The ad unit ID associated with the ad revenue.
@@ -204,8 +198,7 @@ import SetAdRevenuePlacement from "@react-native-examples/AdjustAdRevenue/setAdR
-`adRevenuePlacement` (string)
-: The placement of the ad associated with the revenue.
+`adRevenuePlacement` (string): The placement of the ad associated with the revenue.
@@ -235,11 +228,9 @@ import AddCallbackParameter from "@react-native-examples/AdjustAdRevenue/addCall
-`key` (string)
-: The data key.
+`key` (string): The data key.
-`value` (string)
-: The data value.
+`value` (string): The data value.
@@ -269,11 +260,9 @@ import AddPartnerParameter from "@react-native-examples/AdjustAdRevenue/addPartn
-`key` (string)
-: The data key.
+`key` (string): The data key.
-`value` (string)
-: The data value.
+`value` (string): The data value.
diff --git a/src/content/docs/sdk/react-native/reference/adjustappstoresubscription.mdx b/src/content/docs/sdk/react-native/reference/adjustappstoresubscription.mdx
index 4bea7d908..a719c9927 100644
--- a/src/content/docs/sdk/react-native/reference/adjustappstoresubscription.mdx
+++ b/src/content/docs/sdk/react-native/reference/adjustappstoresubscription.mdx
@@ -7,7 +7,7 @@ slug: en/sdk/react-native/reference/adjustappstoresubscription
import TrackAppStoreSubscription from "@react-native-signatures/Adjust/trackAppStoreSubscription.mdx"
-Use this class to store App Store subscription information. You can pass this to Adjust's servers using the `trackAppStoreSubscription` method || .
+Use this class to store App Store subscription information. You can pass this to Adjust's servers using the `trackAppStoreSubscription` method.
@@ -33,17 +33,13 @@ import Constructor from "@react-native-examples/AdjustAppStoreSubscription/adjus
-`price` (string)
-: The price of the subscription.
+`price` (string): The price of the subscription.
-`currency` (string)
-: The currency of the subscription. Formatted as the [`currencyCode`](https://developer.apple.com/documentation/foundation/nslocale/1642836-currencycode?language=objc) of the [`priceLocale`](https://developer.apple.com/documentation/storekit/skproduct/1506145-pricelocale?language=objc) object
+`currency` (string): The currency of the subscription. Formatted as the [`currencyCode`](https://developer.apple.com/documentation/foundation/nslocale/1642836-currencycode?language=objc) of the [`priceLocale`](https://developer.apple.com/documentation/storekit/skproduct/1506145-pricelocale?language=objc) object
-`transactionId` (string)
-: Your ID for the transaction.
+`transactionId` (string): Your ID for the transaction.
-`receipt` (string)
-: The receipt information.
+`receipt` (string): The receipt information.
@@ -73,8 +69,7 @@ import SetTransactionDate from "@react-native-examples/AdjustAppStoreSubscriptio
-`transactionDate` (string)
-: The date on which the subscription was purchased.
+`transactionDate` (string): The date on which the subscription was purchased.
@@ -104,8 +99,7 @@ import SetSalesRegion from "@react-native-examples/AdjustAppStoreSubscription/se
-`salesRegion` (string)
-: The region in which the subscription was purchased.
+`salesRegion` (string): The region in which the subscription was purchased.
@@ -135,11 +129,9 @@ import AddCallbackParameter from "@react-native-examples/AdjustAppStoreSubscript
-`key` (string)
-: The data key.
+`key` (string): The data key.
-`value` (string)
-: The data value.
+`value` (string): The data value.
@@ -169,11 +161,9 @@ import AddPartnerParameter from "@react-native-examples/AdjustAppStoreSubscripti
-`key` (string)
-: The data key.
+`key` (string): The data key.
-`value` (string)
-: The data value.
+`value` (string): The data value.
diff --git a/src/content/docs/sdk/react-native/reference/adjustattribution.mdx b/src/content/docs/sdk/react-native/reference/adjustattribution.mdx
index c9c83aa4f..58f341a57 100644
--- a/src/content/docs/sdk/react-native/reference/adjustattribution.mdx
+++ b/src/content/docs/sdk/react-native/reference/adjustattribution.mdx
@@ -12,11 +12,11 @@ The `AdjustAttribution` class contains details about the current attribution sta
## Properties
-The following properties can be accessed by calling the `getAttribution` method || . Any values that aren't populated for the user are returned as a null value.
+The following properties can be accessed by calling the `getAttribution` method. Any values that aren't populated for the user are returned as a null value.
-The following values can only be accessed if the `needsCost` property || on your `ADJConfig` instance is `true`:
+The following values can only be accessed if the `needsCost` property on your `ADJConfig` instance is `true`:
- `costType`
- `costAmount`
diff --git a/src/content/docs/sdk/react-native/reference/adjustconfig/index.mdx b/src/content/docs/sdk/react-native/reference/adjustconfig/index.mdx
index 886637f94..a22e1d689 100644
--- a/src/content/docs/sdk/react-native/reference/adjustconfig/index.mdx
+++ b/src/content/docs/sdk/react-native/reference/adjustconfig/index.mdx
@@ -39,18 +39,15 @@ import ConfigWithAppToken from "@react-native-examples/AdjustConfig/constructor.
-`appToken` (string)
-: Your Adjust app token.
+`appToken` (string): Your Adjust app token.
-`environment` (Environment)
-: The environment your app is running in.
+`environment` (Environment): The environment your app is running in.
-`config` (AdjustConfig)
-: A config object initialized with the provided params.
+`config` (AdjustConfig): A config object initialized with the provided params.
diff --git a/src/content/docs/sdk/react-native/reference/adjustconfig/privacy.mdx b/src/content/docs/sdk/react-native/reference/adjustconfig/privacy.mdx
index 0f281a7d7..b5e90c0ca 100644
--- a/src/content/docs/sdk/react-native/reference/adjustconfig/privacy.mdx
+++ b/src/content/docs/sdk/react-native/reference/adjustconfig/privacy.mdx
@@ -29,8 +29,7 @@ import SetUrlStrategy from "@react-native-examples/AdjustConfig/setUrlStrategy.m
-`urlStrategy` (UrlStrategy)
-: The data residency target (see available values below)
+`urlStrategy` (UrlStrategy): The data residency target (see available values below)
@@ -53,7 +52,7 @@ import SetUrlStrategy from "@react-native-examples/AdjustConfig/setUrlStrategy.m
## setCoppaCompliantEnabled
-Enable COPPA (Children's Online Privacy Protection Act) compliance in your app.
+Enable COPPA (Children's Online Privacy Protection Act) compliance in your app.
@@ -73,8 +72,7 @@ import SetCoppaCompliantEnabled from "@react-native-examples/AdjustConfig/setCop
-`coppaCompliantEnabled` (boolean)
-: Whether the app should be COPPA compliant.
+`coppaCompliantEnabled` (boolean): Whether the app should be COPPA compliant.
diff --git a/src/content/docs/sdk/react-native/reference/adjustconfig/setup.mdx b/src/content/docs/sdk/react-native/reference/adjustconfig/setup.mdx
index f4694f9b2..111d1cbd3 100644
--- a/src/content/docs/sdk/react-native/reference/adjustconfig/setup.mdx
+++ b/src/content/docs/sdk/react-native/reference/adjustconfig/setup.mdx
@@ -31,8 +31,7 @@ import SetLogLevel from "@react-native-examples/AdjustConfig/setLogLevel.mdx";
-`logLevel` (LogLevel)
-: The level of logging output by the SDK.
+`logLevel` (LogLevel): The level of logging output by the SDK.
@@ -76,8 +75,7 @@ import SetDefaultTracker from "@react-native-examples/AdjustConfig/setDefaultTra
-`defaultTracker` (string)
-: The token to which all preinstalled sessions are attributed.
+`defaultTracker` (string): The token to which all preinstalled sessions are attributed.
@@ -107,8 +105,7 @@ import SetSendInBackground from "@react-native-examples/AdjustConfig/sendInBackg
-`sendInBackground` (boolean)
-: Whether the SDK should send information to Adjust when the app is running in the background.
+`sendInBackground` (boolean): Whether the SDK should send information to Adjust when the app is running in the background.
@@ -138,8 +135,7 @@ import SetSessionTrackingSucceededCallbackListener from "@react-native-examples/
-`callback` (function)
-: The function to launch when the SDK successfully records a session.
+`callback` (function): The function to launch when the SDK successfully records a session.
@@ -169,8 +165,7 @@ import SetSessionTrackingFailedCallbackListener from "@react-native-examples/Adj
-`callback` (function)
-: The function to launch when the SDK fails to record a session.
+`callback` (function): The function to launch when the SDK fails to record a session.
@@ -200,8 +195,7 @@ import SetEventTrackingSucceededCallbackListener from "@react-native-examples/Ad
-`callback` (function)
-: The function to launch when the SDK successfully records an event.
+`callback` (function): The function to launch when the SDK successfully records an event.
@@ -231,8 +225,7 @@ import SetEventTrackingFailedCallbackListener from "@react-native-examples/Adjus
-`callback` (function)
-: The function to launch when the SDK fails to record an event.
+`callback` (function): The function to launch when the SDK fails to record an event.
@@ -268,8 +261,7 @@ import SetDelayStart from "@react-native-examples/AdjustConfig/setDelayStart.mdx
-`delayStart` (number)
-: The time (in seconds) to delay the start of the SDK by.
+`delayStart` (number): The time (in seconds) to delay the start of the SDK by.
@@ -299,8 +291,7 @@ import SetExternalDeviceId from "@react-native-examples/AdjustConfig/setExternal
-`externalDeviceId` (string)
-: The external device ID associated with the device.
+`externalDeviceId` (string): The external device ID associated with the device.
@@ -330,8 +321,7 @@ import SetEventBufferingEnabled from "@react-native-examples/AdjustConfig/setEve
-`eventBufferingEnabled` (boolean)
-: Whether event buffering is enabled.
+`eventBufferingEnabled` (boolean): Whether event buffering is enabled.
@@ -361,8 +351,7 @@ import SetNeedsCost from "@react-native-examples/AdjustConfig/setNeedsCost.mdx";
-`needsCost` (boolean)
-: Whether the SDK should gather cost data
+`needsCost` (boolean): Whether the SDK should gather cost data
@@ -392,8 +381,7 @@ import SetAttributionCallbackListener from "@react-native-examples/AdjustConfig/
-`callback` (function)
-: The delegate function that the SDK calls when the user's attribution information changes.
+`callback` (function): The delegate function that the SDK calls when the user's attribution information changes.
@@ -423,8 +411,7 @@ import SetPreinstallTrackingEnabled from "@react-native-examples/AdjustConfig/se
-`preinstallTrackingEnabled` (boolean)
-: Whether preinstall tracking is enabled.
+`preinstallTrackingEnabled` (boolean): Whether preinstall tracking is enabled.
@@ -460,8 +447,7 @@ import SetPreinstallFilePath from "@react-native-examples/AdjustConfig/setPreins
-`preinstallFilePath` (string)
-: The path where the preinstall information is written.
+`preinstallFilePath` (string): The path where the preinstall information is written.
@@ -521,8 +507,7 @@ import SetDeferredDeeplinkCallbackListener from "@react-native-examples/AdjustCo
-`callback` (function)
-: The function to launch when deep link content is received.
+`callback` (function): The function to launch when deep link content is received.
@@ -552,8 +537,7 @@ import SetLinkMeEnabled from "@react-native-examples/AdjustConfig/setLinkMeEnabl
-`linkMeEnabled` (boolean)
-: Whether to enable LinkMe.
+`linkMeEnabled` (boolean): Whether to enable LinkMe.
@@ -583,8 +567,7 @@ import SetConversionValueUpdatedCallbackListener from "@react-native-examples/Ad
-`callback` (function)
-: The delegate function the SDK launches when the conversion value updates
+`callback` (function): The delegate function the SDK launches when the conversion value updates
diff --git a/src/content/docs/sdk/react-native/reference/adjustevent.mdx b/src/content/docs/sdk/react-native/reference/adjustevent.mdx
index 8c86baecf..f01e3b8a0 100644
--- a/src/content/docs/sdk/react-native/reference/adjustevent.mdx
+++ b/src/content/docs/sdk/react-native/reference/adjustevent.mdx
@@ -7,7 +7,7 @@ slug: en/sdk/react-native/reference/adjustevent
import TrackEvent from "@react-native-signatures/Adjust/trackEvent.mdx"
-This class contains information about events triggered in your application. You can send this information to Adjust's servers by passing an `AdjustEvent` object to the `trackEvent` method || .
+This class contains information about events triggered in your application. You can send this information to Adjust's servers by passing an `AdjustEvent` object to the `trackEvent` method.
@@ -33,8 +33,7 @@ import Constructor from "@react-native-examples/AdjustEvent/constructor.mdx"
-`eventToken` (string)
-: A 6 character Adjust event token.
+`eventToken` (string): A 6 character Adjust event token.
@@ -64,11 +63,9 @@ import SetRevenue from "@react-native-examples/AdjustEvent/setRevenue.mdx"
-`amount` (number)
-: The amount of currency units associated with the event.
+`amount` (number): The amount of currency units associated with the event.
-`currency` (string)
-: The 3 character [ISO 4217 code](https://www.iban.com/currency-codes) of the currency unit.
+`currency` (string): The 3 character [ISO 4217 code](https://www.iban.com/currency-codes) of the currency unit.
@@ -98,8 +95,7 @@ import SetTransactionId from "@react-native-examples/AdjustEvent/setTransactionI
-`transactionId` (string)
-: A unique identifier used to deduplicate events.
+`transactionId` (string): A unique identifier used to deduplicate events.
@@ -129,8 +125,7 @@ import SetCallbackId from "@react-native-examples/AdjustEvent/setCallbackId.mdx"
-`callbackId` (string)
-: A custom identifier for your event object.
+`callbackId` (string): A custom identifier for your event object.
@@ -160,11 +155,9 @@ import AddCallbackParameter from "@react-native-examples/AdjustEvent/addCallback
-`key` (string)
-: The data key.
+`key` (string): The data key.
-`value` (string)
-: The data value.
+`value` (string): The data value.
@@ -194,11 +187,9 @@ import AddPartnerParameter from "@react-native-examples/AdjustEvent/addPartnerPa
-`key` (string)
-: The data key.
+`key` (string): The data key.
-`value` (string)
-: The data value.
+`value` (string): The data value.
diff --git a/src/content/docs/sdk/react-native/reference/adjustplaystoresubscription.mdx b/src/content/docs/sdk/react-native/reference/adjustplaystoresubscription.mdx
index 5141b1538..27a6c84f0 100644
--- a/src/content/docs/sdk/react-native/reference/adjustplaystoresubscription.mdx
+++ b/src/content/docs/sdk/react-native/reference/adjustplaystoresubscription.mdx
@@ -7,7 +7,7 @@ slug: en/sdk/react-native/reference/adjustplaystoresubscription
import TrackPlayStoreSubscription from "@react-native-signatures/Adjust/trackPlayStoreSubscription.mdx"
-Use this class to store Play Store subscription information. You can pass this to Adjust's servers using the `trackPlayStoreSubscription` method || .
+Use this class to store Play Store subscription information. You can pass this to Adjust's servers using the `trackPlayStoreSubscription` method.
@@ -33,23 +33,17 @@ import Constructor from "@react-native-examples/AdjustPlayStoreSubscription/adju
-`price` (string)
-: The price of the subscription.
+`price` (string): The price of the subscription.
-`currency` (string)
-: The currency of the subscription. Formatted as the [`currencyCode`](https://developer.apple.com/documentation/foundation/nslocale/1642836-currencycode?language=objc) of the [`priceLocale`](https://developer.apple.com/documentation/storekit/skproduct/1506145-pricelocale?language=objc) object
+`currency` (string): The currency of the subscription. Formatted as the [`currencyCode`](https://developer.apple.com/documentation/foundation/nslocale/1642836-currencycode?language=objc) of the [`priceLocale`](https://developer.apple.com/documentation/storekit/skproduct/1506145-pricelocale?language=objc) object
-`sku` (string)
-: The ID of the product.
+`sku` (string): The ID of the product.
-`orderId` (string)
-: Your ID for the transaction.
+`orderId` (string): Your ID for the transaction.
-`signature` (string)
-: The signature of the purchase data.
+`signature` (string): The signature of the purchase data.
-`purchaseToken` (string)
-: The unique token of the transaction. See [Google's documentation](https://developer.android.com/reference/com/android/billingclient/api/Purchase#getPurchaseToken()) for more information.
+`purchaseToken` (string): The unique token of the transaction. See [Google's documentation](https://developer.android.com/reference/com/android/billingclient/api/Purchase#getPurchaseToken()) for more information.
@@ -79,8 +73,7 @@ import SetPurchaseTime from "@react-native-examples/AdjustPlayStoreSubscription/
-`purchaseTime` (string)
-: The date on which the subscription was purchased.
+`purchaseTime` (string): The date on which the subscription was purchased.
@@ -111,11 +104,9 @@ import AddCallbackParameter from "@react-native-examples/AdjustPlayStoreSubscrip
-`key` (string)
-: The data key.
+`key` (string): The data key.
-`value` (string)
-: The data value.
+`value` (string): The data value.
@@ -145,11 +136,9 @@ import AddPartnerParameter from "@react-native-examples/AdjustPlayStoreSubscript
-`key` (string)
-: The data key.
+`key` (string): The data key.
-`value` (string)
-: The data value.
+`value` (string): The data value.
diff --git a/src/content/docs/sdk/react-native/reference/adjustthirdpartysharing.mdx b/src/content/docs/sdk/react-native/reference/adjustthirdpartysharing.mdx
index 509cb2feb..e20d973b2 100644
--- a/src/content/docs/sdk/react-native/reference/adjustthirdpartysharing.mdx
+++ b/src/content/docs/sdk/react-native/reference/adjustthirdpartysharing.mdx
@@ -7,7 +7,7 @@ slug: en/sdk/react-native/reference/adjustthirdpartysharing
import TrackThirdPartySharing from "@react-native-signatures/Adjust/trackThirdPartySharing.mdx"
-Use this class to communicate a user's third party sharing preferences. Send this information to Adjust's servers using the `trackThirdPartySharing` method || .
+Use this class to communicate a user's third party sharing preferences. Send this information to Adjust's servers using the `trackThirdPartySharing` method.
@@ -33,8 +33,7 @@ import InitTrue from "@react-native-examples/AdjustThirdPartySharing/initTrue.md
-`isEnabled` (boolean)
-: Whether third party sharing is enabled.
+`isEnabled` (boolean): Whether third party sharing is enabled.
@@ -66,20 +65,13 @@ import Facebook from "@react-native-examples/AdjustThirdPartySharing/addGranular
-
-
-- - Parameter
- - Description
-- - `partner_name`
- - Use `facebook` to toggle LDU.
-- - `data_processing_options_country`
- - The user is located in.
- - `0`: Request that Facebook use geolocation.
- - `1`: United States of America.
-- - `data_processing_options_state`
- - Notifies Facebook which state the user is located in.
- - `0`: Request that Facebook use geolocation.
- - `1000`: California.
+
+
+| Parameter | Description |
+| --------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
+| `partner_name` | Use `facebook` to toggle LDU. |
+| `data_processing_options_country` | The country in which the user is located.- `0`: Request that Facebook use geolocation.
- `1`: United States of America.
|
+| `data_processing_options_state` | Notifies Facebook in which state the user is located.- `0`: Request that Facebook use geolocation.
- `1000`: California.
|
@@ -87,14 +79,11 @@ import Facebook from "@react-native-examples/AdjustThirdPartySharing/addGranular
-`partnerName` (string)
-: The name of the partner you want to share information with.
+`partnerName` (string): The name of the partner you want to share information with.
-`key` (string)
-: The data key.
+`key` (string): The data key.
-`value` (string)
-: The data value.
+`value` (string): The data value.
@@ -124,12 +113,9 @@ import AddPartnerSharingSetting from "@react-native-examples/AdjustThirdPartySha
-`partnerName` (string)
-: The name of the partner whose settings you want to update. See the table of available partners below.
-`key` (string)
-: The setting you want to update.
-`value` (boolean)
-: Whether the setting is enabled.
+`partnerName` (string): The name of the partner whose settings you want to update. See the table of available partners below.
+`key` (string): The setting you want to update.
+`value` (boolean): Whether the setting is enabled.
diff --git a/src/content/docs/sdk/unity/configuration/att.mdx b/src/content/docs/sdk/unity/configuration/att.mdx
index e9c732e70..760ac0d0d 100644
--- a/src/content/docs/sdk/unity/configuration/att.mdx
+++ b/src/content/docs/sdk/unity/configuration/att.mdx
@@ -10,7 +10,7 @@ import AppTrackingAuthorizationStatusSig from "@unity-signatures/Adjust/appTrack
import CheckForNewAttStatus from "@unity-examples/Adjust/checkForNewAttStatus.mdx"
import CheckForNewAttStatusSig from "@unity-signatures/Adjust/checkForNewAttStatus.mdx"
-If you want to record the device's IDFA (ID for Advertisers), you must display a prompt to get your user's authorization. To do this, you need to include Apple's ATT (App Tracking Transparency) framework in your app. The Adjust SDK stores the user's authorization status and sends it to Adjust's servers with each request.
+If you want to record the device's IDFA (ID for Advertisers), you must display a prompt to get your user's authorization. To do this, you need to include Apple's ATT (App Tracking Transparency) framework in your app. The Adjust SDK stores the user's authorization status and sends it to Adjust's servers with each request.
## Authorization statuses
@@ -27,7 +27,7 @@ If you want to record the device's IDFA (ID for Advertisers), you m
-You might receive a status code of `-1` if the SDK is unable to retrieve the ATT (App Tracking Transparency) status.
+You might receive a status code of `-1` if the SDK is unable to retrieve the ATT (App Tracking Transparency) status.
@@ -74,7 +74,7 @@ Adjust.requestTrackingAuthorizationWithCompletionHandler((status) =>
## Get current authorization status
-You can retrieve a user's current authorization status at any time. Call the `appTrackingAuthorizationStatus` method || to return the authorization status code as an **integer**.
+You can retrieve a user's current authorization status at any time. Call the `appTrackingAuthorizationStatus` method to return the authorization status code as an **integer**.
@@ -89,6 +89,6 @@ Adjust.addSessionPartnerParameter("status", authorizationStatus);
## Check for authorization status changes
-If you use a custom ATT prompt, you need to inform the Adjust SDK of changes to the user's authorization status. Call the `checkForNewAttStatus` method || to send the authorization status to Adjust's servers.
+If you use a custom ATT prompt, you need to inform the Adjust SDK of changes to the user's authorization status. Call the `checkForNewAttStatus` method to send the authorization status to Adjust's servers.
diff --git a/src/content/docs/sdk/unity/configuration/background.mdx b/src/content/docs/sdk/unity/configuration/background.mdx
index dd8d42d8f..629f95ad4 100644
--- a/src/content/docs/sdk/unity/configuration/background.mdx
+++ b/src/content/docs/sdk/unity/configuration/background.mdx
@@ -9,7 +9,7 @@ import SetSendInBackgroundSig from "@unity-signatures/AdjustConfig/sendInBackgro
By default, the Adjust SDK pauses the sending of requests when your app is running in the background. You can configure the SDK to send requests in the background by enabling the background recording feature.
-Your config object contains a boolean `sendInBackground` property that controls this behavior. You can set this property by calling the `setSendInBackground` method || on your config instance with a boolean value.
+Your config object contains a boolean `sendInBackground` property that controls this behavior. You can set this property by calling the `setSendInBackground` method on your config instance with a boolean value.
diff --git a/src/content/docs/sdk/unity/configuration/deep-links.mdx b/src/content/docs/sdk/unity/configuration/deep-links.mdx
index fee949a4e..4b1c98314 100644
--- a/src/content/docs/sdk/unity/configuration/deep-links.mdx
+++ b/src/content/docs/sdk/unity/configuration/deep-links.mdx
@@ -10,15 +10,13 @@ import SetLinkMeEnabledSig from "@unity-signatures/AdjustConfig/setLinkMeEnabled
import SetLaunchDeferredDeeplink from "@unity-examples/AdjustConfig/setLaunchDeferredDeeplink.mdx"
import SetLaunchDeferredDeeplinkSig from "@unity-signatures/AdjustConfig/setLaunchDeferredDeeplink.mdx"
-Deep links are URIs (Uniform Resource Identifiers) that direct users to a specific page in your app without any additional navigation. You can use them throughout your marketing funnel to improve user acquisition, engagement, and retention.
+Deep links are URIs (Uniform Resource Identifiers) that direct users to a specific page in your app without any additional navigation. You can use them throughout your marketing funnel to improve user acquisition, engagement, and retention.
The Adjust SDK uses different logic depending on whether the user already has your app installed on their device:
-Direct deep linking
-: Occurs if the user already has your app installed. The link takes the user to the page specified in the link
+Direct deep linking: Occurs if the user already has your app installed. The link takes the user to the page specified in the link
-Deferred deep linking
-: Occurs if the user doesn't have your app installed. The link takes the user to a storefront to install your app first. After the user installs the app, it opens to the page specified in the link.
+Deferred deep linking: Occurs if the user doesn't have your app installed. The link takes the user to a storefront to install your app first. After the user installs the app, it opens to the page specified in the link.
To get started, follow these steps.
@@ -42,10 +40,10 @@ For Adjust SDK below v4.30 or Unity Editor below v2019.2 (Android only), you nee
Devices running iOS 9 and later use [universal links](https://developer.apple.com/library/ios/documentation/General/Conceptual/AppSearch/UniversalLinks.html) to handle deep links. You need to add your universal link scheme to your app to open deep links in your app. To do this:
1. Set up your universal links in the Adjust dashboard.
-2. Configure Associated Domains for your app in the Apple Developer Portal.
+2. Configure **Associated Domains** for your app in the Apple Developer Portal.
3. Open the Unity editor.
-4. Navigate to the DEEP LINKING section of the Adjust prefab.
-5. Enter your universal link(s) in the iOS Universal Links Domain field. Replace the `https://` protocol with `applinks:`
+4. Navigate to the **DEEP LINKING** section of the Adjust prefab.
+5. Enter your universal link(s) in the **iOS Universal Links Domain** field. Replace the `https://` protocol with `applinks:`
### Set up a custom URL scheme
@@ -53,12 +51,12 @@ Devices running iOS 8 and earlier use a custom URL scheme to handle deep links.
1. Set up your deep links in the Adjust dashboard.
2. Open the Unity editor.
-3. Navigate to the DEEP LINKING section of the Adjust prefab.
-4. Enter your URL scheme(s) in the iOS URL Schemes field. Enter only the scheme without the following `://`.
+3. Navigate to the **DEEP LINKING** section of the Adjust prefab.
+4. Enter your URL scheme(s) in the **iOS URL Schemes** field. Enter only the scheme without the following `://`.
## Deep linking on Android
-Android devices use a unique URI scheme to handle deep links. To set up deep linking, add your scheme to the Android URI Schemes section of the Adjust prefab. The SDK adds the required XML tags to your `AndroidManifest.xml`.
+Android devices use a unique URI scheme to handle deep links. To set up deep linking, add your scheme to the **Android URI Schemes** section of the Adjust prefab. The SDK adds the required XML tags to your `AndroidManifest.xml`.
@@ -66,7 +64,7 @@ Android devices use a unique URI scheme to handle deep links. To set up deep lin
### Disable deferred deep linking
-The SDK opens deferred deep links by default. You can configure this by passing a **boolean** argument to the `setLaunchDeferredDeeplink` method || .
+The SDK opens deferred deep links by default. You can configure this by passing a **boolean** argument to the `setLaunchDeferredDeeplink` method.
@@ -111,6 +109,6 @@ The Adjust SDK checks the pasteboard when a user opens the app for the first tim
When a user clicks on a LinkMe URL they have the option to copy the link information to their system pasteboard. You can use the Adjust SDK to read the system pasteboard for deep link information. If deep link information is present, the SDK forwards the user to the correct page in your app.
-To enable pasteboard checking in your app, pass a true value to the `setLinkMeEnabled` method || on your config object:
+To enable pasteboard checking in your app, pass a true value to the `setLinkMeEnabled` method on your config object:
diff --git a/src/content/docs/sdk/unity/configuration/delay.mdx b/src/content/docs/sdk/unity/configuration/delay.mdx
index 6f5a8993c..84d9285cb 100644
--- a/src/content/docs/sdk/unity/configuration/delay.mdx
+++ b/src/content/docs/sdk/unity/configuration/delay.mdx
@@ -17,7 +17,7 @@ The offline mode setting isn't remembered between sessions. Offline mode is disa
The Adjust SDK sends event and session data to Adjust's servers in real time. You can pause the sending of information by putting the SDK in offline mode. In offline mode the SDK stores all data in a local file on the device. The SDK sends this information to Adjust's servers when you disable offline mode.
-Your config object contains a boolean `isOffline` property that controls this behavior. You can update this property at any time by calling the `setOfflineMode` method || with a boolean argument. The SDK sends all saved information to Adjust's servers when you deactivate offline mode.
+Your config object contains a boolean `isOffline` property that controls this behavior. You can update this property at any time by calling the `setOfflineMode` method with a boolean argument. The SDK sends all saved information to Adjust's servers when you deactivate offline mode.
@@ -25,6 +25,6 @@ Your config object contains a boolean `isOffline` property that controls this be
The Adjust SDK sends event information as soon as a user triggers an event in your app. You can send event information on a schedule by enabling event buffering. Event buffering stores events in a local buffer on the device and sends all requests once per minute.
-Your config object contains a boolean `eventBufferingEnabled` property that controls this behavior. You can set this property by calling the `setEventBufferingEnabled` method || on your config object with a boolean argument.
+Your config object contains a boolean `eventBufferingEnabled` property that controls this behavior. You can set this property by calling the `setEventBufferingEnabled` method on your config object with a boolean argument.
diff --git a/src/content/docs/sdk/unity/configuration/disable.mdx b/src/content/docs/sdk/unity/configuration/disable.mdx
index 2c6543a98..38a2d7d73 100644
--- a/src/content/docs/sdk/unity/configuration/disable.mdx
+++ b/src/content/docs/sdk/unity/configuration/disable.mdx
@@ -11,7 +11,7 @@ import IsEnabledSig from "@unity-signatures/Adjust/isEnabled.mdx"
The Adjust SDK runs by default when your app is open. You can disable and re-enable the Adjust SDK to pause and resume recording. When you disable the Adjust SDK, it doesn't send any data to Adjust's servers.
-You can enable or disable the SDK at any time by calling the `setEnabled` method || with a boolean argument.
+You can enable or disable the SDK at any time by calling the `setEnabled` method with a boolean argument.
@@ -23,7 +23,7 @@ You can only call this method after the first session. This setting persists bet
## Check enabled status
-You can check if the Adjust SDK is enabled at any time by calling the `isEnabled` method || . This method returns a boolean value.
+You can check if the Adjust SDK is enabled at any time by calling the `isEnabled` method. This method returns a boolean value.
diff --git a/src/content/docs/sdk/unity/configuration/external-device-id.mdx b/src/content/docs/sdk/unity/configuration/external-device-id.mdx
index 409a22454..fe2352ffd 100644
--- a/src/content/docs/sdk/unity/configuration/external-device-id.mdx
+++ b/src/content/docs/sdk/unity/configuration/external-device-id.mdx
@@ -17,7 +17,7 @@ See the [External device identifiers article](https://help.adjust.com/en/article
-Your config object contains a **string** `externalDeviceId` property that you can use to store your external device ID. You can set property calling the `setExternalDeviceId` method || with your ID as an argument.
+Your config object contains a **string** `externalDeviceId` property that you can use to store your external device ID. You can set property calling the `setExternalDeviceId` method with your ID as an argument.
diff --git a/src/content/docs/sdk/unity/configuration/log-level.mdx b/src/content/docs/sdk/unity/configuration/log-level.mdx
index 92763f8f8..e06c43921 100644
--- a/src/content/docs/sdk/unity/configuration/log-level.mdx
+++ b/src/content/docs/sdk/unity/configuration/log-level.mdx
@@ -25,7 +25,7 @@ The Adjust SDK provides configurable log levels to return different amounts of i
-You can set your log level by calling the `setLogLevel` method || on your `AdjustConfig` instance.
+You can set your log level by calling the `setLogLevel` method on your `AdjustConfig` instance.
@@ -45,7 +45,7 @@ Adjust.start(adjustConfig);
If your target is Windows-based and you want to see the compiled logs from the SDK in **Production** mode, redirect the log output to your app while testing it in **Sandbox** mode.
-To register a log delegate, call the `setLogDelegate` method || on your `AdjustConfig` instance.
+To register a log delegate, call the `setLogDelegate` method on your `AdjustConfig` instance.
diff --git a/src/content/docs/sdk/unity/configuration/preinstalled.mdx b/src/content/docs/sdk/unity/configuration/preinstalled.mdx
index 3bf7bb2bd..6456a15bf 100644
--- a/src/content/docs/sdk/unity/configuration/preinstalled.mdx
+++ b/src/content/docs/sdk/unity/configuration/preinstalled.mdx
@@ -13,7 +13,7 @@ import SetDefaultTrackerSig from "@unity-signatures/AdjustConfig/setDefaultTrack
You can use the Adjust SDK to record activity from apps that came preinstalled on a user's device. This enables you to send information from users who didn't download your app from a campaign.
-Your config object contains a **boolean** `preinstallTrackingEnabled` property that controls this feature. To enable preinstall measurement, call the `setPreinstallTrackingEnabled` method || with a `true` argument.
+Your config object contains a **boolean** `preinstallTrackingEnabled` property that controls this feature. To enable preinstall measurement, call the `setPreinstallTrackingEnabled` method with a `true` argument.
@@ -27,7 +27,7 @@ The Adjust SDK provides 5 methods for measuring preinstalled apps:
## System properties
-OEM (Original Equipment Manufacturer) partners can leverage Android system properties to attribute preinstalled apps. The OEM writes attribution information to a file and adds its path to the system properties. The Adjust SDK reads this file on initialization to attribute the install.
+OEM (Original Equipment Manufacturer) partners can leverage Android system properties to attribute preinstalled apps. The OEM writes attribution information to a file and adds its path to the system properties. The Adjust SDK reads this file on initialization to attribute the install.
## Content provider
@@ -67,7 +67,7 @@ To set up the receiver, add the following to your `AndroidManifest.xml` file.
Save attribution information for your preinstalled app in a world-readable directory. The SDK reads the information from this file at install to attribute the user. The system encryption protocol protects app data.
-Pass the file path at which your preinstall information can be found to the `setPreinstallFilePath` method || to give the Adjust SDK access to the information.
+Pass the file path at which your preinstall information can be found to the `setPreinstallFilePath` method to give the Adjust SDK access to the information.
@@ -81,7 +81,7 @@ Configuring a default campaign enables you to attribute all preinstalls to a pre
https://app.adjust.com/{token}
```
-2. Copy this token and pass it to the `setDefaultTracker` method || in your app delegate file.
+2. Copy this token and pass it to the `setDefaultTracker` method in your app delegate file.
diff --git a/src/content/docs/sdk/unity/configuration/privacy.mdx b/src/content/docs/sdk/unity/configuration/privacy.mdx
index 687236edc..74107969e 100644
--- a/src/content/docs/sdk/unity/configuration/privacy.mdx
+++ b/src/content/docs/sdk/unity/configuration/privacy.mdx
@@ -25,9 +25,9 @@ The Adjust SDK contains features that you can use to handle user privacy in your
## GDPR right to be forgotten
-Article 17 of the European Union's GDPR (General Data Protection Regulation) grants users the right to be forgotten. When Adjust's servers receive an RTBF (Right to be Forgotten) request, Adjust erases the user's data. The SDK also stops sending requests from the device for the app in question.
+Article 17 of the European Union's GDPR (General Data Protection Regulation) grants users the right to be forgotten. When Adjust's servers receive an RTBF (Right to be Forgotten) request, Adjust erases the user's data. The SDK also stops sending requests from the device for the app in question.
-You can send the user's RTBF request to Adjust by calling the `gdprForgetMe` method || .
+You can send the user's RTBF request to Adjust by calling the `gdprForgetMe` method.
@@ -37,7 +37,7 @@ You can use the Adjust SDK to record when a user changes their third-party shari
### Disable third-party sharing
-Some users may want to opt-out of sharing their data with third-parties. To communicate this to Adjust, call the `trackThirdPartySharing` method || with an [`ADJThirdPartySharing` object](/en/sdk/ios/reference/adjthirdpartysharing) initialized with a `false` value. When Adjust's servers receive this information, Adjust stops sharing the user's data with third-parties. The Adjust SDK continues to work as expected.
+Some users may want to opt-out of sharing their data with third-parties. To communicate this to Adjust, call the `trackThirdPartySharing` method with an [`ADJThirdPartySharing` object](/en/sdk/ios/reference/adjthirdpartysharing) initialized with a `false` value. When Adjust's servers receive this information, Adjust stops sharing the user's data with third-parties. The Adjust SDK continues to work as expected.
@@ -47,13 +47,13 @@ Some users may want to opt-out of sharing their data with third-parties. To comm
### Send granular information
-You can attach granular information when a user updates their third-party sharing preferences. Use this information to communicate more detail about a user's decision. To do this, call the `addGranularOption` method || with your partner name and your options.
+You can attach granular information when a user updates their third-party sharing preferences. Use this information to communicate more detail about a user's decision. To do this, call the `addGranularOption` method with your partner name and your options.
### Update partner settings
-You can use the Adjust SDK to update your third party sharing settings on a per-partner basis. To do this, call the `addPartnerSharingSetting` method || with your partner name and your options.
+You can use the Adjust SDK to update your third party sharing settings on a per-partner basis. To do this, call the `addPartnerSharingSetting` method with your partner name and your options.
@@ -82,26 +82,19 @@ The Adjust SDK sends information to Facebook as soon as the app is installed. Yo
-Facebook provides a feature called LDU (Limited Data Use) to comply with the CCPA (California Consumer Privacy Act). This feature enables you to notify Facebook when a California-based user is opted out of the sale of data. You can also use it if you want to opt all users out by default.
+Facebook provides a feature called LDU (Limited Data Use) to comply with the CCPA (California Consumer Privacy Act). This feature enables you to notify Facebook when a California-based user is opted out of the sale of data. You can also use it if you want to opt all users out by default.
-You can update the Facebook LDU status by passing arguments to the `addGranularOption` method || .
+You can update the Facebook LDU status by passing arguments to the `addGranularOption` method.
-
-
-- - Parameter
- - Description
-- - `partner_name`
- - Use `facebook` to toggle LDU.
-- - `data_processing_options_country`
- - The country the user is located in.
- - `0`: Request that Facebook use geolocation.
- - `1`: United States of America.
-- - `data_processing_options_state`
- - Notifies Facebook which state the user is located in.
- - `0`: Request that Facebook use geolocation.
- - `1000`: California.
+
+
+| Parameter | Description |
+| --------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
+| `partner_name` | Use `facebook` to toggle LDU. |
+| `data_processing_options_country` | The country in which the user is located.- `0`: Request that Facebook use geolocation.
- `1`: United States of America.
|
+| `data_processing_options_state` | Notifies Facebook in which state the user is located.- `0`: Request that Facebook use geolocation.
- `1000`: California.
|
@@ -145,7 +138,7 @@ Adjust.trackThirdPartySharing(adjustThirdPartySharing);
## Disable third-party sharing
-To disable third-party sharing for all users, call the `disableThirdPartySharing` method || . When Adjust's servers receive this information, Adjust stops sharing the user's data with third-parties. The Adjust SDK continues to work as expected.
+To disable third-party sharing for all users, call the `disableThirdPartySharing` method. When Adjust's servers receive this information, Adjust stops sharing the user's data with third-parties. The Adjust SDK continues to work as expected.
@@ -153,7 +146,7 @@ To disable third-party sharing for all users, call the `disableThirdPar
The data residency feature allows you to choose the country in which Adjust stores your data. This is useful if you're operating in a country with strict privacy requirements. When you set up data residency, Adjust stores your data in a data center located in the region your have chosen.
-To set your country of data residency, call the `setUrlStrategy` method || on your `AdjustConfig` instance.
+To set your country of data residency, call the `setUrlStrategy` method on your `AdjustConfig` instance.
@@ -172,6 +165,6 @@ To set your country of data residency, call the `setUrlStrategy` method
## Consent measurement for specific users
-If you are using [Data Privacy settings](https://help.adjust.com/en/article/manage-data-collection-and-retention) in your Adjust dashboard, you need to set up the Adjust SDK to work with them. This includes settings such as consent expiry period and user data retention period. To toggle this feature, call the `trackMeasurementConsent` method || . When enabled, the SDK communicates the data privacy settings to Adjust's servers. Adjust's servers then applies your data privacy rules to the user. The Adjust SDK continues to work as expected.
+If you are using [Data Privacy settings](https://help.adjust.com/en/article/manage-data-collection-and-retention) in your Adjust dashboard, you need to set up the Adjust SDK to work with them. This includes settings such as consent expiry period and user data retention period. To toggle this feature, call the `trackMeasurementConsent` method. When enabled, the SDK communicates the data privacy settings to Adjust's servers. Adjust's servers then applies your data privacy rules to the user. The Adjust SDK continues to work as expected.
diff --git a/src/content/docs/sdk/unity/configuration/push-tokens.mdx b/src/content/docs/sdk/unity/configuration/push-tokens.mdx
index ceae7f40f..267167a1b 100644
--- a/src/content/docs/sdk/unity/configuration/push-tokens.mdx
+++ b/src/content/docs/sdk/unity/configuration/push-tokens.mdx
@@ -9,7 +9,7 @@ import SetDeviceTokenSig from "@unity-signatures/Adjust/setDeviceToken.mdx"
Push tokens are used for [Audience Builder](https://help.adjust.com/en/article/audience-builder) and client callbacks. They're also required for [Uninstall and reinstall tracking](https://help.adjust.com/en/article/uninstalls-reinstalls).
-Your config object contains a string `pushToken` property that you can use to store your push token. You can update this property at any time by calling the `setDeviceToken` method || and passing your token as an argument.
+Your config object contains a string `pushToken` property that you can use to store your push token. You can update this property at any time by calling the `setDeviceToken` method and passing your token as an argument.
diff --git a/src/content/docs/sdk/unity/configuration/skad.mdx b/src/content/docs/sdk/unity/configuration/skad.mdx
index 47dad19e6..009180d14 100644
--- a/src/content/docs/sdk/unity/configuration/skad.mdx
+++ b/src/content/docs/sdk/unity/configuration/skad.mdx
@@ -16,7 +16,7 @@ This feature is only available on devices running iOS 14 and above.
-SKAdNetwork (StoreKit Ad Network) is Apple's attribution framework for
+SKAdNetwork (StoreKit Ad Network) is Apple's attribution framework for
app install and reinstall attribution. The SKAdNetwork workflow goes like this:
1. Apple gathers attribution information and notifies the relevant ad network.
@@ -27,7 +27,7 @@ app install and reinstall attribution. The SKAdNetwork workflow goes like this:
The Adjust SDK communicates with SKAdNetwork by default on v4.23.0 and above. The SDK registers for SKAdNetwork attribution upon initialization.
-Your config object contains a boolean `isSKAdNetworkHandlingActive` property that controls this behavior. You can disable SKAdNetwork communication by calling the `deactivateSKAdNetworkHandling` method || with no argument.
+Your config object contains a boolean `isSKAdNetworkHandlingActive` property that controls this behavior. You can disable SKAdNetwork communication by calling the `deactivateSKAdNetworkHandling` method with no argument.
@@ -41,7 +41,7 @@ You must call the `deactivateSKAdNetworkHandling` method _before_ initializing t
Conversion values are a mechanism used to track user behavior in SKAdNetwork. You can map 64 conditions to values from 0 through 63 and send this integer value to SKAdNetwork on user install. This gives you insight into how your users interact with your app in the first few days.
-If you manage your conversion values with Adjust, the servers update this value in the SDK. You can also update this value by using the `updateConversionValue` method || . This method wraps [Apple's `updateConversionValue` method](https://developer.apple.com/documentation/storekit/skadnetwork/3566697-updateconversionvalue). It accepts an integer argument representing your updated conversion value.
+If you manage your conversion values with Adjust, the servers update this value in the SDK. You can also update this value by using the `updateConversionValue` method. This method wraps [Apple's `updateConversionValue` method](https://developer.apple.com/documentation/storekit/skadnetwork/3566697-updateconversionvalue). It accepts an integer argument representing your updated conversion value.
diff --git a/src/content/docs/sdk/unity/features/ad-revenue.mdx b/src/content/docs/sdk/unity/features/ad-revenue.mdx
index cb3001084..198339fb6 100644
--- a/src/content/docs/sdk/unity/features/ad-revenue.mdx
+++ b/src/content/docs/sdk/unity/features/ad-revenue.mdx
@@ -32,7 +32,7 @@ You need to perform some extra setup steps in your Adjust dashboard to measure a
To send ad revenue to Adjust:
1. Create a new Adjust ad revenue instance and pass your ad revenue source as an argument.
-2. Call the `trackAdRevenue` method || with your ad revenue instance as an argument.
+2. Call the `trackAdRevenue` method with your ad revenue instance as an argument.
@@ -58,13 +58,11 @@ To send ad revenue to Adjust:
You can record ad revenue by setting the `revenue` and `currency` properties on your ad revenue instance.
-To set these properties, call the `setRevenue` method || and pass the following arguments:
+To set these properties, call the `setRevenue` method and pass the following arguments:
-`revenue` **number**
-: The amount of revenue
+`revenue` **number**: The amount of revenue
-`currency` **string**
-: The 3 character [ISO 4217 code](https://www.iban.com/currency-codes) of your reporting currency
+`currency` **string**: The 3 character [ISO 4217 code](https://www.iban.com/currency-codes) of your reporting currency
@@ -80,25 +78,25 @@ The ad revenue object contains properties you can use to report on your ad campa
### Ad impressions
-Record the number of ad impressions by passing an **integer** value to the `setAdImpressionsCount` method || .
+Record the number of ad impressions by passing an **integer** value to the `setAdImpressionsCount` method.
### Ad revenue network
-Record which network generated the revenue by passing a **string** value to the `setAdRevenueNetwork` method || .
+Record which network generated the revenue by passing a **string** value to the `setAdRevenueNetwork` method.
### Ad revenue unit
-Record which ad revenue unit generated the revenue by passing a **string** value to the `setAdRevenueUnit` method || .
+Record which ad revenue unit generated the revenue by passing a **string** value to the `setAdRevenueUnit` method.
### Ad revenue placement
-Record the placement of your ad by passing a **string** value to the `setAdRevenuePlacement` method || .
+Record the placement of your ad by passing a **string** value to the `setAdRevenuePlacement` method.
@@ -108,7 +106,7 @@ If you [register a callback URL](https://help.adjust.com/en/article/recommended-
You can configure callback parameters to your servers. Once you configure parameters on an event, the SDK appends them to your [callback URL](https://help.adjust.com/en/article/raw-data-exports). You can use this information to analyze your users' in-app behavior with your BI system.
-Add callback parameters to your event by calling the `addCallbackParameter` method || with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
+Add callback parameters to your event by calling the `addCallbackParameter` method with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
The Adjust SDK measures the event and sends a request to your URL with the callback parameters. For example, if you register the URL `https://www.mydomain.com/callback`, your callback looks like this:
@@ -146,7 +144,7 @@ Partner parameters don't appear in raw data by default. You can add the `{partne
-Add partner parameters to your event by calling the `addPartnerParameter` method || with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
+Add partner parameters to your event by calling the `addPartnerParameter` method with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
diff --git a/src/content/docs/sdk/unity/features/attribution.mdx b/src/content/docs/sdk/unity/features/attribution.mdx
index 145f4a4e5..2ff3521f2 100644
--- a/src/content/docs/sdk/unity/features/attribution.mdx
+++ b/src/content/docs/sdk/unity/features/attribution.mdx
@@ -11,7 +11,7 @@ import AttributionSig from "@unity-signatures/Adjust/getAttribution.mdx";
When a user interacts with a campaign link, their attribution information updates. This can happen if the user interacts with a [deep link](https://help.adjust.com/en/article/deep-links). The SDK can listen for attribution changes and call a function when it detects an update.
-To configure your callback function, call the `setAttributionChangedDelegate` method || with your function name as an argument.
+To configure your callback function, call the `setAttributionChangedDelegate` method with your function name as an argument.
@@ -25,7 +25,7 @@ Within your delegate function, you have access to the user's `Attribution` infor
## Get current attribution information
-When a user installs your app, Adjust attributes the install to a campaign. The Adjust SDK gives you access to campaign attribution details for your install. To return this information, call the `getAttribution` method || .
+When a user installs your app, Adjust attributes the install to a campaign. The Adjust SDK gives you access to campaign attribution details for your install. To return this information, call the `getAttribution` method.
This method returns an Attribution object. See the [`AdjustAttribution` class reference](/en/sdk/unity/reference/adjustattribution) for a list of available properties.
diff --git a/src/content/docs/sdk/unity/features/device-info.mdx b/src/content/docs/sdk/unity/features/device-info.mdx
index c5b5366e0..1cbfbbbb8 100644
--- a/src/content/docs/sdk/unity/features/device-info.mdx
+++ b/src/content/docs/sdk/unity/features/device-info.mdx
@@ -17,28 +17,28 @@ The Adjust SDK contains helper methods that return device information. Use these
## Adjust device identifier
-Adjust generates a unique ADID (Adjust Device ID) for each device. Call the `getAdid` method || to return this ID as a **string**.
+Adjust generates a unique ADID (Adjust Device ID) for each device. Call the `getAdid` method to return this ID as a **string**.
## ID For Advertisers
-The IDFA (ID for Advertisers) is a device-specific identifier for Apple devices. Call the `getIdfa` method || to return this ID as a **string**.
+The IDFA (ID for Advertisers) is a device-specific identifier for Apple devices. Call the `getIdfa` method to return this ID as a **string**.
## Google Play Services Advertising ID
-The GPS ADID (Google Play Services Advertising ID) is a device-specific identifier for Android devices.
+The GPS ADID (Google Play Services Advertising ID) is a device-specific identifier for Android devices.
Users can opt out of sharing their GPS ADID by toggling the "Opt out of Ads Personalization" setting on their device. When a user enables this setting, the Adjust SDK returns a string of zeros when trying to read the GPS ADID.
-You can access this value by calling the `getGoogleAdId` method || in a background thread. Assign a delegate function to access the GPS ADID value.
+You can access this value by calling the `getGoogleAdId` method in a background thread. Assign a delegate function to access the GPS ADID value.
## Amazon Advertiser ID
-The Amazon Ad ID (Amazon Advertising ID) is a device-specific identifier for Android devices. Call the `getAmazonAdId` method || to return this ID as a **string**.
+The Amazon Ad ID (Amazon Advertising ID) is a device-specific identifier for Android devices. Call the `getAmazonAdId` method to return this ID as a **string**.
diff --git a/src/content/docs/sdk/unity/features/events.mdx b/src/content/docs/sdk/unity/features/events.mdx
index 954da2df1..53ac2161d 100644
--- a/src/content/docs/sdk/unity/features/events.mdx
+++ b/src/content/docs/sdk/unity/features/events.mdx
@@ -20,7 +20,7 @@ import AddPartnerParameterSig from "@unity-signatures/AdjustEvent/addPartnerPara
You can associate your [Adjust event tokens](https://help.adjust.com/en/article/add-events#add-event) to actions in your app to record them. To record an event:
* Create a new Adjust event instance and pass your event token as a string argument.
-* Call the `trackEvent` method || with your event instance as an argument.
+* Call the `trackEvent` method with your event instance as an argument.
@@ -88,13 +88,11 @@ Parameters:
You can record revenue associated with an event by setting the revenue and currency properties on your event instance. Use this feature to record revenue-generating actions in your app.
-To set these properties, call the `setRevenue` method || and pass the following arguments:
+To set these properties, call the `setRevenue` method and pass the following arguments:
-`revenue` (**number**)
-: The amount of revenue generated by the event
+`revenue` (**number**): The amount of revenue generated by the event
-`currency` (**string**)
-: The [ISO 4217 code](https://www.iban.com/currency-codes) of the event currency.
+`currency` (**string**): The [ISO 4217 code](https://www.iban.com/currency-codes) of the event currency.
@@ -135,17 +133,13 @@ If you've enabled [purchase verification](https://help.adjust.com/en/article/pur
-`productId` (String)
-: The product identifier of the item that was successfully purchased
+`productId` (String): The product identifier of the item that was successfully purchased
-`transactionId` (NSString)
-: The [`transactionIdentifier` value](https://developer.apple.com/documentation/storekit/skpaymenttransaction/1411288-transactionidentifier) of the successfully completed purchase. iOS only
+`transactionId` (NSString): The [`transactionIdentifier` value](https://developer.apple.com/documentation/storekit/skpaymenttransaction/1411288-transactionidentifier) of the successfully completed purchase. iOS only
-`receipt` (String)
-: The signed receipt containing the information about the successfully completed purchase. iOS only
+`receipt` (String): The signed receipt containing the information about the successfully completed purchase. iOS only
-`purchaseToken` (String)
-: The purchase token generated for your successfully completed in-app purchase. Android only
+`purchaseToken` (String): The purchase token generated for your successfully completed in-app purchase. Android only
```cs
AdjustEvent adjustEvent = new AdjustEvent("abc123");
@@ -161,13 +155,13 @@ Adjust.trackEvent(adjustEvent);
You can pass an optional identifier to avoid recording duplicate events. The SDK stores the last ten identifiers and skips revenue events with duplicate transaction IDs.
-To set the identifier, call the `setTransactionId` method || and pass your transaction ID as a **string** argument.
+To set the identifier, call the `setTransactionId` method and pass your transaction ID as a **string** argument.
### Example
-This example shows how to record an event with the token `g3mfiw` whenever a user interacts with a button. The function sets the `uniqueId` to `5e85484b-1ebc-4141-aab7-25b869e54c49` using the `setTransactionId` method || .
+This example shows how to record an event with the token `g3mfiw` whenever a user interacts with a button. The function sets the `uniqueId` to `5e85484b-1ebc-4141-aab7-25b869e54c49` using the `setTransactionId` method.
```c#
if (GUI.Button(new Rect(0, Screen.height * 2 / numberOfButtons, Screen.width, Screen.height / numberOfButtons), "Track Unique Event")) {
@@ -194,7 +188,7 @@ If you [register a callback URL](https://help.adjust.com/en/article/set-up-callb
You can configure callback parameters to send to your servers. Once you configure parameters on an event, the SDK appends them to your [callback URL](https://help.adjust.com/en/article/raw-data-exports). You can use this information to analyze your users' in-app behavior with your BI system.
-Add callback parameters to your event by calling the `addCallbackParameter` method || with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
+Add callback parameters to your event by calling the `addCallbackParameter` method with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
@@ -264,7 +258,7 @@ Partner parameters don't appear in raw data by default. You can add the `{partne
-Add partner parameters to your event by calling the `addPartnerParameter` method || with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
+Add partner parameters to your event by calling the `addPartnerParameter` method with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
@@ -298,7 +292,7 @@ Parameters:
You can add a custom string identifier to each event you want to measure. Adjust's servers can report on this identifier in event callbacks. This enables you to keep track of which events have been successfully measured.
-Set up this identifier by calling the `setCallbackId` method || with your ID as a **string** argument.
+Set up this identifier by calling the `setCallbackId` method with your ID as a **string** argument.
diff --git a/src/content/docs/sdk/unity/features/session-parameters.mdx b/src/content/docs/sdk/unity/features/session-parameters.mdx
index 0bc94682a..4910c053f 100644
--- a/src/content/docs/sdk/unity/features/session-parameters.mdx
+++ b/src/content/docs/sdk/unity/features/session-parameters.mdx
@@ -31,15 +31,15 @@ The Adjust SDK merges session callback parameters with event callback parameters
-Add callback parameters to your event by calling the `addSessionCallbackParameter` method || with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
+Add callback parameters to your event by calling the `addSessionCallbackParameter` method with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
-You can remove specific session callback parameters if they're no longer required. To do this, pass the parameter key to the `removeSessionCallbackParameter` method || .
+You can remove specific session callback parameters if they're no longer required. To do this, pass the parameter key to the `removeSessionCallbackParameter` method.
-You can remove all session parameters if they're no longer required. To do this, call the `resetSessionCallbackParameters` method || .
+You can remove all session parameters if they're no longer required. To do this, call the `resetSessionCallbackParameters` method.
@@ -55,15 +55,15 @@ Partner parameters don't appear in raw data by default. You can add the `{partne
-Add partner parameters to your event by calling the `addSessionPartnerParameter` method || with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
+Add partner parameters to your event by calling the `addSessionPartnerParameter` method with **string** key-value arguments. You can add multiple parameters by calling this method multiple times.
-You can remove specific session partner parameters if they're no longer required. To do this, pass the parameter key to the `removeSessionPartnerParameter` method || .
+You can remove specific session partner parameters if they're no longer required. To do this, pass the parameter key to the `removeSessionPartnerParameter` method.
-You can remove all session partner parameters if they're no longer required. To do this, call the `resetSessionPartnerParameters` method || .
+You can remove all session partner parameters if they're no longer required. To do this, call the `resetSessionPartnerParameters` method.
@@ -75,10 +75,10 @@ You can delay the startup of the SDK by up to **10 seconds**.
-The Adjust SDK starts as soon as your app opens. If you want to send data that's not available at launch in session parameters, you can delay the start of the SDK. To do this, pass the delay time in seconds to the `setDelayStart` method || on your config object.
+The Adjust SDK starts as soon as your app opens. If you want to send data that's not available at launch in session parameters, you can delay the start of the SDK. To do this, pass the delay time in seconds to the `setDelayStart` method on your config object.
-After this time has elapsed, the SDK sends the information to Adjust's servers. You can send the information before the timeout by calling the `sendFirstPackages` method || .
+After this time has elapsed, the SDK sends the information to Adjust's servers. You can send the information before the timeout by calling the `sendFirstPackages` method.
diff --git a/src/content/docs/sdk/unity/features/subscriptions.mdx b/src/content/docs/sdk/unity/features/subscriptions.mdx
index dacd5e2d5..454040995 100644
--- a/src/content/docs/sdk/unity/features/subscriptions.mdx
+++ b/src/content/docs/sdk/unity/features/subscriptions.mdx
@@ -85,14 +85,14 @@ You can record the date on which the user purchased a subscription. The SDK retu
-Call the `setTransactionDate` method || method on your subscription object to record the timestamp of the subscription.
+Call the `setTransactionDate` method method on your subscription object to record the timestamp of the subscription.
-Call the `setPurchaseTime` method || on your subscription object to record the timestamp of the subscription.
+Call the `setPurchaseTime` method on your subscription object to record the timestamp of the subscription.
@@ -101,7 +101,7 @@ Call the `setPurchaseTime` method || o
### Record the purchase region (iOS only)
-You can record the region in which the user purchased a subscription. To do this, call the `setSalesRegion` method || on your subscription object and pass the country code as a **string**. This needs to be formatted as the [`countryCode`](https://developer.apple.com/documentation/foundation/nslocale/1643060-countrycode?language=swift) of the [`priceLocale`](https://developer.apple.com/documentation/storekit/skproduct/1506145-pricelocale?language=swift) object.
+You can record the region in which the user purchased a subscription. To do this, call the `setSalesRegion` method on your subscription object and pass the country code as a **string**. This needs to be formatted as the [`countryCode`](https://developer.apple.com/documentation/foundation/nslocale/1643060-countrycode?language=swift) of the [`priceLocale`](https://developer.apple.com/documentation/storekit/skproduct/1506145-pricelocale?language=swift) object.
@@ -146,14 +146,14 @@ Once you have set up your subscription object, you can record it using the Adjus
-Pass your subscription object to the `trackAppStoreSubscription` method || method to record the user's subscription purchase.
+Pass your subscription object to the `trackAppStoreSubscription` method method to record the user's subscription purchase.
-Pass your subscription object to the `trackPlayStoreSubscription` method || method to record the user's subscription purchase.
+Pass your subscription object to the `trackPlayStoreSubscription` method method to record the user's subscription purchase.
diff --git a/src/content/docs/sdk/unity/index.mdx b/src/content/docs/sdk/unity/index.mdx
index 9fe6e05a5..c4ad3b1cf 100644
--- a/src/content/docs/sdk/unity/index.mdx
+++ b/src/content/docs/sdk/unity/index.mdx
@@ -20,7 +20,7 @@ To use the Adjust SDK in your Unity app, you need to add it to your project. You
To import the Adjust SDK to your Unity project:
1. Open the Unity Editor.
-2. Select Assets --> Import Package --> Custom Package.
+2. Select **Assets --> Import Package --> Custom Package**.
3. Select the downloaded SDK package.
## 2. Integrate the SDK
@@ -35,13 +35,13 @@ The Adjust SDK contains a Unity [prefab](https://docs.unity3d.com/Manual/Prefabs
To set up the Adjust SDK, enter the following information:
-1. Your App Token. See App settings for instructions on how to find your token.
-2. Your Environment:
+1. Your **App Token**. See App settings for instructions on how to find your token.
+2. Your **Environment**:
- Choose **Sandbox** if you are testing your app and want to send test data. You need to enable sandbox mode in the dashboard to see test data.
- Choose **Production** when you have finished testing and are ready to release your app.
-3. Your Log Level. This controls what logs you receive. See [Set log level](/en/sdk/unity/configuration/log-level) for more information.
+3. Your **Log Level**. This controls what logs you receive. See [Set log level](/en/sdk/unity/configuration/log-level) for more information.
-The Adjust SDK starts when the app's Awake event triggers by default. To override this behavior, check the START SDK MANUALLY option. This enables you to initialize the Adjust SDK by calling `Adjust.start()` with your config instance as an argument.
+The Adjust SDK starts when the app's Awake event triggers by default. To override this behavior, check the **START SDK MANUALLY** option. This enables you to initialize the Adjust SDK by calling `Adjust.start()` with your config instance as an argument.
```c#
AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox);
@@ -53,7 +53,7 @@ Adjust.start(adjustConfig);
### Add Google Play Services
-Apps that target the Google Play Store must use the gps_adid (Google Advertising ID) to identify devices. You need to add the `play-services-ads-identifier` AAR to your project to access the `gps_adid`.
+Apps that target the Google Play Store must use the gps_adid (Google Advertising ID) to identify devices. You need to add the `play-services-ads-identifier` AAR to your project to access the `gps_adid`.
@@ -69,7 +69,7 @@ If you are using the [External Dependency Manager plugin](https://developers.goo
-To install the ARR (Android Archive) manually, [download it from Maven](https://maven.google.com/web/index.html#com.google.android.gms:play-services-ads-identifier:18.0.1 "A link to the AAR artifact on Maven.") and add it to the `Assets/Plugins/Android` directory.
+To install the ARR (Android Archive) manually, [download it from Maven](https://maven.google.com/web/index.html#com.google.android.gms:play-services-ads-identifier:18.0.1 "A link to the AAR artifact on Maven.") and add it to the `Assets/Plugins/Android` directory.
@@ -92,7 +92,7 @@ To record a device's App Set ID, you need to add the following dependency to you
-To install the ARR (Android Archive) manually, [download it from Maven](https://maven.google.com/web/index.html#com.google.android.gms:play-services-appset:16.0.2 "A link to the AAR artifact on Maven.") and add it to the `Assets/Plugins/Android` directory.
+To install the ARR (Android Archive) manually, [download it from Maven](https://maven.google.com/web/index.html#com.google.android.gms:play-services-appset:16.0.2 "A link to the AAR artifact on Maven.") and add it to the `Assets/Plugins/Android` directory.
@@ -138,7 +138,7 @@ dependencies {
}
```
-2. Download the install referrer library from [Maven](https://maven.google.com/web/index.html?q=install#com.android.installreferrer:installreferrer) and put the ARR (Android Archive) file in your `Plugins/Android` folder.
+2. Download the install referrer library from [Maven](https://maven.google.com/web/index.html?q=install#com.android.installreferrer:installreferrer) and put the ARR (Android Archive) file in your `Plugins/Android` folder.
@@ -163,7 +163,7 @@ This process is performed by the `OnPostprocessBuild` method in `AdjustEditor.cs
-To run the iOS post-build process, make sure that you have iOS build support installed in the Unity Editor.
+To run the iOS post-build process, make sure that you have **iOS build support** installed in the Unity Editor.
@@ -176,37 +176,29 @@ The iOS post-build process makes the following changes to your generated Xcode p
You can enable the following frameworks to access iOS features:
-AdServices.framework
-: Required for Apple Search Ads tracking
+**AdServices.framework**: Required for Apple Search Ads tracking
-AdSupport.framework
-: Required to read the device IDFA
+**AdSupport.framework**: Required to read the device IDFA
-AppTrackingTransparency.framework
-: Required to ask for user's consent to be tracked and obtain consent status
+**AppTrackingTransparency.framework**: Required to ask for user's consent to be tracked and obtain consent status
-StoreKit.framework
-: Required to communicate with the SKAdNetwork framework.
+**StoreKit.framework**: Required to communicate with the SKAdNetwork framework.
-iAd.framework Deprecated
-: Use `AdServices.framework`
+**iAd.framework** Deprecated: Use `AdServices.framework`
#### App Tracking Transparency consent dialog
-If you are using the ATT (App Tracking Transparency) wrapper, enter a **User Tracking Description** message. This displays when you present the tracking consent dialog to your user.
+If you are using the ATT (App Tracking Transparency) wrapper, enter a **User Tracking Description** message. This displays when you present the tracking consent dialog to your user.
#### Deep linking
To enable deep linking, add the following information:
-iOS Universal Links Domain
-: The associated domain used for universal links.
+**iOS Universal Links Domain**: The associated domain used for universal links.
-iOS URL Identifier
-: Your app's bundle ID.
+**iOS URL Identifier**: Your app's bundle ID.
-iOS URL Schemes
-: The URL scheme associated with your app.
+**iOS URL Schemes**: The URL scheme associated with your app.
@@ -217,24 +209,19 @@ The Android post-build process checks for an `AndroidManifest.xml` file in `Asse
You can enable the following permissions to access Android features:
-android.permission.INTERNET
-: Required to connect to the internet.
+**android.permission.INTERNET**: Required to connect to the internet.
-android.permission.ACCESS_NETWORK_STATE
-: Required to read the type of network the device is connected to.
+**android.permission.ACCESS_NETWORK_STATE**: Required to read the type of network the device is connected to.
-com.android.finsky.permission.BIND_GET_INSTALL_REFERRER_SERVICE Deprecated
-: Required to fetch install referrer information via Google Play Store intent.
+**com.android.finsky.permission.BIND_GET_INSTALL_REFERRER_SERVICE** Deprecated: Required to fetch install referrer information via Google Play Store intent.
-com.google.android.gms.permission.AD_ID
-: Required to read the device advertising ID on Android 12 (API level 31) and above. See [Google's `AdvertisingIdClient.info` documentation](https://developers.google.com/android/reference/com/google/android/gms/ads/identifier/AdvertisingIdClient.Info#public-string-getid) for more information.
+**com.google.android.gms.permission.AD_ID**: Required to read the device advertising ID on Android 12 (API level 31) and above. See [Google's `AdvertisingIdClient.info` documentation](https://developers.google.com/android/reference/com/google/android/gms/ads/identifier/AdvertisingIdClient.Info#public-string-getid) for more information.
#### Deep linking
To enable deep linking, add the following information:
-Android URI Schemes
-: The destination of your deep link.
+**Android URI Schemes**: The destination of your deep link.
@@ -261,6 +248,6 @@ The Adjust SDK provides tools for testing and troubleshooting issues with your i
### Test Google Play Services integration
-To test that the Adjust SDK can receive a device's Google Advertising ID, set the [log level](/en/sdk/unity/configuration/log-level) to **verbose** and the environment to **Sandbox**. Start your app and measure a `session` or an event. The SDK logs the gps_adid (Google Play Services Advertiser ID) parameter if it has read the advertising ID.
+To test that the Adjust SDK can receive a device's Google Advertising ID, set the [log level](/en/sdk/unity/configuration/log-level) to **verbose** and the environment to **Sandbox**. Start your app and measure a `session` or an event. The SDK logs the gps_adid (Google Play Services Advertiser ID) parameter if it has read the advertising ID.
If you are having issues retrieving the Google Advertising ID, open an issue in the [GitHub repository](https://github.com/adjust/unity_sdk) or contact support@adjust.com.
diff --git a/src/content/docs/sdk/unity/plugins/imei.mdx b/src/content/docs/sdk/unity/plugins/imei.mdx
index 7b867406a..6f67994cd 100644
--- a/src/content/docs/sdk/unity/plugins/imei.mdx
+++ b/src/content/docs/sdk/unity/plugins/imei.mdx
@@ -10,7 +10,7 @@ This plugin is intended only for apps that don't target the Google Play Store.
-Mobile devices come with an IMEI (International Mobile Equipment Identity) and a MEID (Mobile Equipment Identifier). You can use an Android device's IMEI and MEID for attribution in certain markets. To use this feature, you first need to complete the required steps in your Adjust dashboard. Once you have completed the steps, you can use this plugin.
+Mobile devices come with an IMEI (International Mobile Equipment Identity) and a MEID (Mobile Equipment Identifier). You can use an Android device's IMEI and MEID for attribution in certain markets. To use this feature, you first need to complete the required steps in your Adjust dashboard. Once you have completed the steps, you can use this plugin.
The IMEI plugin provides the IMEI and MEID values of a device. The SDK will continue to use other identifiers as well as the IMEI and MEID.
diff --git a/src/content/docs/sdk/unity/plugins/oaid.mdx b/src/content/docs/sdk/unity/plugins/oaid.mdx
index f591d841d..0519c6162 100644
--- a/src/content/docs/sdk/unity/plugins/oaid.mdx
+++ b/src/content/docs/sdk/unity/plugins/oaid.mdx
@@ -4,9 +4,9 @@ description: Use the OAID plugin to read a device's OAID.
slug: en/sdk/unity/plugins/oaid
---
-The OAID (Open Anonymous Device Identifier) is a unique identifier for Android devices. The MSA (Mobile Security Alliance) recommends all Chinese-manufactured devices provide an OAID. You can use the OAID to attribute and track devices where Google Play Services isn't available.
+The OAID (Open Anonymous Device Identifier) is a unique identifier for Android devices. The MSA (Mobile Security Alliance) recommends all Chinese-manufactured devices provide an OAID. You can use the OAID to attribute and track devices where Google Play Services isn't available.
-The OAID plugin provides the OAID of a device. The SDK will continue to use other identifiers as well as the OAID. The OAID is readable on all devices using the MSA SDK or HMS (Huawei Mobile Service) Core SDK on Huawei devices.
+The OAID plugin provides the OAID of a device. The SDK will continue to use other identifiers as well as the OAID. The OAID is readable on all devices using the MSA SDK or HMS (Huawei Mobile Service) Core SDK on Huawei devices.
## Add the plugin to your app
@@ -27,8 +27,8 @@ You can load the OAID plugin as a [Prefab](https://docs.unity3d.com/Manual/Prefa
To load the OAID plugin as a Prefab:
1. Locate the Prefab in the `AdjustOaid/Prefab` folder.
-2. Untick the Start Manually option.
-3. Tick the Read Oaid option.
+2. Untick the **Start Manually** option.
+3. Tick the **Read Oaid** option.
## Add the MSA SDK to your app
diff --git a/src/content/docs/sdk/unity/reference/adjust/config.mdx b/src/content/docs/sdk/unity/reference/adjust/config.mdx
index 8075816d9..548254012 100644
--- a/src/content/docs/sdk/unity/reference/adjust/config.mdx
+++ b/src/content/docs/sdk/unity/reference/adjust/config.mdx
@@ -30,8 +30,7 @@ import SetEnabled from "@unity-examples/Adjust/setEnabled.mdx"
-`enabled` (bool)
-: Whether the SDK is enabled.
+`enabled` (bool): Whether the SDK is enabled.
@@ -61,8 +60,7 @@ import IsEnabled from "@unity-examples/Adjust/isEnabled.mdx"
-`enabled` (bool)
-: Whether the SDK is enabled.
+`enabled` (bool): Whether the SDK is enabled.
@@ -122,8 +120,7 @@ import SetOfflineMode from "@unity-examples/Adjust/setOfflineMode.mdx"
-`enabled` (bool)
-: Whether the SDK is in offline mode.
+`enabled` (bool): Whether the SDK is in offline mode.
@@ -153,8 +150,7 @@ import SetDeviceToken from "@unity-examples/Adjust/setDeviceToken.mdx"
-`deviceToken` (string)
-: Your push token.
+`deviceToken` (string): Your push token.
diff --git a/src/content/docs/sdk/unity/reference/adjust/device-info.mdx b/src/content/docs/sdk/unity/reference/adjust/device-info.mdx
index c7442d2e9..e548d5338 100644
--- a/src/content/docs/sdk/unity/reference/adjust/device-info.mdx
+++ b/src/content/docs/sdk/unity/reference/adjust/device-info.mdx
@@ -17,7 +17,7 @@ The ADID is available only after the install has been recorded.
-Returns the ADID (Adjust Device ID) associated with the device.
+Returns the ADID (Adjust Device ID) associated with the device.
@@ -37,8 +37,7 @@ import GetAdid from "@unity-examples/Adjust/getAdid.mdx"
-`adid` (string)
-: The Adjust identifier associated with the device
+`adid` (string): The Adjust identifier associated with the device
@@ -48,7 +47,7 @@ import GetAdid from "@unity-examples/Adjust/getAdid.mdx"
## getIdfa
-Returns the IDFA (ID for advertisers) associated with the device.
+Returns the IDFA (ID for advertisers) associated with the device.
@@ -68,8 +67,7 @@ import GetIdfa from "@unity-examples/Adjust/getIdfa.mdx"
-`idfa` (string)
-: The IDFA associated with the device
+`idfa` (string): The IDFA associated with the device
@@ -79,7 +77,7 @@ import GetIdfa from "@unity-examples/Adjust/getIdfa.mdx"
## getGoogleAdid
-Returns the Google ADID (Google advertiser ID) associated with the device.
+Returns the Google ADID (Google advertiser ID) associated with the device.
@@ -99,8 +97,7 @@ import GetGoogleAdid from "@unity-examples/Adjust/getGoogleAdId.mdx"
-`googleAdid` (string)
-: The Google ADID associated with the device
+`googleAdid` (string): The Google ADID associated with the device
@@ -110,7 +107,7 @@ import GetGoogleAdid from "@unity-examples/Adjust/getGoogleAdId.mdx"
## getAmazonAdid
-Returns the Amazon ADID (Amazon advertiser ID) associated with the device.
+Returns the Amazon ADID (Amazon advertiser ID) associated with the device.
@@ -130,8 +127,7 @@ import GetAmazonAdid from "@unity-examples/Adjust/getAmazonAdId.mdx"
-`amazonAdId` (string)
-: The Amazon ADID associated with the device
+`amazonAdId` (string): The Amazon ADID associated with the device
diff --git a/src/content/docs/sdk/unity/reference/adjust/privacy.mdx b/src/content/docs/sdk/unity/reference/adjust/privacy.mdx
index ad3a0985b..f5034265d 100644
--- a/src/content/docs/sdk/unity/reference/adjust/privacy.mdx
+++ b/src/content/docs/sdk/unity/reference/adjust/privacy.mdx
@@ -55,8 +55,7 @@ import TrackThirdPartySharing from "@unity-examples/Adjust/trackThirdPartySharin
-`thirdPartySharing` (AdjustThirdPartySharing)
-: The third party sharing object
+`thirdPartySharing` (AdjustThirdPartySharing): The third party sharing object
@@ -86,8 +85,7 @@ import TrackMeasurementConsent from "@unity-examples/Adjust/trackMeasurementCons
-`enabled` (bool)
-: Whether data collection and retention rules apply for the user.
+`enabled` (bool): Whether data collection and retention rules apply for the user.
@@ -97,7 +95,7 @@ import TrackMeasurementConsent from "@unity-examples/Adjust/trackMeasurementCons
## gdprForgetMe
-Send an RTBF (Right To Be Forgotten) request to Adjust's servers. This erases all information about the user the source app. The SDK stops sending requests for the user.
+Send an RTBF (Right To Be Forgotten) request to Adjust's servers. This erases all information about the user the source app. The SDK stops sending requests for the user.
diff --git a/src/content/docs/sdk/unity/reference/adjust/recording.mdx b/src/content/docs/sdk/unity/reference/adjust/recording.mdx
index dd0a5a08a..615741576 100644
--- a/src/content/docs/sdk/unity/reference/adjust/recording.mdx
+++ b/src/content/docs/sdk/unity/reference/adjust/recording.mdx
@@ -31,8 +31,7 @@ import TrackEvent from "@unity-examples/Adjust/trackEvent.mdx"
-`event` (AdjustEvent)
-: An event object containing the information you want to send to Adjust.
+`event` (AdjustEvent): An event object containing the information you want to send to Adjust.
@@ -62,11 +61,9 @@ import AddSessionCallbackParameter from "@unity-examples/Adjust/addSessionCallba
-`key` (string)
-: The data key
+`key` (string): The data key
-`value` (string)
-: The data value
+`value` (string): The data value
@@ -96,8 +93,7 @@ import RemoveSessionCallbackParameter from "@unity-examples/Adjust/removeSession
-`key` (string)
-: The data key of the parameter you want to remove.
+`key` (string): The data key of the parameter you want to remove.
@@ -151,11 +147,9 @@ import AddSessionPartnerParameter from "@unity-examples/Adjust/addSessionPartner
-`key` (string)
-: The data key
+`key` (string): The data key
-`value` (string)
-: The data value
+`value` (string): The data value
@@ -185,8 +179,7 @@ import RemoveSessionPartnerParameter from "@unity-examples/Adjust/removeSessionP
-`key` (string)
-: The data key of the parameter you want to remove.
+`key` (string): The data key of the parameter you want to remove.
@@ -240,8 +233,7 @@ import TrackAdRevenue from "@unity-examples/Adjust/trackAdRevenue.mdx"
-`adRevenue` (AdjustAdRevenue)
-: The ad revenue object containing the revenue details.
+`adRevenue` (AdjustAdRevenue): The ad revenue object containing the revenue details.
@@ -271,8 +263,7 @@ import TrackPlayStoreSubscription from "@unity-examples/Adjust/trackPlayStoreSub
-`subscription` (AdjustPlayStoreSubscription)
-: The subscription object containing the purchase details.
+`subscription` (AdjustPlayStoreSubscription): The subscription object containing the purchase details.
@@ -302,8 +293,7 @@ import TrackAppStoreSubscription from "@unity-examples/Adjust/trackAppStoreSubsc
-`subscription` (AdjustAppStoreSubscription)
-: The subscription object containing the purchase details.
+`subscription` (AdjustAppStoreSubscription): The subscription object containing the purchase details.
@@ -333,8 +323,7 @@ import GetAttribution from "@unity-examples/Adjust/getAttribution.mdx"
-`attribution` (AdjustAttribution)
-: An attribution object containing attribution data associated with the device.
+`attribution` (AdjustAttribution): An attribution object containing attribution data associated with the device.
diff --git a/src/content/docs/sdk/unity/reference/adjust/skan-att.mdx b/src/content/docs/sdk/unity/reference/adjust/skan-att.mdx
index 55345dd40..4b99c97e7 100644
--- a/src/content/docs/sdk/unity/reference/adjust/skan-att.mdx
+++ b/src/content/docs/sdk/unity/reference/adjust/skan-att.mdx
@@ -31,8 +31,7 @@ import RequestTrackingAuthorization from "@unity-examples/Adjust/requestTracking
-`statusCallback` (Action\)
-: Completion handler to which the status is passed.
+`statusCallback` (Action\): Completion handler to which the status is passed.
@@ -62,8 +61,7 @@ import GetAppTrackingAuthorizationStatus from "@unity-examples/Adjust/appTrackin
-`status` (int)
-: The user's authorization status.
+`status` (int): The user's authorization status.
@@ -117,8 +115,7 @@ import UpdateConversionValue from "@unity-examples/Adjust/updateConversionValue.
-conversionValue (int)
-: The new conversion value.
+conversionValue (int): The new conversion value.
diff --git a/src/content/docs/sdk/unity/reference/adjustadrevenue.mdx b/src/content/docs/sdk/unity/reference/adjustadrevenue.mdx
index ba862ea40..331370866 100644
--- a/src/content/docs/sdk/unity/reference/adjustadrevenue.mdx
+++ b/src/content/docs/sdk/unity/reference/adjustadrevenue.mdx
@@ -31,8 +31,7 @@ import Constructor from "@unity-examples/AdjustAdRevenue/constructor.mdx";
-`source` (NSString)
-: The source of the ad revenue.
+`source` (NSString): The source of the ad revenue.
@@ -77,11 +76,9 @@ import SetRevenue from "@unity-examples/AdjustAdRevenue/setRevenue.mdx"
-`amount` (double)
-: The amount of currency units associated with the ad.
+`amount` (double): The amount of currency units associated with the ad.
-`currency` (string)
-: The 3 character [ISO 4217 code](https://www.iban.com/currency-codes) of the currency unit.
+`currency` (string): The 3 character [ISO 4217 code](https://www.iban.com/currency-codes) of the currency unit.
@@ -111,8 +108,7 @@ import SetAdImpressionsCount from "@unity-examples/AdjustAdRevenue/setAdImpressi
-`adImpressionsCaount` (int)
-: The number of impressions associated with the ad.
+`adImpressionsCaount` (int): The number of impressions associated with the ad.
@@ -142,8 +138,7 @@ import SetAdRevenueNetwork from "@unity-examples/AdjustAdRevenue/setAdRevenueNet
-`adRevenueNetwork` (string)
-: The network associated with the ad revenue.
+`adRevenueNetwork` (string): The network associated with the ad revenue.
@@ -173,8 +168,7 @@ import SetAdRevenueUnit from "@unity-examples/AdjustAdRevenue/setAdRevenueUnit.m
-`unit` (string)
-: The ad unit ID associated with the ad revenue.
+`unit` (string): The ad unit ID associated with the ad revenue.
@@ -204,8 +198,7 @@ import SetAdRevenuePlacement from "@unity-examples/AdjustAdRevenue/setAdRevenueP
-`adRevenuePlacement` (string)
-: The placement of the ad associated with the revenue.
+`adRevenuePlacement` (string): The placement of the ad associated with the revenue.
@@ -235,11 +228,9 @@ import AddCallbackParameter from "@unity-examples/AdjustAdRevenue/addCallbackPar
-`key` (string)
-: The data key.
+`key` (string): The data key.
-`value` (string)
-: The data value.
+`value` (string): The data value.
@@ -269,11 +260,9 @@ import AddPartnerParameter from "@unity-examples/AdjustAdRevenue/addPartnerParam
-`key` (string)
-: The data key.
+`key` (string): The data key.
-`value` (string)
-: The data value.
+`value` (string): The data value.
diff --git a/src/content/docs/sdk/unity/reference/adjustappstoresubscription.mdx b/src/content/docs/sdk/unity/reference/adjustappstoresubscription.mdx
index 69e81d1c6..92d77747f 100644
--- a/src/content/docs/sdk/unity/reference/adjustappstoresubscription.mdx
+++ b/src/content/docs/sdk/unity/reference/adjustappstoresubscription.mdx
@@ -7,7 +7,7 @@ slug: en/sdk/unity/reference/adjustappstoresubscription
import TrackAppStoreSubscription from "@unity-signatures/Adjust/trackAppStoreSubscription.mdx"
-Use this class to store App Store subscription information. You can pass this to Adjust's servers using the `trackAppStoreSubscription` method || .
+Use this class to store App Store subscription information. You can pass this to Adjust's servers using the `trackAppStoreSubscription` method.
@@ -33,17 +33,13 @@ import Constructor from "@unity-examples/AdjustAppStoreSubscription/adjustAppSto
-`price` (string)
-: The price of the subscription.
+`price` (string): The price of the subscription.
-`currency` (string)
-: The currency of the subscription. Formatted as the [`currencyCode`](https://developer.apple.com/documentation/foundation/nslocale/1642836-currencycode?language=objc) of the [`priceLocale`](https://developer.apple.com/documentation/storekit/skproduct/1506145-pricelocale?language=objc) object
+`currency` (string): The currency of the subscription. Formatted as the [`currencyCode`](https://developer.apple.com/documentation/foundation/nslocale/1642836-currencycode?language=objc) of the [`priceLocale`](https://developer.apple.com/documentation/storekit/skproduct/1506145-pricelocale?language=objc) object
-`transactionId` (string)
-: Your ID for the transaction.
+`transactionId` (string): Your ID for the transaction.
-`receipt` (string)
-: The receipt information.
+`receipt` (string): The receipt information.
@@ -73,8 +69,7 @@ import SetTransactionDate from "@unity-examples/AdjustAppStoreSubscription/setTr
-`transactionDate` (string)
-: The date on which the subscription was purchased.
+`transactionDate` (string): The date on which the subscription was purchased.
@@ -104,8 +99,7 @@ import SetSalesRegion from "@unity-examples/AdjustAppStoreSubscription/setSalesR
-`salesRegion` (string)
-: The region in which the subscription was purchased.
+`salesRegion` (string): The region in which the subscription was purchased.
@@ -135,11 +129,9 @@ import AddCallbackParameter from "@unity-examples/AdjustAppStoreSubscription/add
-`key` (string)
-: The data key.
+`key` (string): The data key.
-`value` (string)
-: The data value.
+`value` (string): The data value.
@@ -169,11 +161,9 @@ import AddPartnerParameter from "@unity-examples/AdjustAppStoreSubscription/addP
-`key` (string)
-: The data key.
+`key` (string): The data key.
-`value` (string)
-: The data value.
+`value` (string): The data value.
diff --git a/src/content/docs/sdk/unity/reference/adjustattribution.mdx b/src/content/docs/sdk/unity/reference/adjustattribution.mdx
index 2d817a60d..864475247 100644
--- a/src/content/docs/sdk/unity/reference/adjustattribution.mdx
+++ b/src/content/docs/sdk/unity/reference/adjustattribution.mdx
@@ -12,11 +12,11 @@ The `AdjustAttribution` class contains details about the current attribution sta
## Properties
-The following properties can be accessed by calling the `getAttribution` method || . Any values that aren't populated for the user are returned as a null value.
+The following properties can be accessed by calling the `getAttribution` method. Any values that aren't populated for the user are returned as a null value.
-The following values can only be accessed if the `needsCost` property || on your `ADJConfig` instance is `true`:
+The following values can only be accessed if the `needsCost` property on your `ADJConfig` instance is `true`:
- `costType`
- `costAmount`
diff --git a/src/content/docs/sdk/unity/reference/adjustconfig/index.mdx b/src/content/docs/sdk/unity/reference/adjustconfig/index.mdx
index 075a38349..9c869ca0e 100644
--- a/src/content/docs/sdk/unity/reference/adjustconfig/index.mdx
+++ b/src/content/docs/sdk/unity/reference/adjustconfig/index.mdx
@@ -38,21 +38,17 @@ import ConfigWithAppToken from "@unity-examples/AdjustConfig/constructor.mdx"
-`appToken` (string)
-: Your Adjust app token.
+`appToken` (string): Your Adjust app token.
-`environment` (AdjustEnvironment)
-: The environment your app is running in.
+`environment` (AdjustEnvironment): The environment your app is running in.
-`allowSuppressLogLevel` (bool)
-: Whether to allow all logging to be suppressed.
+`allowSuppressLogLevel` (bool): Whether to allow all logging to be suppressed.
-`config` (AdjustConfig)
-: A config object initialized with the provided params.
+`config` (AdjustConfig): A config object initialized with the provided params.
diff --git a/src/content/docs/sdk/unity/reference/adjustconfig/privacy.mdx b/src/content/docs/sdk/unity/reference/adjustconfig/privacy.mdx
index 8405fe5c1..1b0197f0b 100644
--- a/src/content/docs/sdk/unity/reference/adjustconfig/privacy.mdx
+++ b/src/content/docs/sdk/unity/reference/adjustconfig/privacy.mdx
@@ -29,8 +29,7 @@ import SetUrlStrategy from "@unity-examples/AdjustConfig/setUrlStrategy.mdx";
-`urlStrategy` (string)
-: The data residency target (see available values below)
+`urlStrategy` (string): The data residency target (see available values below)
@@ -53,7 +52,7 @@ import SetUrlStrategy from "@unity-examples/AdjustConfig/setUrlStrategy.mdx";
## setCoppaCompliantEnabled
-Enable COPPA (Children's Online Privacy Protection Act) compliance in your app.
+Enable COPPA (Children's Online Privacy Protection Act) compliance in your app.
@@ -73,8 +72,7 @@ import SetCoppaCompliantEnabled from "@unity-examples/AdjustConfig/setCoppaCompl
-`coppaCompliantEnabled` (bool)
-: Whether the app should be COPPA compliant.
+`coppaCompliantEnabled` (bool): Whether the app should be COPPA compliant.
diff --git a/src/content/docs/sdk/unity/reference/adjustconfig/setup.mdx b/src/content/docs/sdk/unity/reference/adjustconfig/setup.mdx
index 9381d4991..c98326791 100644
--- a/src/content/docs/sdk/unity/reference/adjustconfig/setup.mdx
+++ b/src/content/docs/sdk/unity/reference/adjustconfig/setup.mdx
@@ -31,8 +31,7 @@ import SetLogLevel from "@unity-examples/AdjustConfig/setLogLevel.mdx";
-`logLevel` (AdjustLogLevel)
-: The level of logging output by the SDK.
+`logLevel` (AdjustLogLevel): The level of logging output by the SDK.
@@ -76,8 +75,7 @@ import SetLogDelegate from "@unity-examples/AdjustConfig/setLogDelegate.mdx"
-`logDelegate` (Action\)
-: The delegate function or program that handles log output.
+`logDelegate` (Action\): The delegate function or program that handles log output.
@@ -107,8 +105,7 @@ import SetDefaultTracker from "@unity-examples/AdjustConfig/setDefaultTracker.md
-`defaultTracker` (string)
-: The token to which all preinstalled sessions are attributed.
+`defaultTracker` (string): The token to which all preinstalled sessions are attributed.
@@ -138,8 +135,7 @@ import SetSendInBackground from "@unity-examples/AdjustConfig/sendInBackground.m
-`sendInBackground` (bool)
-: Whether the SDK should send information to Adjust when the app is running in the background.
+`sendInBackground` (bool): Whether the SDK should send information to Adjust when the app is running in the background.
@@ -169,8 +165,7 @@ import SetSessionSuccessDelegate from "@unity-examples/AdjustConfig/setSessionSu
-`sessionSuccessDelegate` (Action\)
-: The function to launch when the SDK successfully records a session.
+`sessionSuccessDelegate` (Action\): The function to launch when the SDK successfully records a session.
@@ -200,8 +195,7 @@ import SetSessionFailureDelegate from "@unity-examples/AdjustConfig/setSessionFa
-`sessionFailureDelegate` (Action\)
-: The function to launch when the SDK fails to record a session.
+`sessionFailureDelegate` (Action\): The function to launch when the SDK fails to record a session.
@@ -231,8 +225,7 @@ import SetEventSuccessDelegate from "@unity-examples/AdjustConfig/setEventSucces
-`eventSuccessDelegate` (Action\)
-: The function to launch when the SDK successfully records an event.
+`eventSuccessDelegate` (Action\): The function to launch when the SDK successfully records an event.
@@ -262,8 +255,7 @@ import SetEventFailureDelegate from "@unity-examples/AdjustConfig/setEventFailur
-`eventFailureDelegate` (Action\)
-: The function to launch when the SDK fails to record an event.
+`eventFailureDelegate` (Action\): The function to launch when the SDK fails to record an event.
@@ -299,8 +291,7 @@ import SetDelayStart from "@unity-examples/AdjustConfig/setDelayStart.mdx"
-`delayStart` (double)
-: The time (in seconds) to delay the start of the SDK by.
+`delayStart` (double): The time (in seconds) to delay the start of the SDK by.
@@ -330,8 +321,7 @@ import SetExternalDeviceId from "@unity-examples/AdjustConfig/setExternalDeviceI
-`externalDeviceId` (string)
-: The external device ID associated with the device.
+`externalDeviceId` (string): The external device ID associated with the device.
@@ -361,8 +351,7 @@ import SetEventBufferingEnabled from "@unity-examples/AdjustConfig/setEventBuffe
-`eventBufferingEnabled` (bool)
-: Whether event buffering is enabled.
+`eventBufferingEnabled` (bool): Whether event buffering is enabled.
@@ -392,8 +381,7 @@ import SetNeedsCost from "@unity-examples/AdjustConfig/setNeedsCost.mdx"
-`needsCost` (bool)
-: Whether the SDK should gather cost data
+`needsCost` (bool): Whether the SDK should gather cost data
@@ -423,8 +411,7 @@ import SetAttributionChangedDelegate from "@unity-examples/AdjustConfig/setAttri
-`attributionChangedDelegate` (Action\)
-: The delegate function that the SDK calls when the user's attribution information changes.
+`attributionChangedDelegate` (Action\): The delegate function that the SDK calls when the user's attribution information changes.
@@ -454,8 +441,7 @@ import SetPreinstallTrackingEnabled from "@unity-examples/AdjustConfig/setPreins
-`preinstallTrackingEnabled` (bool)
-: Whether preinstall tracking is enabled.
+`preinstallTrackingEnabled` (bool): Whether preinstall tracking is enabled.
@@ -491,8 +477,7 @@ import SetPreinstallFilePath from "@unity-examples/AdjustConfig/setPreinstallFil
-`preinstallFilePath` (string)
-: The path where the preinstall information is written.
+`preinstallFilePath` (string): The path where the preinstall information is written.
@@ -552,8 +537,7 @@ import SetLaunchDeferredDeepLink from "@unity-examples/AdjustConfig/setLaunchDef
-`launchDeferredDeepLink` (bool)
-: Whether to enable launching deferred deep links.
+`launchDeferredDeepLink` (bool): Whether to enable launching deferred deep links.
@@ -583,8 +567,7 @@ import SetLinkMeEnabled from "@unity-examples/AdjustConfig/setLinkMeEnabled.mdx"
-`linkMeEnabled` (bool)
-: Whether to enable LinkMe.
+`linkMeEnabled` (bool): Whether to enable LinkMe.
@@ -614,8 +597,7 @@ import SetConversionValueUpdatedDelegate from "@unity-examples/AdjustConfig/setC
-`conversionValueUpdatedDelegate` (Action\)
-: The delegate function the SDK launches when the conversion value updates
+`conversionValueUpdatedDelegate` (Action\): The delegate function the SDK launches when the conversion value updates
diff --git a/src/content/docs/sdk/unity/reference/adjustevent.mdx b/src/content/docs/sdk/unity/reference/adjustevent.mdx
index 30be865a3..28eed15d0 100644
--- a/src/content/docs/sdk/unity/reference/adjustevent.mdx
+++ b/src/content/docs/sdk/unity/reference/adjustevent.mdx
@@ -7,7 +7,7 @@ slug: en/sdk/unity/reference/adjustevent
import TrackEvent from "@unity-signatures/Adjust/trackEvent.mdx"
-This class contains information about events triggered in your application. You can send this information to Adjust's servers by passing an `AdjustEvent` object to the `trackEvent` method || .
+This class contains information about events triggered in your application. You can send this information to Adjust's servers by passing an `AdjustEvent` object to the `trackEvent` method.
@@ -33,8 +33,7 @@ import Constructor from "@unity-examples/AdjustEvent/constructor.mdx"
-`eventToken` (string)
-: A 6 character Adjust event token.
+`eventToken` (string): A 6 character Adjust event token.
@@ -64,11 +63,9 @@ import SetRevenue from "@unity-examples/AdjustEvent/setRevenue.mdx"
-`amount` (double)
-: The amount of currency units associated with the event.
+`amount` (double): The amount of currency units associated with the event.
-`currency` (string)
-: The 3 character [ISO 4217 code](https://www.iban.com/currency-codes) of the currency unit.
+`currency` (string): The 3 character [ISO 4217 code](https://www.iban.com/currency-codes) of the currency unit.
@@ -98,8 +95,7 @@ import SetTransactionId from "@unity-examples/AdjustEvent/setTransactionId.mdx"
-`transactionId` (string)
-: A unique identifier used to deduplicate events.
+`transactionId` (string): A unique identifier used to deduplicate events.
@@ -129,8 +125,7 @@ import SetCallbackId from "@unity-examples/AdjustEvent/setCallbackId.mdx"
-`callbackId` (string)
-: A custom identifier for your event object.
+`callbackId` (string): A custom identifier for your event object.
@@ -160,11 +155,9 @@ import AddCallbackParameter from "@unity-examples/AdjustEvent/addCallbackParamet
-`key` (string)
-: The data key.
+`key` (string): The data key.
-`value` (string)
-: The data value.
+`value` (string): The data value.
@@ -194,11 +187,9 @@ import AddPartnerParameter from "@unity-examples/AdjustEvent/addPartnerParameter
-`key` (string)
-: The data key.
+`key` (string): The data key.
-`value` (string)
-: The data value.
+`value` (string): The data value.
diff --git a/src/content/docs/sdk/unity/reference/adjustplaystoresubscription.mdx b/src/content/docs/sdk/unity/reference/adjustplaystoresubscription.mdx
index ab27e0f97..1bf11256e 100644
--- a/src/content/docs/sdk/unity/reference/adjustplaystoresubscription.mdx
+++ b/src/content/docs/sdk/unity/reference/adjustplaystoresubscription.mdx
@@ -7,7 +7,7 @@ slug: en/sdk/unity/reference/adjustplaystoresubscription
import TrackPlayStoreSubscription from "@unity-signatures/Adjust/trackPlayStoreSubscription.mdx"
-Use this class to store Play Store subscription information. You can pass this to Adjust's servers using the `trackPlayStoreSubscription` method || .
+Use this class to store Play Store subscription information. You can pass this to Adjust's servers using the `trackPlayStoreSubscription` method.
@@ -33,23 +33,17 @@ import Constructor from "@unity-examples/AdjustPlayStoreSubscription/adjustPlayS
-`price` (string)
-: The price of the subscription.
+`price` (string): The price of the subscription.
-`currency` (string)
-: The currency of the subscription. Formatted as the [`currencyCode`](https://developer.apple.com/documentation/foundation/nslocale/1642836-currencycode?language=objc) of the [`priceLocale`](https://developer.apple.com/documentation/storekit/skproduct/1506145-pricelocale?language=objc) object
+`currency` (string): The currency of the subscription. Formatted as the [`currencyCode`](https://developer.apple.com/documentation/foundation/nslocale/1642836-currencycode?language=objc) of the [`priceLocale`](https://developer.apple.com/documentation/storekit/skproduct/1506145-pricelocale?language=objc) object
-`sku` (string)
-: The ID of the product.
+`sku` (string): The ID of the product.
-`orderId` (string)
-: Your ID for the transaction.
+`orderId` (string): Your ID for the transaction.
-`signature` (string)
-: The signature of the purchase data.
+`signature` (string): The signature of the purchase data.
-`purchaseToken` (string)
-: The unique token of the transaction. See [Google's documentation](https://developer.android.com/reference/com/android/billingclient/api/Purchase#getPurchaseToken()) for more information.
+`purchaseToken` (string): The unique token of the transaction. See [Google's documentation](https://developer.android.com/reference/com/android/billingclient/api/Purchase#getPurchaseToken()) for more information.
@@ -79,8 +73,7 @@ import SetPurchaseTime from "@unity-examples/AdjustPlayStoreSubscription/setPurc
-`purchaseTime` (string)
-: The date on which the subscription was purchased.
+`purchaseTime` (string): The date on which the subscription was purchased.
@@ -111,11 +104,9 @@ import AddCallbackParameter from "@unity-examples/AdjustPlayStoreSubscription/ad
-`key` (string)
-: The data key.
+`key` (string): The data key.
-`value` (string)
-: The data value.
+`value` (string): The data value.
@@ -145,11 +136,9 @@ import AddPartnerParameter from "@unity-examples/AdjustPlayStoreSubscription/add
-`key` (string)
-: The data key.
+`key` (string): The data key.
-`value` (string)
-: The data value.
+`value` (string): The data value.
diff --git a/src/content/docs/sdk/unity/reference/adjustthirdpartysharing.mdx b/src/content/docs/sdk/unity/reference/adjustthirdpartysharing.mdx
index f74788a52..db17150c0 100644
--- a/src/content/docs/sdk/unity/reference/adjustthirdpartysharing.mdx
+++ b/src/content/docs/sdk/unity/reference/adjustthirdpartysharing.mdx
@@ -5,9 +5,9 @@ category-title: AdjustThirdPartySharing class
slug: en/sdk/unity/reference/adjustthirdpartysharing
---
-import TrackThirdPartySharing from "@unity-signatures/Adjust/trackThirdPartySharing.mdx"
+import TrackThirdPartySharing from "@unity-signatures/Adjust/trackThirdPartySharing.mdx";
-Use this class to communicate a user's third party sharing preferences. Send this information to Adjust's servers using the `trackThirdPartySharing` method || .
+Use this class to communicate a user's third party sharing preferences. Send this information to Adjust's servers using the `trackThirdPartySharing` method.
@@ -33,8 +33,7 @@ import InitTrue from "@unity-examples/AdjustThirdPartySharing/initTrue.mdx";
-`isEnabled` (bool)
-: Whether third party sharing is enabled.
+`isEnabled` (bool): Whether third party sharing is enabled.
@@ -48,7 +47,7 @@ Adds additional key-value pairs of information to share with third parties. You
-import AddGranularOptionSig from "@unity-signatures/AdjustThirdPartySharing/addGranularOption.mdx"
+import AddGranularOptionSig from "@unity-signatures/AdjustThirdPartySharing/addGranularOption.mdx";
@@ -66,20 +65,13 @@ import Facebook from "@unity-examples/AdjustThirdPartySharing/addGranularOptionF
-
-
-- - Parameter
- - Description
-- - `partner_name`
- - Use `facebook` to toggle LDU.
-- - `data_processing_options_country`
- - The user is located in.
- - `0`: Request that Facebook use geolocation.
- - `1`: United States of America.
-- - `data_processing_options_state`
- - Notifies Facebook which state the user is located in.
- - `0`: Request that Facebook use geolocation.
- - `1000`: California.
+
+
+| Parameter | Description |
+| --------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
+| `partner_name` | Use `facebook` to toggle LDU. |
+| `data_processing_options_country` | The country in which the user is located.- `0`: Request that Facebook use geolocation.
- `1`: United States of America.
|
+| `data_processing_options_state` | Notifies Facebook in which state the user is located.- `0`: Request that Facebook use geolocation.
- `1000`: California.
|
@@ -87,14 +79,11 @@ import Facebook from "@unity-examples/AdjustThirdPartySharing/addGranularOptionF
-`partnerName` (string)
-: The name of the partner you want to share information with.
+`partnerName` (string): The name of the partner you want to share information with.
-`key` (string)
-: The data key.
+`key` (string): The data key.
-`value` (string)
-: The data value.
+`value` (string): The data value.
@@ -124,12 +113,9 @@ import AddPartnerSharingSetting from "@unity-examples/AdjustThirdPartySharing/ad
-`partnerName` (string)
-: The name of the partner whose settings you want to update. See the table of available partners below.
-`key` (string)
-: The setting you want to update.
-`value` (bool)
-: Whether the setting is enabled.
+`partnerName` (string): The name of the partner whose settings you want to update. See the table of available partners below.
+`key` (string): The setting you want to update.
+`value` (bool): Whether the setting is enabled.
diff --git a/src/content/docs/sdk/web/configuration/default-campaign.mdx b/src/content/docs/sdk/web/configuration/default-campaign.mdx
index 760c318bd..dca0b1ef2 100644
--- a/src/content/docs/sdk/web/configuration/default-campaign.mdx
+++ b/src/content/docs/sdk/web/configuration/default-campaign.mdx
@@ -14,7 +14,7 @@ Configuring a default campaign enables you to attribute all preinstalls to a pre
https://app.adjust.com/{token}
```
-2. Pass your campaign token to the `initSdk` method || in the `defaultTracker` argument.
+2. Pass your campaign token to the `initSdk` method in the `defaultTracker` argument.
```js
Adjust.initSdk({
diff --git a/src/content/docs/sdk/web/configuration/delay.mdx b/src/content/docs/sdk/web/configuration/delay.mdx
index bd7b13745..11159e296 100644
--- a/src/content/docs/sdk/web/configuration/delay.mdx
+++ b/src/content/docs/sdk/web/configuration/delay.mdx
@@ -20,6 +20,6 @@ The Adjust SDK sends event and session data to Adjust's servers in real time. Yo
## Event buffering
-The SDK sends all saved information to Adjust's servers when you disable offline mode. To do this, call the `switchBackToOnlineMode` method || .
+The SDK sends all saved information to Adjust's servers when you disable offline mode. To do this, call the `switchBackToOnlineMode` method.
diff --git a/src/content/docs/sdk/web/configuration/disable.mdx b/src/content/docs/sdk/web/configuration/disable.mdx
index 0250b9056..c387a8d74 100644
--- a/src/content/docs/sdk/web/configuration/disable.mdx
+++ b/src/content/docs/sdk/web/configuration/disable.mdx
@@ -11,11 +11,11 @@ import RestartSig from "@web-signatures/Adjust/restart.mdx"
The Adjust SDK runs by default when your app is open. You can disable and re-enable the Adjust SDK to pause and resume recording. When you disable the Adjust SDK, it doesn't send any data to Adjust's servers.
-You can disable the SDK at any time by calling the `stop` method || .
+You can disable the SDK at any time by calling the `stop` method.
-You can restart the SDK at any time by calling the `restart` method || .
+You can restart the SDK at any time by calling the `restart` method.
diff --git a/src/content/docs/sdk/web/configuration/external-device-id.mdx b/src/content/docs/sdk/web/configuration/external-device-id.mdx
index 0f33df6b6..92fad4722 100644
--- a/src/content/docs/sdk/web/configuration/external-device-id.mdx
+++ b/src/content/docs/sdk/web/configuration/external-device-id.mdx
@@ -16,7 +16,7 @@ See the [External device identifiers article](https://help.adjust.com/en/article
-You can set an external device ID by specifying an `externalDeviceId` argument in the `initSdk` method || . The external device ID is case-sensitive. If you have imported external device IDs, make sure the value you pass matches the imported value.
+You can set an external device ID by specifying an `externalDeviceId` argument in the `initSdk` method. The external device ID is case-sensitive. If you have imported external device IDs, make sure the value you pass matches the imported value.
```js
Adjust.initSdk({
diff --git a/src/content/docs/sdk/web/configuration/log-level.mdx b/src/content/docs/sdk/web/configuration/log-level.mdx
index 670b79fc0..cb1b60fb9 100644
--- a/src/content/docs/sdk/web/configuration/log-level.mdx
+++ b/src/content/docs/sdk/web/configuration/log-level.mdx
@@ -20,7 +20,7 @@ The Adjust SDK provides configurable log levels to return different amounts of i
-You can set the log level by specifying an `logLevel` argument in the `initSdk` method || . The SDK defaults to `error` if no value is passed.
+You can set the log level by specifying an `logLevel` argument in the `initSdk` method. The SDK defaults to `error` if no value is passed.
```js {4}
Adjust.initSdk({
@@ -32,7 +32,7 @@ Adjust.initSdk({
## Set log output
-You can delegate a log output location in your web app to show logs directly on the screen. To do this, specify an HTML selector in the `logOutput` argument in the `initSdk` method || . The SDK logs will print to this container.
+You can delegate a log output location in your web app to show logs directly on the screen. To do this, specify an HTML selector in the `logOutput` argument in the `initSdk` method. The SDK logs will print to this container.
```js {4}
Adjust.initSdk({
diff --git a/src/content/docs/sdk/web/configuration/namespace.mdx b/src/content/docs/sdk/web/configuration/namespace.mdx
index 17abd65d2..e9800fe8f 100644
--- a/src/content/docs/sdk/web/configuration/namespace.mdx
+++ b/src/content/docs/sdk/web/configuration/namespace.mdx
@@ -16,7 +16,7 @@ If you set a custom namespace this value shouldn't be changed. If you change to
-You can set an custom namespace by specifying a `namespace` property in the `initSdk` method || .
+You can set an custom namespace by specifying a `namespace` property in the `initSdk` method.
```js {4}
Adjust.initSdk({
diff --git a/src/content/docs/sdk/web/configuration/privacy.mdx b/src/content/docs/sdk/web/configuration/privacy.mdx
index 0a3e7a039..0ddafbce4 100644
--- a/src/content/docs/sdk/web/configuration/privacy.mdx
+++ b/src/content/docs/sdk/web/configuration/privacy.mdx
@@ -14,15 +14,15 @@ The Adjust SDK contains features that you can use to handle user privacy in your
## GDPR right to be forgotten
-Article 17 of the European Union's GDPR (General Data Protection Regulation) grants users the right to be forgotten. When Adjust's servers receive an RTBF (Right to be Forgotten) request, Adjust erases the user's data. The SDK also stops sending requests from the device for the app in question.
+Article 17 of the European Union's GDPR (General Data Protection Regulation) grants users the right to be forgotten. When Adjust's servers receive an RTBF (Right to be Forgotten) request, Adjust erases the user's data. The SDK also stops sending requests from the device for the app in question.
-You can send the user's RTBF request to Adjust by calling the `gdprForgetMe` method || .
+You can send the user's RTBF request to Adjust by calling the `gdprForgetMe` method.
## Disable third-party sharing
-Some users may want to opt-out of sharing their data with third-parties. To communicate this to Adjust, call the `disableThirdPartySharing` method || . When Adjust's servers receive this information, Adjust stops sharing the user's data with third-parties. The Adjust SDK continues to work as expected.
+Some users may want to opt-out of sharing their data with third-parties. To communicate this to Adjust, call the `disableThirdPartySharing` method. When Adjust's servers receive this information, Adjust stops sharing the user's data with third-parties. The Adjust SDK continues to work as expected.
@@ -30,7 +30,7 @@ Some users may want to opt-out of sharing their data with third-parties. To comm
The data residency feature allows you to choose the country in which Adjust stores your data. This is useful if you're operating in a country with strict privacy requirements. When you set up data residency, Adjust stores your data in a data center located in the region your have chosen.
-To set your country of data residency, pass the region code of your preferred country code in the `dataResidency` property of the `initSdk` method || .
+To set your country of data residency, pass the region code of your preferred country code in the `dataResidency` property of the `initSdk` method.
```js {5}
Adjust.initSdk({
@@ -53,7 +53,7 @@ Adjust.initSdk({
## URL strategy
-You can set a URL strategy to prioritize regional endpoints for sending data from the Adjust SDK. To do this, pass the region of your preferred country code in the `urlStrategy` property of the `initSdk` method || .
+You can set a URL strategy to prioritize regional endpoints for sending data from the Adjust SDK. To do this, pass the region of your preferred country code in the `urlStrategy` property of the `initSdk` method.
```js {5}
Adjust.initSdk({
@@ -75,7 +75,7 @@ Adjust.initSdk({
## Set custom endpoint
-By default, the Adjust SDK sends all data to Adjust's endpoints. If you want to specify a custom endpoint, pass your endpoint in the `customUrl` property of the `initSdk` method || .
+By default, the Adjust SDK sends all data to Adjust's endpoints. If you want to specify a custom endpoint, pass your endpoint in the `customUrl` property of the `initSdk` method.
```js {4}
Adjust.initSdk({
diff --git a/src/content/docs/sdk/web/configuration/referrer.mdx b/src/content/docs/sdk/web/configuration/referrer.mdx
index c3d50006b..bd7a41eea 100644
--- a/src/content/docs/sdk/web/configuration/referrer.mdx
+++ b/src/content/docs/sdk/web/configuration/referrer.mdx
@@ -15,6 +15,6 @@ Call this method as close to initializing the SDK as possible to ensure your ref
-To set your referrer, call the `setReferrer` method || and pass your referrer as a URL-encoded **string** argument.
+To set your referrer, call the `setReferrer` method and pass your referrer as a URL-encoded **string** argument.
diff --git a/src/content/docs/sdk/web/features/attribution.mdx b/src/content/docs/sdk/web/features/attribution.mdx
index 07e6d995b..8ca94a78a 100644
--- a/src/content/docs/sdk/web/features/attribution.mdx
+++ b/src/content/docs/sdk/web/features/attribution.mdx
@@ -9,7 +9,7 @@ import GetAttribution from "@web-signatures/Adjust/getAttribution.mdx"
When a user interacts with a campaign link, their attribution information updates. This can happen if the user interacts with a [deep link](https://help.adjust.com/en/article/deep-links). The SDK can listen for attribution changes and call a function when it detects an update.
-You can set an attribution callback method by specifying an `attributionCallback` function in the `initSdk` method || .
+You can set an attribution callback method by specifying an `attributionCallback` function in the `initSdk` method.
```js
Adjust.initSdk({
@@ -49,39 +49,30 @@ export type AttributionMapT = $ReadOnly<{|
|}>;
```
-`adid` (string)
-: The device's unique Adjust identifier.
+`adid` (string): The device's unique Adjust identifier.
-`tracker_token` (string)
-: The campaign token associated with the attribution.
+`tracker_token` (string): The campaign token associated with the attribution.
-`tracker_name` (string)
-: The name of the campaign link.
+`tracker_name` (string): The name of the campaign link.
-`network` (string)
-: The network associate with the campaign.
+`network` (string): The network associate with the campaign.
-`campaign` (string)
-: The name of the campaign associated with the attribution.
+`campaign` (string): The name of the campaign associated with the attribution.
-`adgroup` (string)
-: The adgroup associated with the attribution.
+`adgroup` (string): The adgroup associated with the attribution.
-`creative` (string)
-: The creative associated with the attribution.
+`creative` (string): The creative associated with the attribution.
-`click_label` (string)
-: The [click label](https://help.adjust.com/en/article/user-rewards) associated with the attribution.
+`click_label` (string): The [click label](https://help.adjust.com/en/article/user-rewards) associated with the attribution.
-`state` (string)
-: The current state of the attribution. Either `installed` or `reattributed`
+`state` (string): The current state of the attribution. Either `installed` or `reattributed`
## Get current attribution information
-When a user installs your app, Adjust attributes the install to a campaign. The Adjust SDK gives you access to campaign attribution details for your install. To return this information, call the `getAttribution` method || .
+When a user installs your app, Adjust attributes the install to a campaign. The Adjust SDK gives you access to campaign attribution details for your install. To return this information, call the `getAttribution` method.
```js
Adjust.initSdk({
diff --git a/src/content/docs/sdk/web/features/device-info.mdx b/src/content/docs/sdk/web/features/device-info.mdx
index 1e5c6e4ae..ff9b443ce 100644
--- a/src/content/docs/sdk/web/features/device-info.mdx
+++ b/src/content/docs/sdk/web/features/device-info.mdx
@@ -11,8 +11,8 @@ The Adjust SDK contains helper methods that return device information. Use these
## Web ID
-To identify web users in Adjust, Web SDK generates a unique `web_uuid` when it tracks the first session. The ID is created per subdomain and per browser. The identifier follows the UUID (Universally Unique Identifier) format.
+To identify web users in Adjust, Web SDK generates a unique `web_uuid` when it tracks the first session. The ID is created per subdomain and per browser. The identifier follows the UUID (Universally Unique Identifier) format.
-Call the `getWebUUID` method || to return this information as a **string**.
+Call the `getWebUUID` method to return this information as a **string**.
diff --git a/src/content/docs/sdk/web/features/events.mdx b/src/content/docs/sdk/web/features/events.mdx
index 7955e8d5e..deb34b5a3 100644
--- a/src/content/docs/sdk/web/features/events.mdx
+++ b/src/content/docs/sdk/web/features/events.mdx
@@ -11,7 +11,7 @@ import TrackEventSig from "@web-signatures/Adjust/trackEvent.mdx"
You can associate your [Adjust event tokens](https://help.adjust.com/en/article/add-events#add-event) to actions in your app to record them. To record an event:
1. Create a new Adjust event instance and pass your event token as a **string** argument.
-2. Call the `trackEvent` method || method with your event instance as an argument.
+2. Call the `trackEvent` method method with your event instance as an argument.
@@ -51,13 +51,11 @@ _timeoutId = setTimeout(() => {
You can record revenue associated with an event by setting the `revenue` and `currency` properties on your event instance. Use this feature to record revenue-generating actions in your app.
-To set these properties, call the `trackEvent` method || and pass the following arguments:
+To set these properties, call the `trackEvent` method and pass the following arguments:
-`revenue` (**number**)
-: The amount of revenue generated by the event
+`revenue` (**number**): The amount of revenue generated by the event
-`currency` (**string**)
-: The [ISO 4217 code](https://www.iban.com/currency-codes) of the event currency.
+`currency` (**string**): The [ISO 4217 code](https://www.iban.com/currency-codes) of the event currency.
You must format the currency code as a 3 character string that follows the [ISO 4217 standard](https://www.iban.com/currency-codes). Adjust's servers convert the reported revenue to your chosen reporting currency.
@@ -154,7 +152,7 @@ _timeoutId = setTimeout(() => {
```
-You can override the deduplication limit to change the number of identifiers the Adjust SDK stores. To do this, specify the new limit in the `eventDeduplicationListLimit` argument of the `initSdk` method || .
+You can override the deduplication limit to change the number of identifiers the Adjust SDK stores. To do this, specify the new limit in the `eventDeduplicationListLimit` argument of the `initSdk` method.
```js {4}
Adjust.initSdk({
@@ -313,7 +311,7 @@ _timeoutId = setTimeout(() => {
## Record event and redirect to an external page
-You can record redirects to external pages as events with the Adjust SDK. To ensure the SDK records the event before the redirect happens, the `trackEvent` method || returns a [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise). This `Promise` is fulfilled after the SDK receives a response from Adjust's servers. If an internal error response is returned, the `Promise` is rejected.
+You can record redirects to external pages as events with the Adjust SDK. To ensure the SDK records the event before the redirect happens, the `trackEvent` method returns a [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise). This `Promise` is fulfilled after the SDK receives a response from Adjust's servers. If an internal error response is returned, the `Promise` is rejected.
diff --git a/src/content/docs/sdk/web/features/global-params.mdx b/src/content/docs/sdk/web/features/global-params.mdx
index 4fb2ffd2c..8afd8aec3 100644
--- a/src/content/docs/sdk/web/features/global-params.mdx
+++ b/src/content/docs/sdk/web/features/global-params.mdx
@@ -26,7 +26,7 @@ If you [register a callback URL](https://help.adjust.com/en/article/set-up-callb
You can configure global callback parameters to your servers. Once you configure parameters, the SDK appends them to your callback URL. You can use this information to analyze your users' in-app behavior with your BI system.
-Add callback parameters to your sessions and events by calling the `addGlobalCallbackParameters` method || with an array of **string** key-value pair objects. You can add as many objects to this array as you require.
+Add callback parameters to your sessions and events by calling the `addGlobalCallbackParameters` method with an array of **string** key-value pair objects. You can add as many objects to this array as you require.
@@ -36,11 +36,11 @@ For the above example, the callback URL looks like this:
https://www.mydomain.com/callback?key1=value1&key2=value2
```
-You can remove global callback parameters if they're no longer required. To do this, pass the parameter key to the `removeGlobalCallbackParameter` method || .
+You can remove global callback parameters if they're no longer required. To do this, pass the parameter key to the `removeGlobalCallbackParameter` method.
-You can remove all global callback parameters if they're no longer required. To do this, call the `clearGlobalCallbackParameters` method || .
+You can remove all global callback parameters if they're no longer required. To do this, call the `clearGlobalCallbackParameters` method.
@@ -56,14 +56,14 @@ Partner parameters don't appear in raw data by default. You can add the `{partne
-Add partner parameters to your sessions and events by calling the `addGlobalPartnerParameters` method || with an array of **string** key-value pair objects. You can add as many objects to this array as you require.
+Add partner parameters to your sessions and events by calling the `addGlobalPartnerParameters` method with an array of **string** key-value pair objects. You can add as many objects to this array as you require.
-You can remove global partner parameters if they're no longer required. To do this, pass the parameter key to the `removeGlobalPartnerParameter` method || .
+You can remove global partner parameters if they're no longer required. To do this, pass the parameter key to the `removeGlobalPartnerParameter` method.
-You can remove all global partner parameters if they're no longer required. To do this, call the `clearGlobalPartnerParameters` method || .
+You can remove all global partner parameters if they're no longer required. To do this, call the `clearGlobalPartnerParameters` method.
diff --git a/src/content/docs/sdk/web/index.mdx b/src/content/docs/sdk/web/index.mdx
index 9f387264d..b9c79f224 100644
--- a/src/content/docs/sdk/web/index.mdx
+++ b/src/content/docs/sdk/web/index.mdx
@@ -9,7 +9,7 @@ The Adjust Web SDK enables you to record attribution, events, and more in your w
## 1. Add the SDK to your project
-To get started, you need to add the SDK to your web app. The Adjust SDK works in both CommonJS and AMD (Asynchronous Module Definition) environments and can be accessed through a global `Adjust` namespace when loaded through a CDN (Content Delivery Network).
+To get started, you need to add the SDK to your web app. The Adjust SDK works in both CommonJS and AMD (Asynchronous Module Definition) environments and can be accessed through a global `Adjust` namespace when loaded through a CDN (Content Delivery Network).
### Using a CDN
@@ -81,7 +81,7 @@ The Adjust SDK loads on each page and initiates once per page load.
#### Subresource Integrity
-If you want to use [Subresource Integrity](https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity) checks to mitigate against XSS (Cross-Site Scripting) attacks, you can validate the package before running it by using the following call:
+If you want to use [Subresource Integrity](https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity) checks to mitigate against XSS (Cross-Site Scripting) attacks, you can validate the package before running it by using the following call:
```html