Package google.ads.searchads360.v0.resources

索引

AccessibleBiddingStrategy

表示客户拥有并与客户共享的 BiddingStrategies 的视图。

与 BiddingStrategy 不同,此资源不仅包含相应客户拥有的出价策略,还包含相应客户的经理账号拥有的并与相应客户共享的出价策略。此资源不提供指标,仅公开 BiddingStrategy 属性的有限子集。

字段
resource_name

string

可访问的出价策略的资源名称。AccessibleBiddingStrategy 资源名称采用以下格式:

customers/{customer_id}/accessibleBiddingStrategies/{bidding_strategy_id}

id

int64

出价策略的 ID。

name

string

出价策略的名称。

type

BiddingStrategyType

出价策略的类型。

owner_customer_id

int64

拥有相应出价策略的客户的 ID。

owner_descriptive_name

string

拥有相应出价策略的客户的 descriptive_name。

联合字段 scheme。出价方案。

只能设置一个。scheme 只能是下列其中一项:

maximize_conversion_value

MaximizeConversionValue

一种自动出价策略,可帮助您在不超出预算的前提下,为广告系列争取尽可能高的转化价值。

maximize_conversions

MaximizeConversions

一种自动出价策略,可帮助您在不超出预算的前提下,为广告系列争取尽可能多的转化。

target_cpa

TargetCpa

一种出价策略,可设置出价,在将每次转化费用控制在您设定的目标水平的前提下,帮助您争取尽可能多的转化。

target_impression_share

TargetImpressionShare

一种自动出价策略,可自动优化以实现所选的展示百分比。

target_roas

TargetRoas

一种出价策略,可帮助您在达到特定目标广告支出回报率 (ROAS) 平均值的同时,尽可能提高收入。

target_spend

TargetSpend

一种出价策略,使用该策略,系统会自动为您设置适当的出价,确保在不超出预算的前提下为您争取尽可能多的点击。

MaximizeConversionValue

一种自动出价策略,可帮助您在不超出预算的前提下,为广告系列争取尽可能高的转化价值。

字段
target_roas

double

目标广告支出回报率 (ROAS) 选项。如果设置此选项,出价策略会最大限度地增加收入,同时使目标广告支出回报率达到平均值。如果目标广告支出回报率较高,则出价策略可能无法支出所有预算。如果未设置目标广告支出回报率,则出价策略的目标是尽可能为预算实现最高的广告支出回报率。

MaximizeConversions

一种自动出价策略,可帮助您在不超出预算的前提下,为广告系列争取尽可能多的转化。

字段
target_cpa

int64

“目标每次转化费用 (CPA)”选项。这是指您愿意为每次获取支付的平均金额。

target_cpa_micros

int64

“目标每次转化费用 (CPA)”选项。这是指您愿意为每次获取支付的平均金额。

TargetCpa

一种自动出价策略,可通过设置出价来帮助您达成所设置的目标每次转化费用,同时争取尽可能多的转化。

字段
target_cpa_micros

int64

平均每次转化费用目标。此目标应大于或等于基于账号币种的最低计费单元。

TargetImpressionShare

一种自动出价策略,可设置出价,使一定百分比的搜索广告展示在首页顶部(或其他目标位置)。

字段
location

TargetImpressionShareLocation

搜索结果页上的目标位置。

location_fraction_micros

int64

要在定位到的地理位置展示的广告所占的比例(以微为单位)。例如,1% 等于 10,000。

cpc_bid_ceiling_micros

int64

自动出价系统可以指定的最高每次点击费用出价。这是由广告客户输入的必填字段,该字段用于设置上限值,并以本地微单位指定。

TargetRoas

一种自动出价策略,可帮助您在达到特定目标广告支出回报率 (ROAS) 平均值的同时,尽可能提高收入。

字段
target_roas

double

每单位支出所选择的收入(基于转化数据)。

TargetSpend

这是一种自动出价策略,使用该策略,系统会为您设置适当的出价,确保在不超出预算的前提下为您争取尽可能多的点击。

字段
target_spend_micros
(deprecated)

int64

尽可能争取更多点击次数的支出目标。TargetSpend 出价工具会尝试支出该值或自然限制支出金额中较低的金额。如果未指定,则预算会被用作支出目标。 此字段已弃用,不应再使用。如需了解详情,请访问 https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.html

cpc_bid_ceiling_micros

int64

可通过出价策略设置的出价上限。此限制适用于该策略管理的所有关键字。

某个广告。

字段
resource_name

string

相应广告的资源名称。广告资源名称采用以下格式:

customers/{customer_id}/ads/{ad_id}

final_urls[]

string

广告的所有跨网域重定向之后可能存在的最终到达网址列表。

final_app_urls[]

FinalAppUrl

用户安装了特定应用后在移动设备上使用的最终到达应用网址列表。

final_mobile_urls[]

string

广告的所有跨网域重定向之后可能存在的最终到达移动网址列表。

type

AdType

广告的类型。

id

int64

广告的 ID。

tracking_url_template

string

用于构建跟踪网址的网址模板。

final_url_suffix

string

构建最终到达网址时要使用的后缀。

display_url

string

在某些广告格式的广告说明中显示的网址。

name

string

广告的名称。此名称仅用于能够标识广告。该名称不必是唯一的,也不会影响投放的广告。

联合字段 ad_data。与广告类型相关的详细信息。必须设置一个值。ad_data 只能是下列其中一项:
text_ad

SearchAds360TextAdInfo

与文字广告相关的详细信息。

expanded_text_ad

SearchAds360ExpandedTextAdInfo

与加大型文字广告相关的详细信息。

responsive_search_ad

SearchAds360ResponsiveSearchAdInfo

与自适应搜索广告相关的详细信息。

product_ad

SearchAds360ProductAdInfo

与商品广告相关的详细信息。

expanded_dynamic_search_ad

SearchAds360ExpandedDynamicSearchAdInfo

与加大型动态搜索广告相关的详细信息。

广告组

一个广告组。

字段
resource_name

string

广告组的资源名称。广告组资源名称采用以下格式:

customers/{customer_id}/adGroups/{ad_group_id}

status

AdGroupStatus

广告组的状态。

type

AdGroupType

广告组的类型。

ad_rotation_mode

AdGroupAdRotationMode

广告组的广告轮播模式。

creation_time

string

相应 ad_group 的创建时间戳。时间戳采用客户的时区,并采用“yyyy-MM-dd HH:mm:ss”格式。

targeting_setting

TargetingSetting

与定位相关的功能的设置。

labels[]

string

附加到此广告组的标签的资源名称。

effective_labels[]

string

附加到相应广告组的有效标签的资源名称。有效标签是指继承或直接分配给相应广告组的标签。

engine_id

string

外部引擎账号中的广告组的 ID。此字段仅适用于非 Google Ads 账号,例如 Yahoo Japan、Microsoft、百度等。对于 Google Ads 实体,请改用“ad_group.id”。

start_date

string

相应广告组开始投放广告的日期。默认情况下,广告组会立即或在广告组的开始日期(以较早者为准)开始投放广告。如果设置了此字段,则广告组将从客户时区的指定日期开始时开始投放广告。此字段仅可用于 Microsoft Advertising 和 Facebook 网关账号。

格式:YYYY-MM-DD 示例:2019-03-14

end_date

string

广告组停止投放广告的日期。默认情况下,广告组会在广告组的结束日期停止投放广告。如果设置了此字段,则广告组会在客户时区的指定日期结束时停止投放广告。此字段仅可用于 Microsoft Advertising 和 Facebook 网关账号。

格式:YYYY-MM-DD 示例:2019-03-14

language_code

string

广告组中的广告和关键字的语言。此字段仅可用于 Microsoft Advertising 账号。如需了解详情,请访问:https://docs.microsoft.com/en-us/advertising/guides/ad-languages?view=bingads-13#adlanguage

last_modified_time

string

上次修改此广告组的日期时间。日期时间采用客户的时区,并采用“yyyy-MM-dd HH:mm:ss.ssssss”格式。

id

int64

广告组的 ID。

name

string

广告组的名称。

此字段为必填字段,在创建新广告组时不应为空。

它包含的 UTF-8 全宽字符不得超过 255 个,

并且不得包含任何 null(码位 0x0)、NL 换行符(码位 0xA)或回车符(码位 0xD)。

tracking_url_template

string

用于构建跟踪网址的网址模板。

cpc_bid_micros

int64

每次点击费用 (cost-per-click) 出价上限。

engine_status

AdGroupEngineStatus

广告组的引擎状态。

final_url_suffix

string

用于将参数附加到最终到达网址的网址模板。

AdGroupAd

广告组广告。

字段
resource_name

string

相应广告的资源名称。广告组广告资源名称采用以下格式:

customers/{customer_id}/adGroupAds/{ad_group_id}~{ad_id}

status

AdGroupAdStatus

