Go SDK

go get github.com/Kameleoon/client-go/v3

import (
	kameleoon "github.com/Kameleoon/client-go/v3"
)

// 最初のオプション
config := &kameleoon.KameleoonClientConfig{
	Network: kameleoon.NetworkConfig{ // オプション
		ProxyURL:        "http://proxy-pass:1234/", // オプション
		DoTimeout:       10 * time.Second, // オプション
		ReadTimeout:     5 * time.Second, // オプション
		WriteTimeout:    5 * time.Second, // オプション
		MaxConnsPerHost: 10000, // オプション
	},
	ClientID:         "your-client-id", // このフィールドは必須です。ここに client_id を入力してください。
	ClientSecret:     "your-client-secret", // このフィールドは必須です。ここに client_secret を入力してください。
	TopLevelDomain:   "example.com", // このフィールドは強く推奨されます。指定しないとサブドメイン使用時に問題が生じる可能性があります。
	RefreshInterval:  time.Hour, // オプション(デフォルトは 60 分)
	TrackingInterval: time.Second, // オプション(デフォルトは 1000 ms)
	Environment:      "staging", // オプション
	SessionDuration:  30 * time.Minute, // オプション(デフォルトは 30 分)
    NetworkDomain:    "example.com", // オプション
}
client, err := KameleoonClientFactory.Create("your-project-sitecode", config)

// 2 番目のオプション
config, err := LoadConfig("/etc/kameleoon/client-go.yaml")
client, err := KameleoonClientFactory.Create("your-project-sitecode", config)
// 注意: 上記の例では、設定は毎回読み込まれます。一度だけ読み込むには、`CreateFromFile` を使用してください。

// 3 番目のオプション
client, err := KameleoonClientFactory.CreateFromFile("your-project-sitecode", "/etc/kameleoon/client-go.yaml")

// この例では、`91` は Kameleoon で一意の識別子として設定されたカスタムデータのインデックスを表します。
const MappingIndex = 91
const FeatureKey = "ff123"

// 1. 訪問者の認証前

// 認証されていない訪問者のバリエーションを取得します。
// `anonymousVisitorCode` がその訪問者にランダムに生成された ID であると仮定します。
anonymousVariation, err := kameleoonClient.GetVariation(anonymousVisitorCode, FeatureKey)

// 2. 訪問者の認証後

// `userId` が認証された訪問者の訪問者コードであると仮定します。
kameleoonClient.AddData(anonymousVisitorCode, types.NewCustomData(MappingIndex, userId))
err := kameleoonClient.FlushVisitorInstantly(anonymousVisitorCode)

// `userId` が一意の識別子であることを示します。
kameleoonClient.AddData(userId, types.NewUniqueIdentifier(true))

// 3. 訪問者が認証された後

// `userId` のバリエーションを取得します。匿名訪問者コードのバリエーションと一致します。
userVariation, err := kameleoonClient.GetVariation(userId, FeatureKey)
isSameVariation := userVariation.Key == anonymousVariation.Key // true

// `userId` と `anonymousVisitorCode` がリンクされ、単一の訪問者として追跡されます。
err := kameleoonClient.TrackConversionRevenue(userId, 123, 10.0)

// さらに、リンクされた訪問者は取得済みのリモート訪問者データをすべて共有します。
_, err := kameleoonClient.GetRemoteVisitorData(userId, true)

client.AddData(visitorCode, types.NewCustomData(index, "newVisitorCode"))

import (
	"development.kameleoon.net/sdk/go-sdk/v3/logging"
)

// `NONE` ログレベルではロギングが許可されません。
logging.SetLogLevel(logging.NONE)

// `ERROR` ログレベルでは、SDK の主要な動作に影響を与える可能性のある問題のみのロギングが許可されます。
logging.SetLogLevel(logging.ERROR)

// `WARNING` ログレベルでは、追加の注意が必要な問題のロギングが許可されます。
// `ERROR` ログレベルを拡張します。
// `WARNING` ログレベルがデフォルトのログレベルです。
logging.SetLogLevel(logging.WARNING)

