Common API

    Common API


    記事の要約

    AccessKeyの設定

    発行 accessKeyを設定します。

    late final _shopLiveCommonPlugin = ShopLiveCommon();
    _shopLiveCommonPlugin.setAccessKey(accessKey: String?)


    ユーザー認証

    簡単な認証

    void setUser({required String accessKey, required ShopLiveCommonUser user})ユーザー情報を保存するため。

    • 詳細については、 authenticationガイドを参照してください。

    ショップライブコモンユーザー

    プロパティ名

    種類

    形容

    ユーザーID

    ログインしたユーザーの一意性を確保する値 (必須)

    名前

    糸。

    ユーザー名

    年齢

    Int?

    ユーザーの年齢

    ジェンダー

    ShopLiveCommonUser性別?

    ユーザーの性別

    ユーザースコア

    Int?

    整数は -100 から 100 まで使用できます。

    習慣

    マップ<文字列、動的>?

    1KBまでの任意のデータを設定できます。 これにより、合計/ログイン視聴者のデータを確認できます。

    late final _shopLiveCommonPlugin = ShopLiveCommon();
    _shopLiveCommonPlugin.setUser(
        accessKey: "accessKey",
        user: ShopLiveCommonUser(
          userId: "userId",
          userName: "TestUser",
          userScore: 0,
          gender: ShopLiveCommonUserGender.NEUTRAL,
          age: 20,
          custom: {"key": "value"},
        ));

    JWT認証

    void setAuthToken({required String? userJWT})ShopLive JWTを通じて認証します。

    late final _shopLiveCommonPlugin = ShopLiveCommon();
    _shopLiveCommonPlugin.setAuthToken(userJWT: String)

    資格情報のリセット

    設定されている資格情報を初期化します。

    late final _shopLiveCommonPlugin = ShopLiveCommon();
    _shopLiveCommonPlugin.clearAuth()

    マーケティングファネルの追跡

    UTM タグ(ソース/メディア/キャンペーン/コンテンツ)は、次の機能を使用して追跡できます。ログに記録された情報は、Data Insights で確認できます。

    • void setUtmSource({required String? utmSource})

    • void setUtmMedium({required String? utmMedium})

    • void setUtmCampaign({required String? utmCampaign})

    • void setUtmContent({required String? utmContent})

    パラメータ名

    種類

    形容

    utmソース

    糸。

    流入がどこから来たのかを伝えます。

    utmミディアム

    糸。

    流入がどのように発生したかを伝えます。Googleは、流入につながったマーケティング手法を参照するために、mediumパラメータを設定することを推奨しています。(例:CPC、バナー、メール、ブログ、ソーシャルなど)

    utmキャンペーン

    糸。

    これは、流入を引き起こした広告キャンペーンを示します。キャンペーン名、キャンペーン期間、キャンペーンコンテンツに分けることができます。

    utmコンテンツ

    糸。

    流入がどのような投稿/広告によって引き起こされたかを教えてくれます。これは、キャンペーンパラメータの細分化としてよく使用されます。

    サンプルコード

    late final _shopLiveCommonPlugin = ShopLiveCommon();
    _shopLiveCommonPlugin.setUtmSource(utmSource: "utm_source")
    _shopLiveCommonPlugin.setUtmMedium(utmMedium: "utm_medium")
    _shopLiveCommonPlugin.setUtmCampaign(utmCampaign: "utm_campaign")
    _shopLiveCommonPlugin.setUtmContent(utmContent: "utm_content")