广告的状态。

ad

Ad

广告。

creation_time

string

相应 ad_group_ad 的创建时间戳。日期时间采用客户的时区,并采用“yyyy-MM-dd HH:mm:ss.ssssss”格式。

labels[]

string

附加到此广告组广告的标签的资源名称。

effective_labels[]

string

附加到相应广告的有效标签的资源名称。有效标签是指继承或直接分配给相应广告的标签。

engine_id

string

外部引擎账号中的广告的 ID。此字段仅适用于 Search Ads 360 账号,例如 Yahoo Japan、Microsoft、百度等。对于非 Search Ads 360 实体,请改用“ad_group_ad.ad.id”。

engine_status

AdGroupAdEngineStatus

外部引擎账号中的广告的其他状态。可能的状态(取决于外部账号的类型)包括“活跃”“有效”“待审核”等。

last_modified_time

string

上次修改此广告组广告的日期时间。日期时间采用客户的时区,并采用“yyyy-MM-dd HH:mm:ss.ssssss”格式。

AdGroupAdEffectiveLabel

广告组广告与有效标签之间的关系。有效标签是指继承或直接分配给相应广告组广告的标签。

字段
resource_name

string

广告组广告有效标签的资源名称。广告组广告有效标签资源名称采用以下格式:customers/{owner_customer_id}/adGroupAdEffectiveLabels/{ad_group_id}~{ad_id}~{label_id}

ad_group_ad

string

有效标签所附加到的广告组广告。

label

string

分配给广告组广告的有效标签。

owner_customer_id

int64

拥有有效标签的客户的 ID。

AdGroupAdLabel

广告组广告与标签之间的关系。

字段
resource_name

string

广告组广告标签的资源名称。广告组广告标签资源名称采用以下格式:customers/{owner_customer_id}/adGroupAdLabels/{ad_group_id}~{ad_id}~{label_id}

ad_group_ad

string

标签附加到的广告组广告。

label

string

分配给广告组广告的标签。

owner_customer_id

int64

拥有相应标签的客户的 ID。

AdGroupAsset

广告组与素材资源之间的关联。

字段
resource_name

string

广告组素材资源的资源名称。AdGroupAsset 资源名称采用以下格式:

customers/{customer_id}/adGroupAssets/{ad_group_id}~{asset_id}~{field_type}

ad_group

string

必需。素材资源关联到的广告组。

asset

string

必需。与广告组关联的素材资源。

status

AssetLinkStatus

广告组素材资源的状态。

AdGroupAssetSet

AdGroupAssetSet 是广告组与素材资源组之间的关联。创建 AdGroupAssetSet 会将素材资源集与广告组相关联。

字段
resource_name

string

广告组素材资源集的资源名称。广告组素材资源集的资源名称采用以下格式:

customers/{customer_id}/adGroupAssetSets/{ad_group_id}~{asset_set_id}

ad_group

string

相应素材资源集所关联到的广告组。

asset_set

string

与广告组相关联的素材资源集。

status

AssetSetLinkStatus

广告组素材资源集的状态。只读。

AdGroupAudienceView

广告组受众群体视图。包括展示广告网络和 YouTube 广告网络的兴趣和再营销名单以及搜索广告再营销名单 (RLSA) 的效果数据,这些数据按受众群体级别汇总。

字段
resource_name

string

广告组受众群体视图的资源名称。广告组受众群体视图资源名称采用以下格式:

customers/{customer_id}/adGroupAudienceViews/{ad_group_id}~{criterion_id}

AdGroupBidModifier

表示广告组出价调节系数。

字段
resource_name

string

广告组出价调节系数的资源名称。广告组出价调节系数资源名称采用以下格式:

customers/{customer_id}/adGroupBidModifiers/{ad_group_id}~{criterion_id}

bid_modifier

double

条件匹配时出价的调节系数。调节系数的范围必须介于 0.1 - 10.0 之间。对于 PreferredContent,该范围介于 1.0 - 6.0 之间。使用 0 可停用设备类型。

联合字段 criterion。相应广告组出价调节系数的标准。

在 V5 中开始的创建操作中是必需的。criterion 只能是下列其中一项:

device

DeviceInfo

设备条件。

AdGroupCriterion

广告组条件。ad_group_criterion 报告仅返回明确添加到广告组的条件。

字段
resource_name

string

广告组条件的资源名称。广告组条件资源名称采用以下格式:

customers/{customer_id}/adGroupCriteria/{ad_group_id}~{criterion_id}

creation_time

string

创建此广告组条件时的时间戳。时间戳采用客户的时区,并采用“yyyy-MM-dd HH:mm:ss”格式。

status

AdGroupCriterionStatus

条件的状态。

这是广告组条件实体的状态,由客户端设置。注意:界面报告可能包含其他信息,这些信息会影响条件是否能够运行。在某些情况下,在 API 中移除的条件可能仍会在界面中显示为已启用。例如,默认情况下,广告系列会面向所有年龄段的用户展示(已被排除的除外)。该界面会将各个年龄段显示为“已启用”,因为它们有资格观看广告;但 AdGroupCriterion.status 会显示为“已移除”,因为系统未添加任何肯定条件。

quality_info

QualityInfo

有关相应条件质量的信息。

type

CriterionType

条件的类型。

labels[]

string

广告组条件所附标签的资源名称。

effective_labels[]

string

附加到相应广告组条件的有效标签的资源名称。有效标签是指继承或直接分配给相应广告组条件的标签。

position_estimates

PositionEstimates

不同位置的条件出价的估算值。

final_urls[]

string

广告的所有跨网域重定向之后可能存在的最终到达网址列表。

final_mobile_urls[]

string

所有跨网域重定向之后可能存在的最终到达移动网址列表。

url_custom_parameters[]

CustomParameter

用于替换 tracking_url_templatefinal_urlsmobile_final_urls 中的自定义参数标记的映射列表。

engine_id

string

外部引擎账号中的广告组条件的 ID。此字段仅适用于非 Google Ads 账号,例如 Yahoo Japan、Microsoft、百度等。对于 Google Ads 实体,请改用“ad_group_criterion.criterion_id”。

last_modified_time

string

上次修改此广告组条件的日期时间。日期时间采用客户的时区,并采用“yyyy-MM-dd HH:mm:ss.ssssss”格式。

criterion_id

int64

条件的 ID。

ad_group

string

条件所属的广告组。

negative

bool

是定位 (false) 还是排除 (true) 条件。

该字段不可更改。 如需将条件从正切换为负,请先移除再重新添加。

bid_modifier

double

条件匹配时出价的调节系数。调节系数的范围必须介于 0.1 - 10.0 之间。大多数可定位的条件类型都支持调节系数。

cpc_bid_micros

int64

每次点击费用出价。

effective_cpc_bid_micros

int64

有效每次点击费用 (cost-per-click) 出价。

engine_status

AdGroupCriterionEngineStatus

广告组条件的引擎状态。

final_url_suffix

string

用于将参数附加到最终到达网址的网址模板。

tracking_url_template

string

用于构建跟踪网址的网址模板。

联合字段 criterion。广告组条件。

只能设置一个值。criterion 只能是下列其中一项:

keyword

KeywordInfo

关键字。

listing_group

ListingGroupInfo

商品详情组。

age_range

AgeRangeInfo

年龄段。

gender

GenderInfo

性别。

user_list

UserListInfo

用户列表。

webpage

WebpageInfo

网页

location

LocationInfo

位置信息。

PositionEstimates

不同位置的条件出价的估算值。

字段
top_of_page_cpc_micros

int64

要让广告显示在搜索结果首页顶部所需的每次点击费用出价的估算值。

QualityInfo

用于存放广告组条件质量信息的容器。

字段
quality_score

int32

质量得分。

如果 Google 没有足够的信息来确定值,则系统可能不会填充该字段。

AdGroupCriterionEffectiveLabel

广告组条件与有效标签之间的关系。有效标签是指继承或直接分配给相应广告组条件的标签。

字段
resource_name

string

广告组条件有效标签的资源名称。广告组条件有效标签资源名称采用以下格式:customers/{owner_customer_id}/adGroupCriterionEffectiveLabels/{ad_group_id}~{criterion_id}~{label_id}

ad_group_criterion

string

有效标签所附加到的广告组条件。

label

string

分配给广告组条件的有效标签。

owner_customer_id

int64

拥有有效标签的客户的 ID。

AdGroupCriterionLabel

广告组条件与标签之间的关系。

字段
resource_name

string

广告组条件标签的资源名称。广告组条件标签资源名称采用以下格式:customers/{owner_customer_id}/adGroupCriterionLabels/{ad_group_id}~{criterion_id}~{label_id}

ad_group_criterion

string

标签附加到的广告组条件。

label

string

分配给广告组条件的标签。

owner_customer_id

int64

拥有相应标签的客户的 ID。

AdGroupEffectiveLabel