// `INFO` ログレベルでは、SDK の内部プロセスに関する一般的な情報のロギングが許可されます。
// `WARNING` ログレベルを拡張します。
logging.SetLogLevel(logging.INFO)

// `DEBUG` レベルは SDK の内部プロセスに関する追加の詳細をログ出力し、`INFO` レベルを拡張し、
// よりきめ細かい診断出力を提供します。
// この情報はエンドユーザーが解釈することを意図したものではありませんが、内部のトラブルシューティングを
// 支援するためにサポートチームに送信できます。
logging.SetLogLevel(logging.DEBUG)

import (
    "development.kameleoon.net/sdk/go-sdk/v3/logging"
    "github.com/sirupsen/logrus"
)

type CustomLogger struct {
}

func NewCustomLogger() logging.LoggerWithLevel {
    return &CustomLogger{}
}

func (dl CustomLogger) Log(level logging.LogLevel, message string) {
    switch level {
    case logging.NONE:
    case logging.ERROR:
        logrus.Error(message)
    case logging.WARNING:
        logrus.Warn(message)
    case logging.INFO:
        logrus.Info(message)
    case logging.DEBUG:
        logrus.Debug(message)
    }
}


// ログレベルのフィルタリングはログ処理ロジックとは別に適用されます。
// カスタムロガーは、指定されたログレベル以上のログのみを受け付けます。
// ログレベルが正しく設定されていることを確認してください。
logging.SetLogLevel(logging.DEBUG) // オプション。デフォルトは `logging.WARNING`。
logging.SetLogger(NewCustomLogger())

const siteCode = "sitecode"
config := &kameleoon.KameleoonClientConfig{
	// ...
}

client, err := KameleoonClientFactory.Create(siteCode, config)

const siteCode = "sitecode"
client, err := KameleoonClientFactory.CreateFromFile(siteCode, "/etc/kameleoon/client-go.yaml")

const siteCode = "sitecode"
KameleoonClientFactory.Forget(siteCode)

err := client.WaitInit()
if err != nil {
	// クライアントが正しく初期化されませんでした
	fmt.Println(err)
} else {
	// SDK が初期化されました。ここで機能フラグ/実験設定を取得できます。
}

const featureKey = "new_checkout"

// 機能フラグがアクティブ(ON / OFF)かをチェック
hasNewCheckout, err := client.IsFeatureActive(visitorCode, featureKey)
// トラッキングを無効化
hasNewCheckout, err := client.IsFeatureActiveWithTracking(visitorCode, featureKey, false)

if err != nil {
	switch err.(type) {
	case *errs.VisitorCodeInvalid:
		// 提供された訪問者コードが無効です。この訪問者には古いチェックアウトをトリガーします。
		hasNewCheckout = false
	case *errs.FeatureConfigNotFound:
		// SDK が取得した設定ファイルにまだ機能キーが存在しません。この訪問者には古いチェックアウトをトリガーします。
		hasNewCheckout = false
	default:
		// 予期しないエラーを処理
		panic(err)
	}
}
if hasNewCheckout {
	// 新しいチェックアウトのコードをここに実装
}

const featureKey = "new_checkout"

variation, err := client.GetVariation(visitorCode, featureKey)
// トラッキングを無効化
variation, err := client.GetVariation(visitorCode, featureKey, NewGetVariationOptParams().Track(false))

if err != nil {
	// エラー処理
}

// 割り当てられたバリエーションの変数値を取得
title := variation.Variables["title"].Value

switch (variation.Key) {
	case "on":
		// メインバリエーションキーが visitorCode に対して選択されています
	case "alternative_variation":
		// 代替バリエーションキー
	default:
		// デフォルトバリエーションキー
}

variations, err := client.GetVariations(visitorCode)
// すべてのアクティブなバリエーション
variations, err := client.GetVariations(visitorCode, NewGetVariationsOptParams().OnlyActive(true))
// トラッキングを無効化
variations, err := client.GetVariations(visitorCode, NewGetVariationsOptParams().Track(false))

if err != nil {
	// エラー処理
}

const experimentId = 9516

// 訪問者に対して実験 9516 でバリエーション "on" を強制します。
err := client.SetForcedVariation(visitorCode, experimentId, "on")

