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

ตัวระบุ ชื่อทรัพยากรของกลุ่มเป้าหมายตามรายชื่อผู้ใช้ รูปแบบ: accountTypes/{accountType}/accounts/{account}/userLists/{userList}
id

string (int64 format)

เอาต์พุตเท่านั้น รหัสที่ไม่ซ้ำกันของรายการผู้ใช้
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

ไม่บังคับ รหัสจากระบบภายนอก ผู้ขายรายชื่อผู้ใช้ใช้รหัสนี้เพื่อเชื่อมโยงรหัสในระบบของตน
closingReason

enum (ClosingReason)

เอาต์พุตเท่านั้น สาเหตุที่สถานะการเป็นสมาชิกในรายชื่อผู้ใช้นี้ปิดอยู่
accountAccessStatus

enum (AccessStatus)

ไม่บังคับ ระบุว่ายังเปิดใช้การแชร์นี้อยู่หรือไม่ เมื่อแชร์กลุ่มเป้าหมายตามผู้ใช้กับบัญชี ระบบจะตั้งค่าช่องนี้เป็น ENABLED ต่อมาเจ้าของรายชื่อผู้ใช้สามารถเลือกเพิกถอนการแชร์และทำให้เป็นDISABLEDได้
ฟิลด์ Union user_list_info ข้อมูลเพิ่มเติมเกี่ยวกับกลุ่มเป้าหมายตามรายการผู้ใช้ user_list_info ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
ingestedUserListInfo

object (IngestedUserListInfo)

ไม่บังคับ แสดงรายการผู้ใช้ที่สร้างขึ้นจากข้อมูลผู้ใช้ที่นําเข้า

MembershipStatus

สถานะของกลุ่มเป้าหมายตามรายชื่อผู้ใช้

Enum
MEMBERSHIP_STATUS_UNSPECIFIED ไม่ได้ระบุ
OPEN เปิด - รายชื่อผู้ใช้กำลังสะสมสมาชิกและกำหนดเป้าหมายได้
CLOSED สถานะปิด - ไม่มีการเพิ่มสมาชิกใหม่

ClosingReason

ระบุสาเหตุที่ปิดรายชื่อผู้ใช้ ระบบจะใช้การแจงนับนี้เฉพาะเมื่อระบบปิดรายการโดยอัตโนมัติ

Enum
CLOSING_REASON_UNSPECIFIED ไม่ได้ระบุ
UNUSED ระบบปิดรายการผู้ใช้เนื่องจากไม่ได้ใช้ในการกำหนดเป้าหมายเมื่อเร็วๆ นี้ ดูรายละเอียดได้ที่ https://support.google.com/google-ads/answer/2472738

AccessReason

Enum ที่อธิบายเหตุผลที่เป็นไปได้ในการเข้าถึง

Enum
ACCESS_REASON_UNSPECIFIED ไม่ได้ระบุ
OWNED ผู้ใช้เป็นเจ้าของทรัพยากร
SHARED ระบบจะแชร์ทรัพยากรกับผู้ใช้
LICENSED ผู้ใช้ได้รับอนุญาตให้ใช้ทรัพยากร
SUBSCRIBED ผู้ใช้ติดตามทรัพยากร
AFFILIATED ผู้ใช้เข้าถึงทรัพยากรได้

AccessStatus

ระบุว่าไคลเอ็นต์นี้ยังมีสิทธิ์เข้าถึงรายการอยู่หรือไม่

Enum
ACCESS_STATUS_UNSPECIFIED ไม่ได้ระบุ
ENABLED เปิดใช้การเข้าถึงแล้ว
DISABLED ระบบปิดใช้สิทธิ์เข้าถึงแล้ว

SizeInfo

จํานวนสมาชิกโดยประมาณในรายชื่อผู้ใช้นี้ในเครือข่ายเป้าหมายต่างๆ

การแสดง JSON 
{
  "displayNetworkMembersCount": string,
  "searchNetworkMembersCount": string
}
ช่อง
displayNetworkMembersCount

string (int64 format)