广告组与有效标签之间的关系。有效标签是指继承或直接分配给相应广告组的标签。

字段
resource_name

string

广告组有效标签的资源名称。广告组有效标签资源名称采用以下格式:customers/{owner_customer_id}/adGroupEffectiveLabels/{ad_group_id}~{label_id}

ad_group

string

有效标签所附加到的广告组。

label

string

分配给广告组的有效标签。

owner_customer_id

int64

拥有有效标签的客户的 ID。

AdGroupLabel

广告组与标签之间的关系。

字段
resource_name

string

广告组标签的资源名称。广告组标签资源名称采用以下格式:customers/{owner_customer_id}/adGroupLabels/{ad_group_id}~{label_id}

ad_group

string

标签附加到的广告组。

label

string

分配给广告组的标签。

owner_customer_id

int64

拥有相应标签的客户的 ID。

AgeRangeView

年龄段视图。

字段
resource_name

string

年龄段视图的资源名称。年龄段视图资源名称采用以下格式:

customers/{customer_id}/ageRangeViews/{ad_group_id}~{criterion_id}

素材资源

素材资源是广告的组成部分,可供多个广告共用。它可以是图片 (ImageAsset)、视频 (YoutubeVideoAsset) 等。素材资源是不可变的,无法移除。如需停止投放某个素材资源,请从使用该素材资源的实体中移除该素材资源。

字段
resource_name

string

相应素材资源的资源名称。资产资源名称采用以下格式:

customers/{customer_id}/assets/{asset_id}

type

AssetType

素材资源的类型。

final_urls[]

string

所有跨网域重定向之后可能存在的最终到达网址列表。

final_mobile_urls[]

string

所有跨网域重定向之后可能存在的最终到达移动网址列表。

url_custom_parameters[]

CustomParameter

用于替换 tracking_url_template、final_urls 和/或 final_mobile_urls 中的网址自定义参数标记的映射列表。

status

AssetStatus

素材资源的状态。

creation_time

string

创建此素材资源时的时间戳。时间戳采用客户的时区,并采用“yyyy-MM-dd HH:mm:ss”格式。

last_modified_time

string

上次修改此素材资源的日期时间。日期时间采用客户的时区,并采用“yyyy-MM-dd HH:mm:ss.ssssss”格式。

id

int64

资产的 ID。

name

string

素材资源的选填名称。

tracking_url_template

string

用于构建跟踪网址的网址模板。

final_url_suffix

string

用于将参数附加到采用并行跟踪机制投放的着陆页网址的网址模板。

engine_status

AssetEngineStatus

素材资源的引擎状态。

联合字段 asset_data。资源的具体类型。asset_data 只能是下列其中一项:
youtube_video_asset

YoutubeVideoAsset

YouTube 视频素材资源。

image_asset

ImageAsset

图片素材资源。

text_asset

TextAsset

文字素材资源。

callout_asset

UnifiedCalloutAsset

统一的宣传信息素材资源。

page_feed_asset

UnifiedPageFeedAsset

统一的页面 Feed 素材资源。

mobile_app_asset

MobileAppAsset

移动应用素材资源。

call_asset

UnifiedCallAsset

统一的电话素材资源。

call_to_action_asset

CallToActionAsset

号召性用语素材资源。

location_asset

UnifiedLocationAsset

统一的地址素材资源。

AssetGroup

素材资源组。AssetGroupAsset 用于将素材资源与素材资源组相关联。AssetGroupSignal 用于将信号与素材资源组相关联。

字段
resource_name

string

素材资源组的资源名称。素材资源组资源名称采用以下格式:

customers/{customer_id}/assetGroups/{asset_group_id}

id

int64

素材资源组的 ID。

campaign

string

相应素材资源组关联到的广告系列。与素材资源组相关联的素材资源。

name

string

必需。素材资源组的名称。必需。长度不得少于 1 个字符,不得超过 128 个字符。在广告系列中必须是唯一的。

final_urls[]

string

所有跨网域重定向之后的最终到达网址列表。在效果最大化广告系列中,除非选择停用,否则网址默认符合扩展条件。

final_mobile_urls[]

string

所有跨网域重定向之后的最终到达移动网址列表。在效果最大化广告系列中,除非选择停用,否则网址默认符合扩展条件。

status

AssetGroupStatus

素材资源组的状态。

path1

string

可能显示的文字的第一部分(附加到广告中展示的网址)。

path2

string

可能显示的文字的第二部分(附加到广告中展示的网址)。仅当设置了 path1 时才能设置此字段。

ad_strength

AdStrength

相应素材资源组的整体广告效力。

AssetGroupAsset

AssetGroupAsset 是素材资源与素材资源组之间的关联。添加 AssetGroupAsset 会将素材资源与素材资源组相关联。

字段
resource_name

string

素材资源组素材资源的资源名称。素材资源组素材资源名称采用以下格式:

customers/{customer_id}/assetGroupAssets/{asset_group_id}~{asset_id}~{field_type}

asset_group

string

相应素材资源组资产所关联的素材资源组。

asset

string

相应素材资源组中的素材资源所关联的素材资源。

field_type

AssetFieldType

素材资源在素材资源组中的展示位置说明。例如:HEADLINE、YOUTUBE_VIDEO 等

status

AssetLinkStatus

素材资源与素材资源组之间关联的状态。

AssetGroupAssetCombinationData

素材资源组素材资源组合数据

字段
asset_combination_served_assets[]

AssetUsage

投放的素材资源。

AssetGroupListingGroupFilter

AssetGroupListingGroupFilter 表示素材资源组中的产品信息组过滤条件树节点。

字段
resource_name

string

素材资源组产品信息组过滤条件的资源名称。素材资源组产品信息组过滤条件资源名称采用以下格式:

customers/{customer_id}/assetGroupListingGroupFilters/{asset_group_id}~{listing_group_filter_id}

asset_group

string

相应素材资源组产品信息组过滤条件所属的素材资源组。

id

int64

ListingGroupFilter 的 ID。

type

ListingGroupFilterType

商品详情组过滤条件节点的类型。

vertical

ListingGroupFilterVertical

当前节点树所代表的垂直行业。同一树中的所有节点都必须属于同一垂直行业。

case_value

ListingGroupFilterDimension

相应商品详情组用于细化其父级的维度值。对于根组,此值为未定义。

parent_listing_group_filter

string

父级商品详情组细分的资源名称。对于根商品详情组过滤条件节点,此值为 null。

path

ListingGroupFilterDimensionPath

定义相应商品详情组过滤条件的维度的路径。

AssetGroupSignal

AssetGroupSignal 表示素材资源组中的信号。信号的存在会告知效果最大化广告系列哪些用户最有可能完成转化。效果最大化广告系列会参考信号,寻找意向相似或更强烈的新用户,以在搜索网络、展示广告网络、视频平台等位置促成转化。

字段
resource_name

string

素材资源组信号的资源名称。素材资源组信号资源名称采用以下格式:

customers/{customer_id}/assetGroupSignals/{asset_group_id}~{signal_id}

asset_group

string

相应素材资源组信号所属的素材资源组。

联合字段 signal。素材资源组的信号。signal 只能是下列其中一项:
audience

AudienceInfo

效果最大化广告系列要使用的受众群体信号。

AssetGroupTopCombinationView

显示素材资源组素材资源效果最佳的组合的使用情况。

字段
resource_name

string

素材资源组热门组合视图的资源名称。AssetGroup Top Combination 视图资源名称采用以下格式:“customers/{customer_id}/assetGroupTopCombinationViews/{asset_group_id}~{asset_combination_category}”

asset_group_top_combinations[]

AssetGroupAssetCombinationData

一起投放的素材资源组合中效果最佳的组合。

AssetSet

表示一组素材资源的素材资源组。使用 AssetSetAsset 将素材资源与素材资源组相关联。

字段
id

int64

素材资源组的 ID。

resource_name

string

资源组的资源名称。资产集的资源名称采用以下格式:

customers/{customer_id}/assetSets/{asset_set_id}

AssetSetAsset

AssetSetAsset 是素材资源与素材资源集之间的关联。添加 AssetSetAsset 会将素材资源与素材资源集相关联。

字段
resource_name

string

资源集资产的资源名称。资产集资产资源名称采用以下格式:

customers/{customer_id}/assetSetAssets/{asset_set_id}~{asset_id}

asset_set

string

此素材资源集中的素材资源所关联的素材资源集。

asset

string

此素材资源集中的素材资源所关联的素材资源。

status

AssetSetAssetStatus

素材资源组的素材资源的状态。只读。

受众群体

受众群体是一个效果很好的定位选项,让您可通过组合各种细分受众群属性(例如详细受众特征和兴趣相似的受众群体)得出其交集部分,从而创建出代表目标细分受众群某一部分的受众群体。

字段
resource_name

string

