REST Resource: firstAndThirdPartyAudiences

リソース: FirstAndThirdPartyAudience

ターゲティングに使用される自社または第三者のオーディエンス リストを記述します。ファーストパーティ オーディエンスは、クライアント データを使用して作成されます。サードパーティ オーディエンスはサードパーティ データ プロバイダから提供され、お客様にのみライセンスを提供できます。

JSON 表現 
{
  "name": string,
  "firstAndThirdPartyAudienceId": string,
  "displayName": string,
  "description": string,
  "firstAndThirdPartyAudienceType": enum (FirstAndThirdPartyAudienceType),
  "audienceType": enum (AudienceType),
  "audienceSource": enum (AudienceSource),
  "membershipDurationDays": string,
  "displayAudienceSize": string,
  "activeDisplayAudienceSize": string,
  "youtubeAudienceSize": string,
  "gmailAudienceSize": string,
  "displayMobileAppAudienceSize": string,
  "displayMobileWebAudienceSize": string,
  "displayDesktopAudienceSize": string,
  "appId": string,

  // Union field members can be only one of the following:
  "contactInfoList": {
    object (ContactInfoList)
  },
  "mobileDeviceIdList": {
    object (MobileDeviceIdList)
  }
  // End of list of possible types for union field members.
}
フィールド
name

string

出力専用。ファーストパーティ オーディエンスとサードパーティ オーディエンスのリソース名。
firstAndThirdPartyAudienceId

string (int64 format)

出力専用。ファーストパーティ オーディエンスとサードパーティ オーディエンスの一意の ID。システムによって割り当てられます。
displayName

string

自社オーディエンスと第三者オーディエンスの表示名。
description

string

ユーザーが指定したオーディエンスの説明。

ファーストパーティ オーディエンスにのみ適用されます。
firstAndThirdPartyAudienceType

enum (FirstAndThirdPartyAudienceType)

オーディエンスが自社オーディエンスか第三者オーディエンスか。
audienceType

enum (AudienceType)

オーディエンスのタイプ。
audienceSource

enum (AudienceSource)

出力専用。オーディエンスのソース。
membershipDurationDays

string (int64 format)

エントリが有効なイベントの後にオーディエンスに残る日数。オーディエンスに有効期限がない場合は、このフィールドの値を 10000 に設定します。指定しない場合は、0 より大きく 540 以下でなければなりません。

自社オーディエンスにのみ適用されます。

次のいずれかの audienceType を使用する場合は、このフィールドが必要です。

  • CUSTOMER_MATCH_CONTACT_INFO
  • CUSTOMER_MATCH_DEVICE_ID
displayAudienceSize

string (int64 format)

出力専用。ディスプレイ ネットワークの推定オーディエンス数。

サイズが 1, 000 未満の場合、プライバシー上の理由から数値は非表示になり、0 が返されます。それ以外の場合、数値は小数点以下 2 桁に丸められます。

GET リクエストでのみ返されます。
activeDisplayAudienceSize

string (int64 format)

出力専用。ディスプレイ ネットワークでの過去 1 か月間の推定ユーザー サイズ。

サイズが 1,000 未満の場合、プライバシー上の理由から数値は非表示になり、0 が返されます。それ以外の場合は、2 桁に丸められます。

GET リクエストでのみ返されます。
youtubeAudienceSize

string (int64 format)

出力専用。YouTube ネットワークのユーザーの推定サイズ。

サイズが 1, 000 未満の場合、プライバシー上の理由から数値は非表示になり、0 が返されます。それ以外の場合は、2 桁に丸められます。

自社オーディエンスにのみ適用されます。

GET リクエストでのみ返されます。
gmailAudienceSize

string (int64 format)

出力専用。Gmail ネットワークのオーディエンスの推定規模。

サイズが 1,000 未満の場合、プライバシー上の理由から数値は非表示になり、0 が返されます。それ以外の場合、数値は小数点以下 2 桁に丸められます。

自社オーディエンスにのみ適用されます。

GET リクエストでのみ返されます。
displayMobileAppAudienceSize

string (int64 format)

