From 5090f0346b47749769838211dbf11b8a6b63edb0 Mon Sep 17 00:00:00 2001 From: adjust-pc-team <153073226+adjust-pc-team@users.noreply.github.com> Date: Fri, 18 Oct 2024 10:37:20 +0200 Subject: [PATCH 1/4] File src/content/docs/en/api/deep-link-generator-api.mdx was updated on ko-KR locale --- .../docs/ko/api/deep-link-generator-apimdx | 282 ++++++++++++++++++ 1 file changed, 282 insertions(+) create mode 100644 src/content/docs/ko/api/deep-link-generator-apimdx diff --git a/src/content/docs/ko/api/deep-link-generator-apimdx b/src/content/docs/ko/api/deep-link-generator-apimdx new file mode 100644 index 000000000..29d18d8d8 --- /dev/null +++ b/src/content/docs/ko/api/deep-link-generator-apimdx @@ -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\} + + + +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. + + +* 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 담당자에게 연락하거나 [support@adjust.com](mailto:support@adjust.com) 으로 이메일을 보내 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\} + +**단일 플랫폼 앱** + + +```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 + }' +``` + + + +```http +{"url": "https://insights.go.link/fryYl"} +``` + + + +**멀티 플랫폼 앱** + + +```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 + }' +``` + + + +```url +{"url": "https://insights.go.link/jlbKj"} +``` + + + +**복합 링크** + +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. + + +```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 + }' +``` + + + +```http +{"url": "https://insights.go.link/6JtQx"} +``` + + + +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\} + + + +```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 + } + ] +}' +``` + + + +```json +{ + "data": [ + { + "url": "https://kapp.go.link/4IlkC" + }, + { + "url": "https://kapp.go.link/6KnoE" + }, + { + "url": "https://insights.go.link/5JmnD" + } + ] +} +``` + + + +단축 링크 토큰 업데이트 \{\#update\-short\-link\-token\} +---------------------------------------------------- + +`PUT` 요청을 전송하여 딥링크의 기존 단축 링크 토큰을 긴 링크로 업데이트합니다. + +### Endpoint \{\#endpoint\-update\} + +```http +https://automate.adjust.com/engage/deep-links/{short_token} +``` + +### Example \{\#example\-update\} + + + +```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" +}' +``` + + + +```http +204 No Content +``` + + + From aa8df49caec453ac87bcf515fd02e30276580e88 Mon Sep 17 00:00:00 2001 From: adjust-pc-team <153073226+adjust-pc-team@users.noreply.github.com> Date: Fri, 18 Oct 2024 10:37:22 +0200 Subject: [PATCH 2/4] File src/content/docs/en/api/deep-link-generator-api.mdx was updated on zh-CN locale --- .../docs/zh/api/deep-link-generator-apimdx | 282 ++++++++++++++++++ 1 file changed, 282 insertions(+) create mode 100644 src/content/docs/zh/api/deep-link-generator-apimdx diff --git a/src/content/docs/zh/api/deep-link-generator-apimdx b/src/content/docs/zh/api/deep-link-generator-apimdx new file mode 100644 index 000000000..06bcf44a1 --- /dev/null +++ b/src/content/docs/zh/api/deep-link-generator-apimdx @@ -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\} + + + +深度链接生成器 API 的速率限制为每秒 200 个请求。如果超过此限制，您将收到 429 报错。 + + +* 您需要使用 TrueLink Core 或 Enterprise 套餐才能使用深度链接生成器 API。 +* 使用深度链接生成器 API 创建的链接不会出现在 [Campaign Lab](https://help.adjust.com/en/article/campaign-setup)中。 +* 使用深度链接生成器 API 创建的短链接的 TTL \(生存时间\) 为 120 天。 + +### 要求\{\#requirements\} + +* 管理员、编辑员或自定义编辑员[权限](https://help.adjust.com/en/article/permission-levels)。 +* 为您的 iOS 和安卓应用[设置相同的品牌化域名](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 App Link \(安卓应用链接\)](https://help.adjust.com/en/article/set-up-android-app-links)。 + +* 应用的自定义链接。 + * 单一平台应用、多平台应用 \- [在 Campaign Lab 中创建自定义链接](https://help.adjust.com/en/article/custom-link-setup)，获得单个链接识别码。 + * 多个单一平台应用 \-[在 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)。 + +* 更新 Adjust SDK 来解析短链接。 + * [iOS](/en/sdk/ios/features/short-links) \|[安卓](/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 和安卓应用使用同一地区。 + +认证\{\#authentication\} +------------------------- + +深度链接生成器 API 使用 [Bearer 识别码](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication)进行认证。您必须在向深度链接生成器 API 发出的每个请求的 `Authorization` 标头中包含您的 Adjust API 识别码。 + +如果您的组织启用了单点登录 \(SSO\)，请联系您的 Adjust 代表，或发送电子邮件至 [support@adjust.com](mailto:support@adjust.com)，我们将帮您查找 API 识别码。 + +非单点登录账户的 API 识别码位于用户 **个人档案** 中。要找到该识别码，请按照下列步骤操作。 + +1. 选择账户 \(用户\) 图标。 +2. 选择 **账户设置** 。 +3. 选择 **个人档案** 标签页。 +4. 您的 **API 识别码** 会显示在 **用户详细信息** 中。选择复制按钮来将识别码复制到您的系统剪贴板。 + +### 重置 Adjust API 识别码\{\#reset\-your\-adjust\-api\-token\} + +您可以随时重置 Adjust API 识别码。重置后，旧的识别码将失效。如果您重置了 Adjust API 识别码，请务必在所有使用识别码的位置进行替换。使用无效识别码发送的请求会被 Adjust 拒绝。 + +重置 Adjust API 识别码： + +1. 选择账户 \(用户\) 图标。 +2. 选择 **账户设置** 。 +3. 选择 **个人档案** 标签页。 +4. 您的 **API 识别码** 会显示在 **用户详情** 中。 +5. 选择 **重置 API 识别码** 。 +6. 在窗口中输入账户密码并选择 **重置** 来重置您的 API 识别码。屏幕右上角会显示确认信息。 +7. 选择 **API 识别码** 旁的复制按钮来将识别码复制到您的系统剪贴板。 + +参数\{\#parameters\} +--------------------- + +| 参数 | 数据类型 | 位置 | 描述 | +|--------------------------|-------------------|---------------|---------------------------------------------------------------------------------------------------------------------| +| `adjust_auth_token` | `String` | 标头 | Adjust API 识别码 | +| `link_token` | `String` | 正文 \(Body\) | 自定义链接的链接识别码。如果您是从复合链接生成深度链接，请务必在 Campaign Lab 中使用复合自定义链接的正确链接识别码。 | +| `shorten_url` | `Boolean` | 正文 \(Body\) | 链接是否会被缩短。默认情况下链接不会被缩短。默认值 \- false | +| `campaign` | `String` 或 `null` | 正文 \(Body\) | 推广活动名称 | +| `adgroup` | `String` 或 `null` | 正文 \(Body\) | 广告组名称 | +| `creative` | `String` 或 `null` | 正文 \(Body\) | 素材名称 | +| `deep_link_path` | `String` | 正文 \(Body\) | 指定用户被转至的应用内位置。适用于单一平台应用。 | +| `ios_deep_link_path` | `String` | 正文 \(Body\) | 指定用户被转至的 iOS 应用内位置。适用于多平台 iOS 应用或复合链接。 | +| `android_deep_link_path` | `String` | 正文 \(Body\) | 指定用户被转至的安卓应用内位置。适用于多平台安卓应用或复合链接。 | +| `fallback` | `String` | 正文 \(Body\) | 非默认平台用户被转到的登陆页。在指定后备 URL 时，我们建议为 macOS 用户指定 `redirect_macos`。 | +| `redirect_macos` | `String` | 正文 \(Body\) | 重定向 URL，用于覆盖 Adjust 针对 macOS 的默认重定向。在指定 `fallback` 时，我们建议为 macOS 用户指定该参数。 | +| `label` | `String` | 正文 \(Body\) | 向链接附加自定义数据。使用该参数，添加唯一的[用户推荐 ID](https://help.adjust.com/en/article/set-up-user-referrals)。用户分享来自应用的短链接时，该 ID 会自动填充。 | +| `og_title` | `String` | 正文 \(Body\) | 链接在社交媒体上分享的预览标题。 | +| `og_description` | `String` | 正文 \(Body\) | 链接社交平台分享预览的描述。 | +| `og_image` | `String` | 正文 \(Body\) | JPG 或 PNG 图片的 URL，大小至少为 200 x 200 像素，用于链接的社交分享预览。 | + +生成单个深度链接\{\#generate\-a\-single\-deep\-link\} +---------------------------------------------------- + +发送 `POST` 请求，为单一或多平台应用生成长或短深度链接。 + +### 终端\{\#endpoint\-single\} + +```http +https://automate.adjust.com/engage/deep-links +``` + +### 示例 \{\#examples\-single\} + +**单一平台应用** + + +```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 + }' +``` + + + +```http +{"url": "https://insights.go.link/fryYl"} +``` + + + +**多平台应用** + + +```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 + }' +``` + + + +```url +{"url": "https://insights.go.link/jlbKj"} +``` + + + +**复合链接** + +在使用深度链接生成器 API 生成深度链接之前，请务必[在 Campaign Lab 中创建复合自定义链接](https://help.adjust.com/en/article/custom-link-setup)。 + + +```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 + }' +``` + + + +```http +{"url": "https://insights.go.link/6JtQx"} +``` + + + +批量生成深度链接\{\#generate\-deep\-links\-in\-bulk\} +---------------------------------------------------- + +发送`POST` 请求，为单一或多平台应用批量生成长或短深度链接。 + +### 终端\{\#endpoint\-bulk\} + +```http +https://automate.adjust.com/engage/deep-links/bulk +``` + +### 示例 \{\#example\-bulk\} + + + +```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 + } + ] +}' +``` + + + +```json +{ + "data": [ + { + "url": "https://kapp.go.link/4IlkC" + }, + { + "url": "https://kapp.go.link/6KnoE" + }, + { + "url": "https://insights.go.link/5JmnD" + } + ] +} +``` + + + +更新短链接识别码\{\#update\-short\-link\-token\} +---------------------------------------------- + +发送 `PUT` 请求，将深度链接中的现有短链接识别码更新为长链接识别码。 + +### 终端\{\#endpoint\-update\} + +```http +https://automate.adjust.com/engage/deep-links/{short_token} +``` + +### 示例 \{\#example\-update\} + + + +```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" +}' +``` + + + +```http +204 No Content +``` + + + From 0624eb421f7eacaaa23eef4ca5aa31c06dbcc299 Mon Sep 17 00:00:00 2001 From: adjust-pc-team <153073226+adjust-pc-team@users.noreply.github.com> Date: Fri, 18 Oct 2024 10:37:24 +0200 Subject: [PATCH 3/4] File src/content/docs/en/api/deep-link-generator-api.mdx was updated on ja-JP locale --- .../docs/ja/api/deep-link-generator-apimdx | 282 ++++++++++++++++++ 1 file changed, 282 insertions(+) create mode 100644 src/content/docs/ja/api/deep-link-generator-apimdx diff --git a/src/content/docs/ja/api/deep-link-generator-apimdx b/src/content/docs/ja/api/deep-link-generator-apimdx new file mode 100644 index 000000000..59b2c76d3 --- /dev/null +++ b/src/content/docs/ja/api/deep-link-generator-apimdx @@ -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\} + + + +ディープリンクジェネレーターAPIには、1秒あたり200リクエストのレート制限があります。この制限を超えると、429エラーが発生します。 + + +* ディープリンクジェネレーターAPIは、TrueLinkのCoreまたはEnterpriseのパッケージにご契約のお客様にご利用いただけます。 +* ディープリンクジェネレーターAPIを使用して作成されたリンクは、 [Campaign Lab](https://help.adjust.com/en/article/campaign-setup)に表示されません。 +* ディープリンクジェネレーターAPIを使用して作成されたショートリンクのTTL（有効期間）は120日です。 + +### 要件 \{\#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 アプリリンク（Android App Link）](https://help.adjust.com/en/article/set-up-android-app-links)として定義するようにしてください。 + +* アプリのカスタムリンク。 + * シングルプラットフォームアプリ、マルチプラットフォームアプリ \- [Campaign Labでカスタムリンクを作成して](https://help.adjust.com/en/article/custom-link-setup)、単一のリンクトークンを取得します。 + * 複数のシングルプラットフォームアプリ \- 複数のシングルプラットフォームアプリから[Campaign Labでカスタムリンク](https://help.adjust.com/en/article/custom-link-setup#combined-custom-links)を作成し、「\_」で区切られた複数のリンクトークンを含む、1つの複合カスタムリンクを作成します。詳細については、[複合カスタムリンク向けプラットフォーム固有のリンクトークンを](https://help.adjust.com/en/article/manage-custom-link-setup#link-tokens-combined-custom-link)参照してください。 + +* Adjust SDKを更新して、短縮リンクを解決すること。 + * [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\} +-------------------------- + +ディープリンクジェネレーターは、[ベアラートークン](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication)を使用して認証します。ディープリンクジェネレーターAPIへの各リクエストには、Adjust APIトークンを`Authorization`ヘッダーに必ず含める必要があります。 + +自社でシングルサインオン（SSO）を有効にしている場合は、 Adjustの担当者または[support@adjust.com](mailto:support@adjust.com)にお問い合わせください。APIトークンの取得方法についてサポートいたします。 + +SSO以外のアカウントの場合、APIガイドはユーザーの **プロフィール** に表示されます。トークンを確認するには、以下の手順に従ってください。 + +1. アカウント（ユーザー）アイコンを選択します。 +2. **アカウント設定（Account Settings）** を選択します。 +3. **マイプロフィール（My Profile）** を選択します。 +4. **APIトークン** が **ユーザー情報（User details）** に表示されます。コピーボタンを選択して、トークンをクリップボードにコピーします。 + +### Adjust APIトークンをリセットする \{\#reset\-your\-adjust\-api\-token\} + +Adjust APIトークンはいつでもリセットできます。トークンをリセットすると、古いトークンは無効になります。Adjust APIトークンをリセットした場合、使用中の古いトークンを新しいトークンに置き換える必要があります。無効になったトークンを使用したリクエストは、Adjustによって拒否されます。 + +Adjust APIトークンをリセットする方法： + +1. アカウント（ユーザー）アイコンを選択します。 +2. **アカウント設定（Account Settings）** を選択します。 +3. **マイプロフィール（My Profile）** を選択します。 +4. **APIトークン** が **ユーザー情報（User details）** に表示されます。 +5. **APIトークンをリセットする（Reset API token）** を選択します。 +6. 表示されたモーダルにアカウントのパスワードを入力し、 **リセット** を選択してAPIトークンをリセットします。画面の右上に確認メッセージが表示されます。 +7. **APIトークン** の横にあるコピーボタンを選択して、トークンをクリップボードにコピーします。 + +パラメーター \{\#parameters\} +-------------------------- + +| パラメーター | データタイプ | 入力する値 | 説明 | +|--------------------------|---------------------|-------|------------------------------------------------------------------------------------------------------------------------------------------------| +| `adjust_auth_token` | `String` | 説明 | Adjust APIトークン | +| `link_token` | `String` | ボディ | カスタムリンクのリンクトークン。複合リンクからディープリンクを生成している場合、Campaign Labで組み合わせたカスタムリンクの正しいリンクトークンを使用していることを確認してください。 | +| `shorten_url` | `Boolean` | ボディ | リンクが短縮されるかどうか。リンクはデフォルトでは短縮されません。デフォルト値 \- false | +| `campaign` | `String` または `null` | ボディ | キャンペーンの名前 | +| `adgroup` | `String` または `null` | ボディ | アドグループの名前 | +| `creative` | `String` または `null` | ボディ | クリエイティブの名前 | +| `deep_link_path` | `String` | ボディ | ユーザーが遷移するアプリ内の遷移先を指定。シングルプラットフォームアプリにはこれを使用してください。 | +| `ios_deep_link_path` | `String` | ボディ | ユーザーが遷移するiOSのアプリ内の遷移先を指定。マルチプラットフォームのiOSアプリまたは複合リンクにはこれを使用してください。 | +| `android_deep_link_path` | `String` | ボディ | ユーザーが遷移するiOSのアプリ内の遷移先を指定。マルチプラットフォームのiOSアプリまたは複合リンクにはこれを使用してください。 | +| `fallback` | `String` | ボディ | オフプラットフォームのユーザーを送るランディングページ。フォールバックURLを指定する際には、macOSユーザー向けに`redirect_macos`を指定することをお勧めします。 | +| `redirect_macos` | `String` | ボディ | macOSのAdjustのデフォルトリダイレクトを上書きするリダイレクトURL。\`fallback\` を指定する場合は、macOSユーザー向けに`fallback`を指定することをお勧めします。 | +| `label` | `String` | ボディ | リンクにカスタムデータを追加します。このパラメーターを使用して、ユーザーがアプリからショートリンクを共有した際に自動入力される一意の[ユーザー紹介ID](https://help.adjust.com/en/article/set-up-user-referrals)を追加できます。 | +| `og_title` | `String` | ボディ | リンクのソーシャル共有プレビューのタイトル。 | +| `og_description` | `String` | ボディ | リンクのソーシャル共有プレビューの説明。 | +| `og_image` | `String` | ボディ | ソーシャル共有プレビューに使用する、200 x 200 ピクセル以上のJPGまたはPNG形式の画像のURLを指定。 | + +単一のディープリンクを生成\{\#generate\-a\-single\-deep\-link\} +--------------------------------------------------------- + +シングルまたはマルチプラットフォームのアプリ用に、長いまたは短縮ディープリンクを生成するには、`POST`リクエストを送信します。 + +### エンドポイント \{\#endpoint\-single\} + +```http +https://automate.adjust.com/engage/deep-links +``` + +### 例 \{\#examples\-single\} + +**シングルプラットフォームアプリ** + + +```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 + }' +``` + + + +```http +{"url": "https://insights.go.link/fryYl"} +``` + + + +**マルチプラットフォームアプリ** + + +```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 + }' +``` + + + +```url +{"url": "https://insights.go.link/jlbKj"} +``` + + + +**複合リンク** + +ディープリンクジェネレーターAPIを使用してディープリンクを生成する前に、[Campaign Labで複合カスタムリンクを作成](https://help.adjust.com/en/article/custom-link-setup)してください。 + + +```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 + }' +``` + + + +```http +{"url": "https://insights.go.link/6JtQx"} +``` + + + +ディープリンクを一括で生成\{\#generate\-deep\-links\-in\-bulk\} +--------------------------------------------------------- + +シングルまたはマルチプラットフォームのアプリ用に、長いまたは短縮ディープリンクを一括で生成するには、`POST`リクエストを送信します。 + +### エンドポイント \{\#endpoint\-bulk\} + +```http +https://automate.adjust.com/engage/deep-links/bulk +``` + +### 例 \{\#example\-bulk\} + + + +```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 + } + ] +}' +``` + + + +```json +{ + "data": [ + { + "url": "https://kapp.go.link/4IlkC" + }, + { + "url": "https://kapp.go.link/6KnoE" + }, + { + "url": "https://insights.go.link/5JmnD" + } + ] +} +``` + + + +ショートリンクトークンを更新\{\#update\-short\-link\-token\} +---------------------------------------------------- + +`PUT`リクエストを送信して、ディープリンク内の既存のショートリンクトークンを長いリンクに更新します。 + +### エンドポイント \{\#endpoint\-update\} + +```http +https://automate.adjust.com/engage/deep-links/{short_token} +``` + +### 例 \{\#example\-update\} + + + +```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" +}' +``` + + + +```http +204 No Content +``` + + + From 27c946cae2f399d8bcc6b387d9d6c0756b557b0e Mon Sep 17 00:00:00 2001 From: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 18 Oct 2024 08:38:06 +0000 Subject: [PATCH 4/4] Fix translated files --- .../docs/zh/sdk/cocos2dx/v5/configuration.mdoc | 8 ++++++++ .../docs/zh/sdk/cocos2dx/v5/features/ad-revenue.mdoc | 11 +++++++++++ .../docs/zh/sdk/cocos2dx/v5/features/att.mdoc | 1 + .../zh/sdk/cocos2dx/v5/features/attribution.mdoc | 1 + .../docs/zh/sdk/cocos2dx/v5/features/deep-links.mdoc | 1 + .../docs/zh/sdk/cocos2dx/v5/features/events.mdoc | 7 +++++++ .../sdk/cocos2dx/v5/features/global-parameters.mdoc | 2 ++ .../docs/zh/sdk/cocos2dx/v5/features/privacy.mdoc | 12 ++++++++++++ .../cocos2dx/v5/features/purchase-verification.mdoc | 10 ++++++++++ .../zh/sdk/cocos2dx/v5/features/short-links.mdoc | 2 ++ .../docs/zh/sdk/cocos2dx/v5/features/skan.mdoc | 1 + .../zh/sdk/cocos2dx/v5/features/subscriptions.mdoc | 6 ++++++ src/content/docs/zh/sdk/cocos2dx/v5/index.mdoc | 2 ++ .../docs/zh/sdk/migration/cocos2dx/v4-to-v5.mdoc | 1 + 14 files changed, 65 insertions(+) diff --git a/src/content/docs/zh/sdk/cocos2dx/v5/configuration.mdoc b/src/content/docs/zh/sdk/cocos2dx/v5/configuration.mdoc index 5fe15b69b..1da82879a 100644 --- a/src/content/docs/zh/sdk/cocos2dx/v5/configuration.mdoc +++ b/src/content/docs/zh/sdk/cocos2dx/v5/configuration.mdoc @@ -35,6 +35,7 @@ redirects: - 传递 `AdjustEnvironmentProduction2dx`，可在生产模式下运行 SDK，方便发布。 + {% /deflist %} 您也可以发送下列可选参数： @@ -44,6 +45,7 @@ redirects: : 是否禁用所有日志记录。设为 `true` 可禁用日志记录；设为 `false` 可启用日志记录。 + {% /deflist %} ```cpp @@ -81,6 +83,7 @@ Adjust2dx::initSdk(adjustConfig); : 要使用的日志级别。 + {% /deflist %} ```cpp @@ -97,6 +100,7 @@ Adjust2dx::initSdk(adjustConfig); {% callout type="seealso" %} 要了解更多信息，请参考 Adjust 帮助中心的[外部设备标识符文档](https://help.adjust.com/zh/article/external-device-identifiers)。 + {% /callout %} 外部设备标识符是您为设备或用户自定义的一个值。您可以通过这个值在不同的会话和平台中识别用户。您也可以通过该值基于用户对安装进行去重，这样同一位用户就不会被记录为多次新安装了。请联系您的 Adjust 代表来开始使用外部设备 ID。 @@ -108,6 +112,7 @@ Adjust2dx::initSdk(adjustConfig); : 您的外部设备标识符。需要 **区分大小写** 。如果您导入了外部设备 ID，则需要确保发送的值与已导入的值相匹配。 + {% /deflist %} ```cpp @@ -129,6 +134,7 @@ Adjust2dx::initSdk(adjustConfig); : 用于记录预安装应用安装的 [Adjust 链接识别码](https://help.adjust.com/zh/article/links#adjust-link-token)。 + {% /deflist %} ```cpp @@ -168,6 +174,7 @@ Adjust2dx::initSdk(adjustConfig); {% callout type="important" %} 离线模式设置在会话之间不被保存。离线模式在每次新会话开始时会被关闭。 + {% /callout %} Adjust SDK 会实时向 Adjust 后端发送事件和会话数据。您可以通过将 SDK 设为离线状态来暂停信息的发送。在离线状态中，SDK 会在设备本地文件中存储所有数据。离线模式关闭后，SDK 会将此信息发送至 Adjust 服务器。 @@ -197,6 +204,7 @@ Adjust2dx::switchBackToOnlineMode(); : 您的推送标签。 + {% /deflist %} ```cpp diff --git a/src/content/docs/zh/sdk/cocos2dx/v5/features/ad-revenue.mdoc b/src/content/docs/zh/sdk/cocos2dx/v5/features/ad-revenue.mdoc index ce4a5da49..91fe4cbd6 100644 --- a/src/content/docs/zh/sdk/cocos2dx/v5/features/ad-revenue.mdoc +++ b/src/content/docs/zh/sdk/cocos2dx/v5/features/ad-revenue.mdoc @@ -16,6 +16,7 @@ redirects: 要监测收入，您需要在 Adjust 控制面板中进行一些额外设置步骤。请联系您的技术客户经理或发送邮件至 [support@adjust.com](mailto:support@adjust.com)来开始设置。 + {% /callout %} 您可以使用 Adjust SDK 向 Adjust 发送来自[受支持渠道合作伙伴](https://help.adjust.com/zh/article/ad-revenue)的广告收入信息。 @@ -32,6 +33,7 @@ redirects: : 广告收入来源。请查看下表，了解所以可用来源。 + {% /deflist %} | 参数 | 来源 | @@ -59,6 +61,7 @@ redirects: : 广告收入的币种。 您必须将其格式设置为 3 个字符的[ISO 4217 代码](https://www.iban.com/currency-codes) + {% /deflist %} ```cpp @@ -85,6 +88,7 @@ Adjust2dx::trackAdRevenue(adjustAdRevenue); : 广告展示数量。 + {% /deflist %} ```cpp @@ -103,6 +107,7 @@ Adjust2dx::trackAdRevenue(adjustAdRevenue); : 与广告收入关联的渠道名称。 + {% /deflist %} ```cpp @@ -121,6 +126,7 @@ Adjust2dx::trackAdRevenue(adjustAdRevenue); : 与广告收入关联的广告单元名称。 + {% /deflist %} ```cpp @@ -139,6 +145,7 @@ Adjust2dx::trackAdRevenue(adjustAdRevenue); : 广告单元位置。 + {% /deflist %} ```cpp @@ -164,12 +171,14 @@ https://www.mydomain.com/callback?key=value&foo=bar ``` + {% /codeblock %} {% callout type="note" %} Adjust 不会存储您的自定义回传参数。自定义回传参数只会附加在您的回传 URL 中。 + {% /callout %} 如果您使用的是 CSV 上传，请务必在 CSV 定义中添加参数。 @@ -180,6 +189,7 @@ Adjust 支持许多占位符，这些占位符可用来将信息从 SDK 发送 若想进一步了解 URL 回传，查看可用参数的完整列表，请参阅[回传指南](https://help.adjust.com/zh/article/callbacks)。 + {% /callout %} ```cpp @@ -199,6 +209,7 @@ Adjust 可向您设置的[外部合作伙伴](https://help.adjust.com/zh/article 合作伙伴参数不会默认出现在原始数据中。您可以添加`{partner_parameters}`占位符，通过单个字符串中接收参数。 + {% /callout %} 使用 `std::string` 键值对 argument 调用`addPartnerParameter`方法，以此向事件添加合作伙伴参数。多次调用该方法可添加多个参数。 diff --git a/src/content/docs/zh/sdk/cocos2dx/v5/features/att.mdoc b/src/content/docs/zh/sdk/cocos2dx/v5/features/att.mdoc index dc4263ce5..2ef584e71 100644 --- a/src/content/docs/zh/sdk/cocos2dx/v5/features/att.mdoc +++ b/src/content/docs/zh/sdk/cocos2dx/v5/features/att.mdoc @@ -37,6 +37,7 @@ Adjust SDK 包含 [Apple `requestTrackingAuthorizationWithCompletionHandler` 方 如果您使用自定义弹窗，Adjust SDK 也会记录授权状态。如果在初始化之前展示弹窗，那么 SDK 会随安装事件一同发送状态。如果在初始化之后展示弹窗，那么 SDK 会在用户更新状态后立即向 Adjust 服务器发送状态。 + {% /callout %} ```cpp diff --git a/src/content/docs/zh/sdk/cocos2dx/v5/features/attribution.mdoc b/src/content/docs/zh/sdk/cocos2dx/v5/features/attribution.mdoc index 03e803a9d..85546e99e 100644 --- a/src/content/docs/zh/sdk/cocos2dx/v5/features/attribution.mdoc +++ b/src/content/docs/zh/sdk/cocos2dx/v5/features/attribution.mdoc @@ -27,6 +27,7 @@ redirects: - `costCurrency` + {% /callout %} | 值 | 数据类型 | 描述 | diff --git a/src/content/docs/zh/sdk/cocos2dx/v5/features/deep-links.mdoc b/src/content/docs/zh/sdk/cocos2dx/v5/features/deep-links.mdoc index b0bee2ca1..89af3c5af 100644 --- a/src/content/docs/zh/sdk/cocos2dx/v5/features/deep-links.mdoc +++ b/src/content/docs/zh/sdk/cocos2dx/v5/features/deep-links.mdoc @@ -64,6 +64,7 @@ Adjust2dx::processDeeplink(adjustDeeplink); 用户第一次打开应用时，Adjust SDK 会检查剪贴板。设备会显示对话框，询问用户是否允许应用读取剪贴板。 + {% /callout %} 当用户点击 LinkMe URL 时，可以选择将链接信息复制到剪贴板。您可以使用 Adjust SDK 读取系统剪贴板，获取深度链接信息。如果含有深度链接信息，SDK 就会将用户转到应用中的正确页面。 diff --git a/src/content/docs/zh/sdk/cocos2dx/v5/features/events.mdoc b/src/content/docs/zh/sdk/cocos2dx/v5/features/events.mdoc index e53a796c6..b5b3501b2 100644 --- a/src/content/docs/zh/sdk/cocos2dx/v5/features/events.mdoc +++ b/src/content/docs/zh/sdk/cocos2dx/v5/features/events.mdoc @@ -36,6 +36,7 @@ redirects: : 您的 Adjust 事件识别码。请参阅[添加事件](https://help.adjust.com/zh/article/add-events#manage-your-events)了解更多信息。 + {% /deflist %} ```cpp @@ -57,6 +58,7 @@ Adjust2dx::trackEvent(adjustEvent); : 事件币种的[ISO 4217 代码](https://www.iban.com/currency-codes)。 + {% /deflist %} ```cpp @@ -79,6 +81,7 @@ Adjust2dx::trackEvent(adjustEvent); : 参数值。 + {% /deflist %} ```cpp @@ -102,6 +105,7 @@ Adjust2dx::trackEvent(adjustEvent); : 参数值。 + {% /deflist %} ```cpp @@ -121,6 +125,7 @@ Adjust2dx::trackEvent(adjustEvent) : 唯一的去重 ID。 + {% /deflist %} ```cpp @@ -139,6 +144,7 @@ Adjust2dx::trackEvent(adjustEvent); : 唯一的回传 ID。 + {% /deflist %} ```cpp @@ -157,6 +163,7 @@ Adjust2dx::trackEvent(adjustEvent); : 您的`AdjustEvent2dx`实例。 + {% /deflist %} ```cpp diff --git a/src/content/docs/zh/sdk/cocos2dx/v5/features/global-parameters.mdoc b/src/content/docs/zh/sdk/cocos2dx/v5/features/global-parameters.mdoc index 711c4b839..ec0c0ac3a 100644 --- a/src/content/docs/zh/sdk/cocos2dx/v5/features/global-parameters.mdoc +++ b/src/content/docs/zh/sdk/cocos2dx/v5/features/global-parameters.mdoc @@ -20,6 +20,7 @@ redirects: Adjust SDK 会合并会话回传参数和事件回传参数。事件回传参数优先级高于会话回传参数。这意味着，如果将一个参数键同时添加到事件和会话，那么 SDK 会发送事件参数。 + {% /callout %} 您可以设置发送到服务器的统一回传参数。Adjust SDK 会将所有统一回传参数附加到您的回传 URL 中。您可以利用该信息，通过自己的 BI 系统分析用户应用内行为。 @@ -58,6 +59,7 @@ Adjust 可向您设置的[外部合作伙伴](https://help.adjust.com/zh/article 合作伙伴参数不会默认出现在原始数据导出中。您可以添加`{partner_parameters}`占位符，在同一个字符串中接收参数。 + {% /callout %} ### 添加统一合作伙伴参数{% #add-global-partner-parameters %} diff --git a/src/content/docs/zh/sdk/cocos2dx/v5/features/privacy.mdoc b/src/content/docs/zh/sdk/cocos2dx/v5/features/privacy.mdoc index 5933a8806..84cbfda96 100644 --- a/src/content/docs/zh/sdk/cocos2dx/v5/features/privacy.mdoc +++ b/src/content/docs/zh/sdk/cocos2dx/v5/features/privacy.mdoc @@ -44,6 +44,7 @@ Adjust2dx::gdprForgetMe(); {% callout type="important" %} 请在帮助中心查看[COPPA 合规](https://help.adjust.com/zh/article/coppa-compliance)一文，了解您的应用是否需要符合 COPPA 规定。 + {% /callout %} 如果您的应用属于需要遵守《儿童在线隐私保护法》(COPPA) 的类别，则必须在`AdjustConfig2dx`实例上调用`enableCoppaCompliance`方法。调用该方法会进行下列操作： @@ -86,6 +87,7 @@ Adjust2dx::initSdk(adjustConfig); - 传递`false`以禁用第三方分享。 + {% /deflist %} ```cpp @@ -104,6 +106,7 @@ Adjust2dx::trackThirdPartySharing(adjustThirdPartySharing); {% callout type="important" %} 对于 SAN 合作伙伴，您可以将合作伙伴的名称作为`partnerName`进行传递。对于其他合作伙伴，必须发送合作伙伴 ID。 + {% /callout %} 如果您只想与特定合作伙伴分享指标，或需要设置与特定合作伙伴分享的指标，则必须按照下列步骤操作： @@ -128,6 +131,7 @@ Adjust2dx::trackThirdPartySharing(adjustThirdPartySharing); - 传递`true`可恢复分享指标。 + {% /deflist %} 要与某个合作伙伴分享特定指标，则必须： @@ -175,6 +179,7 @@ Adjust2dx::trackThirdPartySharing(adjustThirdPartySharing); - `uninstall` + {% /listcolumns %} #### 示例 @@ -224,6 +229,7 @@ Adjust2dx::trackThirdPartySharing(adjustThirdPartySharing); : 精细信息的值。 + {% /deflist %} ```cpp @@ -237,6 +243,7 @@ Adjust2dx::trackThirdPartySharing(adjustThirdPartySharing); {% callout type="important" %} 应用一经安装，Adjust SDK 就会向 Facebook 发送信息。您需要确保在初始化 SDK **前** 调用该方法。 + {% /callout %} 为遵守《加州消费者隐私法案》(CCPA) 的规定，Facebook 提供了 "限制数据使用" (LDU) 功能。借助该功能，在有位于美国加利福尼亚州的用户选择拒绝数据出售时，您就能向 Facebook 发送通知。如果您希望将所有用户的默认许可状态设为拒绝，也可以使用该功能。 @@ -263,11 +270,13 @@ Adjust2dx::trackThirdPartySharing(adjustThirdPartySharing); - `1002`: 康涅狄格州。 + {% /deflist %} {% callout type="note" %} 如果在调用该方法时，`data_processing_options_country` **或** `data_processing_options_state`中存在 `0`值，那么 Adjust 就会将 **两个字段** 都返回为 `0`。 + {% /callout %} ```cpp @@ -301,6 +310,7 @@ Adjust2dx::trackThirdPartySharing(adjustThirdPartySharing); : 告知 Adjust 用户是否允许其广告主 ID 被用于归因相关目的。 + {% /deflist %} ```cpp @@ -345,6 +355,7 @@ Adjust2dx::trackThirdPartySharing(adjustThirdPartySharing); : 域名是否用于数据驻留。 + {% /deflist %} 请查看下方策略列表。 @@ -376,6 +387,7 @@ Adjust2dx::initSdk(adjustConfig); : 许可监测是 (`true`) 否 (`false`) 启用。 + {% /deflist %} 开启后，SDK 会将数据隐私设置发送至 Adjust 服务器。Adjust 服务器随后会将您的数据隐私规则应用于用户，而 Adjust SDK 将会继续如常运行。 diff --git a/src/content/docs/zh/sdk/cocos2dx/v5/features/purchase-verification.mdoc b/src/content/docs/zh/sdk/cocos2dx/v5/features/purchase-verification.mdoc index 67c6a0d9d..7bdd7d99f 100644 --- a/src/content/docs/zh/sdk/cocos2dx/v5/features/purchase-verification.mdoc +++ b/src/content/docs/zh/sdk/cocos2dx/v5/features/purchase-verification.mdoc @@ -21,6 +21,7 @@ redirects: 如果您在 Adjust 中使用收入事件来监测购买，则应使用`AdjustEvent2dx`类。如果您只想验证购买但不想将其与事件关联，请使用`AdjustAppStorePurchase2dx`或`AdjustPlayStorePurchase2dx`类。 + {% /callout %} 当您使用 Adjust SDK 发送购买信息时，Adjust 会进行下列操作： @@ -44,6 +45,7 @@ redirects: : 商店返回的任何消息。 + {% /deflist %} ## 验证购买和记录事件{% #verify-purchase-and-record-event %} @@ -64,6 +66,7 @@ redirects: : 要验证的交易 ID。 + {% /deflist %} 1. 请使用下列参数调用 `Adjust2dx::verifyAndTrackPlayStorePurchase` 方法： @@ -78,6 +81,7 @@ redirects: : 接收`AdjustPurchaseVerificationResult2dx`对象作为参数的委托回传函数。 + {% /deflist %} 在此示例中，收入验证响应被输出至日志后台进程。 @@ -108,6 +112,7 @@ Adjust2dx::verifyAndTrackPlayStorePurchase(adjustEvent, [](AdjustPurchaseVerific : 与购买关联的购买识别码。 + {% /deflist %} 1. 请使用下列参数调用 `Adjust::verifyAndTrackPlayStorePurchase` 方法： @@ -122,6 +127,7 @@ Adjust2dx::verifyAndTrackPlayStorePurchase(adjustEvent, [](AdjustPurchaseVerific : 接收`AdjustPurchaseVerificationResult2dx`对象作为参数的委托回传函数。 + {% /deflist %} 在此示例中，收入验证响应被输出至日志后台进程。 @@ -156,6 +162,7 @@ Adjust2dx::verifyAndTrackPlayStorePurchase(adjustEvent, [](AdjustPurchaseVerific : 要验证的交易 ID。 + {% /deflist %} 1. 请使用下列参数调用 `Adjust2dx::verifyAppStorePurchase` 方法： @@ -170,6 +177,7 @@ Adjust2dx::verifyAndTrackPlayStorePurchase(adjustEvent, [](AdjustPurchaseVerific : 接收`AdjustPurchaseVerificationResult2dx`对象作为参数的委托回传函数。 + {% /deflist %} 在此示例中，收入验证响应被输出至日志后台进程。 @@ -197,6 +205,7 @@ Adjust2dx::verifyAppStorePurchase(purchase, [](AdjustPurchaseVerificationResult2 : 与购买关联的购买识别码。 + {% /deflist %} 1. 请使用下列参数调用 `Adjust2dx::verifyPlayStorePurchase` 方法： @@ -211,6 +220,7 @@ Adjust2dx::verifyAppStorePurchase(purchase, [](AdjustPurchaseVerificationResult2 : 接收`AdjustPurchaseVerificationResult2dx`对象作为参数的委托回传函数。 + {% /deflist %} 在此示例中，收入验证响应被输出至日志后台进程。 diff --git a/src/content/docs/zh/sdk/cocos2dx/v5/features/short-links.mdoc b/src/content/docs/zh/sdk/cocos2dx/v5/features/short-links.mdoc index 4721c6df3..940799ecf 100644 --- a/src/content/docs/zh/sdk/cocos2dx/v5/features/short-links.mdoc +++ b/src/content/docs/zh/sdk/cocos2dx/v5/features/short-links.mdoc @@ -22,6 +22,7 @@ Adjust 的[短链接解决方案](https://help.adjust.com/zh/article/short-brand 您无需设置 LinkMe 或链接解析即可使用 Adjust 链接缩短解决方案。 + {% /callout %} 在 Adjust SDK 中添加对以下内容的支持： @@ -43,6 +44,7 @@ Adjust 的[短链接解决方案](https://help.adjust.com/zh/article/short-brand : 接收已解析深度链接的函数。必须返回`void` 。 + {% /deflist %} ```cpp diff --git a/src/content/docs/zh/sdk/cocos2dx/v5/features/skan.mdoc b/src/content/docs/zh/sdk/cocos2dx/v5/features/skan.mdoc index fce7c225c..7df47a1a2 100644 --- a/src/content/docs/zh/sdk/cocos2dx/v5/features/skan.mdoc +++ b/src/content/docs/zh/sdk/cocos2dx/v5/features/skan.mdoc @@ -56,6 +56,7 @@ Adjust2dx::initSdk(adjustConfig); : 接收 SKAN 以`string`形式返回的任何错误消息的函数。 + {% /deflist %} ```cpp diff --git a/src/content/docs/zh/sdk/cocos2dx/v5/features/subscriptions.mdoc b/src/content/docs/zh/sdk/cocos2dx/v5/features/subscriptions.mdoc index dcc4ce34b..01f58421d 100644 --- a/src/content/docs/zh/sdk/cocos2dx/v5/features/subscriptions.mdoc +++ b/src/content/docs/zh/sdk/cocos2dx/v5/features/subscriptions.mdoc @@ -16,6 +16,7 @@ redirects: 下列步骤仅会在 Adjust SDK 中设置订阅跟踪。要启动该功能，Adjust 需要设置应用相关的具体信息。请发送邮件至[support@adjust.com](mailto:support@adjust.com)或与您的技术客户经理联系进行设置。 + {% /callout %} 您可以用 Adjust SDK 记录 App Store 和 Play 应用商店的订阅，并验证这些订阅是否有效。 @@ -48,6 +49,7 @@ redirects: : 您的交易 ID。 + {% /deflist %} ```cpp @@ -70,6 +72,7 @@ AdjustAppStoreSubscription2dx subscription = AdjustAppStoreSubscription2dx( : 订阅时间戳 + {% /deflist %} ```cpp @@ -91,6 +94,7 @@ subscription.setTransactionDate({% $variables.subscription.appStoreSubscription. : 订阅的国家代码。 + {% /deflist %} ```cpp @@ -215,6 +219,7 @@ Adjust2dx::trackAppStoreSubscription(subscription); : 交易唯一识别码。请参考 [Google 的文档]()，了解更多信息 + {% /deflist %} ```cpp @@ -240,6 +245,7 @@ AdjustPlayStoreSubscription2dx subscription = AdjustPlayStoreSubscription2dx( : 订阅时间戳。 + {% /deflist %} ```cpp diff --git a/src/content/docs/zh/sdk/cocos2dx/v5/index.mdoc b/src/content/docs/zh/sdk/cocos2dx/v5/index.mdoc index f3c085174..ee3097296 100644 --- a/src/content/docs/zh/sdk/cocos2dx/v5/index.mdoc +++ b/src/content/docs/zh/sdk/cocos2dx/v5/index.mdoc @@ -238,6 +238,7 @@ Install Referrer 是一种归因机制，可用来将应用安装归因至来源 : 通过传递`AdjustEnvironmentSandbox2dx`在 sandbox 环境中测试您的应用。 + {% /deflist %} 1. 您也可以通过调整[日志级别](/zh/sdk/cocos2dx/configuration#set-your-logging-level)来调整日志的详细程度。 @@ -248,6 +249,7 @@ Install Referrer 是一种归因机制，可用来将应用安装归因至来源 在进行测试时，应当确保将环境设置为 `AdjustEnvironmentSandbox2dx`。请在向应用商店提交应用前，将此设为 `AdjustEnvironmentProduction2dx`。 + {% /callout %} ```cpp diff --git a/src/content/docs/zh/sdk/migration/cocos2dx/v4-to-v5.mdoc b/src/content/docs/zh/sdk/migration/cocos2dx/v4-to-v5.mdoc index d3af8b3f2..305412b84 100644 --- a/src/content/docs/zh/sdk/migration/cocos2dx/v4-to-v5.mdoc +++ b/src/content/docs/zh/sdk/migration/cocos2dx/v4-to-v5.mdoc @@ -133,6 +133,7 @@ AdjustConfig2dx adjustConfig = AdjustConfig2dx(appToken, environment); ``` + {% /codeblock %} ## 变更 API {% #changed-apis %}