Group Identify API

地域

ベースURLは、プロジェクトのデータのレジデンシーによって異なります。このページ内のすべての例では、プロジェクトがAmplitudeのEUデータセンターを利用している場合を除き、デフォルトのベースURLを使用してください。EUデータセンターを利用している場合は、この表に記載されているEU用のベースURLを使用してください。

このAPIでは、イベント取り込みのホストとしてapi2.amplitude.com（デフォルト）またはapi.eu.amplitude.com（EU）が使用されます。他のAmplitude APIでは、別のホスト名（api.amplitude.com、core.amplitude.com、data-api.amplitude.com、experiment.amplitude.comなど）が使用されます。https://analytics.amplitude.comのホスト名は、アナリティクスWebアプリ（ブラウザーUI）であり、取り込みのエンドポイントではありません。

データのレジデンシー	ベースURL
デフォルト	`https://api2.amplitude.com`
欧州連合	`https://api.eu.amplitude.com`

考慮事項

更新は将来のイベントにのみ影響を与え、過去のイベントを更新することはありません。
イベントごとに最大5つの固有のグループタイプと合計10個のグループを追跡できます。
リクエストあたりのグループIDの最大数は1024です。
リクエストあたりのグループプロパティの最大数は1024です。
リクエストあたりの最大バイトサイズは1MBです。

リクエスト

グループプロパティを設定または更新します。

POST https://api2.amplitude.com/groupidentify

curl --location --request POST '<https://api2.amplitude.com/groupidentify>' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'api_key=<API_KEY>' \
--data-urlencode 'identification=[{"group_properties":{"org csm":"Lucas","org plan":"Enterprise","org owner":"Luis"},"group_type":"Seller","group_value":"12345678"}]'

必要なパラメータ

名前	概要
`api_key`	プロジェクトのAPIキー。
`identification`	単一のJSON識別オブジェクトまたはそれぞれが1つの識別情報を表すJSONオブジェクトの配列のいずれかです。

識別のパラメータキー

キー	タイプ	概要	例
`group_type`	文字列	グループのタイプ。	`"org name"`、`"org id"`
`group_value`	文字列	`group_type`の1つの特定の値です。	`"group_type":"org id","group_value":"12345678"`または`"group_type":"account name","group_value":"Acme Corp"`
`group_properties`	オブジェクト	グループに関連付けられたデータを表すキーと値のペアの辞書。それぞれの異なる値は、Amplitudeダッシュボードにグループセグメントとして表示されます。プロパティ値は配列に格納できます。 Amplitudeは日付値を文字列値に変換します。次の操作表を参照してください。	`{"arr": "10000", "cs": ["Justin", "Ben"], "renewal_date": "01/01/2018"}`

group_propertiesは次の操作をサポートしています。

操作	概要
`$set`	プロパティの値を設定します。
`$setOnce`	プロパティの値を設定し、プロパティ値を上書きしないようにします。
`$add`	数値プロパティに数値を追加します。
`$append and $prepend`	グループプロパティ配列の前後に値を追加します。
`$unset`	プロパティを削除します。

ステータスコード

コード	メッセージ
200	成功
400	無効なリクエストです。詳細についてはエラーメッセージを参照してください。

これは役に立ちましたか？