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)

条件を満たすイベントの発生後、エントリがオーディエンスに残る期間（日数）。設定値は 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 このバージョンでは、Type 値が指定されていないか、不明です。
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 を更新します。