// 実験中にセグメンテーションとターゲティング条件を保持しながらバリエーション "on" を強制します。
err := client.SetForcedVariation(
    visitorCode, experimentId, "on", NewSetForcedVariationOptParams().ForceTargeting(false),
)

// 訪問者に対して実験 9516 の強制バリエーションをリセットします。
err := client.SetForcedVariation(visitorCode, experimentId, "")

if err != nil {
    // エラー処理
}

if err := client.EvaluateAudiences(visitorCode); err != nil {
    // エラー処理
}

dataFile := client.GetDataFile()

visitorCode, err := client.GetVisitorCode(req, resp)

visitorCode, err := client.GetVisitorCode(req, resp, "defaultVisitorCode")

import (
	"github.com/Kameleoon/client-go/v3/types"
)
// 単一のデータ項目を追加(デフォルトでトラッキング)
client.AddData(visitorCode, types.NewBrowser(types.BrowserTypeChrome))

// 複数のデータ項目を追加(デフォルトでトラッキング)
client.AddData(visitorCode,
    types.NewPageViewWithTitle("https://url.com", "title", 3),
    types.UserAgent("UserAgent"),
)

// 複数のデータ項目をターゲティングのみのためにローカルに保存(Kameleoon Data API には送信されません)
client.AddDataWithOptParams(
    visitorCode,
    NewAddDataOptParams().Track(false),
    types.NewPageViewWithTitle("https://url.com", "title", 3),
    types.UserAgent("UserAgent")
)

import (
	"github.com/Kameleoon/client-go/v3/types"
)

visitorCode, err := client.GetVisitorCode(req, resp)

client.AddData(visitorCode, types.NewBrowser(types.BrowserTypeChrome))
client.AddData(visitorCode, types.NewConversionWithRevenue(32, 10, false))

client.FlushVisitor(visitorCode) // 間隔トラッキング(最もパフォーマンスの高いトラッキング方法)
client.FlushAll() // すべての訪問者の未送信データに対する間隔トラッキング

client.FlushVisitorInstantly(visitorCode) // 即時トラッキング
client.FlushAll(true) // すべての訪問者の未送信データに対する即時トラッキング

// 一意の ID で操作する場合
client.AddData(types.NewUniqueIdentifier(true))
client.FlushVisitor(visitorCode)

type Test1 struct {
	Value string `json:"some field to insert or update"`
}

remoteData, err := s.client.GetRemoteData("USER_ID") // デフォルトタイムアウトを使用
var test1 Test1
err = json.Unmarshal(remoteData, &test1)

remoteData, err := s.client.GetRemoteData("USER_ID", 1000)

// Mixpanel コホートを取得して使用
type Cohort struct {
	Id        string `json:"mixpanel_cohort_id"`
	Name      string `json:"mixpanel_cohort_name"`
	ProjectId string `json:"mixpanel_cohort_project_id"`
}

type MixPanelCohorts struct {
	Cohorts []Cohort `json:"mixpanel_cohorts"`
}

remoteData, err := s.client.GetRemoteData("USER_ID")
var mixPanel MixPanelCohorts
if err = json.Unmarshal(remoteData, &mixPanel); err == nil {
	cohorts := make([]string, len(mixPanel.Cohorts))
	for _, cohort := range mixPanel.Cohorts {
		cohorts = append(cohorts, cohort.Id)
	}
	client.AddData(visitorCode, types.NewCustomData(customDataIndex, cohorts...))
}

visitorCode := "visitorCode"
var visitorData []types.Data
var err error

// 訪問者データが取得され、`visitorCode` に自動的に追加されます
visitorData, err = client.GetRemoteVisitorData(visitorCode, true) // デフォルトタイムアウトが使用されます
visitorData, err = client.GetRemoteVisitorData(visitorCode, true, time.Second) // 1000 ミリ秒のタイムアウト

// データを取得して手動で追加したい場合のみ、`addData` を `false` に設定します。
visitorData, err = client.GetRemoteVisitorData(visitorCode, false) // デフォルトタイムアウトが使用されます
visitorData, err = client.GetRemoteVisitorData(visitorCode, false, time.Second) // 1000 ミリ秒のタイムアウト