เอาต์พุตเท่านั้น จํานวนสมาชิกโดยประมาณในรายชื่อผู้ใช้นี้บนเครือข่าย Display ของ Google
searchNetworkMembersCount

string (int64 format)

เอาต์พุตเท่านั้น จํานวนโดยประมาณของสมาชิกในกลุ่มเป้าหมายตามรายชื่อผู้ใช้ในโดเมน google.com ซึ่งเป็นสมาชิกที่ใช้ได้สําหรับการกําหนดเป้าหมายในแคมเปญ Search

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

Enum ที่มีประเภทคีย์การอัปโหลดที่เป็นไปได้ของรายชื่อผู้ใช้

Enum
UPLOAD_KEY_TYPE_UNSPECIFIED ไม่ได้ระบุ
CONTACT_ID ข้อมูลลูกค้า เช่น อีเมล หมายเลขโทรศัพท์ หรือที่อยู่
MOBILE_ID รหัสโฆษณาบนอุปกรณ์เคลื่อนที่
USER_ID รหัสผู้ใช้ที่บุคคลที่สามระบุ
PAIR_ID รหัสการกระทบยอดข้อมูลระบุตัวตนของผู้เผยแพร่โฆษณา
PSEUDONYMOUS_ID รหัสแพลตฟอร์มการจัดการข้อมูล: - รหัสผู้ใช้ Google - รหัสที่พาร์ทเนอร์ระบุ - รหัสที่ผู้เผยแพร่โฆษณาระบุ - IDFA ของ iOS - รหัสโฆษณา Android - รหัส Roku - รหัส Amazon Fire TV - รหัส Xbox หรือ Microsoft

ContactIdInfo

ข้อมูลเพิ่มเติมเมื่อ CONTACT_ID เป็นหนึ่งใน uploadKeyTypes

การแสดง JSON 
{
  "matchRatePercentage": integer,
  "dataSourceType": enum (DataSourceType)
}
ช่อง
matchRatePercentage

integer

เอาต์พุตเท่านั้น อัตราการจับคู่สำหรับกลุ่มเป้าหมายตามการจับคู่ข้อมูลลูกค้า
dataSourceType

enum (DataSourceType)

ไม่บังคับ เปลี่ยนแปลงไม่ได้ แหล่งที่มาของข้อมูลการอัปโหลด

DataSourceType

ระบุแหล่งที่มาของข้อมูลการอัปโหลด

Enum
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)

ต้องระบุ เปลี่ยนแปลงไม่ได้ คีย์สเปซของรหัสอุปกรณ์เคลื่อนที่
appId

string

ต้องระบุ เปลี่ยนแปลงไม่ได้ สตริงที่ระบุแอปพลิเคชันบนอุปกรณ์เคลื่อนที่ที่ไม่ซ้ำกันซึ่งรวบรวมข้อมูล

KeySpace

พื้นที่คีย์สำหรับรหัสบนอุปกรณ์เคลื่อนที่

Enum
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)

ต้องระบุ เปลี่ยนแปลงไม่ได้ ระบุผู้เผยแพร่โฆษณาที่ระบบจะกระทบรหัสผู้ใช้ของ Publisher Advertiser Identity Reconciliation ฟิลด์นี้มาจากผู้ให้บริการคลีนรูมและไม่ซ้ำกันเฉพาะในขอบเขตของคลีนรูมนั้น โดยจะใช้เป็นตัวระบุส่วนกลางในคลีนรูมหลายแห่งไม่ได้
publisherName

string

ต้องระบุ ชื่อของผู้เผยแพร่โฆษณาที่มีความหมายซึ่งจะแสดงใน UI เพื่อประสบการณ์การกำหนดเป้าหมายที่ดีขึ้น
matchRatePercentage

integer

ต้องระบุ ฟิลด์นี้ระบุเปอร์เซ็นต์การจับคู่การเป็นสมาชิกของรายชื่อผู้ใช้นี้กับข้อมูลจากบุคคลที่หนึ่งของผู้เผยแพร่โฆษณาที่เกี่ยวข้อง ต้องอยู่ระหว่าง 0 ถึง 100
advertiserIdentifierCount

string (int64 format)

