Getting Started

インストール

You can use our AI-Assisted Setup to install the plugin. Add the Capgo skills to your AI tool using the following command:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

次に、以下のプロンプトを使用してください:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-firebase-performance` plugin in my project.

Manual Setupを使用する場合は、以下のコマンドを実行し、下記のプラットフォーム固有の説明を参照してください。

bun add @capgo/capacitor-firebase-performance
bunx cap sync

インポート

import { FirebasePerformance } from '@capgo/capacitor-firebase-performance';

APIの概要

startTrace

トレースを開始します。

import { FirebasePerformance } from '@capgo/capacitor-firebase-performance';

await FirebasePerformance.startTrace({} as StartTraceOptions);

stopTrace

コピー

import { FirebasePerformance } from '@capgo/capacitor-firebase-performance';

await FirebasePerformance.stopTrace({} as StopTraceOptions);

incrementMetric

コピー incrementBy 有効/無効を切り替えます.

import { FirebasePerformance } from '@capgo/capacitor-firebase-performance';

await FirebasePerformance.incrementMetric({} as IncrementMetricOptions);

setEnabled

__CAPGO_KEEP_0__を有効または無効にします。 アプリの次の起動時に適用されます。

import { FirebasePerformance } from '@capgo/capacitor-firebase-performance';

await FirebasePerformance.setEnabled({} as SetEnabledOptions);

isEnabled

__CAPGO_KEEP_0__が有効か無効かを決定します。

import { FirebasePerformance } from '@capgo/capacitor-firebase-performance';

await FirebasePerformance.isEnabled();

putAttribute

__CAPGO_KEEP_0__のカスタム属性を指定された値に設定します。

import { FirebasePerformance } from '@capgo/capacitor-firebase-performance';

await FirebasePerformance.putAttribute({} as PutAttributeOptions);

getAttribute

__CAPGO_KEEP_0__のカスタム属性の値を取得します。

import { FirebasePerformance } from '@capgo/capacitor-firebase-performance';

await FirebasePerformance.getAttribute({} as GetAttributeOptions);

getAttributes

__CAPGO_KEEP_0__のカスタム属性をすべて取得します。

import { FirebasePerformance } from '@capgo/capacitor-firebase-performance';

await FirebasePerformance.getAttributes({} as GetAttributesOptions);

removeAttribute

カスタム属性を削除します。

import { FirebasePerformance } from '@capgo/capacitor-firebase-performance';

await FirebasePerformance.removeAttribute({} as RemoveAttributeOptions);

putMetric

カスタムメトリクスの値を設定します。

import { FirebasePerformance } from '@capgo/capacitor-firebase-performance';

await FirebasePerformance.putMetric({} as PutMetricOptions);

getMetric

カスタムメトリクスの値を取得します。

import { FirebasePerformance } from '@capgo/capacitor-firebase-performance';

await FirebasePerformance.getMetric({} as GetMetricOptions);

record

__CAPGO_KEEP_0__を指定した名前とオプションで記録します。

__CAPGO_KEEP_0__はウェブ上のみ利用可能です。

import { FirebasePerformance } from '@capgo/capacitor-firebase-performance';

await FirebasePerformance.record({} as RecordOptions);

型の参照

StartTraceOptions

export interface StartTraceOptions {
  /**
   * Custom trace name.
   *
   * Names for custom code traces must meet the following requirements:
   * no leading or trailing whitespace, no leading underscore (_) character,
   * and max length is 100 characters.
   *
   * @since 0.1.0
   */
  traceName: string;
}

StopTraceOptions

export interface StopTraceOptions {
  /**
   * Name of the trace that was set with `startTrace`.
   *
   * @since 0.1.0
   */
  traceName: string;
}

IncrementMetricOptions

export interface IncrementMetricOptions {
  /**
   * Name of the trace that was set with `startTrace`.
   *
   * @since 0.1.0
   */
  traceName: string;
  /**
   * Name of the metric to be incremented.
   *
   * @since 0.1.0
   */
  metricName: string;
  /**
   * Amount by which the metric has to be incremented.
   *
   * @default 1
   * @since 0.1.0
   */
  incrementBy?: number;
}

SetEnabledOptions

export interface SetEnabledOptions {
  /**
   * Should performance monitoring be enabled.
   *
   * @since 0.1.0
   */
  enabled: boolean;
}

IsEnabledResult

export interface IsEnabledResult {
  /**
   * `true` if performance monitoring is enabled, otherwise `false`.
   *
   * @since 0.1.0
   */
  enabled: boolean;
}

PutAttributeOptions

export interface PutAttributeOptions {
  /**
   * Name of the trace to set its attribute.
   *
   * @since 6.3.0
   */
  traceName: string;
  /**
   * Name of the attribute to set its value.
   *
   * @since 6.3.0
   * @example "experiment"
   */
  attribute: string;
  /**
   * The value to set to the attribute.
   *
   * @since 6.3.0
   * @example "A"
   */
  value: string;
}

GetAttributeOptions

export interface GetAttributeOptions {
  /**
   * Name of the trace to set its attribute.
   *
   * @since 6.3.0
   */
  traceName: string;
  /**
   * Name of the attribute to retrieve its value.
   *
   * @since 6.3.0
   */
  attribute: string;
}

GetAttributeResult

export interface GetAttributeResult {
  /**
   * The value of the custom attribute.
   *
   * @since 6.3.0
   */
  value: string | null;
}

GetAttributesOptions

export interface GetAttributesOptions {
  /**
   * Name of the trace to get its attributes.
   *
   * @since 6.3.0
   */
  traceName: string;
}

GetAttributesResult

export interface GetAttributesResult {
  /**
   * A map of all custom attributes of a trace with their values.
   *
   * @since 6.3.0
   */
  attributes: { [key: string]: string };
}

RemoveAttributeOptions

export type RemoveAttributeOptions = GetAttributeOptions;

PutMetricOptions

export interface PutMetricOptions {
  /**
   * Name of the trace to set its metric.
   *
   * @since 6.3.0
   */
  traceName: string;
  /**
   * The metric name.
   *
   * @since 6.3.0
   */
  metricName: string;
  /**
   * The value to set for the metric.
   * The given value is floored down to the nearest integer.
   *
   * @since 6.3.0
   */
  num: number;
}

真実の源

このページはプラグインの src/definitions.tsAPI の公開変更をアップストリームで再実行してください。

Getting Startedから続けて

あなたが使用している場合 スタートガイド APIと連携することで、ダッシュボードとAPIの運用を計画できます。 APIの概要 APIの実装詳細については、APIの概要を参照してください。 導入 導入の実装詳細については、導入を参照してください。 APIのキー APIのキーに関する実装詳細については、APIのキーを参照してください。 デバイス デバイスの実装詳細については、デバイスを参照してください。 バンドル バンドルの実装詳細については、バンドルを参照してください。