// 一意の ID で操作する場合
client.AddData(types.NewUniqueIdentifier(true))
visitorData, err = client.GetRemoteVisitorData(visitorCode, true)

// カスタムリストのデータ型を取得したい場合
var visitorData = client.GetRemoteVisitorDataWithFilter(
    visitorCode,
    true,
    types.RemoteVisitorDataFilter{PreviousVisitAmount: 10, CustomData: true, Conversion: true, Experiments: true},
    // デフォルトタイムアウトが使用されます
)
// または
var visitorData = client.GetRemoteVisitorDataWithFilter(
    visitorCode,
    true,
    types.RemoteVisitorDataFilter{PreviousVisitAmount: 10, CustomData: true, Conversion: true, Experiments: true},
    time.Second, // 1000 ミリ秒のタイムアウト
)

customData, err = client.GetVisitorWarehouseAudience(VisitorWarehouseAudienceParams{
    VisitorCode:     "visitorCode",
    CustomDataIndex: 10,
    WarehouseKey:    "warehouseKey", // オプション
    Timeout:         5 * time.Second, // オプション
})

customData, err = c.GetVisitorWarehouseAudienceWithOptParams(
    "visitorCode", 10, VisitorWarehouseAudienceOptParams{WarehouseKey: "warehouseKey", Timeout: 5 * time.Second})

visitorCode, err := kameleoonClient.GetVisitorCode(req, resp)

err := kameleoonClient.SetLegalConsent(visitorCode, true, resp)

import (
	"github.com/Kameleoon/client-go/v3/types"
)

const goalID = 83023

client.TrackConversion(visitorCode, goalID)

client.TrackConversionRevenue(visitorCode, goalID, 10.0)

// メタデータを追加
client.TrackConversionWithOptParams(visitorCode, goalID, TrackConversionOptParams{
    Metadata: []*types.CustomData{
        types.NewCustomData(3, "metadata1", "md2"),
        types.NewCustomData(5, "md3")
    },
})

engineTrackingCode := kameleoonClient.GetEngineTrackingCode(visitorCode)

kameleoonClient.OnUpdateConfiguration(
	// 設定が更新されました
)

client.AddData(visitorCode, types.NewBrowser(types.BrowserTypeChrome))

client.AddData(visitorCode, types.NewBrowser(types.BrowserTypeSafari, 16.0))

client.AddData(visitorCode, types.NewConversion(32, true))

client.AddData(visitorCode, types.NewConversionWithRevenue(33, 10.0, false))

client.AddData(
    visitorCode,
    types.NewConversionWithOptParams(34, types.ConversionOptParams{
        Revenue: 5.0,
        Metadata: []*types.CustomData{
            types.NewCustomData(3, "metadata1", "md2"),
            types.NewCustomData(5, "md3"),
        },
    }),
)

client.AddData(visitorCode, types.NewConversion(32, false))

client.AddData(visitorCode, types.NewConversionWithRevenue(32, 10, false))

cookie := types.NewCookie(map[string]string{
  "k1": "v1",
  "k2": "v2",
})
client.AddData(visitorCode, cookie)

client.AddData(visitorCode, types.NewGeolocation("France", "Île-de-France", "Paris"))

client.AddData(visitorCode, types.NewGeolocationWithCoords(48.856667, 2.352222, "France", "Île-de-France", "Paris"))

client.AddData(visitorCode, types.NewCustomData(1, "value"))

// 複数の値で
client.AddData(visitorCode, types.NewCustomData(1, "value1", "value2"))

// 'overwrite' フラグを false に設定するには
client.AddData(
    visitorCode,
    types.NewCustomDataWithOptParams(1, NewCustomDataOptParams().Overwrite(false), "value"),
)

// インデックスの代わりに名前を使用するには
client.AddData(visitorCode, types.NewNamedCustomData("my-custom-data", "value"))

// インデックスの代わりに名前を使用し、
// 'overwrite' フラグを false に設定するには
client.AddData(
    visitorCode,
    types.NewNamedCustomDataWithOptParams("my-custom-data", NewCustomDataOptParams().Overwrite(false), "value"),
)

