目次 x
    API: Common
      • 印刷する
      目次

      API: Common

        • 印刷する
        記事の要約

        AccessKey設定

        発行されたAccessKeyを設定します。

        ShopLiveCommon.setAccessKey(accessKey : String?)

        ユーザー 認証

        簡易認証

        ShopLiveCommon.setUser(user: ShopLiveCommonUser)ユーザー情報を保存します。詳細については、 ユーザー 認証 ガイドを参照してください。

        ShopLiveCommon.setuser(user : ShopLiveCommonUser)

        ShopLiveCommonUser

        フィールド

        タイプ

        説明

        userId

        String

        ユーザーID

        name

        String?

        ユーザー名 (チャットウィンドウで使用)

        age

        Int?

        ユーザーの年齢

        gender

        ShopliveCommonUserGender

        ユーザーの性別

        userScore

        Int?

        ユーザー評価

        custom

        [String: Any]

        カスタムデータ

        📘 //       

        Objective-C 環境では、ShopLiveCommonUserObjc オブジェクトを使用してください。

        JWT 認証

        ShopLiveCommon.setAuthToken(authToken : String)ShopLive JWT認証を使用します。

        ShopLiveCommon.setAuthToken(jwt : String)

        ShopLiveCommon.getAuthToken()->String?を使用して、ShopLiveでJWT認証を行います。JWT認証を行わない場合でも、通常の認証で生成されたトークン情報を取得します。

        ShopLiveCommon.getAuthToken() -> String?

        認証情報の初期化

        設定した認証情報を初期化します。

        ShopLiveCommon.clearAuth()

        ログイン認証

        JWT でログインし ているかどうかを判別します。

        if ShopLiveCommon.isLoggedIn() {
  // Do something
}

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

        UTM タグ(参照元 / メディア / キャンペーン / コンテンツ)をトラッキングできます。ログに記録された情報は、データインサイトで確認できます。

        • ShopLiveCommon.setUtmSource(utmSource: String)

        • ShopLiveCommon.setUtmMedium(utmMedium: String)

        • ShopLiveCommon.setUtmCampaign(utmCampaign: String)

        • ShopLiveCommon.setUtmContent(utmContent: String)

        func setUtmSource(utmSource: String?)
func setUtmMedium(utmMedium: String?)
func setUtmCampaign(utmCampaign: String?)
func setUtmContent(utmContent: String?)

        フィールド

        タイプ

        説明

        utmSource

        String?

        そのトラフィックが発生したソースを表します。

        utmMedium

        String?

        そのトラフィックが発生したメディアを表します。Googleは、流入につながったマーケティング手法を参照するためにmediumパラメータを設定することを推奨しています。(例:CPC、バナー、メール、ブログ、SNSなど)

        utmCampaign

        String?

        そのトラフィックが発生したキャンペーンを表します。これは、キャンペーン名、キャンペーン期間、キャンペーンコンテンツに分けることができます。

        utmContent

        String?

        そのトラフィックが発生したコンテンツ（投稿、広告など）を表します。これは、キャンペーンパラメータの細分化としてよく使用されます。

        サンプルコード

        ShopLiveCommon.setUtmSource(“{utm_source}”)
ShopLiveCommon.setUtmMedium(“{utm_medium}”)
ShopLiveCommon.setUtmCampaign(“{utm_campaign}”)
ShopLiveCommon.setUtmContent(“{utm_content}”)

        What's Next