跳轉至

自动事件跟踪

Hive SDK(以下稱為 SDK)可以自動追蹤以下 4 個事件並將其發送到每個歸因:安裝、打開、更新、購買(應用內購買) 遊戲工作室無需實施代碼來追蹤這 4 個事件。

使用 Adjust 的自動事件追蹤

  1. 从每个归因中获取所需的令牌。请参考Adjust仪表板指南以了解如何获取令牌。

    • 要自动跟踪购买和更新事件,请在Adjust仪表板上注册这些事件,并获取应用令牌和事件令牌。应用令牌可以在仪表板主页上获得,事件令牌可以在仪表板 > 所有设置 > 事件中获得。
    • 对于安装和打开事件的自动跟踪,不需要令牌。
  2. 在 hive_config.xml 中添加令牌。

    • 将应用程序令牌、购买事件令牌和更新事件令牌添加到 hive_config.xml。请参阅下面的 示例代码
    • 对于安装和打开事件的自动跟踪,配置 hive_config.xml 并不是必需的。
  3. Adjust 仪表板提供了 SDK 签名 V3 以防止应用程序欺骗。要使用 SDK 签名,您需要审查与 Adjust 的合同条款。
Note

建議自動追蹤您遊戲操作的所有 4 個事件。

SDK 簽名整合

如果您使用过旧版本的 SDK 签名,请在集成签名库之前检查 SDK 签名迁移

如果您是第一次使用 SDK 签名,请按照以下说明进行操作。

安卓

在 Android 環境中使用 SDK 簽名,請遵循以下指示。

  1. 在您的模块级 build.gradle 文件中添加 Adjust 归因以使用 SDK 签名..
    dependencies {
        implementation "com.com2us.android.hive:hive-analytics-provider-adjust"
    }
    
  2. 前往 Adjust 仪表板,并按照 将您的数字证书指纹添加到 Adjust 的允许列表 页面上的说明设置您的指纹。

您可以通过参考 Adjust Suite中的证书设置页面 来检查每个应用程序使用的证书方法的指纹提取方法。

iOS

要在 iOS 環境中使用 SDK 簽名,請將 ProviderAdjust 子規範添加到您的 Podfile 中。

(omitted)
pod HiveAnalyticsProviderAdjust, $HIVE_SDK_VERSION
(omitted)

單一性

如果您想在 Unity 引擎中使用 SDK 签名,您可以在 Unity 引擎菜单中轻松设置。

如果您在下面的 Inspector 菜单中选择 Hive - Hive 依赖项 (ExternalDependency) 并勾选 调整,您可以在没有任何额外设置的情况下使用 SDK 签名。

檢查 SDK 簽名整合狀態

要確認 SDK 簽名庫是否已正確整合,首先確保 Hive SDK 設定 中的 zone 設定為 sandbox。然後,按照以下步驟進行操作。

Note

有關更多詳細資訊,請參閱 Adjust 文檔

  1. 完全卸載測試設備上的應用程式,以確保安裝資訊被發送。
  2. 前往 Adjust 儀表板測試控制台,輸入測試設備資訊,然後點擊 刪除設備 以移除所有設備。
  3. 在測試設備上安裝應用程式並運行,以確保安裝資訊被發送到 Adjust。
  4. 在測試控制台中輸入測試設備的廣告 ID 或 IDFA 以檢索安裝事件資訊。
    • SignatureVerificationResult 欄位應顯示值 Valid Signature
    • 檢查 SignatureVersion 欄位值是否為 3

SDK 簽名遷移

要使用最新的 SDK 簽名,您需要刪除之前的 SDK 簽名版本設置。

Android, iOS

hive_config.xml中的Adjust相關設置中,移除所有為secretIdinfo1info2info3info4設置的鍵和值。

<providers>
    <!-- (code omitted) -->

    <!-- Do not set the Adjust node id field. -->
    <!-- The Adjust node name field is fixed as "Adjust". -->
    <!-- The event node name field is set arbitrarily by the game company. -->

    <!-- Remove secretId="1" info1="5432112345" info2="334123" info3="555333" info4="111333" below -->
    <!-- <Adjust name="Adjust" id="unused" key="APP_TOKEN" secretId="1" info1="5432112345" info2="334123" info3="555333" info4="111333"> -->
    <Adjust name="Adjust" key="APP_TOKEN">
        <events>
            <event name="Purchase" value="PURCHASE_EVENT_TOKEN" />
            <event name="Update" value="UPDATE_EVENT_TOKEN" />
        </events>
    </Adjust>

    <!-- (code omitted) -->
