Android Integration Guide

Presents the login form so the player can pick a sign-in channel.

顯示登入表單，讓玩家選擇登入頻道。

显示登录表单，让玩家选择登录渠道。

Input

輸入

输入

No input.

無輸入。

无输入。

Output

輸出

输出

Silently re-authenticates the last-used channel if a session exists, otherwise presents the login form.

若已存在工作階段，會以最近使用的頻道靜默重新驗證。否則顯示登入表單。

若已存在会话，会以最近使用的渠道静默重新验证。否则显示登录表单。

Input

輸入

输入

No input.

無輸入。

无输入。

Output

輸出

输出

Signs in to one channel directly, bypassing the picker.

直接登入單一頻道，略過選擇器。

直接登录单一渠道，跳过选择器。

Input

輸入

输入

Output

輸出

输出

Opens the Guest account recovery screen through the Direct login call, so a player can bring a Guest account back onto this device.

透過 Direct login 呼叫開啟訪客帳號尋回畫面，讓玩家可以把訪客帳號重新取回這台裝置。

通过 Direct login 调用打开访客账号寻回界面，让玩家可以把访客账号重新取回这台设备。

Legacy login platform only. On the VGA login platform the call raises a fatal error carrying This feature is available only in Legacy.

僅在 Legacy 登入平台上提供。在 VGA 登入平台上，這次呼叫會引發帶有 This feature is available only in Legacy. 的致命錯誤。

仅在 Legacy 登录平台上提供。在 VGA 登录平台上，这次调用会引发带有 This feature is available only in Legacy. 的致命错误。

Input

輸入

输入

Output

輸出

输出

Signs the current player out and clears the stored session.

將目前的玩家登出並清除已儲存的工作階段。

将当前玩家登出并清除已保存的会话。

Input

輸入

输入

No input.

無輸入。

无输入。

Output

輸出

输出

No return value (fire-and-forget).

無回傳值（fire-and-forget）。

无返回值（fire-and-forget）。

Signs the player in with no form to load and no required interaction.

讓玩家登入，無需載入表單，也不需要任何互動。

无需加载表单、无需任何交互即可让玩家登录。

Input

輸入

输入

No input.

無輸入。

无输入。

Output

輸出

输出

Presents the quick-authentication sign-in UI so the player signs in with an available account.

顯示快速身分驗證登入介面，讓玩家使用可用的帳號登入。

展示快速身份验证登录界面，让玩家使用可用账号登录。

Input

輸入

输入

No input.

無輸入。

无输入。

Output

輸出

输出

Signs the player in as an anonymous guest: no account selection or credentials required.

以匿名訪客身分讓玩家登入: 無需選擇帳號或提供憑證。

以匿名访客身份让玩家登录: 无需选择账号或提供凭据。

Input

輸入

输入

No input.

無輸入。

无输入。

Output

輸出

输出

Presents the channel picker so the player chooses which sign-in channel to use.

顯示頻道選擇器，讓玩家選擇要使用的登入頻道。

展示渠道选择器，让玩家选择要使用的登录渠道。

Input

輸入

输入

No input.

無輸入。

无输入。

Output

輸出

输出

Opens the VGA account-management screen and reports what the player did. Works for accounts signed in with either quick-auth version.

開啟 VGA 帳號管理畫面，並回報玩家執行的操作。

打开 VGA 账号管理界面并报告玩家所执行的操作。

Input

輸入

输入

No input.

無輸入。

无输入。

Output

輸出

输出

Validates a player’s session from YOUR game server, not from the client. After ANY login callback hands the game a userID and a sessionID, quick login included, the game’s backend POSTs them to /api/login/checkSession as application/x-www-form-urlencoded, and trusts the player only when returnCode is 1. There is no SDK call for this and no client-side equivalent: a client can claim any session, which is the reason the check exists. The host to send it to and your game’s secret key are issued together on request, see below.

從你的遊戲伺服器驗證玩家的工作階段，而不是從用戶端。任何一種登入回呼把 userID 與 sessionID 交給遊戲之後（含 Quick login），遊戲的後端以 application/x-www-form-urlencoded 將兩者 POST 到 /api/login/checkSession，只有在 returnCode 為 1 時才信任該玩家。SDK 沒有對應的呼叫，用戶端也沒有等價做法：用戶端可以宣稱任何工作階段，這正是需要這道檢查的原因。這個路徑在所有登入後端都相同，不同的是主機與 sig 的欄位順序：VGA 只有一個主機，Passport 舊版則依地區各有一個，分為 VN 與 SEA。你這個版本要用的主機會與你的遊戲 secret key 一併另行申請，見下方說明。

