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,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "contactInfoList": {
    object (ContactInfoList)
  },
  "mobileDeviceIdList": {
    object (MobileDeviceIdList)
  }
  // End of mutually exclusive fields.
}
字段
name

string

仅限输出。第一方受众群体和合作伙伴受众群体的资源名称。
firstPartyAndPartnerAudienceId

string (int64 format)

标识符。第一方受众群体和合作伙伴受众群体的唯一 ID。由系统分配。
displayName

string

可选。第一方受众群体和合作伙伴受众群体的显示名称。
description

string

可选。用户提供的受众群体说明。

仅适用于第一方受众群体。
firstPartyAndPartnerAudienceType

enum (FirstPartyAndPartnerAudienceType)

仅限输出。相应受众群体是否为第一方受众群体和合作伙伴受众群体。
audienceType

enum (AudienceType)

不可变。受众群体的类型。
audienceSource

enum (AudienceSource)

仅限输出。相应受众群体的来源。
membershipDurationDays

string (int64 format)

可选。符合条件的事件发生后，相应条目在受众群体中保留的天数。设置的值必须大于 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 与所上传 mobileDeviceIds 的类型相匹配。

仅适用于 audienceType CUSTOMER_MATCH_DEVICE_ID
目标客户匹配受众群体的初始成员。以下是互斥字段的列表。在响应中，最多只能设置以下字段之一：
contactInfoList

object (ContactInfoList)

仅限输入。用于定义初始受众群体成员的联系信息列表。

仅适用于 audienceType CUSTOMER_MATCH_CONTACT_INFO
mobileDeviceIdList

object (MobileDeviceIdList)

仅限输入。用于定义初始受众群体成员的移动设备 ID 列表。

仅适用于 audienceType CUSTOMER_MATCH_DEVICE_ID
互斥字段的结束。

ContactInfoList

用于封装联系信息列表的封装容器消息，用于定义目标客户匹配受众群体成员。

JSON 表示法 
{
  "contactInfos": [
    {
      object (ContactInfo)
    }
  ],
  "consent": {
    object (Consent)
  }
}
字段
contactInfos[]

object (ContactInfo)

可选。用于定义目标客户匹配受众群体成员的 ContactInfo 对象列表。拆分 contactInfos 后，成员数量不得超过 50 万。
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 的大小不得超过 50 万。
consent

object (Consent)

仅限输入。mobileDeviceIds境内用户的意见征求设置。

如果未设置此字段，则表示未指定同意情况。

如果 adUserData 或 adPersonalization 字段设置为 CONSENT_STATUS_DENIED，则请求将返回错误。

FirstPartyAndPartnerAudienceType

第一方受众群体和合作伙伴受众群体资源的可能类型。

枚举
FIRST_PARTY_AND_PARTNER_AUDIENCE_TYPE_UNSPECIFIED 未指定或未知类型时的默认值。
TYPE_FIRST_PARTY 通过使用客户数据创建的受众群体。
TYPE_PARTNER 由第三方数据提供商提供的受众群体。

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 频道的互动情况创建的。
THIRD_PARTY 受众群体已获得第三方使用许可。
COMMERCE 由商务合作伙伴付费提供的受众群体。
LINEAR 线性电视内容的受众群体。
AGENCY 代理机构提供的受众群体。

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 源自广告数据中心。

方法

create

 创建 FirstPartyAndPartnerAudience。

editCustomerMatchMembers

 更新目标客户匹配受众群体的成员列表。

get

 获取第一方受众群体或合作伙伴受众群体。

list

 列出第一方受众群体和合作伙伴受众群体。

patch

 更新现有的 FirstPartyAndPartnerAudience。