相应受众群体的资源名称。受众群体名称的格式如下:

customers/{customer_id}/audiences/{audience_id}

id

int64

受众群体的 ID。

name

string

必需。受众群体的名称。在所有受众群体中应该是唯一的。长度不得少于 1 个字符,不得超过 255 个字符。

description

string

相应受众群体的说明。

BiddingStrategy

出价策略。

字段
resource_name

string

出价策略的资源名称。出价策略资源名称采用以下格式:

customers/{customer_id}/biddingStrategies/{bidding_strategy_id}

status

BiddingStrategyStatus

出价策略的状态。

此字段为只读字段。

type

BiddingStrategyType

出价策略的类型。通过设置出价方案创建出价策略。

此字段为只读字段。

currency_code

string

出价策略所用的币种(ISO 4217 三字母代码)。

对于经理客户中的出价策略,此币种可在创建时设置,默认设置为经理客户的币种。对于投放广告的客户,此字段无法设置;投放广告的客户中的所有策略都会隐式使用投放广告的客户的币种。在所有情况下,effective_currency_code 字段都会返回相应策略所用的币种。

id

int64

出价策略的 ID。

name

string

出价策略的名称。账号中的所有出价策略必须区分命名。

此字符串的长度应介于 1 到 255 之间(包括 1 和 255),以 UTF-8 字节为单位(经过修剪)。

effective_currency_code

string

出价策略所用的币种(ISO 4217 三字母代码)。

对于经理客户中的出价策略,这是广告客户在创建策略时设置的币种。对于服务客户,这是客户的 currency_code。

出价策略指标以相应币种报告。

此字段为只读字段。

campaign_count

int64

附加到相应出价策略的广告系列数量。

此字段为只读字段。

non_removed_campaign_count

int64

附加到出价策略的未移除广告系列的数量。

此字段为只读字段。

联合字段 scheme。出价方案。

只能设置一个。scheme 只能是下列其中一项:

enhanced_cpc

EnhancedCpc

一种出价策略,可针对更有可能促成转化的点击提高出价,并针对不太可能促成转化的点击降低出价。

maximize_conversion_value

MaximizeConversionValue

一种自动出价策略,可帮助您在不超出预算的前提下,为广告系列争取尽可能高的转化价值。

maximize_conversions

MaximizeConversions

一种自动出价策略,可帮助您在不超出预算的前提下,为广告系列争取尽可能多的转化。

target_cpa

TargetCpa

一种出价策略,可设置出价,在将每次转化费用控制在您设定的目标水平的前提下,帮助您争取尽可能多的转化。

target_impression_share

TargetImpressionShare

一种自动出价策略,可自动优化以实现所选的展示百分比。

target_outrank_share

TargetOutrankShare

一种出价策略,可根据广告客户应在多少百分比的竞价中胜过特定竞争对手来设置出价。该字段已弃用。使用此字段创建新的出价策略或将使用此字段的出价策略附加到广告系列的操作将失败。允许对已填充此方案的策略进行变异。

target_roas

TargetRoas

一种出价策略,可帮助您在达到特定目标广告支出回报率 (ROAS) 平均值的同时,尽可能提高收入。

target_spend

TargetSpend

一种出价策略,使用该策略,系统会自动为您设置适当的出价,确保在不超出预算的前提下为您争取尽可能多的点击。

广告系列

广告系列。

字段
resource_name

string

相应广告系列的资源名称。广告系列资源名称采用以下格式:

customers/{customer_id}/campaigns/{campaign_id}

status

CampaignStatus

广告系列的状态。

添加新的广告系列时,状态默认为 ENABLED。

serving_status

CampaignServingStatus

广告系列的广告投放状态。

bidding_strategy_system_status

BiddingStrategySystemStatus

广告系列出价策略的系统状态。

ad_serving_optimization_status

AdServingOptimizationStatus

广告系列的广告投放优化状态。

advertising_channel_type

AdvertisingChannelType

广告系列中的广告的主要投放目标。可以在 network_settings 中优化定位选项。

此字段为必填字段,在创建新广告系列时不应为空。

只能在创建广告系列时设置。创建广告系列后,此字段便无法更改。

advertising_channel_sub_type

AdvertisingChannelSubType

advertising_channel_type 的可选优化。必须是父级渠道类型的有效子类型。

只能在创建广告系列时设置。创建广告系列后,此字段便无法更改。

url_custom_parameters[]

CustomParameter

用于替换 tracking_url_templatefinal_urlsmobile_final_urls 中的自定义参数标记的映射列表。

real_time_bidding_setting

RealTimeBiddingSetting

实时出价的设置,此功能仅适用于定位到 Ad Exchange 广告资源的广告系列。

network_settings

NetworkSettings

相应广告系列的投放网络设置。

dynamic_search_ads_setting

DynamicSearchAdsSetting

用于控制动态搜索广告 (DSA) 的设置。

shopping_setting

ShoppingSetting

用于控制购物广告系列的设置。

geo_target_type_setting

GeoTargetTypeSetting

广告地理位置定位的设置。

effective_labels[]

string

附加到相应广告系列的有效标签的资源名称。有效标签是指继承或直接分配给相应广告系列的标签。

labels[]

string

此广告系列所附标签的资源名称。

bidding_strategy_type

BiddingStrategyType

出价策略的类型。

您可以通过以下方式创建出价策略:设置出价方案来创建标准出价策略,或设置 bidding_strategy 字段来创建组合出价策略。

此字段为只读字段。

accessible_bidding_strategy

string

AccessibleBiddingStrategy 的资源名称,这是附加的组合出价策略(由“bidding_strategy”标识)的无限制属性的只读视图。如果广告系列未使用组合策略,则为空。不受限制的策略属性可供共享相应策略的所有客户使用,并且可从 AccessibleBiddingStrategy 资源中读取。相比之下,受限属性仅适用于出价策略的所有者客户及其经理。只能从 BiddingStrategy 资源中读取受限属性。

frequency_caps[]

FrequencyCapEntry

用于限制每个用户看到相应广告系列广告的频次的名单。

selective_optimization

SelectiveOptimization

相应广告系列的选择性优化设置,其中包括一组转化操作,用于指导广告系列优化方向。此功能仅适用于将 MULTI_CHANNEL 用作 AdvertisingChannelType 且将 APP_CAMPAIGN 或 APP_CAMPAIGN_FOR_ENGAGEMENT 用作 AdvertisingChannelSubType 的应用广告系列。

optimization_goal_setting

OptimizationGoalSetting

相应广告系列的优化目标设置,包括一组优化目标类型。

tracking_setting

TrackingSetting

用于跟踪信息的广告系列级设置。

engine_id

string

外部引擎账号中的广告系列的 ID。此字段仅适用于非 Google Ads 账号,例如 Yahoo Japan、Microsoft、百度等。对于 Google Ads 实体,请改用“campaign.id”。

excluded_parent_asset_field_types[]

AssetFieldType

应从此广告系列中排除的素材资源字段类型。具有这些字段类型的素材资源链接不会由此广告系列从更高级别继承。

create_time

string

创建广告系列时的时间戳。时间戳采用客户的时区,并采用“yyyy-MM-dd HH:mm:ss”格式。create_time 将在 v1 中被弃用。请改用 creation_time。

creation_time

string

创建广告系列时的时间戳。时间戳采用客户的时区,并采用“yyyy-MM-dd HH:mm:ss”格式。

last_modified_time

string

上次修改此广告系列的日期时间。日期时间采用客户的时区,并采用“yyyy-MM-dd HH:mm:ss.ssssss”格式。

feed_types[]

AssetSetType

直接附加到相应广告系列的 Feed 类型。

id

int64

广告系列的 ID。

name

string

广告系列的名称。

此字段为必填字段,在创建新广告系列时不应为空。

并且不得包含任何 null(码位 0x0)、NL 换行符(码位 0xA)或回车符(码位 0xD)。

tracking_url_template

string

用于构建跟踪网址的网址模板。

campaign_budget

string

相应广告系列的广告系列预算的资源名称。

start_date

string

广告系列在提供服务的客户所在时区开始运行的日期(采用 YYYY-MM-DD 格式)。

end_date

string

广告系列在提供服务的客户所在时区运行的最后一天(采用 YYYY-MM-DD 格式)。创建时,默认为 2037-12-30,这表示广告系列将无限期投放。要将现有的广告系列设置为无限期投放,请将此字段设置为 2037-12-30。

final_url_suffix

string

用于将查询参数附加到通过并行跟踪投放的着陆页的后缀。

url_expansion_opt_out

bool

表示选择停用网址扩展功能,以定位到更具针对性的网址。如果选择停用(true),则仅定位到素材资源组中的最终到达网址或广告客户的 Google Merchant Center 或商家数据 Feed 中指定的网址。如果选择启用(false),则定位整个网域。此字段只能针对效果最大化广告系列进行设置,其默认值为 false。

