カスタマー マッチ オーディエンスを作成する

CreateUserListRequest を送信して、カスタマー マッチ オーディエンスを作成します。

リクエスト本文を作成する

UserList リソースを作成します。設定する一般的なフィールドは次のとおりです。

displayName
必須 リストの表示名。この名前は、アカウントが所有するすべてのリストの中で一意である必要があります。
description
リストの簡単な説明。
integrationCode
システムからの ID。
membershipDuration

オーディエンス メンバーがリストに追加されてからリストに残る期間。値は整数日である必要があります。設定しない場合、デフォルトは最大値になります。

JSON を使用する場合は、期間の日数に 86400（1 日あたりの秒数）を掛けて秒数を計算します。次に、値を乗算結果に設定し、その後に s を追加します。たとえば、メンバーシップの期間を 90 日にする場合は、90 * 86400 = 7776000 以降の値 7776000s を使用します。

プロトコル バッファ形式を使用する場合は、日数に基づいて Duration オブジェクトを構築するためのコンビニエンス メソッド（存在する場合）を使用します。たとえば、Java 用の protobuf-java-util ライブラリには fromDays() 簡易メソッドがあります。それ以外の場合は、期間の日数に 86400（1 日あたりの秒数）を掛けて秒数を計算し、その結果を使用して Duration オブジェクトの seconds フィールドを設定します。

カスタマー マッチの必須フィールド

カスタマー マッチ オーディエンスでは ingestedUserListInfo フィールドは必須です。

以下は、オーディエンス リストにメンバーを追加するために使用するデータの種類に基づいて IngestedUserListInfo で設定するフィールドです。

連絡先情報リスト

連絡先情報（ハッシュ化されたメールアドレス、電話番号、住所）を使用してオーディエンス メンバーを定義する場合は、次のフィールドを設定します。

uploadKeyTypes

CONTACT_ID アップロード鍵の種類を含むリストに設定します。

uploadKeyTypes リストには 1 つのエントリのみを含める必要があります。

contactIdInfo

dataSourceType が DataSourceType 列挙型から適切な値に設定された ContactIdInfo メッセージに設定します。

モバイル ID リスト

モバイル ID を使用してオーディエンス メンバーを定義する場合は、次のフィールドを設定します。

uploadKeyTypes

MOBILE_ID アップロード鍵の種類を含むリストに設定します。

uploadKeyTypes リストには 1 つのエントリのみを含める必要があります。

mobileIdInfo

MobileIdInfo メッセージに設定します。

  • DataSourceType 列挙型から適切な値を dataSourceType に設定します。

  • keySpace を IOS または ANDROID に設定します。

  • appId を、データの収集元となったモバイル アプリケーションを一意に識別する文字列に設定します。

ユーザー ID リスト

ユーザー ID を使用してオーディエンス メンバーを定義する場合は、次のフィールドを設定します。

uploadKeyTypes

USER_ID アップロード鍵の種類を含むリストに設定します。

uploadKeyTypes リストには 1 つのエントリのみを含める必要があります。

リクエストを作成する

顧客一致オーディエンスを作成するには、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"
}

リクエストを送信する

リクエストを送信し、必要に応じてリクエスト ヘッダーを含めます。

リクエストが成功すると、レスポンスには、id と name が入力された作成済みの UserList が含まれます。これらのフィールドの値は、オーディエンスにオーディエンス メンバーを追加するリクエストで必要になるため、メモしておきます。

リクエストが失敗した場合は、エラーを調べて失敗の原因を特定し、リクエストとヘッダーを更新して問題を修正してから、更新したリクエストとヘッダーを送信します。

前へ
概要
次へ
オーディエンスにメンバーをアップロードする