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,

  // 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

เอาต์พุตเท่านั้น ชื่อแหล่งข้อมูลของกลุ่มเป้าหมายบุคคลที่หนึ่งและกลุ่มเป้าหมายของพาร์ทเนอร์
firstPartyAndPartnerAudienceId

string (int64 format)

ตัวระบุ รหัสที่ไม่ซ้ำกันของกลุ่มเป้าหมายบุคคลที่หนึ่งและกลุ่มเป้าหมายของพาร์ทเนอร์ กำหนดโดยระบบ
displayName

string

เอาต์พุตเท่านั้น ชื่อที่แสดงของกลุ่มเป้าหมายบุคคลที่หนึ่งและกลุ่มเป้าหมายของพาร์ทเนอร์
description

string

เอาต์พุตเท่านั้น คําอธิบายกลุ่มเป้าหมายที่ผู้ใช้ระบุ

ใช้ได้กับกลุ่มเป้าหมายบุคคลที่หนึ่งเท่านั้น
firstPartyAndPartnerAudienceType

enum (FirstPartyAndPartnerAudienceType)

เอาต์พุตเท่านั้น ระบุว่ากลุ่มเป้าหมายเป็นกลุ่มเป้าหมายบุคคลที่หนึ่งและกลุ่มเป้าหมายพาร์ทเนอร์หรือไม่
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)

เอาต์พุตเท่านั้น ขนาดกลุ่มเป้าหมายโดยประมาณสําหรับเครือข่าย Display

หากขนาดน้อยกว่า 1, 000 ระบบจะซ่อนตัวเลขและแสดงผลเป็น 0 เพื่อเหตุผลด้านความเป็นส่วนตัว มิฉะนั้น ระบบจะปัดเศษตัวเลขเป็นเลขนัยสำคัญ 2 หลัก

แสดงเฉพาะในคำขอ GET
activeDisplayAudienceSize

string (int64 format)

เอาต์พุตเท่านั้น ขนาดกลุ่มเป้าหมายโดยประมาณสําหรับเครือข่าย Display ในเดือนที่ผ่านมา

หากขนาดน้อยกว่า 1, 000 ระบบจะซ่อนตัวเลขและแสดงผลเป็น 0 เพื่อเหตุผลด้านความเป็นส่วนตัว มิฉะนั้น ระบบจะปัดเศษตัวเลขเป็นเลขนัยสำคัญ 2 หลัก

แสดงเฉพาะในคำขอ GET
youtubeAudienceSize

string (int64 format)

เอาต์พุตเท่านั้น ขนาดกลุ่มเป้าหมายโดยประมาณของเครือข่าย YouTube

หากขนาดน้อยกว่า 1, 000 ระบบจะซ่อนตัวเลขและแสดงผลเป็น 0 เพื่อเหตุผลด้านความเป็นส่วนตัว มิฉะนั้น ระบบจะปัดเศษตัวเลขเป็นเลขนัยสำคัญ 2 หลัก

ใช้ได้กับกลุ่มเป้าหมายบุคคลที่หนึ่งเท่านั้น

แสดงเฉพาะในคำขอ GET
gmailAudienceSize

string (int64 format)

เอาต์พุตเท่านั้น ขนาดกลุ่มเป้าหมายโดยประมาณสําหรับเครือข่าย Gmail

หากขนาดน้อยกว่า 1, 000 ระบบจะซ่อนตัวเลขและแสดงผลเป็น 0 เพื่อเหตุผลด้านความเป็นส่วนตัว มิฉะนั้น ระบบจะปัดเศษตัวเลขเป็นเลขนัยสำคัญ 2 หลัก

ใช้ได้กับกลุ่มเป้าหมายบุคคลที่หนึ่งเท่านั้น

แสดงเฉพาะในคำขอ GET
displayMobileAppAudienceSize

string (int64 format)

เอาต์พุตเท่านั้น ขนาดกลุ่มเป้าหมายโดยประมาณของแอปบนอุปกรณ์เคลื่อนที่ในเครือข่าย Display