联合字段 campaign_bidding_strategy。相应广告系列的竞价策略。

必须是组合出价策略(通过 BiddingStrategy 服务创建)或嵌入到广告系列中的标准出价策略。campaign_bidding_strategy 只能是下列其中一项:

bidding_strategy

string

相应广告系列所用组合出价策略的资源名称。

manual_cpa

ManualCpa

标准“每次转化费用人工出价”出价策略。一种人工出价策略,可让广告客户为广告客户指定的操作设置出价。仅支持本地生活服务广告系列。

manual_cpc

ManualCpc

标准“每次点击费用人工出价”出价策略。基于点击的手动出价,用户按每次点击付费。

manual_cpm

ManualCpm

标准“每千次展示费用人工出价”出价策略。人工出价,按展示次数付费,用户为每千次展示付费。

maximize_conversions

MaximizeConversions

标准“尽可能提高转化次数”出价策略,可在不超出预算的前提下自动争取尽可能多的转化次数。

maximize_conversion_value

MaximizeConversionValue

标准“尽可能提高转化价值”出价策略,可自动设置出价,以便在您的预算范围内,帮助您争取尽可能高的收入。

target_cpa

TargetCpa

标准“目标每次转化费用”出价策略,可自动设置出价,在不超出您设置的目标每次转化费用 (CPA) 的前提下,帮您获得尽可能多的转化。

target_impression_share

TargetImpressionShare

“目标展示次数份额”出价策略。一种自动出价策略,可设置出价以实现所选的展示次数百分比。

target_roas

TargetRoas

标准“目标广告支出回报率”出价策略,可自动最大限度地提高收入,同时确保达到特定的平均目标广告支出回报率 (ROAS)。

target_spend

TargetSpend

一种标准的目标支出出价策略,使用该策略,系统会自动为您设置适当的出价,确保在不超出预算的前提下为您争取尽可能多的点击。

percent_cpc

PercentCpc

标准“百分比形式的每次点击费用”出价策略,其中出价是部分商品或服务的广告价格的一小部分。

target_cpm

TargetCpm

一种自动优化每千次展示费用的出价策略。

DynamicSearchAdsSetting

用于控制动态搜索广告 (DSA) 的设置。

字段
domain_name

string

必需。相应设置所代表的网域,例如“google.com”或“www.google.com”。

language_code

string

必需。指定网域语言的语言代码,例如“en”。

use_supplied_urls_only

bool

广告系列是否仅使用广告客户提供的网址。

GeoTargetTypeSetting

表示与广告地理位置定位相关的一组设置。

字段
positive_geo_target_type

PositiveGeoTargetType

相应广告系列中用于正向地理位置定位的设置。

negative_geo_target_type

NegativeGeoTargetType

相应广告系列中用于否定地理位置定位的设置。

NetworkSettings

相应广告系列的投放网络设置。

字段
target_search_network

bool

广告是否将在 Google 搜索网络中的合作伙伴网站上投放(要求 target_google_search 也设为 true)。

target_content_network

bool

广告是否将在 Google 展示广告网络中的指定展示位置上投放。展示位置通过“展示位置”定位条件指定。

target_partner_search_network

bool

广告是否将在 Google 合作伙伴网络中投放。这仅可用于部分 Google 合作伙伴账号。

OptimizationGoalSetting

相应广告系列的优化目标设置,包括一组优化目标类型。

字段
optimization_goal_types[]

OptimizationGoalType

优化目标类型列表。

SelectiveOptimization

相应广告系列的选择性优化设置,其中包括一组转化操作,用于指导广告系列优化方向。此功能仅适用于将 MULTI_CHANNEL 用作 AdvertisingChannelType 且将 APP_CAMPAIGN 或 APP_CAMPAIGN_FOR_ENGAGEMENT 用作 AdvertisingChannelSubType 的应用广告系列。

字段
conversion_actions[]

string

用于优化相应广告系列的转化操作的所选资源名称集。

ShoppingSetting

购物广告系列的设置。定义了广告系列可宣传的商品范围,以及此广告系列与其他购物广告系列的互动方式。

字段
feed_label

string

要纳入广告系列中的商品的 Feed 标签。只能设置 feed_label 或 sales_country 之一。如果使用 feed_label 字段代替 sales_country 字段,则该字段接受相同格式的国家/地区代码,例如“XX”。否则,可以是 Google Merchant Center 中用于 Feed 标签的任何字符串。

use_vehicle_inventory

bool

是否定位车辆详情广告资源。

merchant_id

int64

Merchant Center 账号的 ID。此字段对于创建操作是必需的。对于购物广告系列,此字段不可更改。

sales_country

string

广告系列中待涵盖产品的销售国家/地区。

campaign_priority

int32

广告系列的优先级。数值越高,相应广告系列的优先级就越高,反之越低。此字段是购物广告系列的必需字段,值介于 0 到 2 之间(含边界值)。对于智能购物广告系列而言,此字段是选填项,如进行设置则须等于 3。

enable_local

bool

是否包含本地商品。

TrackingSetting

用于跟踪信息的广告系列级设置。

字段
tracking_url

string

用于动态跟踪的网址。

CampaignAsset

广告系列与素材资源之间的关联。

字段
resource_name

string

广告系列资源的资源名称。CampaignAsset 资源名称采用以下格式:

customers/{customer_id}/campaignAssets/{campaign_id}~{asset_id}~{field_type}

status

AssetLinkStatus

广告系列素材资源的状态。

campaign

string

素材资源关联到的广告系列。

asset

string

与广告系列关联的素材资源。

CampaignAssetSet

CampaignAssetSet 是广告系列与素材资源组之间的关联。添加 CampaignAssetSet 会将素材资源组与广告系列相关联。

字段
resource_name

string

广告系列素材资源组的资源名称。资产集资产资源名称采用以下格式:

customers/{customer_id}/campaignAssetSets/{campaign_id}~{asset_set_id}

campaign

string

相应素材资源集所关联的广告系列。

asset_set

string

与广告系列关联的素材资源集。

status

AssetSetLinkStatus

广告系列素材资源组素材资源的状态。只读。

CampaignAudienceView

广告系列受众群体视图。包括展示广告网络和 YouTube 广告网络的兴趣和再营销名单,以及搜索广告再营销名单 (RLSA) 的效果数据,按广告系列和受众群体条件汇总。此视图仅包含在广告系列一级添加的受众群体。

字段
resource_name

string

广告系列受众群体视图的资源名称。广告系列受众群体视图资源名称采用以下格式:

customers/{customer_id}/campaignAudienceViews/{campaign_id}~{criterion_id}

CampaignBudget

广告系列预算。

字段
resource_name

string

广告系列预算的资源名称。广告系列预算资源名称采用以下格式:

customers/{customer_id}/campaignBudgets/{campaign_budget_id}

delivery_method

BudgetDeliveryMethod

确定广告系列预算的支出速率的投放方式。

如果在创建操作中未指定,则默认为 STANDARD。

period

BudgetPeriod

支出预算的时间段。如果未指定,则默认为 DAILY。

amount_micros

int64

预算的金额,以账号的本地货币为单位。金额以微单位指定,即一百万等同于一个货币单位。每月支出上限为该金额的 30.4 倍。

CampaignCriterion

广告系列定位条件。

字段
resource_name

string

相应广告系列条件的资源名称。广告系列条件的资源名称采用以下格式:

customers/{customer_id}/campaignCriteria/{campaign_id}~{criterion_id}

display_name

string

条件的显示名称。

对于变更,此字段会被忽略。

type

CriterionType

条件的类型。

status

CampaignCriterionStatus

条件的状态。

last_modified_time

string

上次修改此广告系列条件的日期时间。日期时间采用客户的时区,并采用“yyyy-MM-dd HH:mm:ss.ssssss”格式。

criterion_id

int64

条件的 ID。

在变更期间,此字段会被忽略。

bid_modifier

float

条件匹配时出价的调节系数。调节系数的范围必须介于 0.1 - 10.0 之间。大多数可定位的条件类型都支持调节系数。使用 0 可停用设备类型。

negative

bool

是定位 (false) 还是排除 (true) 条件。

联合字段 criterion。广告系列定位条件。

只能设置一个值。criterion 只能是下列其中一项:

keyword

KeywordInfo

关键字。

location

LocationInfo

位置信息。

device

DeviceInfo

设备。

age_range

AgeRangeInfo

年龄段。

gender

GenderInfo

性别。

user_list

UserListInfo

用户列表。

language

LanguageInfo

语言。

webpage

WebpageInfo

网页。

location_group

LocationGroupInfo

营业地点组

CampaignEffectiveLabel

表示广告系列与有效标签之间的关系。有效标签是指继承或直接分配给相应广告系列的标签。

字段
resource_name

string

资源的名称。CampaignEffectivelabel 资源名称采用以下格式:customers/{owner_customer_id}/campaignEffectiveLabels/{campaign_id}~{label_id}