从你的游戏服务器验证玩家的会话，而不是从客户端。任何一种登录回调把 userID 与 sessionID 交给游戏之后（含 Quick login），游戏的后端以 application/x-www-form-urlencoded 将两者 POST 到 /api/login/checkSession，只有在 returnCode 为 1 时才信任该玩家。SDK 没有对应的调用，客户端也没有等价做法：客户端可以声称任何会话，这正是需要这道检查的原因。这个路径在所有登录后端都相同，不同的是主机与 sig 的字段顺序：VGA 只有一个主机，Passport 旧版则依地区各有一个，分为 VN 与 SEA。你这个版本要用的主机会与你的游戏 secret key 一并另行申请，见下方说明。

Server-side only. The path is /api/login/checkSession, but the HOST and your game’s secret key are not published here. Email pin.sdk.dev@vng.com.vn to be issued both. The secret key must never ship in a game client.

僅限伺服器端。 路徑為 /api/login/checkSession，但網域與你的遊戲 secret key 不會公開在這裡，請來信 pin.sdk.dev@vng.com.vn 索取。secret key 絕對不可以隨遊戲用戶端一起發布。

仅限服务器端。 路径为 /api/login/checkSession，但域名与你的游戏 secret key 不会公开在这里，请来信 pin.sdk.dev@vng.com.vn 索取。secret key 绝对不可以随游戏客户端一起发布。

Input

輸入

输入

Output

輸出

输出

Validates a player’s session from YOUR game server, not from the client. After ANY login callback hands the game a userID and a sessionID, quick login included, the game’s backend POSTs them to /api/login/checkSession as application/x-www-form-urlencoded, and trusts the player only when returnCode is 1. There is no SDK call for this and no client-side equivalent: a client can claim any session, which is the reason the check exists. This build has TWO hosts, one for VN and one for SEA, and you are issued the one your game runs on. The path, the parameters and the signature are the same on both. That host and your game’s secret key are issued together on request, see below.

從你的遊戲伺服器驗證玩家的工作階段，而不是從用戶端。任何一種登入回呼把 userID 與 sessionID 交給遊戲之後（含 Quick login），遊戲的後端以 application/x-www-form-urlencoded 將兩者 POST 到 /api/login/checkSession，只有在 returnCode 為 1 時才信任該玩家。SDK 沒有對應的呼叫，用戶端也沒有等價做法：用戶端可以宣稱任何工作階段，這正是需要這道檢查的原因。這個版本有兩個主機，一個給 VN、一個給 SEA，你會拿到你的遊戲實際執行的那一個。兩者的路徑、參數與簽章方式完全相同。該主機與你的遊戲 secret key 會一併另行申請，見下方說明。

从你的游戏服务器验证玩家的会话，而不是从客户端。任何一种登录回调把 userID 与 sessionID 交给游戏之后（含 Quick login），游戏的后端以 application/x-www-form-urlencoded 将两者 POST 到 /api/login/checkSession，只有在 returnCode 为 1 时才信任该玩家。SDK 没有对应的调用，客户端也没有等价做法：客户端可以声称任何会话，这正是需要这道检查的原因。这个版本有两个主机，一个给 VN、一个给 SEA，你会拿到你的游戏实际运行的那一个。两者的路径、参数与签名方式完全相同。该主机与你的游戏 secret key 会一并另行申请，见下方说明。

Server-side only. The path is /api/login/checkSession, but the HOST and your game’s secret key are not published here. Email pin.sdk.dev@vng.com.vn to be issued both. The secret key must never ship in a game client.

僅限伺服器端。 路徑為 /api/login/checkSession，而主機與 secret key 都會在你整合時收到的 SDK_Define_Variable.pdf 裡，不會公開在這裡。VN 與 SEA 後端是不同的主機，所以該檔案裡的那一個就是你遊戲要用的。若你手上沒有這份檔案，請來信 pin.sdk.dev@vng.com.vn。secret key 絕對不可以隨遊戲用戶端一起發布。

仅限服务器端。 路径为 /api/login/checkSession，而主机与 secret key 都会在你集成时收到的 SDK_Define_Variable.pdf 里，不会公开在这里。VN 与 SEA 后端是不同的主机，所以该文件里的那一个就是你游戏要用的。若你手上没有这份文件，请来信 pin.sdk.dev@vng.com.vn。secret key 绝对不可以随游戏客户端一起发布。

Input

輸入

输入

Output

輸出

输出

Fetches the sellable products for a set of item ids.

為一組道具 ID 取得可販售的商品。

为一组物品 id 获取可售商品。

Input

輸入

输入

Output

輸出

输出

Runs a purchase and reports the outcome. Build the request with the purchase-info object: all fields required.

