Ví dụ về truy vấn OData

Lưu ý

Customer Insights - Data bảng cũng có thể được truy cập bằng Dataverse API. Chúng tôi khuyên bạn nên sử dụng Dataverse API để truy vấn dữ liệu Customer Insights vì chúng cung cấp khả năng lọc toàn diện hơn, thông lượng lớn hơn và độ trễ thấp hơn. Để biết thêm thông tin, hãy xem Dataverse API dành cho Customer Insights.

Giao thức dữ liệu mở (OData) là giao thức truy cập dữ liệu được xây dựng trên các giao thức cốt lõi như HTTP. Nó sử dụng các phương pháp được chấp nhận phổ biến như REST cho web. Có nhiều loại thư viện và công cụ khác nhau có thể được sử dụng để sử dụng dịch vụ OData.

Để giúp bạn xây dựng cách triển khai của riêng mình dựa trên Dynamics 365 Customer Insights - Data API, hãy xem lại một số truy vấn mẫu thường được yêu cầu.

Sửa đổi các mẫu truy vấn để làm cho chúng hoạt động trên môi trường đích:

  • {serviceRoot}: https://api.ci.ai.dynamics.com/v1/instances/{instanceId} trong đó {instanceId} là GUID của môi trường Customer Insights - Data bạn muốn truy vấn. Thao tác ListAllInstances cho phép bạn tìm {InstanceId} mà bạn có quyền truy cập.
  • {CID}: GUID của một bản ghi khách hàng thống nhất. Ví dụ: ce759201f786d590bf2134bff576c369.
  • {AlternateKey}: Mã định danh khóa chính của bản ghi khách hàng trong nguồn dữ liệu. Ví dụ: CNTID_1002
  • {DSname}: Chuỗi có tên bảng là nguồn dữ liệu được nhập vào Customer Insights - Data. Ví dụ: Website_contacts.
  • {SegmentName}: Chuỗi có tên bảng đầu ra của một phân đoạn trong Customer Insights - Data. Ví dụ: Male_under_40.

Quý khách hàng

Truy vấn mẫu cho bảng Khách hàng .

Loại truy vấn Ví dụ: Lưu ý
ID khách hàng duy nhất {serviceRoot}/data/Customer?$filter=CustomerId eq '{CID}'
Khóa thay thế {serviceRoot}/data/Customer?$filter={DSname_TableName_PrimaryKeyColumnName} eq '{AlternateKey}' Các khóa thay thế vẫn tồn tại trong bảng khách hàng hợp nhất
Chọn {serviceRoot}/data/Customer?$select=CustomerId,FullName&$filter=customerid eq '1'
Vào {serviceRoot}/data/Customer?$filter=CustomerId in ('{CID1}',’{CID2}’)
Khóa thay thế + Trong {serviceRoot}/data/Customer?$filter={DSname_TableName_PrimaryKeyColumnName} in ('{AlternateKey}','{AlternateKey}')
Tìm kiếm {serviceRoot}/data/Customer?$top=10&$skip=0&$search="string" Trả về 10 kết quả hàng đầu cho chuỗi tìm kiếm
Thành viên phân khúc {serviceRoot}/data/Customer?select=*&$filter=IsMemberOfSegment('{SegmentName}')&$top=10 Trả về số hàng đặt trước từ bảng phân đoạn.
Tư cách thành viên phân khúc cho khách hàng {serviceRoot}/data/Customer?$filter=CustomerId eq '{CID}'&IsMemberOfSegment('{SegmentName}') Trả về hồ sơ khách hàng nếu họ là thành viên của phân khúc nhất định

Hoạt động thống nhất

Truy vấn mẫu cho bảng UnifiedActivity .

