Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Smartling translations are updated for commit f7700b61cf538bbfbc4f651690e8f798367c9e70 from main #1136

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Smartling translations are updated for commit f7700b61cf538bbfbc4f651690e8f798367c9e70 from main #1136

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5090f03
File src/content/docs/en/api/deep-link-generator-api.mdx was updated …
adjust-pc-team Oct 18, 2024
aa8df49
File src/content/docs/en/api/deep-link-generator-api.mdx was updated …
adjust-pc-team Oct 18, 2024
0624eb4
File src/content/docs/en/api/deep-link-generator-api.mdx was updated …
adjust-pc-team Oct 18, 2024
27c946c
Fix translated files
github-actions[bot] Oct 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
282 changes: 282 additions & 0 deletions src/content/docs/ja/api/deep-link-generator-apimdx
View file
Open in desktop

Large diffs are not rendered by default.

282 changes: 282 additions & 0 deletions src/content/docs/ko/api/deep-link-generator-apimdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,282 @@
---
title: "딥링크 생성기 API"
description: "딥링크 생성기 API를 사용하여 앱에 대한 긴/단축 딥링크를 개별 또는 일괄로 생성할 수 있습니다."
category-title: "딥링크 생성기 API"
slug: "en/api/deep-link-generator-api"
sidebar-position: 8
---
딥링크 생성기 API를 사용하여 앱에 대한 긴/단축 딥링크를 개별 또는 일괄로 생성할 수 있습니다. 이러한 맞춤형 딥링크는 다양한 플랫폼에서 사용자 경험을 향상시킵니다.