หากขนาดน้อยกว่า 1, 000 ระบบจะซ่อนตัวเลขและแสดงผลเป็น 0 เพื่อเหตุผลด้านความเป็นส่วนตัว มิฉะนั้น ระบบจะปัดเศษตัวเลขเป็นเลขนัยสำคัญ 2 หลัก

ใช้ได้กับกลุ่มเป้าหมายบุคคลที่หนึ่งเท่านั้น

แสดงเฉพาะในคำขอ GET
displayMobileWebAudienceSize

string (int64 format)

เอาต์พุตเท่านั้น ขนาดกลุ่มเป้าหมายโดยประมาณในเว็บบนอุปกรณ์เคลื่อนที่ในเครือข่าย Display

หากขนาดน้อยกว่า 1, 000 ระบบจะซ่อนตัวเลขและแสดงผลเป็น 0 เพื่อเหตุผลด้านความเป็นส่วนตัว มิฉะนั้น ระบบจะปัดเศษตัวเลขเป็นเลขนัยสำคัญ 2 หลัก

ใช้ได้กับกลุ่มเป้าหมายบุคคลที่หนึ่งเท่านั้น

แสดงเฉพาะในคำขอ GET
displayDesktopAudienceSize

string (int64 format)

เอาต์พุตเท่านั้น ขนาดกลุ่มเป้าหมายบนเดสก์ท็อปโดยประมาณในเครือข่าย Display

หากขนาดน้อยกว่า 1, 000 ระบบจะซ่อนตัวเลขและแสดงผลเป็น 0 เพื่อเหตุผลด้านความเป็นส่วนตัว มิฉะนั้น ระบบจะปัดเศษตัวเลขเป็นเลขนัยสำคัญ 2 หลัก

ใช้ได้กับกลุ่มเป้าหมายบุคคลที่หนึ่งเท่านั้น

แสดงเฉพาะในคำขอ GET
appId

string

ไม่บังคับ appId ตรงกับประเภทของ mobileDeviceId ที่อัปโหลด

มีผลกับ audienceType CUSTOMER_MATCH_DEVICE_ID เท่านั้น
ฟิลด์สหภาพ members สมาชิกเริ่มต้นของกลุ่มเป้าหมายตามการจับคู่ข้อมูลลูกค้า members ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
contactInfoList

object (ContactInfoList)

อินพุตเท่านั้น รายชื่อข้อมูลติดต่อเพื่อกําหนดสมาชิกกลุ่มเป้าหมายเริ่มต้น

มีผลกับ audienceType CUSTOMER_MATCH_CONTACT_INFO เท่านั้น
mobileDeviceIdList

object (MobileDeviceIdList)

อินพุตเท่านั้น รายการรหัสอุปกรณ์เคลื่อนที่เพื่อกําหนดสมาชิกกลุ่มเป้าหมายเริ่มต้น

มีผลกับ audienceType CUSTOMER_MATCH_DEVICE_ID เท่านั้น

FirstPartyAndPartnerAudienceType

ประเภทแหล่งข้อมูลกลุ่มเป้าหมายบุคคลที่หนึ่งและพาร์ทเนอร์ที่เป็นไปได้

Enum
FIRST_PARTY_AND_PARTNER_AUDIENCE_TYPE_UNSPECIFIED ค่าเริ่มต้นเมื่อไม่ได้ระบุประเภทหรือไม่ทราบประเภท
TYPE_FIRST_PARTY กลุ่มเป้าหมายที่สร้างผ่านการใช้ข้อมูลลูกค้า
TYPE_PARTNER กลุ่มเป้าหมายที่มาจากผู้ให้บริการข้อมูลบุคคลที่สาม

AudienceType

ประเภทกลุ่มเป้าหมายที่เป็นไปได้

