REST Resource: accountTypes.accounts.userLists

資源：UserList

使用者清單資源。

JSON 表示法 
{
  "name": string,
  "id": string,
  "readOnly": boolean,
  "membershipDuration": string,
  "accessReason": enum (AccessReason),
  "sizeInfo": {
    object (SizeInfo)
  },
  "targetNetworkInfo": {
    object (TargetNetworkInfo)
  },
  "displayName": string,
  "description": string,
  "membershipStatus": enum (MembershipStatus),
  "integrationCode": string,
  "closingReason": enum (ClosingReason),
  "accountAccessStatus": enum (AccessStatus),

  // Union field user_list_info can be only one of the following:
  "ingestedUserListInfo": {
    object (IngestedUserListInfo)
  }
  // End of list of possible types for union field user_list_info.
}
欄位
name

string

ID。使用者名單的資源名稱。格式：accountTypes/{accountType}/accounts/{account}/userLists/{userList}
id

string (int64 format)

僅供輸出。使用者名單的專屬 ID。
readOnly

boolean

僅供輸出。這個選項會指出使用者是否可以編輯清單。
membershipDuration

string (Duration format)

(選用步驟) 使用者在使用者名單中的保留時間。有效時間長度必須是 24 小時 (86400 秒) 的整數倍數。如果提供的值不是 24 小時的確切倍數，系統會傳回 INVALID_ARGUMENT 錯誤。

時間長度以秒為單位，最多可有 9 個小數位數，並應以「s」結尾，例如："3.5s"。
accessReason

enum (AccessReason)

僅供輸出。這個帳戶獲准存取名單的原因。
sizeInfo

object (SizeInfo)

僅供輸出。不同目標聯播網中，這份使用者名單的預估成員人數。
targetNetworkInfo

object (TargetNetworkInfo)

(選用步驟) 不同目標聯播網的資格資訊。
displayName

string

必填。使用者清單的顯示名稱。
description

string

(選用步驟) 使用者清單的說明。
membershipStatus

enum (MembershipStatus)

(選用步驟) 這份使用者名單的成員資格狀態。
integrationCode

string

(選用步驟) 外部系統的 ID。使用者名單賣家會使用這項資訊，在自家系統中建立 ID 關聯。
closingReason

enum (ClosingReason)

僅供輸出。使用者名單成員資格狀態關閉的原因。
accountAccessStatus

enum (AccessStatus)

(選用步驟) 指出這項共用功能是否仍處於啟用狀態。當使用者名單與這個欄位設為 ENABLED 的帳戶共用時，之後使用者名單擁有者可以決定撤銷共用，並設為 DISABLED。
聯集欄位 user_list_info。使用者名單的其他資訊。user_list_info 只能是下列其中一項：
ingestedUserListInfo

object (IngestedUserListInfo)

(選用步驟) 代表由使用者擷取資料填入的使用者名單。

MembershipStatus

使用者名單的狀態。

列舉
MEMBERSHIP_STATUS_UNSPECIFIED 不指定。
OPEN 開放狀態 - 使用者名單正在累積成員，且可供指定。
CLOSED 「已關閉」狀態：無法新增成員。

ClosingReason

指出使用者清單關閉的原因。只有在系統自動關閉清單時，才會使用這個列舉。

列舉
CLOSING_REASON_UNSPECIFIED 不指定。
UNUSED 由於使用者名單近期未用於指定目標，因此已關閉。詳情請參閱 https://support.google.com/google-ads/answer/2472738。

AccessReason

列舉說明可能的存取原因。

列舉
ACCESS_REASON_UNSPECIFIED 不指定。
OWNED 資源屬於使用者。
SHARED 資源已與使用者共用。
LICENSED 使用者已獲得資源授權。
SUBSCRIBED 使用者已訂閱資源。
AFFILIATED 使用者可以存取資源。

AccessStatus

指出這個用戶端是否仍可存取清單。

列舉
ACCESS_STATUS_UNSPECIFIED 不指定。
ENABLED 存取權已啟用。
DISABLED 存取權已停用。

SizeInfo

不同目標聯播網中，這份使用者名單的預估成員人數。

JSON 表示法 
{
  "displayNetworkMembersCount": string,
  "searchNetworkMembersCount": string,
  "youtubeMembersCount": string,
  "gmailMembersCount": string
}
欄位
displayNetworkMembersCount

string (int64 format)

