UserList

使用者名單。這是客戶可能指定的使用者名單。

JSON 表示法 
{
  "resourceName": string,
  "membershipStatus": enum (UserListMembershipStatus),
  "sizeRangeForDisplay": enum (UserListSizeRange),
  "sizeRangeForSearch": enum (UserListSizeRange),
  "type": enum (UserListType),
  "closingReason": enum (UserListClosingReason),
  "accessReason": enum (AccessReason),
  "accountUserListStatus": enum (UserListAccessStatus),
  "id": string,
  "readOnly": boolean,
  "name": string,
  "description": string,
  "integrationCode": string,
  "membershipLifeSpan": string,
  "sizeForDisplay": string,
  "sizeForSearch": string,
  "eligibleForSearch": boolean,
  "eligibleForDisplay": boolean,
  "matchRatePercentage": integer,

  // Union field user_list can be only one of the following:
  "crmBasedUserList": {
    object (CrmBasedUserListInfo)
  },
  "similarUserList": {
    object (SimilarUserListInfo)
  },
  "ruleBasedUserList": {
    object (RuleBasedUserListInfo)
  },
  "logicalUserList": {
    object (LogicalUserListInfo)
  },
  "basicUserList": {
    object (BasicUserListInfo)
  }
  // End of list of possible types for union field user_list.
}
欄位
resourceName

string

不可變動。使用者名單的資源名稱。使用者名單資源名稱的形式如下：

customers/{customerId}/userLists/{userListId}
membershipStatus

enum (UserListMembershipStatus)

這份使用者名單的會員資格狀態。指出使用者名單為公開還是有效。只有開放的使用者名單可累積更多使用者，並且可做為指定目標。
sizeRangeForDisplay

enum (UserListSizeRange)

僅供輸出。大小範圍，以「UserList」在 Google 多媒體廣告聯播網上的使用者人數為準。

這是唯讀欄位。
type

enum (UserListType)

僅供輸出。此清單的類型。

這是唯讀欄位。
closingReason

enum (UserListClosingReason)

說明這項使用者名單成員資格狀態關閉的原因。只會針對因閒置而自動關閉的名單填入資料，且會在名單成員資格狀態開啟後清除。
accessReason

enum (AccessReason)

僅供輸出。指出這個帳戶獲準存取名單的原因。例如「共用」、「自有」、「已授權」或「已訂閱」。

這是唯讀欄位。
accountUserListStatus

enum (UserListAccessStatus)

指出是否仍啟用此共用。與使用者共用 UserList 時，這個欄位會設為「已啟用」。userList 擁有者之後可以選擇撤銷共用，並將其設為「已停用」。這個欄位的預設值是「已啟用」。
id

string (int64 format)

僅供輸出。使用者名單的編號。
readOnly

boolean

僅供輸出。這個選項指出使用者是否可修改名單。此值取決於名單的所有權和類型。比如說，外部再行銷使用者名單就不能修改。

這是唯讀欄位。
name

string

此使用者名單的名稱。視 accessReason 而定，使用者名單名稱可能不得重複 (例如，若 accessReason=SHARED)
description

string

此使用者名單的說明。
integrationCode

string

外部系統產生的 ID。使用者名單賣方會用來連結自家系統上的 ID。
membershipLifeSpan

string (int64 format)

自使用者加入名單以來，使用者 Cookie 留在名單上的天數。此欄位的值必須介於 0 到 540 (含) 之間。不過，如果是以客戶關係管理系統為基礎的使用者名單，這個欄位可設為 10000，代表沒有到期時間。

如果是 logicalUserList 和 ruleBasedUserList 類型，系統會忽略這個欄位。這些類型的清單成員資格取決於清單定義的規則。
sizeForDisplay

string (int64 format)

僅供輸出。這份使用者名單在 Google 多媒體廣告聯播網上的預估使用者人數。若無法判斷使用者人數，此值會是 null。

