Tạo đối tượng So khớp khách hàng

Tạo đối tượng So khớp khách hàng bằng cách gửi một CreateUserListRequest.

Xây dựng nội dung yêu cầu

Tạo tài nguyên UserList. Sau đây là các trường phổ biến cần đặt.

displayName
Bắt buộc Tên hiển thị của danh sách. Tên phải là duy nhất trong tất cả các danh sách do tài khoản sở hữu.
description
Nội dung mô tả ngắn gọn về danh sách.
integrationCode
Mã nhận dạng từ hệ thống của bạn.
membershipDuration

Thời gian một thành viên thuộc đối tượng ở lại trong danh sách sau khi được thêm vào. Giá trị phải tương ứng với số ngày nguyên. Nếu không được đặt, giá trị mặc định sẽ là giá trị tối đa.

Nếu sử dụng JSON, hãy tính số giây bằng cách nhân số ngày của thời lượng với 86400 (số giây mỗi ngày). Sau đó, hãy đặt giá trị thành kết quả phép nhân, tiếp theo là s. Ví dụ: nếu bạn muốn thời hạn thành viên là 90 ngày, hãy sử dụng giá trị 7776000s90 * 86400 = 7776000.

Nếu sử dụng định dạng vùng đệm giao thức, hãy sử dụng phương thức tiện lợi để tạo đối tượng Duration dựa trên số ngày, nếu có phương thức tiện lợi như vậy. Ví dụ: thư viện protobuf-java-util dành cho Java có fromDays() phương thức tiện lợi. Nếu không, hãy tính số giây bằng cách nhân số ngày của thời lượng với 86400 (số giây mỗi ngày) rồi sử dụng kết quả để đặt trường seconds của đối tượng Duration.

Các trường bắt buộc đối với tính năng So khớp khách hàng

Bạn phải có trường ingestedUserListInfo cho đối tượng So khớp khách hàng.

Sau đây là các trường cần đặt trên IngestedUserListInfo dựa trên loại dữ liệu bạn muốn sử dụng để thêm thành viên thuộc đối tượng vào danh sách.

Danh sách thông tin liên hệ

Đặt các trường sau nếu bạn muốn sử dụng thông tin liên hệ (địa chỉ email, số điện thoại hoặc địa chỉ đã băm) để xác định thành viên thuộc đối tượng:

uploadKeyTypes

Đặt thành một danh sách chứa loại khoá tải lên CONTACT_ID.

Danh sách uploadKeyTypes chỉ được chứa một mục.

contactIdInfo

Đặt thành một ContactIdInfo thông báo có dataSourceType được đặt thành giá trị thích hợp từ DataSourceType enum.

Danh sách Mobile ID

Đặt các trường sau nếu bạn muốn sử dụng mã thiết bị di động để xác định thành viên thuộc đối tượng:

uploadKeyTypes

Đặt thành một danh sách chứa loại khoá tải lên MOBILE_ID.

Danh sách uploadKeyTypes chỉ được chứa một mục.

mobileIdInfo

Đặt thành một MobileIdInfo thông báo:

  • Đặt dataSourceType thành giá trị thích hợp từ DataSourceType enum.

  • Đặt keySpace thành IOS hoặc ANDROID.

  • Đặt appId thành chuỗi xác định duy nhất ứng dụng di động mà dữ liệu được thu thập.

Danh sách mã nhận dạng người dùng

Đặt các trường sau nếu bạn muốn sử dụng mã nhận dạng người dùng để xác định thành viên thuộc đối tượng:

uploadKeyTypes

Đặt thành một danh sách chứa loại khoá tải lên USER_ID.

Danh sách uploadKeyTypes chỉ được chứa một mục.

Xây dựng yêu cầu

Để tạo đối tượng So khớp khách hàng, hãy tạo create yêu cầu cho tài nguyên UserList.

  1. Đặt trường parent thành tên tài nguyên của tài khoản. Tên tài nguyên phải tuân theo định dạng accountTypes/{accountType}/accounts/{account_id}.

  2. Sử dụng UserList mà bạn đã tạo cho nội dung yêu cầu.

  3. Nếu thông tin đăng nhập của bạn không dành cho Tài khoản Google là người dùng trên parent, hãy đặt tiêu đề như mô tả trong phần Định cấu hình đích và tiêu đề.

Sau đây là các yêu cầu mẫu ở định dạng JSON cho nhiều loại thông tin người dùng. Mỗi yêu cầu đặt membershipDuration thành 2592000s, trong đó 2592000 là số giây trong 30 ngày. Nhấp vào nút Mở trong APIs Explorer để thử một yêu cầu.

Thông tin liên hệ

{
    "description": "Customer Match for contact info",
    "displayName": "Contact info audience",
    "ingestedUserListInfo": {
        "contactIdInfo": {
            "dataSourceType": "DATA_SOURCE_TYPE_FIRST_PARTY"
        },
        "uploadKeyTypes": [
            "CONTACT_ID"
        ]
    },
    "membershipDuration": "2592000s"
}

Mã thiết bị di động

{
    "description": "Customer Match for mobile IDs",
    "displayName": "Mobile ID audience",
    "ingestedUserListInfo": {
        "mobileIdInfo": {
            "dataSourceType": "DATA_SOURCE_TYPE_FIRST_PARTY",
            "keySpace": "ANDROID",
            "appId": "com.labpixies.flood"
        },
        "uploadKeyTypes": [
            "MOBILE_ID"
        ]
    },
    "membershipDuration": "2592000s"
}

Mã nhận dạng người dùng

{
    "description": "Customer Match for user IDs",
    "displayName": "User ID audience",
    "ingestedUserListInfo": {
        "userIdInfo": {
            "dataSourceType": "DATA_SOURCE_TYPE_FIRST_PARTY"
        },
        "uploadKeyTypes": [
            "USER_ID"
        ]
    },
    "membershipDuration": "2592000s"
}

Gửi yêu cầu

Gửi yêu cầu và nếu cần, hãy thêm tiêu đề yêu cầu.

Nếu yêu cầu thành công, phản hồi sẽ chứa UserList đã tạo với idname được điền sẵn. Hãy ghi lại các giá trị trong những trường này vì bạn cần các giá trị đó trong yêu cầu thêm thành viên thuộc đối tượng vào đối tượng.

Nếu yêu cầu không thành công, kiểm tra các lỗi để xác định nguyên nhân gây ra lỗi, cập nhật yêu cầu và tiêu đề để khắc phục mọi vấn đề, sau đó gửi yêu cầu và tiêu đề đã cập nhật.