僅供輸出。Google 多媒體廣告聯播網上這份使用者名單的預估成員人數。
searchNetworkMembersCount

string (int64 format)

僅供輸出。google.com 網域中，這份使用者名單的預估成員人數。這些成員可做為搜尋廣告活動的指定目標。
youtubeMembersCount

string (int64 format)

僅供輸出。YouTube 上這份使用者名單的預估成員人數。
gmailMembersCount

string (int64 format)

僅供輸出。這份 Gmail 使用者名單的預估成員人數。

TargetNetworkInfo

不同目標聯播網的資格資訊。

JSON 表示法 
{
  "eligibleForDisplay": boolean,
  "eligibleForSearch": boolean
}
欄位
eligibleForDisplay

boolean

僅供輸出。表示這份使用者名單符合 Google 多媒體廣告聯播網的資格。

IngestedUserListInfo

代表由使用者提供的資料填入的使用者名單。

JSON 表示法 
{
  "uploadKeyTypes": [
    enum (UploadKeyType)
  ],
  "contactIdInfo": {
    object (ContactIdInfo)
  },
  "mobileIdInfo": {
    object (MobileIdInfo)
  },
  "userIdInfo": {
    object (UserIdInfo)
  },
  "pairIdInfo": {
    object (PairIdInfo)
  },
  "pseudonymousIdInfo": {
    object (PseudonymousIdInfo)
  },
  "partnerAudienceInfo": {
    object (PartnerAudienceInfo)
  }
}
欄位
uploadKeyTypes[]

enum (UploadKeyType)

必填。不可變動。這份使用者名單的上傳金鑰類型。
contactIdInfo

object (ContactIdInfo)

(選用步驟) 如果 CONTACT_ID 是 uploadKeyTypes 之一，則為其他資訊。
mobileIdInfo

object (MobileIdInfo)

(選用步驟) 如果 MOBILE_ID 是 uploadKeyTypes 之一，則為其他資訊。
userIdInfo

object (UserIdInfo)

(選用步驟) 如果 USER_ID 是 uploadKeyTypes 之一，則為其他資訊。
pairIdInfo

object (PairIdInfo)

(選用步驟) 如果 PAIR_ID 是 uploadKeyTypes 之一，則為其他資訊。

這項功能僅供資料合作夥伴使用。
pseudonymousIdInfo

object (PseudonymousIdInfo)

(選用步驟) 「PSEUDONYMOUS_ID」的其他資訊是「uploadKeyTypes」之一。
partnerAudienceInfo

object (PartnerAudienceInfo)

(選用步驟) 合作夥伴目標對象的其他資訊。

這項功能僅供資料合作夥伴使用。

UploadKeyType

列舉，內含使用者名單的可能上傳金鑰類型。

列舉
UPLOAD_KEY_TYPE_UNSPECIFIED 不指定。
CONTACT_ID 顧客資訊，例如電子郵件地址、電話號碼或實際地址。
MOBILE_ID 行動廣告 ID。
USER_ID 第三方提供的使用者 ID。
PAIR_ID 發布商及廣告主使用者身分資料比對 ID。
PSEUDONYMOUS_ID 資料管理平台 ID：- Google 使用者 ID - 合作夥伴提供的 ID - 發布商提供的 ID - iOS 廣告識別碼 - Android 廣告 ID - Roku ID - Amazon Fire TV ID - Xbox 或 Microsoft ID

ContactIdInfo

如果 CONTACT_ID 是 uploadKeyTypes 之一，則為其他資訊。

JSON 表示法 
{
  "matchRatePercentage": integer,
  "dataSourceType": enum (DataSourceType)
}
欄位
matchRatePercentage

integer

僅供輸出。目標顧客比對使用者名單的媒合率。
dataSourceType

enum (DataSourceType)

(選用步驟) 不可變動。上傳資料的來源

DataSourceType

指出上傳資料的來源。

列舉
DATA_SOURCE_TYPE_UNSPECIFIED 不指定。
DATA_SOURCE_TYPE_FIRST_PARTY 上傳的資料是第一方資料。
DATA_SOURCE_TYPE_THIRD_PARTY_CREDIT_BUREAU 上傳的資料來自第三方徵信機構。
DATA_SOURCE_TYPE_THIRD_PARTY_VOTER_FILE 上傳的資料來自第三方選民檔案。
DATA_SOURCE_TYPE_THIRD_PARTY_PARTNER_DATA 上傳的資料是第三方合作夥伴資料。

