REST Resource: firstAndThirdPartyAudiences

资源：FirstAndThirdPartyAudience

描述用于定位的第一方或第三方受众群体名单。第一方受众群体是通过使用客户数据创建的。第三方受众群体由第三方数据提供商提供，且只能授予客户使用。

JSON 表示法 
{
  "name": string,
  "firstAndThirdPartyAudienceId": string,
  "displayName": string,
  "description": string,
  "firstAndThirdPartyAudienceType": enum (FirstAndThirdPartyAudienceType),
  "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

仅限输出。第一方受众群体和第三方受众群体的资源名称。
firstAndThirdPartyAudienceId

string (int64 format)

仅限输出。第一方受众群体和第三方受众群体的唯一 ID。由系统分配。
displayName

string

第一方和第三方受众群体的显示名称。
description

string

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

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

enum (FirstAndThirdPartyAudienceType)

受众群体是第一方受众群体还是第三方受众群体。
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)

仅限输出。展示广告网络的估算受众群体规模。

出于隐私保护方面的原因，如果大小小于 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 与所上传 mobileDeviceId 的类型相匹配。

仅适用于 audienceType CUSTOMER_MATCH_DEVICE_ID
联合字段 members。目标客户匹配受众群体的初始成员。members 只能是下列其中一项：
contactInfoList

object (ContactInfoList)

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

仅适用于 audienceType CUSTOMER_MATCH_CONTACT_INFO
mobileDeviceIdList

object (MobileDeviceIdList)

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

仅适用于 audienceType CUSTOMER_MATCH_DEVICE_ID

FirstAndThirdPartyAudienceType

第一方和第三方受众群体资源的可能类型。

枚举
FIRST_AND_THIRD_PARTY_AUDIENCE_TYPE_UNSPECIFIED 如果未指定类型或类型未知，则使用默认值。
FIRST_AND_THIRD_PARTY_AUDIENCE_TYPE_FIRST_PARTY 通过使用客户数据创建的受众群体。
FIRST_AND_THIRD_PARTY_AUDIENCE_TYPE_THIRD_PARTY 由第三方数据提供商提供的受众群体。

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 频道的互动情况创建的。
LICENSED 第三方受众群体类型的子类型。

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

ContactInfoList

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

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

object (ContactInfo)

用于定义目标客户匹配受众群体成员的 ContactInfo 对象的列表。拆分 contactInfo 后，成员数量不得超过 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，请求将返回错误。

方法

create

 创建 FirstAndThirdPartyAudience。

editCustomerMatchMembers

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

get

 获取第一方和第三方受众群体。

list

 列出第一方受众群体和第三方受众群体。

patch

 更新现有 FirstAndThirdPartyAudience。