出力専用。ディスプレイ ネットワークにおけるモバイルアプリのオーディエンスの推定規模。

サイズが 1,000 未満の場合、プライバシー上の理由から数値は非表示になり、0 が返されます。それ以外の場合、数値は小数点以下 2 桁に丸められます。

自社オーディエンスにのみ適用されます。

GET リクエストでのみ返されます。
displayMobileWebAudienceSize

string (int64 format)

出力専用。ディスプレイ ネットワークにおけるモバイルウェブのオーディエンスの推定規模。

サイズが 1,000 未満の場合、プライバシー上の理由から数値は非表示になり、0 が返されます。それ以外の場合、数値は小数点以下 2 桁に丸められます。

自社オーディエンスにのみ適用されます。

GET リクエストでのみ返されます。
displayDesktopAudienceSize

string (int64 format)

出力専用。ディスプレイ ネットワークにおけるパソコンのオーディエンスの推定規模。

サイズが 1,000 未満の場合、プライバシー上の理由から数値は非表示になり、0 が返されます。それ以外の場合、数値は小数点以下 2 桁に丸められます。

自社オーディエンスにのみ適用されます。

GET リクエストでのみ返されます。
appId

string

appId が、アップロードされる mobileDeviceIds のタイプと一致している。

audienceType CUSTOMER_MATCH_DEVICE_ID にのみ適用
共用体フィールド members。カスタマー マッチ オーディエンスの初期のメンバー。members は次のいずれかになります。
contactInfoList

object (ContactInfoList)

入力のみの最初のオーディエンス メンバーを定義する連絡先情報のリスト。

audienceType CUSTOMER_MATCH_CONTACT_INFO にのみ適用されます
mobileDeviceIdList

object (MobileDeviceIdList)

入力のみの初期オーディエンス メンバーを定義するモバイル デバイス ID のリスト。

audienceType CUSTOMER_MATCH_DEVICE_ID にのみ適用

FirstAndThirdPartyAudienceType

ファーストパーティとサードパーティのオーディエンス リソースの種類。

列挙型
FIRST_AND_THIRD_PARTY_AUDIENCE_TYPE_UNSPECIFIED タイプが指定されていない場合や不明な場合のデフォルト値。
FIRST_AND_THIRD_PARTY_AUDIENCE_TYPE_FIRST_PARTY クライアント データを使用して作成されたオーディエンス。
FIRST_AND_THIRD_PARTY_AUDIENCE_TYPE_THIRD_PARTY 第三者データ プロバイダから提供されるオーディエンス。

AudienceType

オーディエンスのタイプ。

列挙型
AUDIENCE_TYPE_UNSPECIFIED タイプが指定されていないか、不明な場合のデフォルト値。
CUSTOMER_MATCH_CONTACT_INFO ユーザーと既知の連絡先情報を照合して、オーディエンスを生成しました。
CUSTOMER_MATCH_DEVICE_ID ユーザーと既知のモバイル デバイス ID を照合することで、オーディエンスが生成されました。
CUSTOMER_MATCH_USER_ID オーディエンスは、既知のユーザー ID と顧客を照合して生成されました。
ACTIVITY_BASED

オーディエンスはキャンペーン アクティビティに基づいて作成されました。
FREQUENCY_CAP

配信されたインプレッション数に基づいて除外されたユーザーに基づいてオーディエンスが作成されました。
TAG_BASED オーディエンスは、ピクセルに関連付けられたカスタム変数に基づいて作成されました。
YOUTUBE_USERS 動画、YouTube 広告、YouTube チャンネルの操作履歴に基づいてオーディエンスが作成されました。
LICENSED サードパーティ オーディエンス タイプのサブタイプ。

AudienceSource

考えられるオーディエンス ソース。

列挙型
AUDIENCE_SOURCE_UNSPECIFIED オーディエンス ソースが指定されていない場合、または不明な場合のデフォルト値。
DISPLAY_VIDEO_360 ディスプレイ＆ビデオ 360 からのトラフィックである。
CAMPAIGN_MANAGER キャンペーン マネージャー 360 から作成されたもの。
AD_MANAGER Google アド マネージャーから送信されたもの。
SEARCH_ADS_360 検索広告 360 から取得されます。
YOUTUBE YouTube から発生した。
ADS_DATA_HUB Ads Data Hub から取得されたデータ。