執行購買並回報結果。使用購買資訊物件建立請求: 所有欄位皆為必填。

执行购买并报告结果。使用购买信息对象构建请求: 所有字段均为必填。

Input

輸入

输入

Output

輸出

输出

Reports whether the player has a reward waiting to be granted, so the game can show or hide the claim entry point.

回報玩家是否有待發放的獎勵，讓遊戲決定要顯示或隱藏領取入口。

报告玩家是否有待发放的奖励，让游戏决定要显示或隐藏领取入口。

Input

輸入

输入

Output

輸出

输出

Grants the pending reward and reports whether a failure is worth retrying.

發放待領取的獎勵，並回報該次失敗是否值得重試。

发放待领取的奖励，并报告该次失败是否值得重试。

Input

輸入

输入

Output

輸出

输出

Required analytics setup: binds the current role id and name to the analytics session so tracked events carry role context. Call once after login, before sending events.

必要的分析設定：將目前的角色 ID 與名稱綁定到分析工作階段，讓追蹤的事件帶有角色情境。請在登入後、傳送事件前呼叫一次。

必需的分析设置：将当前角色 id 和名称绑定到分析会话，使追踪的事件带有角色上下文。登录后、发送事件前调用一次。

Required setup for analytics.

分析的必要設定。

分析的必需设置。

Input

輸入

输入

Output

輸出

输出

No return value (fire-and-forget).

無回傳值（fire-and-forget）。

无返回值（fire-and-forget）。

Constraints that apply to every event you send through this facade: they aggregate the rules of the underlying providers. Review them before instrumenting:

• Event names must begin with a letter, contain no spaces (use underscores), and be at most 100 characters. They may not begin with ", \, =, +, or -, are case-sensitive (af_purchase ≠ af_PURCHASE), and may include non-English characters.
• Per event: at most 25 parameters.
• Parameter names must be at most 40 characters.
• Parameter values must not exceed 1000 characters (longer values may be truncated). Keep total event values under 2000 characters.
• Revenue / price values use digits and a single decimal point only, with at most 5 digits after the point.
• Cardinality: at most 300 unique event names per day.
• Unique users are counted only for the first 100 events after a user installs the app.
• Referring URLs must be URL-encoded.
• Meta (Facebook) Ads impose additional limits on event parameters.

適用於你透過此門面傳送的每個事件的限制: 它們彙整了底層各供應商的規則。請在埋點前詳閱：

• 事件名稱 必須以字母開頭、不得包含空格（請使用底線），且最多 100 個字元。不得以 "、\、=、+ 或 - 開頭，區分大小寫（af_purchase ≠ af_PURCHASE），並可包含非英文字元。
• 每個事件： 最多 25 個參數。
• 參數名稱 最多 40 個字元。
• 參數值 不得超過 1000 個字元（過長的值可能會被截斷）。請將事件的總值控制在 2000 個字元以內。
• 收益／價格值 僅能使用數字與單一小數點，小數點後最多 5 位數。
• 基數： 每天最多 300 個不重複的事件名稱。
• 不重複使用者 僅在使用者安裝應用程式後的前 100 個事件內計算。
• 來源 URL 必須經過 URL 編碼。
• Meta（Facebook）Ads 對事件參數施加額外限制。

适用于你通过此门面发送的每个事件的约束: 它们汇总了底层各提供方的规则。在埋点前请先阅读：

• 事件名称 必须以字母开头，不含空格（使用下划线），且最多 100 个字符。不得以 "、\、=、+ 或 - 开头，区分大小写（af_purchase ≠ af_PURCHASE），并且可以包含非英文字符。
• 每个事件： 最多 25 个参数。
• 参数名称 最多 40 个字符。
• 参数值 不得超过 1000 个字符（过长的值可能被截断）。请将事件的总值保持在 2000 个字符以内。
• 收入 / 价格值 只能使用数字和单个小数点，小数点后最多 5 位。
• 基数（Cardinality）： 每天最多 300 个唯一事件名称。
• 唯一用户 仅统计用户安装应用后的前 100 个事件。
• 引荐 URL（Referring URLs） 必须经过 URL 编码。
• Meta（Facebook）广告 对事件参数施加额外限制。

Sends one custom event to the providers you explicitly choose via the platforms list. The event name is sent as-is: its natural name: apart from the optional per-provider prefix you set yourself. To send to the SDK’s default provider set without naming platforms, use miscCustomEvent instead.

將一個自訂事件傳送到你透過 platforms 清單明確選擇的供應商。事件名稱會原樣傳送: 使用其自然名稱: 除了你自行設定的可選每供應商前綴之外。若要在不指定平台的情況下傳送到 SDK 的預設供應商集合，請改用 miscCustomEvent。