</providers>

單一

Hive Unity SDK(以下簡稱「Unity SDK」)不需要移除之前的 SDK 簽名版本設置。

自動追蹤事件與 Airbridge

  1. 獲取所需的令牌。欲了解如何發放令牌的更多信息,請參閱Airbridge 儀表板指南
    • 從儀表板 > 設定 > 令牌管理中獲取應用程序 SDK 令牌和應用程序名稱。
  2. 對於 Android 和 iOS,將令牌、應用程序名稱和更新事件設置添加到 hive_config.xml 中。請參閱下面的 hive_config.xml 示例代碼
  3. 對於 Windows,您需要 Hive 控制台設置,而不是 hive_config.xml 設置。請參閱下面的 Windows 設置
  4. 如果您同時應用 Windows、Android 和 iOS,請聯繫 Airbridge 以進行預配置。
  5. Airbridge 提供 SDK 簽名 以防止應用程序欺騙。您必須首先檢查與 Airbridge 的協議條款才能使用此功能。獲取密鑰並將其作為 secretIdsecret 值添加到 hive_config.xml 中。有關 SDK 簽名安全信息的更多信息,請參閱 Airbridge 指南。此功能僅支持 Android 和 iOS,不支持 Windows。

SDK 簽名整合

如果您是第一次使用 SDK 签名,请按照以下说明进行操作。

hive_config.xml 示例代码

<providers>
        <!-- (代码省略) -->
        <!-- 设置 Airbridge -->
        <!-- Airbridge 节点 name 字段为 "Airbridge" 固定值。 -->
        <!-- Airbridge 节点 id 字段不进行设置。 -->
        <!-- event 节点 name, value 字段由游戏公司自行设置。 -->

        <Airbridge name="Airbridge" key="APP_SDK_TOKEN" appName="APP_NAME" secretId="SECRET_ID" secret="SECRET">
                <events>
                        <event name="Update" value="Update" />
                </events>
        </Airbridge>

        <!-- (代码省略) -->
</providers>
<providers>
        <!-- (代码省略) -->
        <!-- 设置 Airbridge -->
        <!-- Airbridge 节点名称字段为 "Airbridge" 固定值。 -->
        <!-- Airbridge 节点 ID 字段不进行设置。 -->
        <!-- 事件节点名称、值字段由游戏公司自行设置。 -->

        <Airbridge name="Airbridge" key="APP_SDK_TOKEN" appName="APP_NAME" secretId="SECRET_ID" secret="SECRET">
                <events>
                        <event name="Install" value="安裝"/>
                        <event name="Update" value="更新" />
                        <event name="Open" value="打開"/>
                        <event name="PrePurchase" value="airbridge.initiateCheckout"/>
                        <event name="PurchaseCancel" value="airbridge.ecommerce.order.canceled"/>
                        <event name="Purchase" value="airbridge.ecommerce.order.completed"/>
                </events>
        </Airbridge>

        <!-- (代码省略) -->
</providers>

安卓, iOS

hive_config.xml中设置与Airbridge相关的secretIdsecret键值。

