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)

僅供輸出。多媒體廣告聯播網的預估目標對象規模。

基於隱私權考量，如果這個大小小於 1000，系統會隱藏該數字，並傳回 0。否則，系統會將數字無條件進位至兩個有效數字。

僅在 GET 要求中傳回。
activeDisplayAudienceSize

string (int64 format)

僅供輸出。多媒體廣告聯播網過去一個月的預估目標對象規模。

基於隱私權考量，如果這個大小小於 1000，系統會隱藏該數字，並傳回 0。否則，系統會將數字無條件進位至兩個有效數字。

僅在 GET 要求中傳回。
youtubeAudienceSize

string (int64 format)

僅供輸出。YouTube 聯播網的預估目標對象規模。

基於隱私權考量，如果這個大小小於 1000，系統會隱藏該數字，並傳回 0。否則，系統會將數字無條件進位至兩個有效數字。

僅適用於第一方目標對象。

僅在 GET 要求中傳回。
gmailAudienceSize

string (int64 format)

僅供輸出。Gmail 網路的預估目標對象規模。

基於隱私權考量，如果這個大小小於 1000，系統會隱藏該數字，並傳回 0。否則，系統會將數字無條件進位至兩個有效數字。

僅適用於第一方目標對象。

僅在 GET 要求中傳回。
displayMobileAppAudienceSize

string (int64 format)

僅供輸出。多媒體廣告聯播網中的行動應用程式預估目標對象規模。

基於隱私權考量，如果這個大小小於 1000，系統會隱藏該數字，並傳回 0。否則，系統會將數字無條件進位至兩個有效數字。

僅適用於第一方目標對象。

僅在 GET 要求中傳回。
displayMobileWebAudienceSize

string (int64 format)

僅供輸出。多媒體廣告聯播網中的行動版網站預估目標對象規模。

基於隱私權考量，如果這個大小小於 1000，系統會隱藏該數字，並傳回 0。否則，系統會將數字無條件進位至兩個有效數字。

僅適用於第一方目標對象。

僅在 GET 要求中傳回。
displayDesktopAudienceSize

string (int64 format)

僅供輸出。多媒體廣告聯播網中的桌機預估目標對象規模。

基於隱私權考量，如果這個大小小於 1000，系統會隱藏該數字，並傳回 0。否則，系統會將數字無條件進位至兩個有效數字。

僅適用於第一方目標對象。

僅在 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 目標對像是根據客戶與已知 User ID 比對而產生。
ACTIVITY_BASED

目標對像是根據廣告活動建立。
FREQUENCY_CAP

目標對象的建立依據為排除放送的曝光次數。
TAG_BASED 目標對像是根據附加至像素的自訂變數建立。
YOUTUBE_USERS 目標對象的建立依據包括使用者過去與影片、YouTube 廣告或 YouTube 頻道的互動，
LICENSED 第三方目標對象類型的子類型。

AudienceSource

可能的目標對象來源。

列舉
AUDIENCE_SOURCE_UNSPECIFIED 未指定或對象來源的預設值。
DISPLAY_VIDEO_360 源自 Display & Video 360。
CAMPAIGN_MANAGER 源自 Campaign Manager 360。
AD_MANAGER 源自 Google Ad Manager。
SEARCH_ADS_360 源自 Search Ads 360。
YOUTUBE 源自 YouTube。
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 名單。mobileDeviceId 大小不得超過 500,000。
consent

object (Consent)

僅限輸入。「mobileDeviceIds」中使用者的同意聲明設定。

如果不設定這個欄位，就表示未指定同意聲明。

如果將 adUserData 或 adPersonalization 欄位設為 CONSENT_STATUS_DENIED，要求會傳回錯誤。

方法

create

 建立 FirstAndThirdPartyAudience。

editCustomerMatchMembers

 更新目標顧客比對目標對象的成員名單。

get

 取得第一方和第三方目標對象。

list

 列出第一方和第三方目標對象。

patch

 更新現有的 FirstAndThirdPartyAudience。