這是唯讀欄位。
eligibleForDisplay

boolean

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

這是唯讀欄位。
matchRatePercentage

integer

僅供輸出。表示目標顧客比對名單的媒合率。這個欄位的範圍是 [0-100]。若其他名單類型無法計算媒合率，則這個值會是空值。

這是唯讀欄位。

聯集欄位 user_list。使用者名單。

只能設定一個值。user_list 只能採用下列其中一種設定：
crmBasedUserList

object (CrmBasedUserListInfo)

廣告主提供的客戶關係管理使用者清單。
similarUserList

object (SimilarUserListInfo)

僅供輸出。與另一個 UserList 中的使用者類似的使用者名單。這些清單為唯讀狀態，並由 Google 自動建立。
ruleBasedUserList

object (RuleBasedUserListInfo)

規則產生的使用者名單。
logicalUserList

object (LogicalUserListInfo)

結合使用者名單和使用者興趣的使用者名單。
basicUserList

object (BasicUserListInfo)

指定一組轉換或再行銷動作的使用者名單。

UserListMembershipStatus

列舉包括可能的使用者名單成員資格狀態。

列舉
UNSPECIFIED 未指定。
UNKNOWN 僅用於傳回值。代表這個版本未知的值。
OPEN 開放狀態 - 名單正在累積會員，可以做為指定目標。
CLOSED 關閉狀態 - 沒有任何新會員加入，無法用於指定目標。

UserListSizeRange

列舉包含可能的使用者名單大小範圍。

列舉
UNSPECIFIED 未指定。
UNKNOWN 僅用於傳回值。代表這個版本未知的值。
LESS_THAN_FIVE_HUNDRED 使用者名單少於 500 位使用者。
LESS_THAN_ONE_THOUSAND 使用者名單的使用者介於 500 至 1000 人之間。
ONE_THOUSAND_TO_TEN_THOUSAND 使用者名單的使用者介於 1000 至 10,000 之間。
TEN_THOUSAND_TO_FIFTY_THOUSAND 使用者名單的使用者人數介於 10,000 至 50,000 之間。
FIFTY_THOUSAND_TO_ONE_HUNDRED_THOUSAND 使用者名單的使用者介於 50,000 至 100000 之間。
ONE_HUNDRED_THOUSAND_TO_THREE_HUNDRED_THOUSAND 使用者名單的使用者介於 100,000 至 300,000 之間。
THREE_HUNDRED_THOUSAND_TO_FIVE_HUNDRED_THOUSAND 使用者名單的使用者人數介於 300,000 至 500000 之間。
FIVE_HUNDRED_THOUSAND_TO_ONE_MILLION 使用者名單的使用者介於 500 萬到 100 萬人。
ONE_MILLION_TO_TWO_MILLION 使用者名單的使用者介於 1 至 200 萬人。
TWO_MILLION_TO_THREE_MILLION 使用者名單人數介於 2 到 300 萬人之間。
THREE_MILLION_TO_FIVE_MILLION 使用者名單人數介於 3 至 500 萬人之間。
FIVE_MILLION_TO_TEN_MILLION 使用者名單的使用者介於 5 至 1 千萬人。
TEN_MILLION_TO_TWENTY_MILLION 使用者名單的使用者介於 10 至 2 千萬人。
TWENTY_MILLION_TO_THIRTY_MILLION 使用者名單的使用者介於 20 至 3 千萬人。
THIRTY_MILLION_TO_FIFTY_MILLION 使用者名單的使用者介於 30 至 5 千萬人。
OVER_FIFTY_MILLION 使用者名單有超過 5 千萬名使用者。

UserListType

列舉包括可能的使用者名單類型。