Windows

  1. 在 Hive 控制台中進行行銷歸因 - Airbridge 設定。

    • hive_config.xml 中不需要設置與 Airbridge 相關的 secretIdsecret 鍵值。
  2. 根據以下說明在 hive_config.xml 中設置它。參考 hive_config.xml 示例代碼
    當設置為 Airbridge 中定義的值時,可以作為 Airbridge 標準事件發送。
    Airbridge 事件類型

    • 安裝:需要設置。
    • 開啟:需要設置。
    • 更新:需要設置。
    • 預購:需要設置。您可以發送一個標準事件,值為 airbridge.initiateCheckout。
    • 購買取消:需要設置。您可以發送一個標準事件,值為 airbridge.ecommerce.order.canceled。
    • 購買:需要設置。您可以發送一個標準事件,值為 airbridge.ecommerce.order.completed。
  3. (可選) Airbridge 事件傳輸延遲
    Windows 環境的 PC SDK 提供了一個功能,可以延遲特定 Airbridge 事件的傳輸,直到登錄(登錄)之後。此功能可以通過在 hive_config.xml 中定義相關屬性來啟用和管理。

    hive_config.xml 文件中的 標籤內使用 win: 前綴定義相關屬性,如下例所示:

        <providers>
    <!-- (code omitted) -->
    <Airbridge
        win:DeferSendUntilGate="signin"
        win:DeferScope="include"
        win:DeferEventList="Install,Update,Open"
        win:DeferSendTimeout="86400"
        win:DeferQueueMax="1000">
        <events>
            <event name="Install" value="Install"/>
            <event name="Open" value="Open"/>
        </events>
    </Airbridge>
    <!-- (code omitted) -->
    </providers>
    

    hive_config.xml 文件中為 Airbridge 事件傳輸延遲定義的屬性如下:

    屬性 描述 選項 最大值 備註
    win:DeferSendUntilGate 指定事件傳輸開始閘門(時機)
    • init(預設)
    • signin
    設置排隊事件實際開始傳輸到 Airbridge 的時機。
    • init: 在 SDK 初始化後立即開始傳輸。
    • signin: 在登錄(登入)事件發生後開始傳輸。
    win:DeferScope 指定延遲傳輸的事件範圍
    • all
    • include
    • none(預設)
    設置應用延遲傳輸功能的事件範圍。
    • none(預設): 不使用延遲傳輸。
    • all: 延遲所有發生事件的傳輸直到指定的閘門。
    • include(推薦): 只延遲在 win:DeferEventList 中指定的事件的傳輸。
    win:DeferEventList 延遲傳輸的事件列表 僅在 win:DeferScope 設置為 include 時應用。
    • 列出用','(逗號)分隔的延遲傳輸事件名稱。允許空格。
    • 範例: "Install,Update,Open"
    win:DeferSendTimeout 最大延遲時間(秒) 86400(24 小時)
    • 如果在設定的時間(秒)內未打開 DeferSendUntilGate,則立即傳輸等待事件。
    • 如果未設置或值為 0,事件將無限期等待而不傳輸,直到閘門打開
    win:DeferQueueMax 最大延遲事件存儲數量 1000
    • 可以存儲在延遲傳輸隊列中的事件最大數量。
    • 當此數量超過時,最舊的事件將自動刪除。
    • 如果未設置或值為 0,則忽略最大數量限制。

聯合

從菜單中選擇 Hive - 編輯配置 並激活 Android 或 iOS 標籤。接下來,在 Airbridge 中設置傳遞的 secretId, secret 值。

當自動事件發生時發送的信息

當特定事件被執行時,該事件會自動發送到 Airbridge 應用程式歸因。此時發送的信息如下。

out
事件名稱 參數 備註
登入 登入
  • user.externalUserID: playerId
登出 登出
開始付款 啟動結帳
  • totalQuantity
  • currency
  • originalCurrency
  • products
  • products.name: 產品標題
  • originalCurrency: 從SDK發送的貨幣
  • currency: 設定Airbridge應用程式時註冊的基礎貨幣
購買完成 訂單完成
  • totalQuantity
  • currency
  • originalCurrency
  • value
  • transactionID
  • inAppPurchased
  • products
  • products.name: 產品標題
  • value: sum products.price
  • originalCurrency: 從SDK發送的貨幣
  • currency: 設定Airbridge時註冊的基礎貨幣
購買取消 訂單取消
  • transactionType
  • totalQuantity
  • currency
  • originalCurrency
  • value
  • inAppPurchased
  • products
  • transactionType: "cancel"
  • products.name: 產品標題
  • value: sum products.price
  • originalCurrency: 從SDK發送的貨幣
  • currency: 設定Airbridge應用程式時註冊的基礎貨幣
訂閱 訂閱
  • totalQuantity
  • currency
  • originalCurrency
  • value
  • isRenewal
  • products
  • products.name: 產品標題
  • value: sum products.price
  • originalCurrency: 從SDK發送的貨幣
  • currency: 設定Airbridge應用程式時註冊的基礎貨幣
廣告展示 廣告展示
  • ad_placement
  • ad_platform
  • ad_type
  • ad_unit_id
  • currency
  • eventType
  • revenue
  • 自動追蹤當Adiz, Adkit
    • 更新計劃中
廣告點擊 廣告點擊
  • ad_placement
  • ad_platform
  • ad_type
  • ad_unit_id
  • currency
  • eventType
  • revenue
  • 自動追蹤當 Adiz, Adkit
    • 計劃更新