campaign

string

有效标签所附加到的广告系列。

label

string

分配给广告系列的有效标签。

owner_customer_id

int64

拥有有效标签的客户的 ID。

CampaignLabel

表示广告系列与标签之间的关系。

字段
resource_name

string

资源的名称。广告系列标签资源名称采用以下格式:customers/{owner_customer_id}/campaignLabels/{campaign_id}~{label_id}

campaign

string

标签附加到的广告系列。

label

string

分配给广告系列的标签。

owner_customer_id

int64

拥有相应标签的客户的 ID。

CartDataSalesView

购物车数据销售情况视图。

字段
resource_name

string

购物车数据销售情况视图的资源名称。购物车数据销售情况视图资源名称采用以下格式:customers/{customer_id}/cartDataSalesView

转化

转化。

字段
resource_name

string

相应转化操作的资源名称。转化资源名称采用以下格式:

customers/{customer_id}/conversions/{ad_group_id}~{criterion_id}~{ds_conversion_id}

id

int64

转化的 ID

criterion_id

int64

Search Ads 360 条件 ID。值为 0 表示条件未归因。

merchant_id

int64

包含获得点击的商品的 Search Ads 360 商品目录账号 ID。当您在 Search Ads 360 中关联商品目录账号时,Search Ads 360 会生成此 ID。

ad_id

int64

广告 ID。值为 0 表示广告未归因。

click_id

string

转化归因于的访问的唯一字符串,该字符串会作为点击 ID 网址参数传递到着陆页。

visit_id

int64

转化归因于的 Search Ads 360 访问 ID。

advertiser_conversion_id

string

对于线下转化,此 ID 由广告主提供。如果广告客户未指定此类 ID,Search Ads 360 会生成一个 ID。对于线上转化,这等于 ID 列或 floodlight_order_id 列,具体取决于广告客户的 Floodlight 指令。

product_id

string

被点击的商品的 ID。

product_channel

ProductChannel

获得点击的商品的销售渠道:线上或本地。

product_language_code

string

为包含商品数据的 Merchant Center Feed 设置的语言 (ISO-639-1)。

product_store_id

string

获得点击的本地商品目录广告中的商店。此 ID 应与本地商品 Feed 中使用的商店 ID 一致。

product_country_code

string

为包含获得点击的商品的商品目录 Feed 注册的国家/地区(ISO-3166 格式)。

attribution_type

AttributionType

转化归因于的原因:访问或关键字+广告。

conversion_date_time

string

转化事件的时间戳。

conversion_last_modified_date_time

string

转化上次修改的时间戳。

conversion_visit_date_time

string

转化归因于的访问的时间戳。

conversion_quantity

int64

转化记录的商品数量,由 qty 网址参数确定。广告主负责动态填充该参数(如转化中售出的商品数量),否则默认为 1。

conversion_revenue_micros

int64

转化事件的调整后收入(以微为单位)。此字段始终采用广告投放账号所用的币种。

floodlight_original_revenue

int64

在修改 Floodlight 货币指令之前,与 Floodlight 事件关联的未更改的原始收入(采用当前报告所用的币种)。

floodlight_order_id

string

广告主为转化提供的 Floodlight 订单 ID。

status

ConversionStatus

转化的状态,可以是 ENABLED 或 REMOVED。

asset_id

int64

转化事件期间发生互动的素材资源的 ID。

asset_field_type

AssetFieldType

转化事件的素材资源字段类型。

ConversionAction

转化操作。

字段
resource_name

string

转化操作的资源名称。转化操作资源名称采用以下格式:

customers/{customer_id}/conversionActions/{conversion_action_id}

creation_time

string

Floodlight 活动的创建时间戳,采用 ISO 8601 格式。

status

ConversionActionStatus

针对转化事件累计的此转化操作的状态。

type

ConversionActionType

相应转化操作的类型。

category

ConversionActionCategory

相应转化操作所报告的转化的类别。

value_settings

ValueSettings

与此转化操作关联的转化事件的价值相关的设置。

attribution_model_settings

AttributionModelSettings

与相应转化操作的归因模型相关的设置。

floodlight_settings

FloodlightSettings

Floodlight 转化类型的 Floodlight 设置。

id

int64

转化操作的 ID。

name

string

转化操作的名称。

此字段为必填字段,在创建新转化操作时不应为空。

primary_for_goal

bool

如果转化操作的 primary_for_goal 位为 false,则无论客户转化目标或广告系列转化目标如何,该转化操作都无法用于所有广告系列的出价。不过,自定义转化目标不会考虑 primary_for_goal,因此,如果某个广告系列配置了自定义转化目标,且该目标包含 primary_for_goal = false 的转化操作,那么该转化操作仍然可用于出价。默认情况下,如果未设置 primary_for_goal,则该值为 true。在 V9 中,primary_for_goal 只能在创建后通过“更新”操作设置为 false,因为它未声明为可选。

owner_customer

string

转化操作所有者客户的资源名称;如果这是系统定义的转化操作,则为 null。

include_in_client_account_conversions_metric

bool

相应转化操作是否应纳入“client_account_conversions”指标中。

include_in_conversions_metric

bool

相应转化操作是否应纳入到“转化次数”指标中。

click_through_lookback_window_days

int64

互动(例如点击)与转化事件之间可能相隔的最长天数。

app_id

string

应用转化操作的应用 ID。

AttributionModelSettings

与相应转化操作的归因模型相关的设置。

字段
attribution_model

AttributionModel

相应转化操作的归因模型类型。

data_driven_model_status

DataDrivenModelStatus

相应转化操作的以数据为依据的归因模型的状态。

FloodlightSettings

与 Floodlight 转化操作相关的设置。

字段
activity_group_tag

string

报告转化次数时用于标识 Floodlight 活动组的字符串。

activity_tag

string

报告转化次数时用于标识 Floodlight 活动的字符串。

activity_id

int64

DoubleClick Campaign Manager (DCM) 中的 Floodlight 活动的 ID。

ValueSettings

与此转化操作关联的转化事件的价值相关的设置。

字段
default_value

double

当针对相应转化操作发送的转化事件包含无效、不允许或缺失的价值时,或者当相应转化操作配置为始终使用默认价值时,要使用的价值。

default_currency_code

string

当针对相应转化操作发送的转化事件包含无效或缺失的币种代码时,或者当相应转化操作配置为始终使用默认价值时,要使用的币种代码。

always_use_default_value

bool

控制是否使用默认价值和默认币种代码来代替相应转化操作的转化事件中指定的价值和币种代码。

ConversionCustomVariable

转化自定义变量。如需了解详情,请参阅 https://support.google.com/sa360/answer/13567857 中的“新版 Search Ads 360 中的自定义 Floodlight 指标和维度简介”。

字段
resource_name

string

转化自定义变量的资源名称。转化自定义变量资源名称采用以下格式:

customers/{customer_id}/conversionCustomVariables/{conversion_custom_variable_id}

id

int64

转化自定义变量的 ID。

name

string

必需。转化自定义变量的名称。名称应是唯一的。名称的最大长度为 100 个字符。前后不应有任何多余空格。

tag

string

必需。转化自定义变量的标记。标记应是唯一的,并且由字符“u”直接后跟一个小于或等于 100 的数字组成。例如:“u4”。

status

ConversionCustomVariableStatus

转化自定义变量针对转化事件累计的状态。

owner_customer

string

拥有相应转化自定义变量的客户的资源名称。

family

ConversionCustomVariableFamily

转化自定义变量的系列。

cardinality

ConversionCustomVariableCardinality

转化自定义变量的基数。

floodlight_conversion_custom_variable_info

FloodlightConversionCustomVariableInfo

Search Ads 360 Floodlight 转化自定义变量的字段。

custom_column_ids[]

int64

使用相应转化自定义变量的自定义列的 ID。

FloodlightConversionCustomVariableInfo

Search Ads 360 Floodlight 转化自定义变量的相关信息。

字段
floodlight_variable_type

FloodlightVariableType

在 Search Ads 360 中定义的 Floodlight 变量类型。

floodlight_variable_data_type

FloodlightVariableDataType

在 Search Ads 360 中定义的 Floodlight 变量数据类型。

ConversionTrackingSetting

与 Search Ads 360 转化跟踪相关的一组客户级设置。

字段
accepted_customer_data_terms

bool

客户是否已接受客户数据条款。如果使用跨账号转化跟踪,此值会从经理账号继承。此字段为只读字段。如需了解详情,请访问 https://support.google.com/adspolicy/answer/7475709

conversion_tracking_status

ConversionTrackingStatus

转化跟踪状态。它表示客户是否在使用转化跟踪,以及该客户的转化跟踪所有者是谁。如果相应客户使用的是跨账号转化跟踪,则返回的值会因请求的 login-customer-id 而异。