Loại truy vấn Ví dụ: Lưu ý
Hoạt động của CID {serviceRoot}/data/UnifiedActivity?$filter=CustomerId eq '{CID}' Liệt kê các hoạt động của một hồ sơ khách hàng cụ thể
Khung thời gian hoạt động {serviceRoot}/data/UnifiedActivity?$filter=CustomerId eq '{CID}' and ActivityTime gt 2017-01-01T00:00:00.000Z and ActivityTime lt 2020-01-01T00:00:00.000Z Hoạt động của hồ sơ khách hàng trong một khung thời gian
Loại hoạt động {serviceRoot}/data/UnifiedActivity?$filter=CustomerId eq '{CID}' and ActivityType eq '{ActivityName}'
Hoạt động theo tên hiển thị {serviceRoot}/data/UnifiedActivity$filter=CustomerId eq ‘{CID}’ and ActivityTypeDisplay eq ‘{ActivityDisplayName}’
Sắp xếp hoạt động {serviceRoot}/data/UnifiedActivity?$filter=CustomerId eq ‘{CID}’ & $orderby=ActivityTime asc Sắp xếp các hoạt động tăng dần hoặc giảm dần
Mọi hoạt động và biện pháp vì một khách hàng {serviceRoot}/data/Customer?$expand=UnifiedActivity,Customer_Measure&$filter=CustomerId eq '{CID}' Hoạt động và biện pháp là các cặp khóa/giá trị bổ sung trên hồ sơ khách hàng được trả về

Quản lý quy trình công việc

Các truy vấn mẫu liên quan đến các quy trình trong Customer Insights - Data chẳng hạn như làm mới nguồn dữ liệu, hợp nhất dữ liệu hoặc nhận trạng thái của công việc hợp nhất.

Loại truy vấn Ví dụ: Lưu ý
Nhận ID nguồn dữ liệu {serviceRoot}/manage/datasources/v2 Trả về tất cả các nguồn dữ liệu trên môi trường của bạn. Từ phản hồi, bạn có thể kiểm tra 'tên thân thiện' để tìm nguồn dữ liệu cụ thể rồi sử dụng 'dataSourceId' của nó.
Làm mới nguồn dữ liệu {serviceRoot}/manage/workflows/main/jobs?operationType=Ingestion&identifiers='{dataSourceId}'&forceRunRequested=true Sử dụng 'dataSourceId' từ phản hồi ở trên để làm mới nguồn dữ liệu. Đây là một yêu cầu POST.
Chạy làm mới hoàn toàn {serviceRoot}/manage/workflows/main/jobs?operationType=all&forceRunRequested=true Làm mới tất cả các quy trình trên môi trường của bạn. Đây là một yêu cầu POST.
Nhận trạng thái của các quy trình {serviceRoot}/manage/workflows/main/jobs

Ví dụ khác

Truy vấn mẫu cho các bảng khác.

Loại truy vấn Ví dụ: Lưu ý
Các biện pháp CID {serviceRoot}/data/Customer_Measure?$filter=CustomerId eq '{CID}'
Thương hiệu phong phú của CID {serviceRoot}/data/BrandShareOfVoiceFromMicrosoft?$filter=CustomerId eq '{CID}'
Lợi ích phong phú của CID {serviceRoot}/data/InterestShareOfVoiceFromMicrosoft?$filter=CustomerId eq '{CID}'
Trong khoản + Mở rộng {serviceRoot}/data/Customer?$expand=UnifiedActivity,Customer_Measure&$filter=CustomerId in ('{CID}', '{CID}')

Giới hạn

  • API Customer Insights trả về tối đa 100 đối tượng theo mặc định. Bạn có thể phân tích hơn 100 đối tượng được trả về bằng cách sử dụng các kỹ thuật phân trang tiêu chuẩn. Ngoài ra, bạn có thể xuất dữ liệu của mình.

  • Các truy vấn sau đây không được hỗ trợ:

    • $filter trên các bảng nguồn đã nhập. Bạn chỉ có thể chạy truy vấn $filter trên các bảng hệ thống Customer Insights - Data tạo.
    • $expand từ truy vấn $search . Ví dụ: Customer?$expand=UnifiedActivity$top=10&$skip=0&$search="corey".
    • $expand từ $select nếu chỉ chọn một tập hợp con các thuộc tính. Ví dụ: Customer?$select=CustomerId,FullName&$expand=UnifiedActivity&$filter=CustomerId eq '{CID}'.
    • $expand làm phong phú thêm mối quan hệ về thương hiệu hoặc sở thích cho một khách hàng nhất định. Ví dụ: Customer?$expand=BrandShareOfVoiceFromMicrosoft&$filter=CustomerId eq '518291faaa12f6d853c417835d40eb10'.
    • Truy vấn dự đoán bảng đầu ra mô hình thông qua khóa thay thế. Ví dụ: OOBModelOutputTable?$filter=HotelCustomerID eq '{AK}'.