getVisitorValues

これは、デフォルトで Analytics の識別子、ID サービス、データ収集オプトアウト、地域およびメタデータ「blob」コンテンツを返す非同期 API です。オプションの visitor.FIELDS 列挙を使用して、返される ID を制御することもできます。

内容:

構文

この関数は、次の構文を使用します(斜体は変数のプレースホルダーを表します): var *values* = visitor.getVisitorValues (callback, [visitor.FIELDS. *ID type*, visitor.FIELDS. *ID type*]);

関数パラメーターの詳細は次のとおりです。

  • *callback* は、返される ID を受け取るコールバックコードを表します。
  • (オプション) visitor.FIELDS. *ID type* は、この関数で返す必要がある ID 値を指定できる列挙です。

詳しくは、以下の使用例と定義を参照してください。

使用例 1:デフォルトデータセットのリクエスト

このコードは、標準データセットを返します。リクエストと応答は、次の例のようになります。

//Call the ID service 
var visitor = Visitor.getInstance ("Insert Experience Cloud organization ID here",{...}); 
   
//Add your callback to the GET method to return IDs and data. 
visitor.getVisitorValues(visitorIdsCallback);

デフォルトのサンプル応答では、デモ用に一部の値が短縮されています。

//Formatted IDs in JSON response 
{ 
    MCMID: 'mid-1234', 
    MCOPTOUT: 'isoptedout-true', 
    MCAID: 'aid-1234', 
    MCAAMLH: 7, 
    MCAAMB: 'hgfe54236786oygj' 
}

使用例 2:カスタムデータセットのリクエスト

このコードはオプションの配列を使用し、visitor.FIELDS 列挙を使用して特定の ID セットを返します。この場合、訪問者の Experience Cloud ID(MCID)と Analytics ID(MCAID)のみが必要です。リクエストと応答は、次の例のようになります。

//Call the ID service 
var visitor = Visitor.getInstance("Insert Experience Cloud organization ID here", { ... });

// Add an optional array to specify which IDs you want to return. 
visitor.getVisitorValues(visitorIdsCallback, [visitor.FIELDS.MCMID, visitor.FIELDS.MCAID]);

カスタマイズされたレスポンスの例では、リクエストで指定された ID のみが返されます。

//Formatted IDs in JSON response 
{ 
    MCMID: 'mid-1234', 
    MCAID: 'aid-4321' 
}

レスポンスパラメーターの定義

以下の表に、レスポンスパラメーターとその定義を示します。これらは visitor.FIELDS 列挙に含まれるすべての値でもあります。特定の変数に値がない場合、このメソッドは空の文字列を返すことに注意してください。

説明

MCAAMB

「blob」と呼ばれる、暗号化された Audience Manager メタデータです。

MCAAMLH

データ収集地域 ID です。これは、特定の ID サービスデータセンターの地理的場所を示す数値識別子です。

DCS 地域 ID、場所、ホスト名および getLocationHint を参照してください。

MCAID

訪問者の Analytics ID です。

MCMID

訪問者の Experience Cloud ID です。

Cookie と Experience Cloud Identity Service を参照してください。

MCOPTOUT

訪問者がデータ収集をオプトアウトしたかを示すフラグです。

以下の値が含まれます。

  • 'isoptedout-true':訪問者はデータ収集をオプトアウトしています。
  • 'isoptedout-false':訪問者はデータ収集をオプトアウトしていません。

このページ