評估 評分
  • 按鈕類型
  • 類別
  • 方向
  • 類別:
    • hive_review_click: Hive 評論 UI
    • hive_native_review_request: 市場原生評論彈出窗口
  • 方向:
    • 豎向: "1"
    • 橫向: "2"
分享 分享

使用 Singular、Appsflyer 和 Firebase Analytics 的自動事件追蹤

  1. 從每個歸因儀表板獲取所需的密鑰。請參閱每個歸因儀表板的指南以了解如何獲取密鑰。
  2. 根據以下指南配置 hive_config.xml。欲了解更多詳細資訊,請參見以下示例代碼。

    • 開放: 只需為 Firebase Analytics 進行配置。
    • 更新: 需要為所有歸因進行配置:Singular、Appsflyer、Firebase Analytics
    • 購買: 需要為 Singular 和 Firebase Analytics 進行配置。
    • 如果您使用 SDK iOS (Native, Unity, Unreal) 的 AppsFlyer 歸因,則需要為 Apple AppID 設置 itunseConnectAppId
    <providers>
            <!-- 配置 Singular -->
            <!-- Singular 節點的名稱字段固定為 "Singular." -->
            <!-- 事件節點的名稱和數值字段由每個遊戲工作室定義。 -->
            <Singular name="Singular" id="SDK_KEY" key="SDK_SECRET_KEY">
                    <events>
                            <event name="Purchase" value="purchase"/>
                            <event name="Update" value="update"/>
                    </events>
            </Singular>
    
            <!-- 配置 AppsFlyer -->
            <!-- AppsFlyer 節點的名稱字段固定為 "AppsFlyer." -->
            <!-- 不要設置 AppsFlyer 節點的 id 字段。 -->
            <!-- 事件節點的名稱和數值字段由每個遊戲工作室定義。 -->
            <AppsFlyer name="AppsFlyer" id="unused" key="DEV_KEY" itunseConnectAppId="909923112">
                    <events>
                            <event name="Update" value="Update"/>
                    </events>
            </AppsFlyer>
    
            <!-- 配置 Firebase 分析 -->
            <!-- 事件节点的名称和值字段由每个游戏工作室定义。 -->
            <firebase>
                    <events>
                            <event name="Purchase" value="purchase"/>
                            <event name="Open" value="open"/>
                            <event name="Update" value="update"/>
                    </events>
            </firebase>
    </providers>
    
Note

為了順利運行遊戲,建議自動追蹤所有更新、開啟和購買事件。

購買事件所發送的信息

如果您使用 IAP 实现游戏的计费,SDK 会自动将购买事件发送到第三方移动应用归因。每个事件发送的信息如下。

事件名稱 參數 備註
調整 購買
  • 價格
  • 貨幣
  • 訂單ID
  • 產品ID
  • 標題
  • 伺服器ID
  • 數量
  • 收入
  • 產品ID: 產品 ID
  • 收入: 價格 * 數量
Airbridge 訂單完成
  • 總數量
  • 貨幣
  • 原始貨幣
  • 價值
  • 交易ID
  • 應用內購買
  • 產品
  • 產品名稱: 產品標題
  • 價值: 產品價格總和
  • 原始貨幣: 從 SDK 發送的貨幣
  • 貨幣: 設定 Airbridge 應用時註冊的基礎貨幣
Singular __iap__
  • r
  • pk
  • pcc
  • pn
  • pc
  • pq
  • pp
  • 市場
  • 伺服器
  • psku
  • pvid
  • haid
  • r: 收入 (價格 * 數量)
  • pk: 訂單 ID
  • pcc: 貨幣
  • pn: 標題
  • pc: 應用內項目
  • pq: 數量
  • pp: 價格
  • 市場: google
  • 伺服器: 伺服器ID
  • psku: 產品 ID
  • pvid: Hive PlayerID
  • haid: Hive Analytics ID
AppsFlyer 購買
  • af_price
  • af_currency
  • af_quantity
  • af_content
  • af_receipt_id
  • custsom_product_id
  • af_content_type
  • af_revenue
  • custsom_product_id: 產品 ID
  • af_content: 產品描述
  • af_content_type: 標題
  • af_revenue: 價格 * 數量
Firebase Analytics 購買
  • 價格
  • 貨幣
  • 訂單ID
  • 產品ID
  • 標題
  • 伺服器ID
  • 數量
  • 收入
  • 產品ID: 產品 ID
  • 收入: 價格 * 數量