コンテンツにスキップ

クイックスタート

このページでは、Cocos Creator SDK を最短で導入するための手順を説明します。RUM、Log、Trace データの報告を 1 回で確認できるところまでを目標とします。

このページのサンプルは現在の SDK バージョン構成を使用しています。

事前準備

  1. リアルユーザーモニタリング（RUM） で Android アプリと iOS アプリをそれぞれ作成し、2 つのアプリ ID を取得します。

  2. データの報告方法を 1 つ準備します。

    • ローカル環境へのデプロイ: datakitUrl を準備します。
    • パブリック DataWay: datawayUrl と clientToken を準備します。

  3. @cloudcare/cocos-sdk をインストールし、プロジェクトインストーラーを実行します。詳細な手順はアプリ接入を参照してください。

  4. Cocos Creator を開き直し、Android または iOS のネイティブプロジェクトを生成します。
  5. CocoaPods を使用する iOS プロジェクトでは、Podfile があるディレクトリで pod install を実行し、その後 .xcworkspace を開きます。SPM を使用する場合は、iOS ネイティブビルドの設定に従ってコンパイルしてください。新しいプロジェクトに Pods をインストールする必要はありません。

以下の最小サンプルは基本パッケージのみを使用します。セッションリプレイが必要な場合は、まずReplay インストールパラメータの手順に従って独立パッケージをインストールし、--replay を実行してから、組み合わせた SDK インスタンスを使用して初期化してください。

最小限の初期化

以下のサンプルは Creator 3 を使用しています。Creator 2 の場合は、インポートエントリを @cloudcare/cocos-sdk/creator2 に変更してください。

import { guanceSdk } from '@cloudcare/cocos-sdk/creator3';

export function startObservability(): void {
  guanceSdk.start({
    sdk: {
      datakitUrl: 'https://your-datakit.example.com',
      serviceName: 'cocos-game',
      env: 'prod',
      debug: true,
    },
    rum: {
      androidAppId: 'android-rum-app-id',
      iosAppId: 'ios-rum-app-id',
      sampleRate: 1,
    },
    logger: {
      enableCustomLog: true,
      enableLinkRumData: true,
      sampleRate: 1,
    },
    trace: {
      traceType: 'ddTrace',
      enableLinkRumData: true,
      sampleRate: 1,
    },
    autoTrack: {
      scenes: true,
      actions: true,
      errors: true,
      network: true,
    },
  });
}

最初にデータを収集するシーンのロード前に startObservability() を呼び出し、アプリのライフサイクル全体で初期化が 1 回だけ行われるようにしてください。

アプリの大部分が Android/iOS のネイティブページで、Cocos を使用するのが 1 ページまたは少数のページのみの場合は、guanceSdk.start() を再度呼び出さないでください。このシナリオでは、ネイティブホスト側で SDK の初期化を 1 回行い、Cocos 側は attach() で接続します。詳細はネイティブと Cocos のハイブリッド開発を参照してください。

パブリック DataWay を使用する場合は、sdk を次のように変更します。

sdk: {
  datawayUrl: 'https://open.dataway.url',
  clientToken: 'client-token',
  serviceName: 'cocos-game',
  env: 'prod',
  debug: true,
},

datakitUrl と datawayUrl はどちらか一方を選択します。datawayUrl を使用する場合は、clientToken も必ず指定してください。

カスタムログを 1 件出力する

初期化後に以下を呼び出します。

guanceSdk.logger.log('Cocos SDK initialized', 'info', {
  scene: 'Boot',
});

接入の検証

  1. Android または iOS のネイティブビルドでアプリを実行します。ブラウザプレビューではデータは報告されません。
  2. シーンを切り替え、タッチ操作を 1 回実行し、ネットワークリクエストを発行します。
  3. Cocos コンソールとネイティブログに、初期化または Bridge に関するエラーがないか確認します。
  4. RUM > エクスプローラー に移動し、対応する Android または iOS アプリを選択します。
  5. View、Action、または Resource データが存在することを確認し、ログエクスプローラーでカスタムログを確認します。
  6. 検証が完了したら、本番環境では debug をオフにします。

次のステップ

フィードバック

このページは役に立ちましたか？