enhanced_conversions_for_leads_enabled

bool

客户是否已选择启用增强型潜在客户转化。如果使用跨账号转化跟踪,此值会从经理账号继承。此字段为只读字段。

google_ads_conversion_customer

string

创建和管理转化的客户的资源名称。此字段为只读字段。

conversion_tracking_id

int64

相应账号所用的转化跟踪 ID。此 ID 不表示客户是否使用转化跟踪(conversion_tracking_status 表示)。此字段为只读字段。

google_ads_cross_account_conversion_tracking_id

int64

客户的经理的转化跟踪 ID。当客户选择启用转化跟踪时,系统会设置此 ID,并且此 ID 会替换 conversion_tracking_id。此字段只能通过 Google Ads 界面进行管理。此字段为只读字段。

cross_account_conversion_tracking_id

int64

客户的经理的转化跟踪 ID。当客户选择采用跨账号转化跟踪时,系统会设置此值,并替换 conversion_tracking_id。

CustomColumn

自定义列。请访问 https://support.google.com/sa360/answer/9633916,了解 Search Ads 360 自定义列

字段
resource_name

string

自定义列的资源名称。自定义列资源名称采用以下格式:

customers/{customer_id}/customColumns/{custom_column_id}

id

int64

自定义列的 ID。

name

string

自定义列的用户定义名称。

description

string

用户定义的自定义列说明。

value_type

CustomColumnValueType

自定义列的结果值的类型。

references_attributes

bool

当自定义列引用一个或多个属性时,值为 True。

references_metrics

bool

当自定义列引用一个或多个指标时,返回 True。

queryable

bool

当自定义列可用于 SearchAds360Service.Search 和 SearchAds360Service.SearchStream 的查询时,返回 True。

referenced_system_columns[]

string

相应自定义列的被引用系统列的列表。例如,自定义列“展示次数和点击次数之和”引用了系统列 {"metrics.clicks", "metrics.impressions"}。

render_type

CustomColumnRenderType

自定义列的结果值应如何解读。

客户

客户。

字段
resource_name

string

客户的资源名称。客户资源名称采用以下格式:

customers/{customer_id}

conversion_tracking_setting

ConversionTrackingSetting

客户的转化跟踪设置。

account_type

AccountType

Engine 账号类型,例如 Google Ads、Microsoft Advertising、Yahoo Japan、百度、Facebook、Engine Track 等。

double_click_campaign_manager_setting

DoubleClickCampaignManagerSetting

经理客户的 DoubleClick Campaign Manager (DCM) 设置。

account_status

AccountStatus

账号状态,例如“已启用”“已暂停”“已移除”等。

last_modified_time

string

上次修改此客户的日期时间。日期时间采用客户的时区,并采用“yyyy-MM-dd HH:mm:ss.ssssss”格式。

engine_id

string

外部引擎账号中的账号的 ID。

status

CustomerStatus

客户的状态。

creation_time

string

创建此客户时的时间戳。时间戳采用客户的时区,并采用“yyyy-MM-dd HH:mm:ss”格式。

manager_id

int64

经理的客户 ID。值为 0 表示客户没有 SA360 经理账号。

manager_descriptive_name

string

经理的描述性名称。

sub_manager_id

int64

子级经理的客户 ID。值为 0 表示客户没有子 SA360 经理账号。

sub_manager_descriptive_name

string

子级经理的描述性名称。

associate_manager_id

int64

副经理的客户 ID。值为 0 表示客户没有 SA360 副经理。

associate_manager_descriptive_name

string

副经理的描述性名称。

account_level

AccountLevelType

客户的账号层级:经理账号、子级经理账号、副经理账号、服务账号。

id

int64

客户的 ID。

descriptive_name

string

(可选)客户的非唯一描述性名称。

currency_code

string

账号采用的币种。支持 ISO 4217 标准中的一部分货币代码。

time_zone

string

客户的当地时区 ID。

tracking_url_template

string

用于根据参数构建跟踪网址的网址模板。

final_url_suffix

string

用于将参数附加到最终到达网址的网址模板。

auto_tagging_enabled

bool

相应客户是否已启用自动标记功能。

manager

bool

相应客户是否为经理。

CustomerAsset

客户与资源之间的关联。

字段
resource_name

string

客户资产的资源名称。CustomerAsset 资源名称采用以下格式:

customers/{customer_id}/customerAssets/{asset_id}~{field_type}

asset

string

必需。与客户关联的素材资源。

status

AssetLinkStatus

客户素材资源的状态。

CustomerAssetSet

CustomerAssetSet 是客户与资产集之间的关联。添加 CustomerAssetSet 会将素材资源集与客户相关联。

字段
resource_name

string

客户资产集的资源名称。资产集资产资源名称采用以下格式:

customers/{customer_id}/customerAssetSets/{asset_set_id}

asset_set

string

与客户关联的素材资源集。

customer

string

相应素材资源集所关联的客户。

status

AssetSetLinkStatus

客户素材资源组的素材资源的状态。只读。

CustomerClient

指定客户与客户客户之间的关联。CustomerClient 仅适用于经理客户。包括所有直接客户和间接客户,以及经理账号本身。

字段
resource_name

string

客户客户端的资源名称。CustomerClient 资源名称采用以下格式:customers/{customer_id}/customerClients/{client_customer_id}

applied_labels[]

string

请求客户所拥有的应用于客户端客户的标签的资源名称。标签资源名称采用以下格式:

customers/{customer_id}/labels/{label_id}

status

CustomerStatus

客户客户的状态。只读。

client_customer

string

与指定客户相关联的客户客户的资源名称。只读。

hidden

bool

指定相应账号是否为隐藏账号。

只读。

level

int64

给定客户与客户之间的距离。对于自链接,级别值为 0。只读。

time_zone

string

客户端时区的通用区域设置数据资源库 (CLDR) 字符串表示形式,例如 America/Los_Angeles。只读。

test_account

bool

标识客户是否为测试账号。只读。

manager

bool

用于标识客户是否为经理。只读。

descriptive_name

string

客户的描述性名称。只读。

currency_code

string

客户的币种代码(例如“USD”“EUR”)。只读。

id

int64

客户客户的 ID。只读。

DoubleClickCampaignManagerSetting

经理客户的 DoubleClick Campaign Manager (DCM) 设置。

字段
advertiser_id

int64

与相应客户相关联的 Campaign Manager 广告客户的 ID。

network_id

int64

与相应客户相关联的 Campaign Manager 广告联盟的 ID。

time_zone

string

与相应客户相关联的 Campaign Manager 广告网络时区(采用 IANA 时区数据库格式),例如 America/New_York。

DynamicSearchAdsSearchTermView

动态搜索广告搜索字词视图。

字段
resource_name

string

动态搜索广告搜索字词视图的资源名称。动态搜索广告搜索字词视图资源名称的格式如下:

customers/{customer_id}/dynamicSearchAdsSearchTermViews/{ad_group_id}~{search_term_fingerprint}~{headline_fingerprint}~{landing_page_fingerprint}~{page_url_fingerprint}

landing_page

string

展示的动态选择的着陆页网址。

此字段为只读字段。

GenderView

性别视图。gender_view 资源反映的是实际投放状态,而不是添加了哪些条件。默认情况下,没有性别条件的广告组会向所有性别的用户展示,因此 gender_view 中会显示所有性别的统计信息。

字段
resource_name

string

性别视图的资源名称。性别视图资源名称采用以下格式:

customers/{customer_id}/genderViews/{ad_group_id}~{criterion_id}

GeoTargetConstant

地理位置定位条件常量。

字段
resource_name

string

地理位置定位目标常量的资源名称。地理位置定位目标常量资源名称采用以下格式:

geoTargetConstants/{geo_target_constant_id}

status

GeoTargetConstantStatus

地理位置定位条件常量的状态。

id

int64

地理位置定位条件常量的 ID。

name

string

地理位置定位条件常量的英文名称。

country_code

string

与目标相关联的 ISO-3166-1 alpha-2 国家/地区代码。

target_type

string

地理位置定位条件常量的定位类型。

canonical_name

string

完全限定的英文名称,由目标名称及其父级和国家/地区的名称组成。

parent_geo_target

string

父地理位置定位目标常量的资源名称。地理位置定位目标常量资源名称采用以下格式:

geoTargetConstants/{parent_geo_target_constant_id}

KeywordView

关键字视图。

字段
resource_name

string

关键字视图的资源名称。关键字视图资源名称采用以下格式:

customers/{customer_id}/keywordViews/{ad_group_id}~{criterion_id}

标签

标签。

字段
resource_name

string

资源的名称。标签资源名称采用以下格式:customers/{owner_customer_id}/labels/{label_id}

status

LabelStatus

标签的状态。只读。

text_label

TextLabel

一种在彩色背景上显示文字的标签。

id

int64

标签的 ID。只读。