ContactInfoList

カスタマー マッチのオーディエンス メンバーを定義する連絡先情報のリストのラッパー メッセージ。

JSON 表現 
{
  "contactInfos": [
    {
      object (ContactInfo)
    }
  ],
  "consent": {
    object (Consent)
  }
}
フィールド
contactInfos[]

object (ContactInfo)

カスタマー マッチのオーディエンス メンバーを定義する ContactInfo オブジェクトのリスト。contactInfos を分割した後のメンバーのサイズは、500,000 以下にする必要があります。
consent

object (Consent)

入力のみのcontactInfos のユーザーの同意設定。

このフィールドを未設定のままにした場合、同意ステータスが指定されていないことを示します。

adUserData フィールドまたは adPersonalization フィールドが CONSENT_STATUS_DENIED に設定されている場合、リクエストはエラーを返します。

ContactInfo

カスタマー マッチのオーディエンス メンバーを定義する連絡先情報。

JSON 表現 
{
  "hashedEmails": [
    string
  ],
  "hashedPhoneNumbers": [
    string
  ],
  "zipCodes": [
    string
  ],
  "hashedFirstName": string,
  "hashedLastName": string,
  "countryCode": string
}
フィールド
hashedEmails[]

string

メンバーの SHA256 ハッシュ化されたメールアドレスのリスト。ハッシュ化する前に、すべての空白文字を削除し、文字列がすべて小文字であることを確認します。
hashedPhoneNumbers[]

string

メンバーの SHA256 ハッシュ化された電話番号のリスト。ハッシュ化の前に、すべての電話番号を E.164 形式でフォーマットし、国コードを含める必要があります。
zipCodes[]

string

メンバーの郵便番号のリスト。

次のフィールドも設定する必要があります。
hashedFirstName

string

メンバーの名（ファースト ネーム）の SHA256 ハッシュ。ハッシュ化する前に、すべての空白文字を削除し、文字列がすべて小文字であることを確認します。

次のフィールドも設定する必要があります。
hashedLastName

string

SHA256 でハッシュ化されたメンバーの姓。ハッシュ化する前に、すべての空白文字を削除し、文字列がすべて小文字であることを確認します。

次のフィールドも設定する必要があります。
countryCode

string

メンバーの国コード。

次のフィールドでも設定する必要があります。

ConsentStatus

同意ステータス。

列挙型
CONSENT_STATUS_UNSPECIFIED このバージョンでタイプ値が指定されていないか、不明です。
CONSENT_STATUS_GRANTED 同意が付与されます。
CONSENT_STATUS_DENIED 同意が拒否されました。

MobileDeviceIdList

カスタマー マッチ オーディエンス メンバーを定義するモバイル デバイス ID のリスト用のラッパー メッセージ。

JSON 表現 
{
  "mobileDeviceIds": [
    string
  ],
  "consent": {
    object (Consent)
  }
}
フィールド
mobileDeviceIds[]

string

カスタマー マッチ オーディエンス メンバーを定義するモバイル デバイス ID のリスト。mobileDeviceIds のサイズは 500,000 以下にする必要があります。
consent

object (Consent)

入力のみのmobileDeviceIds のユーザーの同意設定。

このフィールドを未設定のままにすると、同意が指定されていないことを示します。

adUserData フィールドまたは adPersonalization フィールドが CONSENT_STATUS_DENIED に設定されている場合、リクエストはエラーを返します。

メソッド

create

 FirstAndThirdPartyAudience を作成します。

editCustomerMatchMembers

 カスタマー マッチ オーディエンスのメンバーリストを更新します。

get

 ファースト パーティ オーディエンスとサードパーティ オーディエンスを取得します。

list

 ファースト パーティ オーディエンスとサードパーティ オーディエンスを一覧表示します。

patch

 既存の FirstAndThirdPartyAudience を更新します。