Skip to content

Commit

Permalink
Align text to GFM spec (#481)
Browse files Browse the repository at this point in the history
  • Loading branch information
Sporiff authored Feb 21, 2024
2 parents 07e6ac5 + f7fa679 commit 703316f
Show file tree
Hide file tree
Showing 231 changed files with 1,590 additions and 5,005 deletions.
6 changes: 3 additions & 3 deletions src/content/docs/api/ad-spend-api/cost-id.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 <Abbr>UUID (Universally Unique Identifier)</Abbr> 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 <Abbr>IDFA (ID For Advertisers)</Abbr> 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 <Abbr>CPM (Cost Per Mille)</Abbr> 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.
6 changes: 3 additions & 3 deletions src/content/docs/api/app-automation-api/app-endpoint.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -200,9 +200,9 @@ GET https://settings.adjust.com/api/app/{adjust_app_token}/channels

<Table>

| 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. |

</Table>

Expand Down
22 changes: 11 additions & 11 deletions src/content/docs/api/app-automation-api/authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 (<Icon name="CogWheel" />) in the bottom left corner.
2. Select <GuiLabel>Account settings</GuiLabel>. Your account settings page opens.
3. Select the <GuiLabel>My profile</GuiLabel> tab.
4. Your <GuiLabel>API Token</GuiLabel> is shown with your <GuiLabel>User Details</GuiLabel>. Select the copy button (<Icon name="Copy" />) 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 (<Icon name="CogWheel" />) in the bottom left corner.
2. Select <GuiLabel>Account settings</GuiLabel>. Your account settings page opens.
3. Select the <GuiLabel>My Profile</GuiLabel> tab.
4. Your <GuiLabel>API Token</GuiLabel> is shown with your <GuiLabel>User details</GuiLabel>.
5. Select <GuiLabel>Reset API token</GuiLabel>. A popup modal appears.
6. Enter your account password in the modal and select <GuiLabel>Reset</GuiLabel> to reset your API token. The modal closes and a confirmation appears in the top right of the screen.
7. Select the copy button (<Icon name="Copy" />) next to the <GuiLabel>API Token</GuiLabel> 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.
49 changes: 13 additions & 36 deletions src/content/docs/api/app-automation-api/channel-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,42 +31,19 @@ All parameters need to be passed as a key-value pair inside the `channel_setup`

</Callout>

<Table list>

- - 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.
<Table>

| 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` | <ul><li>`app_id`</li><li>`token`</li></ul> | <ul><li>`app_id`: Your app's Chartboost ID.</li><li>`token`: Your app's signature.</li></ul> |
| `inmobi` | <ul><li>`property_id`</li><li>`advertiser_id`</li></ul> | <ul><li>`property_id`: Your app's ID in Inmobi.</li><li>`advertiser_id`: Your Inmobi advertiser ID.</li></ul> |

</Table>

Expand Down
12 changes: 5 additions & 7 deletions src/content/docs/api/app-automation-api/status-endpoint.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,12 @@ Use this endpoint to return the status of a settings copy process. You receive y
}
```

<Accordion title="Statuses">
### 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.

</Accordion>
- `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

Expand Down
22 changes: 11 additions & 11 deletions src/content/docs/api/blocklist-api/authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 (<Icon name="CogWheel" />) in the bottom left corner.
2. Select <GuiLabel>Account settings</GuiLabel>. Your account settings page opens.
3. Select the <GuiLabel>My profile</GuiLabel> tab.
4. Your <GuiLabel>API Token</GuiLabel> is shown with your <GuiLabel>User Details</GuiLabel>. Select the copy button (<Icon name="Copy" />) 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 (<Icon name="CogWheel" />) in the bottom left corner.
2. Select <GuiLabel>Account settings</GuiLabel>. Your account settings page opens.
3. Select the <GuiLabel>My Profile</GuiLabel> tab.
4. Your <GuiLabel>API Token</GuiLabel> is shown with your <GuiLabel>User details</GuiLabel>.
5. Select <GuiLabel>Reset API token</GuiLabel>. A popup modal appears.
6. Enter your account password in the modal and select <GuiLabel>Reset</GuiLabel> to reset your API token. The modal closes and a confirmation appears in the top right of the screen.
7. Select the copy button (<Icon name="Copy" />) next to the <GuiLabel>API Token</GuiLabel> 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.
14 changes: 7 additions & 7 deletions src/content/docs/api/blocklist-api/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ slug: en/api/blocklist-api

</Callout>

Use the Adjust Blocklist API to block traffic from fraudulent or outdated tracker URLs. Blocklisted trackers display a <GuiLabel>BLOCKLISTED</GuiLabel> 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.

<Callout type="seealso" title="See also">
<Callout type="seealso">

See [Self-attributing network setup
](https://help.adjust.com/en/suite/article/self-attributing-network-san-setup) for a list of SAN partners.
Expand Down Expand Up @@ -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 (<Icon name="ChevronUpSmall" />).
2. Select <GuiLabel>Tracker URLs</GuiLabel>.
3. Select <GuiLabel>Settings</GuiLabel> (<Icon name="CogWheel" />) 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 <GuiLabel>BLOCKLISTED</GuiLabel>.
Links on the blocklist display as **BLOCKLISTED**.

You can't <GuiLabel>EDIT</GuiLabel> 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).
22 changes: 11 additions & 11 deletions src/content/docs/api/campaign-api/authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 (<Icon name="CogWheel" />) in the bottom left corner.
2. Select <GuiLabel>Account settings</GuiLabel>. Your account settings page opens.
3. Select the <GuiLabel>My profile</GuiLabel> tab.
4. Your <GuiLabel>API Token</GuiLabel> is shown with your <GuiLabel>User Details</GuiLabel>. Select the copy button (<Icon name="Copy" />) 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 (<Icon name="CogWheel" />) in the bottom left corner.
2. Select <GuiLabel>Account settings</GuiLabel>. Your account settings page opens.
3. Select the <GuiLabel>My Profile</GuiLabel> tab.
4. Your <GuiLabel>API Token</GuiLabel> is shown with your <GuiLabel>User details</GuiLabel>.
5. Select <GuiLabel>Reset API token</GuiLabel>. A popup modal appears.
6. Enter your account password in the modal and select <GuiLabel>Reset</GuiLabel> to reset your API token. The modal closes and a confirmation appears in the top right of the screen.
7. Select the copy button (<Icon name="Copy" />) next to the <GuiLabel>API Token</GuiLabel> 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.
16 changes: 7 additions & 9 deletions src/content/docs/api/campaign-api/create-tracker.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -46,15 +46,6 @@ Create a new tracker or subtracker associated to your app.

</Table>

<Accordion title="Tracker levels">

- Network = `1`
- Campaign = `2`
- Adgroup = `3`
- Creative = `4`

</Accordion>

```json title="Response format"
{
"name": "String",
Expand All @@ -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

<Tabs>
Expand Down
22 changes: 11 additions & 11 deletions src/content/docs/api/device-api/authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 (<Icon name="CogWheel" />) in the bottom left corner.
2. Select <GuiLabel>Account settings</GuiLabel>. Your account settings page opens.
3. Select the <GuiLabel>My profile</GuiLabel> tab.
4. Your <GuiLabel>API Token</GuiLabel> is shown with your <GuiLabel>User Details</GuiLabel>. Select the copy button (<Icon name="Copy" />) 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 (<Icon name="CogWheel" />) in the bottom left corner.
2. Select <GuiLabel>Account settings</GuiLabel>. Your account settings page opens.
3. Select the <GuiLabel>My Profile</GuiLabel> tab.
4. Your <GuiLabel>API Token</GuiLabel> is shown with your <GuiLabel>User details</GuiLabel>.
5. Select <GuiLabel>Reset API token</GuiLabel>. A popup modal appears.
6. Enter your account password in the modal and select <GuiLabel>Reset</GuiLabel> to reset your API token. The modal closes and a confirmation appears in the top right of the screen.
7. Select the copy button (<Icon name="Copy" />) next to the <GuiLabel>API Token</GuiLabel> 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.
2 changes: 1 addition & 1 deletion src/content/docs/api/gdpr-api/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ category-title: GDPR API
slug: en/api/gdpr-api
---

Adjust offers an API endpoint to facilitate <Abbr>RTBF (Right to be Forgotten)</Abbr> 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.
Expand Down
Loading

0 comments on commit 703316f

Please sign in to comment.