Enum
AUDIENCE_TYPE_UNSPECIFIED ค่าเริ่มต้นเมื่อไม่ได้ระบุประเภทหรือไม่ทราบประเภท
CUSTOMER_MATCH_CONTACT_INFO กลุ่มเป้าหมายสร้างขึ้นโดยการจับคู่ลูกค้ากับข้อมูลติดต่อที่ทราบ
CUSTOMER_MATCH_DEVICE_ID กลุ่มเป้าหมายสร้างขึ้นผ่านการจับคู่ลูกค้ากับรหัสอุปกรณ์เคลื่อนที่ที่รู้จัก
CUSTOMER_MATCH_USER_ID กลุ่มเป้าหมายสร้างขึ้นผ่านการจับคู่ลูกค้ากับรหัสผู้ใช้ที่รู้จัก
ACTIVITY_BASED

กลุ่มเป้าหมายสร้างขึ้นตามกิจกรรมของแคมเปญ
FREQUENCY_CAP

กลุ่มเป้าหมายสร้างขึ้นโดยยกเว้นจํานวนการแสดงผลที่แสดง
TAG_BASED กลุ่มเป้าหมายสร้างขึ้นตามตัวแปรที่กําหนดเองซึ่งแนบกับพิกเซล
YOUTUBE_USERS กลุ่มเป้าหมายสร้างขึ้นจากการโต้ตอบที่ผ่านมากับวิดีโอ โฆษณา YouTube หรือช่อง YouTube
THIRD_PARTY กลุ่มเป้าหมายได้รับอนุญาตจากบุคคลที่สามให้ใช้งานได้
COMMERCE กลุ่มเป้าหมายที่พาร์ทเนอร์ด้านการค้าจัดหาให้โดยคิดค่าธรรมเนียม
LINEAR กลุ่มเป้าหมายสําหรับเนื้อหาทีวีแบบดั้งเดิม

AudienceSource

แหล่งที่มาของกลุ่มเป้าหมายที่เป็นไปได้

Enum
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 มาจาก Ads Data Hub

ContactInfoList

ข้อความ Wrapper สําหรับรายการข้อมูลติดต่อที่กําหนดสมาชิกกลุ่มเป้าหมายการจับคู่ข้อมูลลูกค้า

การแสดง 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

สถานะความยินยอม

Enum
CONSENT_STATUS_UNSPECIFIED ไม่ได้ระบุค่าประเภทหรือค่าประเภทไม่รู้จักในเวอร์ชันนี้
CONSENT_STATUS_GRANTED ได้รับความยินยอมแล้ว
CONSENT_STATUS_DENIED ปฏิเสธความยินยอม

MobileDeviceIdList

ข้อความ Wrapper สําหรับรายการรหัสอุปกรณ์เคลื่อนที่ที่กําหนดสมาชิกกลุ่มเป้าหมายตามการจับคู่ข้อมูลลูกค้า

การแสดง JSON 
{
  "mobileDeviceIds": [
    string
  ],
  "consent": {
    object (Consent)
  }
}
ช่อง
mobileDeviceIds[]

string

รายการรหัสอุปกรณ์เคลื่อนที่ที่กําหนดสมาชิกกลุ่มเป้าหมายตามการจับคู่ข้อมูลลูกค้า ขนาดของ mobileDeviceIds ต้องไม่เกิน 500,000
consent

object (Consent)

อินพุตเท่านั้น การตั้งค่าความยินยอมสำหรับผู้ใช้ใน mobileDeviceIds

การไม่ตั้งค่าช่องนี้หมายความว่าไม่ได้ระบุความยินยอม

หากตั้งค่าช่อง adUserData หรือ adPersonalization เป็น CONSENT_STATUS_DENIED คำขอจะแสดงข้อผิดพลาด

เมธอด

create

 สร้าง FirstPartyAndPartnerAudience

editCustomerMatchMembers

 อัปเดตรายชื่อสมาชิกของกลุ่มเป้าหมายตามการจับคู่ข้อมูลลูกค้า

get

 รับกลุ่มเป้าหมายบุคคลที่หนึ่งหรือกลุ่มเป้าหมายของพาร์ทเนอร์

list

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

patch

 อัปเดต FirstPartyAndPartnerAudience ที่มีอยู่