iOS SDK - グローバル・プロパティの設定

フォローする
Avatar
Jared Ornstead
Updated
ドキュメント

グローバルプロパティの設定

Singular SDKでは、アプリから送信されるすべてのセッションやイベントと一緒にSingularサーバーに送信されるカスタムプロパティを定義することができます。これらのプロパティは、ユーザーやアプリのモード/ステータスなど、あらゆる情報を表すことができます。

グローバルプロパティは5つまで定義できます。これらのグローバルプロパティは、アプリが実行される間、あなたが設定を解除するか、ユーザーがアプリをアンインストールするまで（あなたが設定した最新の値で）保持されます。

使用例

グローバル・プロパティの使用例としては、以下のようなものがあります：

  • サードパーティのSDKから識別子を渡し、Singularからそのサードパーティへのポストバックでマッチング目的で使用します。
  • ゲームアプリでは、"Level "というプロパティを定義し、初期値を "0 "に設定することができます。アプリから送信されるセッションやイベントはすべて、"Level"："0".ユーザーがレベルアップすると、プロパティは "1 "にリセットされます。

注意事項

  • グローバルプロパティは現在、Singularのユーザーレベルのイベントログ（属性ログのエクスポートを参照）とポストバックに反映されます。Singularの集計レポート（レポートページまたはレポートAPI）でのグローバルプロパティのサポートは将来追加される予定です。この機能についてご質問がある場合、またはグローバルプロパティサポートのアップデートにご興味がある場合は、Singularカスタマーサクセスマネージャーまでお問い合わせください。
  • 各プロパティ名と値の長さは200文字までです。それ以上のプロパティ名や値を渡すと、200文字に切り詰められます。

コンフィグオブジェクトによるグローバルプロパティの設定

SDKを初期化する前にグローバル・プロパティを設定するには、ConfigオブジェクトのsetGlobalPropertyメソッドを使用します。

グローバル・プロパティとその値はアプリの実行間で持続するため、設定するプロパティがすでに別の値に設定されている可能性があることに注意してください。既存のプロパティを新しい値で上書きするかどうかをSDKに指示するには、overrideExistingパラメータを使用します。

setGlobalProperty メソッド
説明 グローバル プロパティを設定します。
シグネチャ (void)setGlobalProperty:(NSString*)key withValue:(NSString*)value overrideExisting:(BOOL)overrideExisiting；
使用例
SwiftObjective-C 
func getConfig() -> SingularConfig? {         
  // (Optional) Get 3rd-party identifiers to set in Global Properties:     


  // If 3rd-party SDKs are providing any identifiers to Singular, the


  // respective SDK must be initialized before Singular.     


  let thirdPartyKey = "anonymousID"     
  let thirdPartyID = "2ed20738-059d-42b5-ab80-5aa0c530e3e1"     
  
  // Singular Config Options     


  guard let config = SingularConfig(apiKey: Constants.APIKEY, 
    andSecret: Constants.SECRET) else {
      return nil
      }
  //...     
  // Using Singular Global Properties feature to capture third party identifiers


  config.setGlobalProperty(thirdPartyKey, withValue: thirdPartyID, overrideExisting: true)     
  //...
  return config 
}

初期化後のグローバル・プロパティの設定

以下のメソッドを使用して、アプリの実行中にいつでもグローバル・プロパティを設定、解除、取得できます。

注意事項

  • プロパティがまだ存在せず、他のグローバル・プロパティが既に5つ存在する場合、プロパティは追加されません。
  • プロパティが既に設定されている場合、overrideExisting パラメータは、既存の値をオーバーライドするかどうかを決定します。
  • このメソッドは、プロパティが正常に設定された場合は true を返し、そうでない場合は false を返します。
setGlobalProperty メソッド
説明 グローバル・プロパティを指定された値に設定します。
シグニチャ (BOOL) setGlobalProperty:(NSString*)key andValue:(NSString*)value overrideExisting:(BOOL)overrideExisting
使用例
SwiftObjective-C 
var result = Singular.setGlobalProperty("propertyName",
  andValue: "propertyValue", overrideExisting: true)
getGlobalProperties メソッド
説明 すべてのグローバル・プロパティとその現在の値を Map として取得します。
シグネチャ NSDictionary*) getGlobalProperties
使用例
SwiftObjective-C 
var globalProperties = Singular.getGlobalProperties()
unsetGlobalProperty メソッド
説明 グローバル・プロパティを削除します。
シグネチャ (void) unsetGlobalProperty:(NSString*)key
使用例
SwiftObjective-C 
Singular.unsetGlobalProperty("propertyName")
clearGlobalProperties メソッド
説明 すべてのグローバル・プロパティを削除する。
シグネチャ (void) clearGlobalProperties
使用例
SwiftObjective-C 
Singular.clearGlobalProperties()