ไม่บังคับ จํานวนระเบียนข้อมูลจากบุคคลที่หนึ่งของผู้ลงโฆษณาที่อัปโหลดไปยังผู้ให้บริการ Clean Room ซึ่งไม่ได้หมายถึงขนาดของกลุ่มเป้าหมายตามข้อมูลลูกค้า
cleanRoomIdentifier

string

ต้องระบุ เปลี่ยนแปลงไม่ได้ ระบุความสัมพันธ์ที่ไม่ซ้ำกันระหว่างผู้ลงโฆษณาและผู้เผยแพร่โฆษณากับผู้ให้บริการ Clean Room รายเดียวหรือผู้ให้บริการ Clean Room หลายราย

PseudonymousIdInfo

ข้อมูลเพิ่มเติมเมื่อ PSEUDONYMOUS_ID เป็นหนึ่งใน uploadKeyTypes

การแสดง JSON 
{
  "syncStatus": enum (SyncStatus),
  "billableRecordCount": string
}
ช่อง
syncStatus

enum (SyncStatus)

เอาต์พุตเท่านั้น สถานะการซิงค์ของรายชื่อผู้ใช้
billableRecordCount

string (int64 format)

ไม่บังคับ เปลี่ยนแปลงไม่ได้ จำนวนระเบียนที่เรียกเก็บเงินได้ (เช่น อัปโหลดหรือจับคู่)

SyncStatus

สถานะการซิงค์ของรายชื่อผู้ใช้

Enum
SYNC_STATUS_UNSPECIFIED ไม่ได้ระบุ
CREATED ระบบได้สร้างรายการผู้ใช้เป็นตัวยึดตำแหน่งแล้ว ระบบยังคงซิงค์เนื้อหาและ/หรือข้อมูลเมตาของรายการอยู่ รายชื่อผู้ใช้ยังไม่พร้อมใช้งาน
READY_FOR_USE รายชื่อผู้ใช้พร้อมใช้งานแล้ว ซิงค์เนื้อหาและคุกกี้อย่างถูกต้อง
FAILED เกิดข้อผิดพลาดขณะซิงค์เนื้อหาและ/หรือข้อมูลเมตาของรายการผู้ใช้ ใช้รายชื่อผู้ใช้ไม่ได้

PartnerAudienceInfo

ข้อมูลเพิ่มเติมสำหรับกลุ่มเป้าหมายที่เป็นพาร์ทเนอร์

ฟีเจอร์นี้ใช้ได้เฉพาะกับพาร์ทเนอร์ด้านข้อมูลเท่านั้น

การแสดง JSON 
{
  "partnerAudienceSource": enum (PartnerAudienceSource),
  "commercePartner": string
}
ช่อง
partnerAudienceSource

enum (PartnerAudienceSource)

ต้องระบุ เปลี่ยนแปลงไม่ได้ แหล่งที่มาของกลุ่มเป้าหมายพาร์ทเนอร์
commercePartner

string

ไม่บังคับ ชื่อพาร์ทเนอร์ Commerce อนุญาตเฉพาะในกรณีที่ partnerAudienceSource เป็น COMMERCE_AUDIENCE

PartnerAudienceSource

แหล่งที่มาของกลุ่มเป้าหมายของพาร์ทเนอร์

Enum
PARTNER_AUDIENCE_SOURCE_UNSPECIFIED ไม่ได้ระบุ
COMMERCE_AUDIENCE แหล่งที่มาของกลุ่มเป้าหมายพาร์ทเนอร์คือกลุ่มเป้าหมายเพื่อการพาณิชย์
LINEAR_TV_AUDIENCE แหล่งที่มาของกลุ่มเป้าหมายพาร์ทเนอร์คือกลุ่มเป้าหมายที่รับชมทีวีเชิงเส้น
AGENCY_PROVIDER_AUDIENCE แหล่งที่มาของกลุ่มเป้าหมายพาร์ทเนอร์คือกลุ่มเป้าหมายของเอเจนซี/ผู้ให้บริการ

เมธอด

create

 สร้าง UserList

delete

 ลบ UserList

get

 รับ UserList

list

 แสดง UserList

patch

 อัปเดต UserList