REST Resource: firstAndThirdPartyAudiences

資源：FirstAnd thirdPartyAudience

說明用於指定目標的第一方或第三方目標對象名單。第一方目標對像是透過客戶資料建立而成。第三方目標對像是由第三方資料供應商提供，因此只能授權給客戶。

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 目標對像是透過比對客戶與已知使用者 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。