受眾端點
對象是具有相同類似行為和/或特徵的人集合。 這些人員集合可透過使用Adobe Experience Platform或外部來源產生。 您可以使用 /audiences
區段API中的端點,可讓您以程式設計方式擷取、建立、更新和刪除對象。
快速入門
本指南中使用的端點屬於 Adobe Experience Platform Segmentation Service API。 在繼續之前,請檢閱 快速入門手冊 如需成功呼叫API所需的重要資訊,包括必要的標題以及如何讀取範例API呼叫。
擷取對象清單 list
您可以透過向以下網站發出GET請求,擷取貴組織的所有對象清單: /audiences
端點。
API格式
此 /audiences
端點支援數個查詢引數,以協助篩選結果。 雖然這些引數是選用的,但強烈建議使用這些引數,以幫助在列出資源時減少昂貴的額外負荷。 如果您不使用引數呼叫此端點,則會擷取貴組織可用的所有對象。 可包含多個引數,以&符號(&
)。
GET /audiences
GET /audiences?{QUERY_PARAMETERS}
擷取對象清單時,可以使用以下查詢引數:
start
start=5
limit
limit=10
sort
attributeName:[desc/asc]
.sort=updateTime:desc
property
property=
property=audienceId==test-audience-id
name
name=Sample
description
description=Test Description
要求
以下請求會擷取貴組織中建立的最後兩個對象。
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 |
兩者 | 適用於對象的系統產生唯讀識別碼。 |
audienceId |
兩者 | 如果對象是平台產生的對象,此值與 id . 如果對象是外部產生的,此值由使用者端提供。 |
schema |
兩者 | 對象的Experience Data Model (XDM)結構。 |
imsOrgId |
兩者 | 對象所屬組織的ID。 |
sandbox |
兩者 | 有關受眾所屬沙箱的資訊。 有關沙箱的更多資訊可在以下連結中找到: 沙箱總覽. |
name |
兩者 | 對象名稱。 |
description |
兩者 | 對象說明。 |
expression |
平台產生 | 對象的設定檔查詢語言(PQL)運算式。 如需PQL運算式的詳細資訊,請參閱 PQL運算式指南. |
mergePolicyId |
平台產生 | 與對象相關聯的合併原則ID。 有關合併原則的更多資訊可在以下網址找到: 合併原則指南. |
evaluationInfo |
平台產生 | 顯示評估對象的方式。 可能的評估方法包括批次、同步(串流)或連續(邊緣)。 有關評估方法的詳細資訊,請參閱 分段總覽 |
dependents |
兩者 | 相依於目前受眾的受眾ID陣列。 如果您建立的對象是區段的區段,就會使用此屬性。 |
dependencies |
兩者 | 對象所依賴的對象ID陣列。 如果您建立的對象是區段的區段,就會使用此屬性。 |
type |
兩者 | 系統產生的欄位,顯示對象是平台產生的還是外部產生的對象。 可能的值包括 SegmentDefinition 和 ExternalSegment . A SegmentDefinition 是指在Platform中產生的對象,而 ExternalSegment 是指不是在Platform中產生的對象。 |
originName |
兩者 | 參照對象來源名稱的欄位。 對於平台產生的對象,此值將為 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
您可以透過向以下傳送POST請求來建立新對象: /audiences
端點。
API格式
POST /audiences
要求
accordion | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
用於建立平台產生對象的範例請求 | ||||||||||||||||||||
|
accordion | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
建立外部產生對象的範例要求 | ||||||||||||||||||||||||||||
|
回應
成功的回應會傳回HTTP狀態200,其中包含您新建立之對象的相關資訊。
accordion | ||
---|---|---|
擷取平台產生的對象時的範例回應。 | ||
|
accordion | ||
---|---|---|
擷取外部產生的對象時的範例回應。 | ||
|
更新對象中的欄位 update-field
您可以透過向以下連結發出PATCH請求,更新特定對象的欄位: /audiences
端點,並提供您要在請求路徑中更新的對象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 |
若要更新對象,此值一律為 add . |
path |
您要更新的欄位路徑。 |
value |
您要更新欄位的值。 |
回應
成功的回應會傳回HTTP狀態200,其中包含您新更新對象的資訊。
code language-json |
---|
|
更新對象 put
您可以向發出PUT請求,更新(覆寫)特定對象。 /audiences
端點,並提供您要在請求路徑中更新的對象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 | |
---|---|
屬性 | 說明 |
audienceId |
對象的ID。 對於外部產生的對象,此值可由使用者提供。 |
name |
對象名稱。 |
namespace |
對象的名稱空間。 |
description |
對象說明。 |
type |
系統產生的欄位,顯示對象是平台產生的還是外部產生的對象。 可能的值包括 SegmentDefinition 和 ExternalSegment . A SegmentDefinition 是指在Platform中產生的對象,而 ExternalSegment 是指不是在Platform中產生的對象。 |
lifecycleState |
對象的狀態。 可能的值包括 draft , published 、和 inactive . draft 代表建立對象的時間, published 發佈對象時,以及 inactive 對象不再作用中時。 |
datasetId |
可找到對象資料的資料集ID。 |
labels |
與對象相關的物件層級資料使用情況和屬性型存取控制標籤。 |
回應
成功的回應會傳回HTTP狀態200以及您新更新對象的詳細資料。 請注意,您的對象詳細資訊會因平台產生的對象或外部產生的對象而有所不同。
code language-json |
---|
|
刪除對象 delete
您可以向以下網站發出DELETE請求,刪除特定對象: /audiences
端點,並在請求路徑中提供您要刪除之對象的ID。
API格式
DELETE /audiences/{AUDIENCE_ID}
{AUDIENCE_ID}
id
欄位,為 非 此 audienceId
欄位。要求
code language-shell |
---|
|
回應
成功的回應會傳回HTTP狀態204且沒有訊息。
擷取多個對象 bulk-get
您可以向以下網站發出POST請求,擷取多個對象: /audiences/bulk-get
端點,並提供您要擷取之對象的ID。
API格式
POST /audiences/bulk-get
要求
code language-shell |
---|
|
回應
成功的回應會傳回HTTP狀態207,其中包含您要求對象的資訊。
code language-json |
---|
|
後續步驟
閱讀本指南後,您現在已更能瞭解如何使用Adobe Experience Platform API建立、管理和刪除對象。 如需使用UI進行對象管理的詳細資訊,請參閱 分段UI指南.