- 资源:FirstAndThirdPartyAudience
- FirstAndThirdPartyAudienceType
- AudienceType
- AudienceSource
- ContactInfoList
- ContactInfo
- 用户同意
- ConsentStatus
- MobileDeviceIdList
- 方法
资源:FirstAndThirdPartyAudience
描述用于定位的第一方或第三方受众群体名单。第一方受众群体是使用客户数据创建的。第三方受众群体由第三方数据提供商提供,只能供客户使用。
JSON 表示法 |
---|
{ "name": string, "firstAndThirdPartyAudienceId": string, "displayName": string, "description": string, "firstAndThirdPartyAudienceType": enum ( |
字段 | |
---|---|
name |
仅供输出。第一方受众群体和第三方受众群体的资源名称。 |
firstAndThirdPartyAudienceId |
仅供输出。第一方受众群体和第三方受众群体的唯一 ID。由系统分配。 |
displayName |
第一方受众群体和第三方受众群体的显示名称。 |
description |
用户提供的受众群体说明。 仅适用于第一方受众群体。 |
firstAndThirdPartyAudienceType |
相应受众群体是第一方受众群体还是第三方受众群体。 |
audienceType |
受众群体的类型。 |
audienceSource |
仅供输出。相应受众群体的来源。 |
membershipDurationDays |
符合条件的事件发生后,条目在受众群体中保留的时长(以天为单位)。如果受众群体没有到期时间,请将此字段的值设置为 10000。否则,设置值必须大于 0 且小于或等于 540。 仅适用于第一方受众群体。 如果使用了以下
|
displayAudienceSize |
仅供输出。展示广告网络的受众群体规模估算值。 如果大小小于 1000,则出于隐私保护方面的考虑,系统会隐藏该数字,并返回 0。否则,该数字将四舍五入为两位有效数字。 仅在 GET 请求中返回。 |
activeDisplayAudienceSize |
仅供输出。上个月展示广告网络的估算受众群体规模。 如果大小小于 1000,则出于隐私保护方面的考虑,系统会隐藏该数字,并返回 0。否则,该数字将四舍五入为两位有效数字。 仅在 GET 请求中返回。 |
youtubeAudienceSize |
仅供输出。YouTube 广告网络的估算受众群体规模。 如果大小小于 1000,则出于隐私保护方面的考虑,系统会隐藏该数字,并返回 0。否则,该数字将四舍五入为两位有效数字。 仅适用于第一方受众群体。 仅在 GET 请求中返回。 |
gmailAudienceSize |
仅供输出。Gmail 广告网络的估算受众群体规模。 如果大小小于 1000,则出于隐私保护方面的考虑,系统会隐藏该数字,并返回 0。否则,该数字将四舍五入为两位有效数字。 仅适用于第一方受众群体。 仅在 GET 请求中返回。 |
displayMobileAppAudienceSize |
仅供输出。展示广告网络中的移动应用受众群体规模估算值。 如果大小小于 1000,则出于隐私保护方面的考虑,系统会隐藏该数字,并返回 0。否则,该数字将四舍五入为两位有效数字。 仅适用于第一方受众群体。 仅在 GET 请求中返回。 |
displayMobileWebAudienceSize |
仅供输出。展示广告网络中的移动网站受众群体规模估算值。 如果大小小于 1000,则出于隐私保护方面的考虑,系统会隐藏该数字,并返回 0。否则,该数字将四舍五入为两位有效数字。 仅适用于第一方受众群体。 仅在 GET 请求中返回。 |
displayDesktopAudienceSize |
仅供输出。展示广告网络中的桌面设备受众群体规模估算值。 如果大小小于 1000,则出于隐私保护方面的考虑,系统会隐藏该数字,并返回 0。否则,该数字将四舍五入为两位有效数字。 仅适用于第一方受众群体。 仅在 GET 请求中返回。 |
appId |
appId 与要上传的 mobileDeviceId 的类型相匹配。 仅适用于 |
联合字段 members 。目标客户匹配受众群体的初始成员。members 只能是下列其中一项: |
|
contactInfoList |
仅限输入。用于定义初始受众群体成员的联系信息列表。 仅适用于 |
mobileDeviceIdList |
仅限输入。用于定义初始受众群体成员的移动设备 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 ( |
字段 | |
---|---|
contactInfos[] |
用于定义目标客户匹配受众群体成员的 ContactInfo 对象列表。拆分 contactInfo 后的成员数量不得超过 500,000。 |
consent |
仅限输入。 如果您未设置此字段,则表示未指定意见征求。 如果 |
ContactInfo
用于定义目标客户匹配受众群体成员的联系信息。
JSON 表示法 |
---|
{ "hashedEmails": [ string ], "hashedPhoneNumbers": [ string ], "zipCodes": [ string ], "hashedFirstName": string, "hashedLastName": string, "countryCode": string } |
字段 | |
---|---|
hashedEmails[] |
经过 SHA256 哈希处理的成员电子邮件地址列表。在进行哈希处理之前,请移除所有空格,并确保字符串全部为小写。 |
hashedPhoneNumbers[] |
经过 SHA256 哈希处理的成员电话号码列表。在进行哈希处理之前,所有电话号码都必须采用 E.164 格式,并包含国家/地区呼叫代码。 |
zipCodes[] |
成员的邮政编码列表。 还必须使用以下字段进行设置: |
hashedFirstName |
经过 SHA256 哈希处理的成员名字。在进行哈希处理之前,请移除所有空格,并确保字符串全部为小写。 还必须使用以下字段进行设置: |
hashedLastName |
经过 SHA256 哈希处理的成员姓氏。在进行哈希处理之前,请移除所有空格,并确保字符串全部为小写。 还必须使用以下字段进行设置: |
countryCode |
成员的国家/地区代码。 还必须使用以下字段进行设置: |
同意
用户意见征求状态。
JSON 表示法 |
---|
{ "adUserData": enum ( |
字段 | |
---|---|
adUserData |
表示用户对广告用户数据的同意情况。 |
adPersonalization |
表示用户对广告个性化的同意情况。 |
ConsentStatus
用户意见征求状态。
枚举 | |
---|---|
CONSENT_STATUS_UNSPECIFIED |
该版本中未指定类型值,或类型值未知。 |
CONSENT_STATUS_GRANTED |
用户选择同意。 |
CONSENT_STATUS_DENIED |
用户选择拒绝。 |
MobileDeviceIdList
用于定义目标客户匹配受众群体成员的移动设备 ID 列表的封装容器消息。
JSON 表示法 |
---|
{
"mobileDeviceIds": [
string
],
"consent": {
object ( |
字段 | |
---|---|
mobileDeviceIds[] |
用于定义目标客户匹配受众群体成员的移动设备 ID 列表。mobileDeviceId 的大小不得超过 500,000。 |
consent |
仅限输入。 如果您未设置此字段,则表示未指定意见征求。 如果 |
方法 |
|
---|---|
|
创建 FirstAndThirdPartyAudience。 |
|
更新目标客户匹配受众群体的成员列表。 |
|
获取第一方和第三方受众群体。 |
|
列出第一方和第三方受众群体。 |
|
更新现有 FirstAndThirdPartyAudience。 |