name

string

标签的名称。

此字段为必填字段,在创建新标签时不应为空。

此字符串的长度应介于 1 到 80 之间(包括 1 和 80)。

LanguageConstant

一种语言。

字段
resource_name

string

语言常量的资源名称。语言常量资源名称采用以下格式:

languageConstants/{criterion_id}

id

int64

语言常量的 ID。

code

string

语言代码,例如“en_US”“en_AU”“es”“fr”等。

name

string

语言的英文全名,例如“English (US)”“Spanish”等。

targetable

bool

相应语言是否可定位。

ListingGroupFilterDimension

素材资源组产品信息组过滤条件的商品详情维度。

字段
联合字段 dimension。始终存在以下类型之一的维度。dimension 只能是下列其中一项:
product_bidding_category

ProductBiddingCategory

商品优惠的出价类别。

product_brand

ProductBrand

商品优惠的品牌。

product_channel

ProductChannel

商品优惠的适用地区。

product_condition

ProductCondition

商品优惠的条件。

product_custom_attribute

ProductCustomAttribute

商品优惠的自定义属性。

product_item_id

ProductItemId

商品优惠的商品 ID。

product_type

ProductType

商品优惠的类型。

ProductBiddingCategory

特定级别的出价类别的一个元素。顶层类别的级别为 1,其子类别的级别为 2,以此类推。目前,我们最多支持 5 个级别。用户必须指定一个维度类型,以指明类别的级别。同一细分的所有情形都必须具有相同的维度类型(类别级)。

字段
level

ListingGroupFilterBiddingCategoryLevel

表示类目在分类中的级别。

id

int64

商品出价类别的 ID。

此 ID 等同于此文章中所述的 google_product_category ID:https://support.google.com/merchants/answer/6324436

ProductBrand

商品的品牌。

字段
value

string

商品品牌的字符串值。

ProductChannel

商品优惠的适用地区。

字段
channel

ListingGroupFilterProductChannel

相应地区的价值。

ProductCondition

商品优惠的条件。

字段
condition

ListingGroupFilterProductCondition

条件的值。

ProductCustomAttribute

商品优惠的自定义属性。

字段
index

ListingGroupFilterCustomAttributeIndex

表示自定义属性的索引。

value

string

商品自定义属性的字符串值。

ProductItemId

商品优惠的商品 ID。

字段
value

string

相应 ID 的值。

ProductType

商品优惠的类型。

字段
level

ListingGroupFilterProductTypeLevel

类型的级别。

value

string

相应类型的值。

ListingGroupFilterDimensionPath

用于定义商品详情组过滤条件的维度路径。

字段
dimensions[]

ListingGroupFilterDimension

从商品详情组过滤条件层次结构(不包括根节点)到相应商品详情组过滤条件的维度的完整路径。

LocationView

地理位置视图会按地理位置条件汇总广告系列的效果。

字段
resource_name

string

位置视图的资源名称。位置信息视图资源名称采用以下格式:

customers/{customer_id}/locationViews/{campaign_id}~{criterion_id}

ProductBiddingCategoryConstant

商品出价类别。

字段
resource_name

string

商品出价类别的资源名称。商品出价类别的资源名称采用以下格式:

productBiddingCategoryConstants/{country_code}~{level}~{id}

level

ProductBiddingCategoryLevel

商品出价类别的级别。

status

ProductBiddingCategoryStatus

商品出价类别的状态。

id

int64

商品出价类别的 ID。

此 ID 等同于此文章中所述的 google_product_category ID:https://support.google.com/merchants/answer/6324436

country_code

string

商品出价类别的双字母大写国家/地区代码。

product_bidding_category_constant_parent

string

父级商品出价类别的资源名称。

language_code

string

商品出价类别的语言代码。

localized_name

string

显示根据 language_code 本地化的商品出价类别的显示值。

ProductGroupView

产品组视图。

字段
resource_name

string

商品组视图的资源名称。产品组视图资源名称采用以下格式:

customers/{customer_id}/productGroupViews/{ad_group_id}~{criterion_id}

SearchAds360Field

SearchAds360Service 使用的字段或资源(制品)。

字段
resource_name

string

相应制品版本的资源名称。制品资源名称的格式为:

SearchAds360Fields/{name}

category

SearchAds360FieldCategory

相应制品所属的类别。

selectable_with[]

string

可通过所述制品选择的所有资源、细分和指标的名称。

attribute_resources[]

string

可通过所述制品选择的所有资源名称。如果搜索查询中包含这些资源中的字段,则这些字段不会细分指标。

此字段仅针对类别为 RESOURCE 的制品设置。

metrics[]

string

此字段列出了在 FROM 子句中使用时,可通过所述制品选择的所有指标的名称。仅针对类别为 RESOURCE 的制品设置。

segments[]

string

此字段列出了所有制成品(无论是细分还是其他资源)的名称,这些制成品在搜索查询中包含时以及在 FROM 子句中使用所描述的制品时,会细分指标。仅针对类别为 RESOURCE 的制品设置。

enum_values[]

string

如果制品是 ENUM 类型的字段,则制品可以采用的值。

此字段仅针对类别为 SEGMENT 或 ATTRIBUTE 的制品进行设置。

data_type

SearchAds360FieldDataType

此字段用于确定可在 WHERE 子句中与相应制品搭配使用的运算符。

name

string

相应制品的名字。

selectable

bool

相应制品是否可在搜索查询的 SELECT 子句中使用。

filterable

bool

相应制品是否可在搜索查询的 WHERE 子句中使用。

sortable

bool

相应制品是否可在搜索查询的 ORDER BY 子句中使用。

type_url

string

描述制品数据类型的 proto 的网址。

is_repeated

bool

字段制品是否重复。

ShoppingPerformanceView

购物广告效果视图。提供在多个产品维度级别汇总的购物广告系列统计信息。来自 Merchant Center 的商品维度值(例如品牌、类别、自定义属性、商品状况和商品类型)将反映相应事件记录时的每个维度的状态。

字段
resource_name

string

购物广告效果视图的资源名称。购物广告效果视图资源名称采用以下格式:customers/{customer_id}/shoppingPerformanceView

UserList

用户列表。这是客户可以定位的用户列表。

字段
resource_name

string

用户列表的资源名称。用户列表资源名称采用以下格式:

customers/{customer_id}/userLists/{user_list_id}

type

UserListType

相应列表的类型。

此字段为只读字段。

id

int64

用户列表的 ID。

name

string

相应用户名单的名称。根据其 access_reason,用户列表名称可能不是唯一的(例如,如果 access_reason=SHARED)

UserLocationView

用户位置信息视图。

“用户地理位置”视图包含在国家/地区一级汇总的所有指标,每个国家/地区对应一行。它会按定位到或未定位到的地理位置,报告基于用户实际所在地理位置的指标。如果使用其他细分字段,您可能会获得每个国家/地区的多行数据。

字段
resource_name

string

用户位置信息视图的资源名称。UserLocation 视图资源名称采用以下格式:

customers/{customer_id}/userLocationViews/{country_criterion_id}~{targeting_location}

country_criterion_id

int64

国家/地区的条件 ID。

targeting_location

bool

指明是否定位了营业地点。

访问

一次访问。

字段
resource_name

string

相应访问的资源名称。访问资源名称的格式为:

customers/{customer_id}/visits/{ad_group_id}~{criterion_id}~{ds_visit_id}

id

int64

相应访问的 ID。

criterion_id

int64

Search Ads 360 关键字 ID。值为 0 表示关键字未归因。

merchant_id

int64

包含获得点击的商品的 Search Ads 360 商品目录账号 ID。当您在 Search Ads 360 中关联商品目录账号时,Search Ads 360 会生成此 ID。

ad_id

int64

广告 ID。值为 0 表示广告未归因。

click_id

string

作为点击 ID 网址参数传递到着陆页的每次访问的唯一字符串。

visit_date_time

string

相应访问事件的时间戳。时间戳采用客户的时区,并采用“yyyy-MM-dd HH:mm:ss”格式。

product_id

string

被点击的商品的 ID。

product_channel

ProductChannel

获得点击的商品的销售渠道:线上或本地。

product_language_code

string

为包含商品数据的 Merchant Center Feed 设置的语言 (ISO-639-1)。

product_store_id

string

获得点击的本地商品目录广告中的商店。此 ID 应与本地商品 Feed 中使用的商店 ID 一致。

product_country_code

string

为包含获得点击的商品的商品目录 Feed 注册的国家/地区(ISO-3166 格式)。

asset_id

int64

访问事件期间发生互动的资产的 ID。

asset_field_type

AssetFieldType

访问事件的素材资源字段类型。

WebpageView

网页浏览量。

字段
resource_name

string

网页视图的资源名称。网页视图资源名称采用以下格式:

customers/{customer_id}/webpageViews/{ad_group_id}~{criterion_id}