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 系統會透過比對顧客與已知使用者 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 清單，用於定義目標顧客比對目標對象成員。mobileDeviceIds 的大小不得超過 500,000。
consent

object (Consent)

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

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

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

方法

create

 建立 FirstAndThirdPartyAudience。

editCustomerMatchMembers

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

get

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

list

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

patch

 更新現有的 FirstAndThirdPartyAudience。