client.AddData(visitorCode, types.NewDevice(types.DeviceTypeDesktop))

client.AddData(visitorCode, types.NewOperatingSystem(types.OperatingSystemTypeWindows))

client.AddData(visitorCode, types.NewPageView("https://url.com", 3))

client.AddData(visitorCode, types.NewPageViewWithTitle("https://url.com", "title", 3))

client.AddData(visitorCode, types.NewUserAgent("visitor_user_agent"))

client.AddData(visitorCode, types.NewUniqueIdentifier(true))

client.AddData(visitorCode, types.NewApplicationVersion("10")) // major

client.AddData(visitorCode, types.NewApplicationVersion("10.20")) // major.minor

client.AddData(visitorCode, types.NewApplicationVersion("10.20.30")) // major.minor.patch

// DataFile から機能フラグのマップを取得します。
// マップは機能フラグの識別子をキーとし、各値は FeatureFlag オブジェクトです。
featureFlags := dataFile.FeatureFlags

// DataFile の最終変更タイムスタンプを取得します。
// 値は Unix エポックからのミリ秒を表す int64 です。
dateModified := dataFile.DateModified

// 現在の環境で機能フラグが有効かを確認
isEnvironmentEnabled := featureFlag.IsEnvironmentEnabled

// デフォルトバリエーションのキーを取得
defaultVariationKey = featureFlag.DefaultVariationKey

// デフォルトバリエーションオブジェクトを取得
defaultVariation := featureFlag.DefaultVariation()

// 機能フラグのすべてのバリエーションをマップとして取得(キー = バリエーションキー、値 = Variation オブジェクト)
variations := featureFlag.Variations

// 機能フラグに関連付けられたすべてのターゲティングルールを取得
rules := featureFlag.Rules

// ルールのすべてのバリエーションをマップとして取得(キー = バリエーションキー、値 = Variation オブジェクト)
variations := rule.Variations

// バリエーション名を取得
var variationName string = variation.Name

// バリエーションキーを取得
var variationKey string = variation.Key

// バリエーション ID を取得
var variationID *int = variation.VariationID

// 実験 ID を取得
var experimentID *int = variation.ExperimentID

// 変数マップを取得
var variables map[string]Variable = variation.Variables

// 変数マップを取得
var variables map[string]Variable = variation.Variables

// 変数の型は、後続の処理のために取得できます
var variableType string = variables["isDiscount"].Type

// キーで変数の値を取得
var isDiscount bool = variables["isDiscount"].Value.(bool)

// 変数の値はさまざまな型である可能性があります
var title string = variables["title"].Value.(string)

// バリエーションのある機能実験
const variationKey = ""

if variationKey, err := s.client.GetFeatureVariationKey(visitorCode, featureKey); err == nil {
	switch variationKey {
	case "variation 1":
		// 訪問者はバリエーション 1 キーでバケッティングされました。
	case "variation 2":
		// 訪問者はバリエーション 2 キーでバケッティングされました。
	default:
		// 訪問者はデフォルトバリエーションでバケッティングされたか、未割り当てのトラフィックサンプルの一部です。
	}
} else {
	// エラーが発生しました。SDK によって取得された現在の設定で機能フラグキーが見つかりません。
}

arrayFeatureFlagKeys, err := client.GetActiveFeatureListForVisitor(visitorCode)

activeFeatures, err := client.GetActiveFeatures(visitorCode)

visitorCode, err := client.GetVisitorCode(req, resp)
featureKey := "featureKey"
variableKey = "variableKey"

if variableValue, err := s.client.GetFeatureVariable(visitorCode, featureKey, variableKey); err == nil {
	// variableValue に応じたカスタムコード
} else {
	// エラーが発生しました。SDK によって取得された現在の設定で機能フラグが見つかりません。
}

featureKey := "test_feature_variables"
variationKey := "on"

if allVariables, err := s.client.GetFeatureVariationVariables(featureKey, variationKey); err == nil {
	// カスタムコード
} else {
	// エラーが発生しました。機能フラグまたはバリエーションがクライアント設定に存在しません
}

arrayFeatureKeys := client.GetFeatureList()