コンテンツにスキップ

クイックスタート

このドキュメントでは、Cocos Creator SDK の最短の導入経路を説明し、RUM・Log・Trace データの報告を一度で検証できるようにします。

導入前に、インストールした npm パッケージとネイティブ依存関係が SDK バージョンと依存関係の要件 を満たしていることを確認してください。

事前準備

  1. RUM で Android アプリと iOS アプリをそれぞれ作成し、2 つのアプリ ID を取得します。

  2. 次のいずれかの報告方法を準備します。

    • ローカル環境へのデプロイ: 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 も必ず渡してください。

カスタムログを出力する

初期化後に呼び出します：

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 をオフにします。

次のステップ

フィードバック

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