オーディエンスエンドポイント
オーディエンスとは、類似の行動や特徴を共有する人々の集まりのことです。 これらの人物のコレクションは、Adobe Experience Platformを使用するか、外部ソースから生成できます。 セグメント APIで/audiences エンドポイントを使用できます。これにより、オーディエンスをプログラムで取得、作成、更新、削除できます。
はじめに
このガイドで使用されているエンドポイントは、Adobe Experience Platform Segmentation Service APIの一部です。 続行する前に、必須ヘッダーやサンプル API呼び出しの読み取り方法など、APIへの呼び出しを正常に行うために知っておく必要がある重要な情報については、入門ガイド を確認してください。
オーディエンスのリストの取得 list
/audiences エンドポイントに対してGET リクエストを行うことで、組織のすべてのオーディエンスのリストを取得できます。
API 形式
/audiences エンドポイントは、結果を絞り込むのに役立つ、複数のクエリパラメーターをサポートしています。これらのパラメーターはオプションですが、リソースのリスト時にコストのかかるオーバーヘッドを減らすために、使用を強くお勧めします。 パラメーターを指定せずにこのエンドポイントを呼び出すと、組織で使用可能なすべてのオーディエンスが取得されます。 複数のパラメーターを使用する場合は、アンパサンド(&)で区切ります。
GET /audiences
GET /audiences?{QUERY_PARAMETERS}
property=audienceId クエリパラメーターと組み合わせて使用すると、非アクティブなオーディエンス が返されます。オーディエンスのリストを取得する際には、次のクエリパラメーターを使用できます。
startstart=5limitlimit=10sortattributeName:[desc/asc]形式で記述されています。sort=updateTime:descpropertyproperty=形式で記述されていますproperty=audienceId==test-audience-idnamename=Sampledescriptiondescription=Test DescriptionentityTypeentityType=_xdm.context.accountリクエスト
次のリクエストは、組織で作成された最後の2つのオーディエンスを取得します。
| code language-shell |
|---|
|
応答
応答が成功すると、HTTP ステータス 200が返され、組織内でJSONとして作成されたオーディエンスのリストが表示されます。
| code language-json |
|---|
|
| table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 6-row-3 7-row-3 8-row-3 9-row-3 10-row-3 11-row-3 12-row-3 13-row-3 14-row-3 15-row-3 16-row-3 17-row-3 18-row-3 | ||
|---|---|---|
| プロパティ | オーディエンスタイプ | 説明 |
id |
両方 | オーディエンスのシステム生成の読み取り専用ID。 |
audienceId |
両方 | オーディエンスがプラットフォームで生成されたオーディエンスの場合、これはidと同じ値です。 オーディエンスが外部で生成された場合、この値はクライアントから提供されます。 |
schema |
両方 | オーディエンスのExperience Data Model (XDM)スキーマ。 |
imsOrgId |
両方 | オーディエンスが属する組織のID。 |
sandbox |
両方 | オーディエンスが属するサンドボックスに関する情報。 サンドボックスの詳細については、 サンドボックスの概要を参照してください。 |
name |
両方 | オーディエンスの名前。 |
description |
両方 | オーディエンスの説明。 |
expression |
プラットフォーム生成 | Profile Query Language(PQL)のオーディエンスの表現。 PQL式の詳細については、PQL式ガイド を参照してください。 |
mergePolicyId |
プラットフォーム生成 | オーディエンスが関連付けられている結合ポリシーのID。 結合ポリシーについて詳しくは、結合ポリシーガイドを参照してください。 |
evaluationInfo |
プラットフォーム生成 | オーディエンスがどのように評価されるかを示します。 評価方法として、バッチ、同期(ストリーミング)、連続(エッジ)などがあります。 評価方法の詳細については、 セグメント化の概要を参照してください |
dependents |
両方 | 現在のオーディエンスに依存するオーディエンス IDの配列。 これは、セグメントのセグメントであるオーディエンスを作成する場合に使用されます。 |
dependencies |
両方 | オーディエンスが依存するオーディエンス IDの配列。 これは、セグメントのセグメントであるオーディエンスを作成する場合に使用されます。 |
type |
両方 | オーディエンスがプラットフォーム生成のオーディエンスか、外部で生成されたオーディエンスかを表示するシステム生成フィールド。 指定できる値はSegmentDefinitionとExternalSegmentです。 SegmentDefinitionはPlatformで生成されたオーディエンスを表し、ExternalSegmentはPlatformで生成されなかったオーディエンスを表します。 |
originName |
両方 | オーディエンスのオリジンの名前を参照するフィールド。 Platformで生成されたオーディエンスの場合、この値はREAL_TIME_CUSTOMER_PROFILEになります。 Audience Orchestrationで生成されたオーディエンスの場合、この値はAUDIENCE_ORCHESTRATIONになります。 Adobe Audience Managerで生成されたオーディエンスの場合、この値はAUDIENCE_MANAGERになります。 その他の外部生成オーディエンスの場合、この値はCUSTOM_UPLOADになります。 |
createdBy |
両方 | オーディエンスを作成したユーザーのID |
labels |
両方 | オーディエンスに関連する、オブジェクトレベルのデータ使用ラベルと属性ベースのアクセス制御ラベル。 |
namespace |
両方 | オーディエンスが属する名前空間。 指定できる値は、AAM、AAMSegments、AAMTraits、AEPSegmentsです。 |
linkedAudienceRef |
両方 | 他のオーディエンス関連システムの識別子を含むオブジェクト。 |
新しいオーディエンスの作成 create
/audiences エンドポイントにPOST リクエストを行うことで、新しいオーディエンスを作成できます。
API 形式
POST /audiences
リクエスト
| code language-shell |
|---|
|
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 | |
|---|---|
| プロパティ | 説明 |
name |
オーディエンスの名前。 |
description |
オーディエンスの説明。 |
type |
オーディエンスがプラットフォーム生成のオーディエンスか、外部で生成されたオーディエンスかを表示するフィールド。 指定できる値はSegmentDefinitionとExternalSegmentです。 SegmentDefinitionはPlatformで生成されたオーディエンスを表し、ExternalSegmentはPlatformで生成されなかったオーディエンスを表します。 |
expression |
Profile Query Language(PQL)のオーディエンスの表現。 PQL式の詳細については、PQL式ガイド を参照してください。 |
schema |
オーディエンスのExperience Data Model (XDM)スキーマ。 |
labels |
オーディエンスに関連する、オブジェクトレベルのデータ使用ラベルと属性ベースのアクセス制御ラベル。 |
応答
応答が成功すると、HTTP ステータス 200が返され、新しく作成したオーディエンスに関する情報が表示されます。
| code language-json |
|---|
|
指定したオーディエンスの検索 get
/audiences エンドポイントに対してGET リクエストを行い、取得するオーディエンスのIDをリクエストパスで指定することで、特定のオーディエンスに関する詳細な情報を検索できます。
API 形式
GET /audiences/{AUDIENCE_ID}
{AUDIENCE_ID}id フィールドであり、フィールドのではなくaudienceIdであることに注意してください。リクエスト
| code language-shell |
|---|
|
応答
応答が成功すると、HTTP ステータス 200が返され、指定されたオーディエンスに関する情報が返されます。
| code language-json |
|---|
|
オーディエンスの上書き put
特定のオーディエンスを更新(上書き)するには、/audiences エンドポイントに対してPUT リクエストを行い、更新するオーディエンスのIDをリクエストパスで指定します。
API 形式
PUT /audiences/{AUDIENCE_ID}
{AUDIENCE_ID}id フィールドであり、フィールドのではなくaudienceIdであることに注意してください。リクエスト
| code language-shell |
|---|
|
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 | |
|---|---|
| プロパティ | 説明 |
audienceId |
オーディエンスのID。 外部で生成されたオーディエンスの場合、この値はユーザーから提供される場合があります。 |
name |
オーディエンスの名前。 |
namespace |
オーディエンスの名前空間。 |
description |
オーディエンスの説明。 |
type |
オーディエンスがプラットフォーム生成のオーディエンスか、外部で生成されたオーディエンスかを表示するシステム生成フィールド。 指定できる値はSegmentDefinitionとExternalSegmentです。 SegmentDefinitionはExperience Platformで生成されたオーディエンスを表し、ExternalSegmentはExperience Platformで生成されなかったオーディエンスを表します。 |
expression |
オーディエンスのPQL式を含むオブジェクト。 |
lifecycleState |
オーディエンスのステータス。使用可能な値には、draft、publishedおよびinactiveが含まれます。 draftは、オーディエンスが作成された時点、オーディエンスが公開された時点でpublished、オーディエンスがアクティブでなくなった時点でinactiveを表します。 |
datasetId |
オーディエンスデータが見つかるデータセットのID。 |
labels |
オーディエンスに関連する、オブジェクトレベルのデータ使用ラベルと属性ベースのアクセス制御ラベル。 |
応答
応答が成功すると、HTTP ステータス 200が返され、新しく更新されたオーディエンスの詳細が表示されます。 オーディエンスの詳細は、Experience Platformで生成されたオーディエンスであるか、外部で生成されたオーディエンスであるかによって異なります。
| code language-json |
|---|
|
オーディエンスの更新 patch
特定のオーディエンスを更新するには、/audiences エンドポイントに対してPATCH リクエストを行い、更新するオーディエンスのIDをリクエストパスで指定します。
API 形式
PATCH /audiences/{AUDIENCE_ID}
{AUDIENCE_ID}id フィールドであり、フィールドのではなくaudienceIdであることに注意してください。リクエスト
| code language-shell |
|---|
|
| table 0-row-2 1-row-2 2-row-2 3-row-2 | |
|---|---|
| プロパティ | 説明 |
op |
実行されたPATCH操作の種類。 このエンドポイントでは、この値は常に /addです。 |
path |
更新するフィールドのパス。 id、audienceId、namespace、などのシステム生成フィールドは編集できません。 |
value |
pathで指定されたプロパティに割り当てられた新しい値。 |
応答
応答が成功すると、更新されたオーディエンスを含むHTTP ステータス 200が返されます。
| code language-json |
|---|
|
オーディエンスの削除 delete
特定のオーディエンスを削除するには、/audiences エンドポイントに対してDELETE リクエストを行い、削除するオーディエンスのIDをリクエストパスで指定します。
API 形式
DELETE /audiences/{AUDIENCE_ID}
{AUDIENCE_ID}id フィールドであり、フィールドのではなくaudienceIdであることに注意してください。リクエスト
| code language-shell |
|---|
|
応答
リクエストが成功した場合、HTTP ステータス 204 が返され、メッセージは返されません。
複数のオーディエンスの取得 bulk-get
/audiences/bulk-get エンドポイントにPOST リクエストを行い、取得するオーディエンスのIDを指定することで、複数のオーディエンスを取得できます。
API 形式
POST /audiences/bulk-get
リクエスト
| code language-shell |
|---|
|
応答
応答が成功すると、HTTP ステータス 207が、リクエストされたオーディエンスの情報とともに返されます。
| code language-json |
|---|
|
次の手順
このガイドでは、Adobe Experience Platform APIを使用してオーディエンスを作成、管理、削除する方法について解説します。 UIを使用したオーディエンス管理について詳しくは、 セグメント化UI ガイド を参照してください。