MobileIdInfo

如果 MOBILE_ID 是 uploadKeyTypes 之一，則為其他資訊。

JSON 表示法 
{
  "dataSourceType": enum (DataSourceType),
  "keySpace": enum (KeySpace),
  "appId": string
}
欄位
dataSourceType

enum (DataSourceType)

(選用步驟) 不可變動。上傳資料的來源。
keySpace

enum (KeySpace)

必填。不可變動。行動 ID 的主要空間。
appId

string

必填。不可變動。這個字串可唯一識別收集資料的行動應用程式。

KeySpace

行動 ID 的金鑰空間。

列舉
KEY_SPACE_UNSPECIFIED 不指定。
IOS iOS 鍵空間。
ANDROID Android 鍵空間。

UserIdInfo

如果 USER_ID 是 uploadKeyTypes 之一，則為其他資訊。

JSON 表示法 
{
  "dataSourceType": enum (DataSourceType)
}
欄位
dataSourceType

enum (DataSourceType)

(選用步驟) 不可變動。上傳資料的來源。

PairIdInfo

如果 PAIR_ID 是 uploadKeyTypes 之一，則為其他資訊。

這項功能僅供資料合作夥伴使用。

JSON 表示法 
{
  "publisherId": string,
  "publisherName": string,
  "matchRatePercentage": integer,
  "advertiserIdentifierCount": string,
  "cleanRoomIdentifier": string
}
欄位
publisherId

string (int64 format)

必填。不可變動。識別與發布商及廣告主使用者身分資料比對使用者名單比對的發布商。這個欄位由資料無塵室供應商提供，且僅在該無塵室的範圍內是唯一的。這無法做為多個淨室的通用 ID。
publisherName

string

必填。發布商的描述性名稱，會顯示在使用者介面中，提供更優質的指定目標體驗。
matchRatePercentage

integer

必填。這個欄位表示這份使用者名單與相應發布商第一方資料的會員比對百分比。必須介於 0 到 100 之間 (含 0 和 100)。
advertiserIdentifierCount

string (int64 format)

(選用步驟) 已上傳至資料無塵室供應商的廣告主第一方資料記錄數。這不代表 PAIR 使用者名單的大小。
cleanRoomIdentifier

string

必填。不可變動。識別與單一或多個資料無塵室供應商的專屬廣告主與發布商關係。

PseudonymousIdInfo

如果 PSEUDONYMOUS_ID 是 uploadKeyTypes 之一，則為其他資訊。

JSON 表示法 
{
  "syncStatus": enum (SyncStatus),
  "billableRecordCount": string
}
欄位
syncStatus

enum (SyncStatus)

僅供輸出。使用者清單的同步狀態。
billableRecordCount

string (int64 format)

(選用步驟) 不可變動。計費記錄數 (例如上傳或比對的記錄)。

SyncStatus

使用者清單的同步狀態。

列舉
SYNC_STATUS_UNSPECIFIED 不指定。
CREATED 使用者清單已建立為預留位置。清單內容和/或中繼資料仍在同步處理中。使用者名單尚未準備就緒。
READY_FOR_USE 使用者清單已可使用。內容和 Cookie 已正確同步。
FAILED 同步處理使用者清單內容和/或中繼資料時發生錯誤。無法使用使用者清單。

PartnerAudienceInfo

合作夥伴目標對象的其他資訊。

這項功能僅供資料合作夥伴使用。

JSON 表示法 
{
  "partnerAudienceSource": enum (PartnerAudienceSource),
  "commercePartner": string
}
欄位
partnerAudienceSource

enum (PartnerAudienceSource)

必填。不可變動。合作夥伴目標對象的來源。
commercePartner

string

(選用步驟) 商務夥伴名稱。只有在 partnerAudienceSource 為 COMMERCE_AUDIENCE 時才允許。

PartnerAudienceSource

合作夥伴目標對象來源。

列舉
PARTNER_AUDIENCE_SOURCE_UNSPECIFIED 不指定。
COMMERCE_AUDIENCE 合作夥伴目標對象來源為商務目標對象。
LINEAR_TV_AUDIENCE 合作夥伴目標對象來源為傳統電視目標對象。
AGENCY_PROVIDER_AUDIENCE 合作夥伴目標對象來源為代理商/供應商目標對象。

方法

create

 建立 UserList。

delete

 刪除 UserList。

get

 取得 UserList。

list

 列出 UserLists。

patch

 更新 UserList。