列舉
UNSPECIFIED 未指定。
UNKNOWN 僅用於傳回值。代表這個版本未知的值。
REMARKETING 以一組轉換類型代表 UserList。
LOGICAL 以其他使用者名單/興趣的組合代表 UserList。
EXTERNAL_REMARKETING 在 Google Ad Manager 平台中建立的使用者名單。
RULE_BASED 與規則相關聯的使用者名單。
SIMILAR 使用者名單，與另一個 UserList 中使用者類似的使用者。
CRM_BASED 廣告主以電子郵件或其他格式形式提供的第一方客戶關係管理資料使用者名單。

UserListClosingReason

舉例說明使用者清單可能關閉的原因。

列舉
UNSPECIFIED 未指定。
UNKNOWN 僅用於傳回值。代表這個版本未知的值。
UNUSED 這份使用者名單已閒置超過一年，因此已關閉。

AccessReason

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

列舉
UNSPECIFIED 未指定。
UNKNOWN 僅用於傳回值。代表這個版本未知的值。
OWNED 資源為使用者所有。
SHARED 資源會分享給使用者。
LICENSED 使用者已授權資源。
SUBSCRIBED 使用者已訂閱資源。
AFFILIATED 使用者可以存取資源。

UserListAccessStatus

列舉包括可能的使用者名單存取權狀態。

列舉
UNSPECIFIED 未指定。
UNKNOWN 僅用於傳回值。代表這個版本未知的值。
ENABLED 已啟用存取權。
DISABLED 存取權已停用。

CrmBasedUserListInfo

廣告主提供的客戶關係管理使用者清單。

JSON 表示法 
{
  "uploadKeyType": enum (CustomerMatchUploadKeyType),
  "dataSourceType": enum (UserListCrmDataSourceType),
  "appId": string
}
欄位
uploadKeyType

enum (CustomerMatchUploadKeyType)

清單的鍵類型。同一份清單不得列出混合資料類型。這是 ADD 作業的必填欄位。
dataSourceType

enum (UserListCrmDataSourceType)

清單的資料來源。預設值為 FIRST_PARTY。只有許可清單上的客戶可以建立第三方來源的客戶關係管理名單。
appId

string