시작에 앞서 \{\#before\-you\-begin\}
------------------------------------

시작하기 전에 알아야 할 사항은 다음과 같습니다.

### Availability \{\#availability\}

<callout type="important">

The Deep link generator API has a rate limit of 200 requests per second. You will get a 429 error if you exceed this limit.
</Callout>

* You need to be on the TrueLink Core, or Enterprise package to get access to the Deep link generator API.
* Links created using the Deep link generator API aren't displayed in [Campaign Lab](https://help.adjust.com/en/article/campaign-setup).
* 딥링크 생성기 API를 사용하여 생성된 단축 링크의 TTL\(time\-to\-live\)은 120일입니다.

### Requirements \{\#requirements\}

* 관리자, 편집자 또는 사용자 지정 편집자 [권한](https://help.adjust.com/en/article/permission-levels).
* iOS와 Android 앱에 대해 [동일한 브랜드 도메인을 설정](https://help.adjust.com/en/article/set-up-branded-domain)합니다.
* iOS 앱의 경우 브랜드 도메인을 [Associated Domain](https://help.adjust.com/en/article/set-up-branded-domain#ios-only-update)으로 추가하시기 바랍니다. 이렇게 하면 도메인이 유니버셜 링크로 구성되도록 설정됩니다.
* Android 앱의 경우 브랜드 도메인을 [Android 앱 링크](https://help.adjust.com/en/article/set-up-android-app-links)로 정의하시기 바랍니다.

* A custom link for your app.
* Single\-platform apps, multi\-platform apps \- [Create a custom link in Campaign Lab](https://help.adjust.com/en/article/custom-link-setup) to get a single link token.
* 여러 개의 단일 플랫폼 앱 \- [Campaign Lab](https://help.adjust.com/en/article/custom-link-setup#combined-custom-links) 에서 여러 개의 단일 플랫폼 앱으로부터 결합된 커스텀 링크를 생성하여, 여러 개의 링크 토큰이 '\_'로 구분된 단일 결합된 커스텀 링크를 생성할 수 있습니다. 자세한 정보는 [복합 커스텀 링크에 대한 플랫폼별 링크 토큰](https://help.adjust.com/en/article/manage-custom-link-setup#link-tokens-combined-custom-link)을 참조하시기 바랍니다.

* Update the Adjust SDK to resolve short links.
* [iOS](/en/sdk/ios/features/short-links) \| [Android](/en/sdk/android/features/short-links) \| [Unity](/en/sdk/unity/features/short-links) \| [React Native](/en/sdk/react-native/features/short-links) \| [Flutter](/en/sdk/flutter/features/short-links) \| [Cordova](/en/sdk/cordova/features/short-links) \| [Cocos2d\-x](/en/sdk/cocos2dx/features/short-links)

* [데이터 레지던시를 설정](https://help.adjust.com/en/article/data-residency-setup)한 경우, iOS와 Android 앱에 동일한 지역을 사용해야 합니다.

인증 \{\#authentication\}
--------------------------

The Deep link generator API uses [Bearer tokens](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication) for authentication. You MUST include your Adjust API token in an `Authorization` header with each request you make to the Deep link generator API.

Single Sign\-On \(SSO\)를 활성화한 경우, Adjust 담당자에게 연락하거나 [[email protected]](mailto:[email protected]) 으로 이메일을 보내 API를 찾는 데 도움을 받으시기 바랍니다.

비 SSO 계정의 경우, API는 사용자의 **프로필** 에서 확인하실 수 있습니다. Adjust API 토큰을 확인하려면 다음 단계를 따르시기 바랍니다.

1. Select the account \(user\) icon.
2. **계정 설정** 을 선택합니다.
3. **내 프로필** 탭을 선택합니다.
4. **API 토큰** 은 **사용자 세부 사항** 과 함께 표시됩니다. 시스템 클립보드에 토큰을 복사하기 위해 복사를 선택합니다.

### Adjust API 토큰 재설정 \{\#reset\-your\-adjust\-api\-token\}

Adjust API 토큰은 언제든지 재설정할 수 있습니다. 토큰을 재설정하면 이전의 토큰은 무효화됩니다. Adjust API 토큰을 재설정한 경우 기존 토큰이 사용되는 모든 곳에서 교체해야 합니다. 무효화된 토큰에 대한 요청은 Adjust에 의해 거부됩니다.

To reset your Adjust API token:

1. Select the account \(user\) icon.
2. **계정 설정** 을 선택합니다.
3. **내 프로필** 탭을 선택합니다.
4. **API 토큰** 은 **사용자 세부 사항** 과 함께 표시됩니다.
5. **API 토큰 재설정** 을 선택합니다.
6. Enter your account password in the modal that appears and select **Reset** to reset your API token. A confirmation appears in the top right of the screen.
7. 시스템 클립보드에 **API 토큰** 을 복사하기 위해 복사를 선택합니다.

Parameters \{\#parameters\}
------------------------------

| 파라미터 | 데이터 유형 | In | 설명 |
|--------------------------|--------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `adjust_auth_token` | `String` | 헤더 | Adjust API token |
| `link_token` | `String` | Body | 커스텀 링크의 링크 토큰. 결합된 링크에서 딥링크를 생성하는 경우, Campaign Lab에서 결합된 커스텀 링크로부터의 올바른 링크 토큰을 사용해야 합니다. |
| `shorten_url` | `Boolean` | Body | Whether the link will be shortened. The link isn't shortened by default. Default value \- false |
| `campaign` | `String` 또는 `null` | Body | 캠페인의 이름 |
| `adgroup` | `String` 또는 `null` | Body | The name of the adgroup |
| `creative` | `String` 또는 `null` | Body | The name of the creative |
| `deep_link_path` | `String` | Body | Specifies the in\-app destination your users are taken to. Use this for single\-platform apps. |
| `ios_deep_link_path` | `String` | Body | Specifies the iOS in\-app destination your users are taken to. Use this for multi\-platform iOS apps or combined links. |
| `android_deep_link_path` | `String` | Body | Specifies the Android in\-app destination your users are taken to. Use this for multi\-platform Android apps or combined links. |
| `fallback` | `String` | Body | Landing page where you send off\-platform users. When you specify the fallback URL, it's recommended to specify `redirect_macos` for macOS users. |
| `redirect_macos` | `String` | Body | Redirect URL to override Adjust's default redirect for macOS. When you specify the `fallback`, it's recommended to specify this parameter for macOS users. |
| `label` | `String` | Body | Adds custom data to the link. Use this parameter to add a unique [user referral ID](https://help.adjust.com/en/article/set-up-user-referrals) that's autopopulated when a user shares a short link from your app. |
| `og_title` | `String` | Body | Title of the social sharing preview of the link. |
| `og_description` | `String` | Body | Description of the social sharing preview of the link. |
| `og_image` | `String` | Body | URL to a JPG or PNG image of at least 200 x 200 pixels size for the social sharing preview of the link. |

단일 딥링크 \{\#generate\-a\-single\-deep\-link\} 생성
------------------------------------------------------

`POST` 요청을 전송하여 단일 또는 멀티 플랫폼 앱에 대해 긴/단축 딥링크를 생성합니다.

### Endpoint \{\#endpoint\-single\}

```http
https://automate.adjust.com/engage/deep-links
```

### 예 \{\#examples\-single\}

**단일 플랫폼 앱**
<codeblock title="Request - cURL">

```bash
curl --location 'https://automate.adjust.com/engage/deep-links' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer adjustApiToken' \
--data '{
"link_token": "1c52mluz",
"redirect": "https://example.com/redirect",
"fallback": "https://example.com/fallback",
"deep_link_path": "/custom-path",
"shorten_url": true
}'
```

</CodeBlock> <codeblock title="응답">

```http
{"url": "https://insights.go.link/fryYl"}
```

</CodeBlock>

**멀티 플랫폼 앱**
<codeblock title="Request - cURL">

```bash
curl --location 'https://automate.adjust.com/engage/deep-links' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer adjustApiToken' \
--data '{
"link_token": "2d41nkvy",
"redirect": "https://example.com/redirect",
"fallback": "https://example.com/fallback",
"android_deep_link_path": "/custom-path",
"redirect_macos": "https://www.example.com/redirectmacos",
"shorten_url": true
}'
```

</CodeBlock> <codeblock title="응답">

```url
{"url": "https://insights.go.link/jlbKj"}
```

</CodeBlock>

**복합 링크**

Ensure that you [create a combined custom link in Campaign Lab](https://help.adjust.com/en/article/custom-link-setup) before you generate a deep link using the Deep link generator API.
<codeblock title="Request - cURL">

```bash
curl --location 'https://automate.adjust.com/engage/deep-links' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer adjustApiToken' \
--data '{
"link_token": "1c2n7ybx_1cjet4nl",
"redirect": "https://example.com/redirect",
"fallback": "https://example.com/fallback",
"ios_deep_link_path": "/custom-path-ios",
"android_deep_link_path": "/custom-path-android",
"redirect_macos": "https://www.example.com/redirectmacos",
"shorten_url": true
}'
```

</CodeBlock> <codeblock title="응답">

```http
{"url": "https://insights.go.link/6JtQx"}
```

</CodeBlock>

Generate deep links in bulk \{\#generate\-deep\-links\-in\-bulk\}
------------------------------------------------------------------------

`POST` 요청을 전송하여 단일 또는 멀티 플랫폼 앱에 대해 긴/단축 딥링크를 일괄 생성합니다.

### Endpoint \{\#endpoint\-bulk\}

```http
https://automate.adjust.com/engage/deep-links/bulk
```

### Example \{\#example\-bulk\}

<codeblock title="Request - cURL">

```bash
curl --location 'https://automate.adjust.com/engage/deep-links/bulk' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer adjustApiToken' \
--data '{
"data": [
{
"link_token": "1doptv0c",
"redirect": "https://example.com/redirect",
"fallback": "https://example.com/fallback",
"campaign": "custom-campaign",
"shorten_url": true
},
{
"link_token": "1df3xslh_1dsykkaa",
"redirect": "https://example.com/redirect",
"fallback": "https://example.com/fallback",
"ios_deep_link_path": "/custom-path-ios",
"android_deep_link_path": "/custom-path-android",
"shorten_url": true
},
{
"link_token": "1dzwtdjt",
"redirect": "https://example.com/redirect",
"fallback": "https://example.com/fallback",
"android_deep_link_path": "/custom-path",
"shorten_url": true
}
]
}'
```

</CodeBlock> <codeblock title="응답">

```json
{
"data": [
{
"url": "https://kapp.go.link/4IlkC"
},
{
"url": "https://kapp.go.link/6KnoE"
},
{
"url": "https://insights.go.link/5JmnD"
}
]
}
```

</CodeBlock>

단축 링크 토큰 업데이트 \{\#update\-short\-link\-token\}
----------------------------------------------------

`PUT` 요청을 전송하여 딥링크의 기존 단축 링크 토큰을 긴 링크로 업데이트합니다.

### Endpoint \{\#endpoint\-update\}

```http
https://automate.adjust.com/engage/deep-links/{short_token}
```

### Example \{\#example\-update\}

<codeblock title="Request - cURL">

```bash
curl --location --request PUT 'https://automate.adjust.com/engage/deep-links/4IlkC' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer adjustApiToken' \
--data '{
"link_token": "1doptv0c",
"redirect": "https://example.com/new-redirect",
"fallback": "https://example.com/new-fallback",
"deep_link_path": "/new-custom-path"
}'
```

</CodeBlock> <codeblock title="응답">

```http
204 No Content
```

</CodeBlock>

Loading