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

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

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

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

displayName

必須リストの表示名。この名前は、アカウントが所有するすべてのリストの中で一意である必要があります。

description

リストの簡単な説明。

integrationCode

システムからの ID。

membershipDuration

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

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

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

カスタマーマッチに必要なフィールド

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

リストにオーディエンスメンバーを追加するために使用するデータの種類に応じて、 IngestedUserListInfo に設定するフィールドは次のとおりです。

連絡先情報リスト

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

uploadKeyTypes

CONTACT_ID アップロードキータイプを含むリストに設定します。

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

contactIdInfo

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

モバイル ID リスト

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

uploadKeyTypes

MOBILE_ID アップロードキータイプを含むリストに設定します。

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

mobileIdInfo

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

dataSourceType を DataSourceType 列挙型の適切な値に設定します。
keySpace を IOS または ANDROID に設定します。
appId を、データの収集元となったモバイルアプリを一意に識別する文字列に設定します。
- iOS の場合、ID 文字列は、App Store URL の末尾に表示される 9 桁の文字列です。たとえば、App Store リンクが https://apps.apple.com/us/app/flood-it/id476943146の「Flood-It!」アプリの場合は476943146です。
- Android の場合、ID 文字列は、アプリのパッケージ名です。たとえば、Google Play リンクが https://play.google.com/store/apps/details?id=com.labpixies.floodの「Flood-It!」アプリの場合は com.labpixies.floodです。

リクエストを作成する

カスタマーマッチオーディエンスを作成するには、create リクエストを UserList リソースに対して作成します。

parent フィールドをアカウントのリソース名に設定します。リソース名は形式 accountTypes/{accountType}/accounts/{account_id}に従う必要があります。
リクエストの本文には、作成した UserList を使用します。
認証情報が 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"
}

リクエストを送信する

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

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

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

概要

オーディエンスにメンバーをアップロードする

カスタマー マッチ オーディエンスを作成する コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。