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 は、アップロードする 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 オブジェクトのリストです。contactInfo を分割した後のメンバーのサイズは 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 に設定されている場合、リクエストはエラーを返します。

Methods

create

 FirstAndThirdPartyAudience を作成します。

editCustomerMatchMembers

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

get

 自社オーディエンスと第三者オーディエンスを取得します。

list

 自社オーディエンスと第三者オーディエンスを一覧表示します。

patch

 既存の FirstAndThirdPartyAudience を更新します。