REST Resource: firstPartyAndPartnerAudiences

資源：FirstPartyAndPartnerAudience

說明用於指定目標的第一方或合作夥伴目標對象名單。第一方目標對象是透過使用客戶資料建立。合作夥伴目標對象由第三方資料供應商提供，只能授權給客戶。

JSON 表示法 
{
  "name": string,
  "firstPartyAndPartnerAudienceId": string,
  "displayName": string,
  "description": string,
  "firstPartyAndPartnerAudienceType": enum (FirstPartyAndPartnerAudienceType),
  "audienceType": enum (AudienceType),
  "audienceSource": enum (AudienceSource),
  "membershipDurationDays": string,
  "displayAudienceSize": string,
  "activeDisplayAudienceSize": string,
  "youtubeAudienceSize": string,
  "gmailAudienceSize": string,
  "displayMobileAppAudienceSize": string,
  "displayMobileWebAudienceSize": string,
  "displayDesktopAudienceSize": string,
  "appId": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "contactInfoList": {
    object (ContactInfoList)
  },
  "mobileDeviceIdList": {
    object (MobileDeviceIdList)
  }
  // End of mutually exclusive fields.
}
欄位
name

string

僅供輸出。第一方和夥伴目標對象的資源名稱。
firstPartyAndPartnerAudienceId

string (int64 format)

ID。第一方和合作夥伴目標對象的專屬 ID。由系統指派。
displayName

string

(選用步驟) 第一方和合作夥伴目標對象的顯示名稱。
description

string

(選用步驟) 使用者提供的目標對象說明。

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

enum (FirstPartyAndPartnerAudienceType)

僅供輸出。目標對象是否為第一方和夥伴目標對象。
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)

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

基於隱私權考量，如果大小小於 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 與上傳的 mobileDeviceIds 類型相符。

僅適用於「audienceType」CUSTOMER_MATCH_DEVICE_ID
目標顧客比對目標對象的初始成員。以下列出互斥欄位。回應中最多會設定一個欄位：
contactInfoList

object (ContactInfoList)

僅限輸入。聯絡資訊清單，用於定義初始目標對象成員。

僅適用於「audienceType」CUSTOMER_MATCH_CONTACT_INFO
mobileDeviceIdList

object (MobileDeviceIdList)

僅限輸入。行動裝置 ID 清單，用於定義初始目標對象成員。

僅適用於「audienceType」CUSTOMER_MATCH_DEVICE_ID
互斥欄位的結尾。

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，要求會傳回錯誤。

FirstPartyAndPartnerAudienceType

第一方和合作夥伴目標對象資源的可能類型。

列舉
FIRST_PARTY_AND_PARTNER_AUDIENCE_TYPE_UNSPECIFIED 如果未指定或不明類型，則為預設值。
TYPE_FIRST_PARTY 使用顧客資料建立的目標對象。
TYPE_PARTNER 由第三方資料供應商提供的目標對象。

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 頻道的互動情形建立目標對象。
THIRD_PARTY 目標對象已獲得第三方授權使用。
COMMERCE 由商務夥伴提供，需付費。
LINEAR 傳統電視內容的目標對象。
AGENCY 代理商提供的目標對象。

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 源自廣告資料中心。

方法

create

 建立 FirstPartyAndPartnerAudience。

editCustomerMatchMembers

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

get

 取得第一方或合作夥伴目標對象。

list

 列出第一方和夥伴目標對象。

patch

 更新現有的 FirstPartyAndPartnerAudience。