專門用來識別收集資料來源行動應用程式的字串。以 iOS 來說，ID 字串是 App Store 網址結尾顯示的 9 位數字串 (例如「476943146」代表「Flood-It!」2」的 App Store 連結為 http://itunes.apple.com/us/app/flood-it!-2/id476943146)。以 Android 來說，ID 字串是應用程式的套件名稱 (例如「Color Drips」的「com.labpixies.colordrips」表示 Google Play 連結為 https://play.google.com/store/apps/details?id=com.labpixies.colordrips)。建立 CrmBasedUserList 以上傳行動廣告 ID 時必填。

CustomerMatchUploadKeyType

列舉說明可能的目標顧客比對上傳金鑰類型。

列舉
UNSPECIFIED 未指定。
UNKNOWN 僅用於傳回值。代表這個版本未知的值。
CONTACT_INFO 系統會比對客戶資訊 (例如電子郵件地址、電話號碼或實際地址) 中的客戶資訊。
CRM_ID 系統會透過廣告客戶產生並指派的使用者 ID 比對成員。
MOBILE_ADVERTISING_ID 系統會比對成員與行動廣告 ID。

UserListCrmDataSourceType

列舉可能的使用者名單 crm 資料來源類型。

列舉
UNSPECIFIED 未指定。
UNKNOWN 僅用於傳回值。代表這個版本未知的值。
FIRST_PARTY 上傳的資料屬於第一方資料。
THIRD_PARTY_CREDIT_BUREAU 上傳的資料來自第三方徵信機構。
THIRD_PARTY_VOTER_FILE 上傳的資料來自第三方選民檔案。

SimilarUserListInfo

SimilarUserList 是與另一個 UserList 中使用者類似的使用者清單。這些清單僅供讀取，並由 Google 自動建立。

JSON 表示法 
{
  "seedUserList": string
}
欄位
seedUserList

string

此名單的來源種子使用者清單。

RuleBasedUserListInfo

代表規則產生的使用者名單。

JSON 表示法 
{
  "prepopulationStatus": enum (UserListPrepopulationStatus),
  "flexibleRuleUserList": {
    object (FlexibleRuleUserListInfo)
  }
}
欄位
prepopulationStatus

enum (UserListPrepopulationStatus)

預先填入的狀態。如果未設定，這個欄位會預設為「NONE」，代表系統不會將先前的使用者納入考量。如果設為 REQUESTED，系統會將符合名單定義的過往網站訪客或應用程式使用者 (僅適用於多媒體廣告聯播網) 加入名單。不過，視名單的再行銷效期和加入再行銷代碼的日期而定，系統只會加入最近 30 天內過去的使用者。要求處理完畢後，狀態會更新為「FINISHED」；如果要求失敗，狀態會更新為「失敗」。
flexibleRuleUserList

object (FlexibleRuleUserListInfo)

富有彈性的規則，表示包含一或多項動作的訪客。彈性使用者名單是由兩份運算元清單 (含運算元和獨家運算元) 定義；每個運算元都代表一群使用者在特定時間範圍內採取的動作。這些運算元清單會與 AND_NOT 運算子合併，因此以內含運算元代表的使用者，納入使用者名單中，再減去專屬運算元代表的使用者。

UserListPrepopulationStatus

列舉說明可能的使用者名單預先填入狀態。

列舉
UNSPECIFIED 未指定。
UNKNOWN 僅用於傳回值。代表這個版本未知的值。
REQUESTED 正在要求預先填入。
FINISHED 預先填入完成。
FAILED 無法預先填入。

FlexibleRuleUserListInfo

富有彈性的規則，表示包含一或多項動作的訪客。彈性使用者名單是由兩份運算元清單 (含運算元和獨家運算元) 定義；每個運算元都代表一群使用者在特定時間範圍內採取的動作。這些運算元清單會與 AND_NOT 運算子合併，因此以內含運算元代表的使用者，納入使用者名單中，再減去專屬運算元代表的使用者。

JSON 表示法 
{
  "inclusiveRuleOperator": enum (UserListFlexibleRuleOperator),
  "inclusiveOperands": [
    {
      object (FlexibleRuleOperandInfo)
    }
  ],
  "exclusiveOperands": [
    {
      object (FlexibleRuleOperandInfo)
    }
  ]
}
欄位
inclusiveRuleOperator

enum (UserListFlexibleRuleOperator)

用於定義包含運算元如何合併的運算子。
inclusiveOperands[]

object (FlexibleRuleOperandInfo)

規則代表應納入使用者名單中的使用者。這些位於 AND_NOT 運算子左側，並由 AND/OR 指定 (由 inclusiveRuleOperator 指定) 合併。
exclusiveOperands[]

object (FlexibleRuleOperandInfo)

規則代表應從使用者名單中排除的使用者。這些位於 AND_NOT 運算子的右側，並以 OR 聯結。

UserListFlexibleRuleOperator

列舉說明可能的使用者名單合併規則運算子。

列舉
UNSPECIFIED 未指定。
UNKNOWN 僅用於傳回值。代表這個版本未知的值。
AND A AND B。
OR A 或 B。

FlexibleRuleOperandInfo

提供彈性的規則，包含通用規則和回溯期。

JSON 表示法 
{
  "rule": {
    object (UserListRuleInfo)
  },
  "lookbackWindowDays": string
}
欄位
rule

object (UserListRuleInfo)

定義此規則的規則項目群組清單。規則項目群組會歸入同一組。
lookbackWindowDays

string (int64 format)

這項規則的回溯期 (以天為單位)。從現在起到 X 天前。

UserListRuleInfo

根據網站傳送或由廣告客戶上傳的自訂參數，由客戶定義的規則。

JSON 表示法 
{
  "ruleType": enum (UserListRuleType),
  "ruleItemGroups": [
    {
      object (UserListRuleItemGroupInfo)
    }
  ]
}
欄位
ruleType

enum (UserListRuleType)

規則類型會決定規則項目分組方式。

預設值為 ANDs 的 OR (幹擾標準格式)。也就是說，規則項目群組中的規則項目會以「AND」結合在一起，而群組本身會以「OR」結合。

FlexRuleUserList 唯一支援的類型是 OR。
ruleItemGroups[]

object (UserListRuleItemGroupInfo)

定義此規則的規則項目群組清單。規則項目群組會根據規則類型分為一組。

UserListRuleType

列舉說明可能的使用者名單規則類型。

列舉
UNSPECIFIED 未指定。
UNKNOWN 僅用於傳回值。代表這個版本未知的值。
AND_OF_ORS 綜合常態。
OR_OF_ANDS 阻斷正常形式。

UserListRuleItemGroupInfo

一組規則項目。

JSON 表示法 
{
  "ruleItems": [
    {
      object (UserListRuleItemInfo)
    }
  ]
}
欄位
ruleItems[]

object (UserListRuleItemInfo)

系統會根據規則類型將規則項目分為一組。

UserListRuleItemInfo

不可分割的規則項目。

JSON 表示法 
{
  "name": string,

  // Union field rule_item can be only one of the following:
  "numberRuleItem": {
    object (UserListNumberRuleItemInfo)
  },
  "stringRuleItem": {
    object (UserListStringRuleItemInfo)
  },
  "dateRuleItem": {
    object (UserListDateRuleItemInfo)
  }
  // End of list of possible types for union field rule_item.
}
欄位
name

string

規則變數名稱。這個值應與像素觸發的對應鍵名稱相符。名稱只能使用 US-ascii 字母或底線，或是大於 127 的 UTF8 代碼，且必須由美國 ASCII 字母/數字、底線或大於 127 的 UTF8 編碼組成。網站有兩個內建變數網址 (name = 'url__') 和參照網址 (name = 'ref_url__')。建立新的規則項目時，必須填寫這個欄位。
聯集欄位 rule_item。不可分割的規則項目。rule_item 只能是下列其中一項：
numberRuleItem

object (UserListNumberRuleItemInfo)

由數字運算組成的不可分割規則項目。
stringRuleItem

object (UserListStringRuleItemInfo)

由字串運算組成的不可分割規則項目。
dateRuleItem

object (UserListDateRuleItemInfo)

由日期運算組成的不可分割規則項目。

UserListNumberRuleItemInfo

由數字運算組成的規則項目。

JSON 表示法 
{
  "operator": enum (UserListNumberRuleItemOperator),
  "value": number
}
欄位
operator

enum (UserListNumberRuleItemOperator)

數字比較運算子。這是必填欄位，必須在建立新的數字規則項目時填入。
value

number

要與變數比較的數值。這是必填欄位，必須在建立新的數字規則項目時填入。

UserListNumberRuleItemOperator

列舉說明可能的使用者清單編號規則項目運算子。

列舉
UNSPECIFIED 未指定。
UNKNOWN 僅用於傳回值。代表這個版本未知的值。
GREATER_THAN 大於。
GREATER_THAN_OR_EQUAL 大於或等於。
EQUALS 等於。
NOT_EQUALS 不等於。
LESS_THAN 小於。
LESS_THAN_OR_EQUAL 小於或等於。

UserListStringRuleItemInfo

由字串運算組成的規則項目。

JSON 表示法 
{
  "operator": enum (UserListStringRuleItemOperator),
  "value": string
}
欄位
operator

enum (UserListStringRuleItemOperator)

字串比較運算子。這是必填欄位，必須在建立新的字串規則項目時填入。
value

string

字串規則項目的右側。如果是網址或參照網址，則此值不能包含無效的網址字元，例如換行符號、引號、定位點或括號。這是必填欄位，必須在建立新的字串規則項目時填入。

UserListStringRuleItemOperator

列舉說明可能的使用者名單字串規則項目運算子。

列舉
UNSPECIFIED 未指定。
UNKNOWN 僅用於傳回值。代表這個版本未知的值。
CONTAINS 包含。
EQUALS 等於。
STARTS_WITH 開頭為。
ENDS_WITH 結尾是。
NOT_EQUALS 不等於。
NOT_CONTAINS 不包含。
NOT_STARTS_WITH 開頭不是。
NOT_ENDS_WITH 結尾不是。

UserListDateRuleItemInfo

由日期作業組成的規則項目。

JSON 表示法 
{
  "operator": enum (UserListDateRuleItemOperator),
  "value": string,
  "offsetInDays": string
}
欄位
operator

enum (UserListDateRuleItemOperator)

日期比較運算子。這是必填欄位，必須在建立新的日期規則項目時填入。
value

string

字串，代表要與規則變數比較的日期值。支援的日期格式為 YYYY-MM-DD。系統回報的時間以客戶的時區為準。
offsetInDays

string (int64 format)

右側的相對日期值，以與現在相差的天數表示。如果兩者同時存在，則會覆寫這個欄位。

UserListDateRuleItemOperator

列舉說明可能的使用者清單日期規則項目運算子。

列舉
UNSPECIFIED 未指定。
UNKNOWN 僅用於傳回值。代表這個版本未知的值。
EQUALS 等於。
NOT_EQUALS 不等於。
BEFORE 之前。
AFTER 之後，

LogicalUserListInfo

代表自訂的使用者名單組合。

JSON 表示法 
{
  "rules": [
    {
      object (UserListLogicalRuleInfo)
    }
  ]
}
欄位
rules[]

object (UserListLogicalRuleInfo)

用來定義此使用者名單的邏輯名單規則。由邏輯運算子 (ALL/ANY/NONE) 和一份使用者名單清單定義。系統在評估所有規則時，都會以「AND」運算子處理。

這是建立邏輯使用者名單的必要項目。

UserListLogicalRuleInfo

使用者名單邏輯規則。規則包含一個邏輯運算子 (和/或/非) 和一組做為運算元的使用者名單。

JSON 表示法 
{
  "operator": enum (UserListLogicalRuleOperator),
  "ruleOperands": [
    {
      object (LogicalUserListOperandInfo)
    }
  ]
}
欄位
operator

enum (UserListLogicalRuleOperator)

規則的邏輯運算子。
ruleOperands[]

object (LogicalUserListOperandInfo)

規則的運算元清單。

UserListLogicalRuleOperator

列舉說明可能的使用者名單邏輯規則運算子。

列舉
UNSPECIFIED 未指定。
UNKNOWN 僅用於傳回值。代表這個版本未知的值。
ALL And - 所有運算元。
ANY Or - 至少一個運算元。
NONE Not - 不含任何運算元。

LogicalUserListOperandInfo

由使用者名單組成的邏輯使用者名單的運算元。

JSON 表示法 
{
  "userList": string
}
欄位
userList

string

使用者清單做為運算元的資源名稱。

BasicUserListInfo

指定使用者名單，做為一組轉換或再行銷動作。

JSON 表示法 
{
  "actions": [
    {
      object (UserListActionInfo)
    }
  ]
}
欄位
actions[]

object (UserListActionInfo)

與這份使用者名單相關的動作。

UserListActionInfo

代表用來建立再行銷使用者名單的動作類型。

JSON 表示法 
{

  // Union field user_list_action can be only one of the following:
  "conversionAction": string,
  "remarketingAction": string
  // End of list of possible types for union field user_list_action.
}
欄位
聯集欄位 user_list_action。使用者名單動作的子類型。user_list_action 只能是下列其中一項：
conversionAction

string

並非透過再行銷產生的轉換動作。
remarketingAction

string

再行銷動作。