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
}
字段
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

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

方法

get

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

list

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