建立目標客戶比對目標對象

傳送 CreateUserListRequest，建立目標顧客比對目標對象。

建構要求主體

建立 UserList 資源。以下是常見的設定欄位。

displayName

必填：清單的顯示名稱。帳戶擁有的所有清單名稱不得重複。

description

清單的簡短說明。

integrationCode

系統中的 ID。

membershipDuration

目標對象成員加入名單後，在名單中保留的時間長度。這個值必須對應到整天。如未設定，預設值為上限。

如果使用 JSON，請將天數乘以 86400 (每天的秒數)，即可計算秒數。然後將值設為乘法結果，後面加上 s。舉例來說，如果會員期為 90 天，請使用 7776000s 值，因為 90 * 86400 = 7776000。

如果使用通訊協定緩衝區格式，請使用簡便方法，根據天數建構 Duration 物件 (如有這類簡便方法)。舉例來說，Java 的 protobuf-java-util 程式庫具有 fromDays() 便利方法。否則，請將天數乘以 86400 (每天的秒數)，計算出秒數，然後使用結果設定 Duration 物件的 seconds 欄位。

目標顧客比對的必填欄位

目標顧客比對目標對象必須填寫「ingestedUserListInfo」欄位。

以下是您要根據IngestedUserListInfo設定的欄位，這些欄位會決定您要使用哪種資料將目標對象成員加入名單。

聯絡資訊清單

如要使用聯絡資訊 (經雜湊處理的電子郵件地址、電話號碼或地址) 定義目標對象成員，請設定下列欄位：

uploadKeyTypes

設為包含 CONTACT_ID 上傳金鑰類型的清單。

uploadKeyTypes 清單只能包含一個項目。

contactIdInfo

設為 ContactIdInfo 訊息，並將 dataSourceType 設為 DataSourceType 列舉中的適當值。

行動 ID 清單

如要使用行動 ID 定義目標對象成員，請設定下列欄位：

uploadKeyTypes

設為包含 MOBILE_ID 上傳金鑰類型的清單。

uploadKeyTypes 清單只能包含一個項目。

mobileIdInfo

設為 a MobileIdInfo message：

• 將 dataSourceType 設為 DataSourceType 列舉中的適當值。

• 將 keySpace 設為 IOS 或 ANDROID。

• 將 appId 設為可單獨識別資料收集來源行動應用程式的字串。

  • 以 iOS 來說，ID 字串為 App Store 網址結尾顯示的 9 個數字，舉例來說，如果「Flood-It!」應用程式的 App Store 連結為 https://apps.apple.com/us/app/flood-it/id476943146，則 476943146 為該應用程式的 App Store ID。

  • 以 Android 來說，ID 字串則為應用程式的套件名稱。舉例來說，如果「Flood-It!」應用程式的 Google Play 連結為 https://play.google.com/store/apps/details?id=com.labpixies.flood，則 com.labpixies.flood。

使用者 ID 清單

如要使用 User ID 定義目標對象成員，請設定下列欄位：

uploadKeyTypes

設為包含 USER_ID 上傳金鑰類型的清單。

uploadKeyTypes 清單只能包含一個項目。

建構要求

如要建立目標顧客比對目標對象，請為 UserList 資源建構 create 要求。

1. 將 parent 欄位設為帳戶的資源名稱。資源名稱的格式必須為 accountTypes/{accountType}/accounts/{account_id}。

2. 使用您為要求主體建構的 UserList。

3. 如果您的憑證不適用於parent的使用者 Google 帳戶，請按照「設定目的地和標頭」一文所述設定標頭。

以下是不同類型使用者資訊的 JSON 格式要求範例。 每項要求都會將 membershipDuration 設為 2592000s，其中 2592000 是 30 天的秒數。按一下「在 API Explorer 中開啟」按鈕，即可試用要求。

聯絡資訊

在 API Explorer 中開啟

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

行動 ID

在 API Explorer 中開啟

{
    "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"
}

使用者 ID

在 API Explorer 中開啟

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

傳送要求

傳送要求，並視需要加入要求標頭。

如果要求成功，回應會包含已建立的 UserList，並填入 id 和 name。請記下這些欄位中的值，因為您需要在要求中將目標對象成員新增至目標對象。

如果要求失敗，請檢查錯誤，找出失敗原因，更新要求和標頭來修正問題，然後傳送更新後的要求和標頭。