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)

出力専用。ディスプレイ ネットワークでの PC ユーザーの推定サイズ。

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

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

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

string

appId は、アップロードする mobileDeviceId のタイプと一致します。

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 を更新します。