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.

Tạo nội dung yêu cầu

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

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

Khoảng thời gian mà một thành viên đối tượng vẫn nằm trong danh sách sau khi được thêm. Giá trị phải tương ứng với số ngày. 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, theo sau 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 bộ đệm giao thức, hãy dùng phương thức thuận tiện để tạo một đối tượng Duration dựa trên số ngày, nếu có phương thức thuận tiện như vậy. Ví dụ: thư viện protobuf-java-util cho Java có một phương thức tiện lợi fromDays(). Nếu không, hãy tính số giây bằng cách nhân số ngày của khoảng thời gian với 86400 (số giây mỗi ngày) và 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 điền thông tin vào 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 mà bạn muốn dùng để thêm thành viên đố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 đố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 thông báo ContactIdInfo với dataSourceType được đặt thành giá trị thích hợp từ enum DataSourceType.

Danh sách mã thiết bị di động

Đặt các trường sau nếu bạn muốn sử dụng mã nhận dạng thiết bị di động để xác định thành viên đố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 thông báo MobileIdInfo:

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

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

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

Tạo yêu cầu

Để tạo đối tượng So khớp khách hàng, hãy tạo một createrequest 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 phải là của một 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 đến và tiêu đề.

Dưới đây là các yêu cầu mẫu ở định dạng JSON cho các 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 Trình khám phá API để 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ã nhận dạng trên 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"
}

Gửi yêu cầu

Gửi yêu cầu và thêm tiêu đề yêu cầu (nếu cần).

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. Ghi lại các giá trị trong những trường này vì bạn cần chúng trong các yêu cầu thêm thành viên đối tượng vào đối tượng.

Nếu yêu cầu không thành công, hãy 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.