向你通过 platforms 列表显式选择的提供方发送一个自定义事件。事件名称按原样（其自然名称）发送，仅带上你自行设置的可选的每提供方前缀。若要发送到 SDK 的默认提供方集合而不指定 platforms，请改用 miscCustomEvent。

Input

輸入

输入

Output

輸出

输出

No return value (fire-and-forget).

無回傳值（fire-and-forget）。

无返回值（fire-and-forget）。

Sends a custom event to the SDK’s default provider set: the no-platform-list counterpart of sendCustomEvent (you don’t pick providers). The SDK auto-prefixes the event name per provider, delivering it as vgsdk_{prefix}_{event name}: see Analytics platform prefixes.

將自訂事件傳送到 SDK 的預設供應商集合: 為 sendCustomEvent 不帶平台清單的對應版本（你不需選擇供應商）。SDK 會依各供應商自動為事件名稱加上前綴，以 vgsdk_{prefix}_{event name} 傳遞: 請參閱 分析平台前綴。

向 SDK 的默认提供方集合发送一个自定义事件: 即 sendCustomEvent 的无 platforms 列表版本（你不选择提供方）。SDK 会为每个提供方自动为事件名称添加前缀，以 vgsdk_{prefix}_{event name} 形式发送: 请参阅 分析平台前缀。

Input

輸入

输入

Output

輸出

输出

No return value (fire-and-forget).

無回傳值（fire-and-forget）。

无返回值（fire-and-forget）。

Logs an app open.

記錄一次應用程式開啟。

记录一次应用打开。

Input

輸入

输入

Output

輸出

输出

No return value (fire-and-forget).

無回傳值（fire-and-forget）。

无返回值（fire-and-forget）。

Logs the configuration fetch.

記錄設定的取得。

记录配置获取。

Input

輸入

输入

Output

輸出

输出

No return value (fire-and-forget).

無回傳值（fire-and-forget）。

无返回值（fire-and-forget）。

Logs the start of a configuration check.

記錄一次設定檢查的開始。

记录配置检查的开始。

Input

輸入

输入

Output

輸出

输出

No return value (fire-and-forget).

無回傳值（fire-and-forget）。

无返回值（fire-and-forget）。

Logs the end of a configuration check.

記錄一次設定檢查的結束。

记录配置检查的结束。

Input

輸入

输入

Output

輸出

输出

No return value (fire-and-forget).

無回傳值（fire-and-forget）。

无返回值（fire-and-forget）。

Logs the start of a CDN resource download.

記錄一次 CDN 資源下載的開始。

记录 CDN 资源下载的开始。

Input

輸入

输入

Output

輸出

输出

No return value (fire-and-forget).

無回傳值（fire-and-forget）。

无返回值（fire-and-forget）。

Logs 25% CDN download progress.

記錄 CDN 下載 25% 的進度。

记录 CDN 下载进度 25%。

Input

輸入

输入

Output

輸出

输出

No return value (fire-and-forget).

無回傳值（fire-and-forget）。

无返回值（fire-and-forget）。

Logs 50% CDN download progress.

記錄 CDN 下載 50% 的進度。

记录 CDN 下载进度 50%。

Input

輸入

输入

Output

輸出

输出

No return value (fire-and-forget).

無回傳值（fire-and-forget）。

无返回值（fire-and-forget）。

Logs 75% CDN download progress.

記錄 CDN 下載 75% 的進度。

记录 CDN 下载进度 75%。

Input

輸入

输入

Output

輸出

输出

No return value (fire-and-forget).

無回傳值（fire-and-forget）。

无返回值（fire-and-forget）。

Logs CDN download completion.

記錄 CDN 下載完成。

记录 CDN 下载完成。

Input

輸入

输入

Output

輸出

输出

No return value (fire-and-forget).

無回傳值（fire-and-forget）。

无返回值（fire-and-forget）。

Logs the start of resource extraction.

記錄一次資源解壓的開始。

记录资源解压的开始。

Input

輸入

输入

Output

輸出

输出

No return value (fire-and-forget).

無回傳值（fire-and-forget）。

无返回值（fire-and-forget）。

Logs the end of resource extraction.

記錄一次資源解壓的結束。

记录资源解压的结束。

Input

輸入

输入

Output

輸出

输出

No return value (fire-and-forget).

無回傳值（fire-and-forget）。

无返回值（fire-and-forget）。

Logs a new user joining a server.

記錄新使用者加入伺服器。

记录新用户加入服务器。

Input

輸入

输入

Output

輸出

输出

No return value (fire-and-forget).

無回傳值（fire-and-forget）。

无返回值（fire-and-forget）。