新版 Search Ads 360 Reporting API 现已发布。您可以加入 searchads-api-announcements Google 网上论坛，及时了解即将发布的增强功能和版本。

此页面由 Cloud Translation API 翻译。

Package google.ads.searchads360.v0.services

索引

CustomColumnService

用于管理自定义列的服务。

GetCustomColumn

GetCustomColumn
`rpc GetCustomColumn(GetCustomColumnRequest) returns (CustomColumn)` 返回请求的自定义列的完整详细信息。授权范围需要以下 OAuth 范围： `https://www.googleapis.com/auth/doubleclicksearch`

rpc GetCustomColumn(GetCustomColumnRequest) returns (CustomColumn)

返回请求的自定义列的完整详细信息。

授权范围

需要以下 OAuth 范围：

https://www.googleapis.com/auth/doubleclicksearch

ListCustomColumns

ListCustomColumns
`rpc ListCustomColumns(ListCustomColumnsRequest) returns (ListCustomColumnsResponse)` 返回与相应客户关联的所有自定义列的完整详情。授权范围需要以下 OAuth 范围： `https://www.googleapis.com/auth/doubleclicksearch`

rpc ListCustomColumns(ListCustomColumnsRequest) returns (ListCustomColumnsResponse)

返回与相应客户关联的所有自定义列的完整详情。

授权范围

需要以下 OAuth 范围：

https://www.googleapis.com/auth/doubleclicksearch

CustomerService

用于管理客户的服务。

ListAccessibleCustomers

ListAccessibleCustomers
`rpc ListAccessibleCustomers(ListAccessibleCustomersRequest) returns (ListAccessibleCustomersResponse)` 返回可由对调用进行身份验证的用户直接访问的客户的资源名称。抛出的错误列表：AuthenticationError AuthorizationError HeaderError InternalError QuotaError RequestError 授权范围需要以下 OAuth 范围： `https://www.googleapis.com/auth/doubleclicksearch`

rpc ListAccessibleCustomers(ListAccessibleCustomersRequest) returns (ListAccessibleCustomersResponse)

返回可由对调用进行身份验证的用户直接访问的客户的资源名称。

抛出的错误列表：AuthenticationError AuthorizationError HeaderError InternalError QuotaError RequestError

授权范围

需要以下 OAuth 范围：

https://www.googleapis.com/auth/doubleclicksearch

SearchAds360FieldService

用于提取 Search Ads 360 API 字段的服务。

GetSearchAds360Field

GetSearchAds360Field
`rpc GetSearchAds360Field(GetSearchAds360FieldRequest) returns (SearchAds360Field)` 仅返回请求的字段。抛出的错误列表：AuthenticationError AuthorizationError HeaderError InternalError QuotaError RequestError 授权范围需要以下 OAuth 范围： `https://www.googleapis.com/auth/doubleclicksearch`

rpc GetSearchAds360Field(GetSearchAds360FieldRequest) returns (SearchAds360Field)

仅返回请求的字段。

抛出的错误列表：AuthenticationError AuthorizationError HeaderError InternalError QuotaError RequestError

授权范围

需要以下 OAuth 范围：

https://www.googleapis.com/auth/doubleclicksearch

SearchSearchAds360Fields

SearchSearchAds360Fields
`rpc SearchSearchAds360Fields(SearchSearchAds360FieldsRequest) returns (SearchSearchAds360FieldsResponse)` 返回与搜索查询匹配的所有字段。抛出的错误列表：AuthenticationError AuthorizationError HeaderError InternalError QueryError QuotaError RequestError 授权范围需要以下 OAuth 范围： `https://www.googleapis.com/auth/doubleclicksearch`

rpc SearchSearchAds360Fields(SearchSearchAds360FieldsRequest) returns (SearchSearchAds360FieldsResponse)

返回与搜索查询匹配的所有字段。

抛出的错误列表：AuthenticationError AuthorizationError HeaderError InternalError QueryError QuotaError RequestError

授权范围

需要以下 OAuth 范围：

https://www.googleapis.com/auth/doubleclicksearch

SearchAds360Service

用于提取各个资源中数据和指标的服务。

搜索

搜索
`rpc Search(SearchSearchAds360Request) returns (SearchSearchAds360Response)` 返回与搜索查询匹配的所有行。抛出的错误的列表：AuthenticationError AuthorizationError HeaderError InternalError QueryError QuotaError RequestError 授权范围需要以下 OAuth 范围： `https://www.googleapis.com/auth/doubleclicksearch`

rpc Search(SearchSearchAds360Request) returns (SearchSearchAds360Response)

返回与搜索查询匹配的所有行。

抛出的错误的列表：AuthenticationError AuthorizationError HeaderError InternalError QueryError QuotaError RequestError

授权范围

需要以下 OAuth 范围：

https://www.googleapis.com/auth/doubleclicksearch

SearchStream

SearchStream
`rpc SearchStream(SearchSearchAds360StreamRequest) returns (SearchSearchAds360StreamResponse)` 返回与搜索串流查询匹配的所有行。抛出的错误的列表：AuthenticationError AuthorizationError HeaderError InternalError QueryError QuotaError RequestError 授权范围需要以下 OAuth 范围： `https://www.googleapis.com/auth/doubleclicksearch`

rpc SearchStream(SearchSearchAds360StreamRequest) returns (SearchSearchAds360StreamResponse)

返回与搜索串流查询匹配的所有行。

抛出的错误的列表：AuthenticationError AuthorizationError HeaderError InternalError QueryError QuotaError RequestError

授权范围

需要以下 OAuth 范围：

https://www.googleapis.com/auth/doubleclicksearch

ConversionCustomDimensionHeader

转化自定义维度标题的消息。

字段

字段
`id`	`int64` 转化自定义维度 ID。
`name`	`string` 转化自定义维度的用户定义名称。

id

int64

转化自定义维度 ID。

name

string

转化自定义维度的用户定义名称。

ConversionCustomMetricHeader

转化自定义指标标题的消息。

字段

字段
`id`	`int64` 转化自定义指标 ID。
`name`	`string` 转化自定义指标的用户定义名称。

id

int64

转化自定义指标 ID。

name

string

转化自定义指标的用户定义名称。

CustomColumnHeader

自定义列标题的消息。

字段

字段
`id`	`int64` 自定义列 ID。
`name`	`string` 自定义列的用户定义名称。
`references_metrics`	`bool` 如果自定义列引用指标，则为 true。

id

int64

自定义列 ID。

name

string

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

references_metrics

bool

如果自定义列引用指标，则为 true。

GetCustomColumnRequest

CustomColumnService.GetCustomColumn 的请求消息。

字段

字段
`resource_name`	`string` 必需。要提取的自定义列的资源名称。

resource_name

string

必需。要提取的自定义列的资源名称。

GetSearchAds360FieldRequest

SearchAds360FieldService.GetSearchAds360Field 的请求消息。

字段

字段
`resource_name`	`string` 必需。要获取的字段的资源名称。

resource_name

string

必需。要获取的字段的资源名称。

ListAccessibleCustomersRequest

此类型没有字段。

CustomerService.ListAccessibleCustomers 的请求消息。

ListAccessibleCustomersResponse

CustomerService.ListAccessibleCustomers 的响应消息。

字段

字段
`resource_names[]`	`string` 对调用进行身份验证的用户可以直接访问的客户资源名称。

resource_names[]

string

对调用进行身份验证的用户可以直接访问的客户资源名称。

ListCustomColumnsRequest

CustomColumnService.ListCustomColumns 的请求消息

字段

字段
`customer_id`	`string` 必需。要应用自定义列列表操作的客户 ID。

customer_id

string

必需。要应用自定义列列表操作的客户 ID。

ListCustomColumnsResponse

用于提取与客户关联的所有自定义列的响应消息。

字段

字段
`custom_columns[]`	`CustomColumn` 所提供客户拥有的自定义列。

custom_columns[]

CustomColumn

所提供客户拥有的自定义列。

RawEventConversionDimensionHeader

原始事件转化维度标头的消息。

字段

字段
`id`	`int64` 转化自定义变量 ID。
`name`	`string` 原始事件维度的用户定义名称。

id

int64

转化自定义变量 ID。

name

string

原始事件维度的用户定义名称。

RawEventConversionMetricHeader

原始事件转化指标标头的消息。

字段

字段
`id`	`int64` 转化自定义变量 ID。
`name`	`string` 原始事件指标的用户指定名称。

id

int64

转化自定义变量 ID。

name

string

原始事件指标的用户指定名称。

SearchAds360Row

查询返回的行。

字段
`ad_group`	`AdGroup` 查询中引用的广告组。
`ad_group_ad`	`AdGroupAd` 查询中引用的广告。
`ad_group_ad_effective_label`	`AdGroupAdEffectiveLabel` 查询中引用的广告组广告有效标签。
`ad_group_ad_label`	`AdGroupAdLabel` 查询中引用的广告组广告标签。
`ad_group_asset`	`AdGroupAsset` 查询中引用的广告组素材资源。
`ad_group_asset_set`	`AdGroupAssetSet` 查询中引用的广告组素材资源组。
`ad_group_audience_view`	`AdGroupAudienceView` 查询中引用的广告组受众群体视图。
`ad_group_bid_modifier`	`AdGroupBidModifier` 查询中引用的出价调节系数。
`ad_group_criterion`	`AdGroupCriterion` 查询中引用的条件。
`ad_group_criterion_effective_label`	`AdGroupCriterionEffectiveLabel` 查询中引用的广告组条件有效标签。
`ad_group_criterion_label`	`AdGroupCriterionLabel` 查询中引用的广告组条件标签。
`ad_group_effective_label`	`AdGroupEffectiveLabel` 查询中引用的有效广告组标签。
`ad_group_label`	`AdGroupLabel` 查询中引用的广告组标签。
`age_range_view`	`AgeRangeView` 查询中引用的年龄段视图。
`asset`	`Asset` 查询中引用的资产。
`asset_group_asset`	`AssetGroupAsset` 查询中引用的素材资源组素材资源。
`asset_group_signal`	`AssetGroupSignal` 查询中引用的素材资源组信号。
`asset_group_listing_group_filter`	`AssetGroupListingGroupFilter` 查询中引用的素材资源组产品信息组过滤条件。
`asset_group_top_combination_view`	`AssetGroupTopCombinationView` 查询中引用的素材资源组“效果最佳的组合”视图。
`asset_group`	`AssetGroup` 查询中引用的素材资源组。
`asset_set_asset`	`AssetSetAsset` 查询中引用的素材资源组素材资源。
`asset_set`	`AssetSet` 查询中引用的素材资源集。
`bidding_strategy`	`BiddingStrategy` 查询中引用的出价策略。
`campaign_budget`	`CampaignBudget` 查询中引用的广告系列预算。
`campaign`	`Campaign` 查询中引用的广告系列。
`campaign_asset`	`CampaignAsset` 查询中引用的广告系列素材资源。
`campaign_asset_set`	`CampaignAssetSet` 查询中引用的广告系列素材资源组。
`campaign_audience_view`	`CampaignAudienceView` 查询中引用的广告系列受众群体视图。
`campaign_criterion`	`CampaignCriterion` 查询中引用的广告系列定位条件。
`campaign_effective_label`	`CampaignEffectiveLabel` 查询中引用的广告系列有效标签。
`campaign_label`	`CampaignLabel` 查询中引用的广告系列标签。
`cart_data_sales_view`	`CartDataSalesView` 查询中引用的购物车数据销售视图。
`audience`	`Audience` 查询中引用的受众群体。
`conversion_action`	`ConversionAction` 查询中引用的转化操作。
`conversion_custom_variable`	`ConversionCustomVariable` 查询中引用的转化自定义变量。
`customer`	`Customer` 查询中提及的客户。
`customer_asset`	`CustomerAsset` 查询中引用的客户素材资源。
`customer_asset_set`	`CustomerAssetSet` 查询中引用的客户素材资源集。
`accessible_bidding_strategy`	`AccessibleBiddingStrategy` 查询中引用的可用出价策略。
`customer_manager_link`	`CustomerManagerLink` 查询中引用的 CustomerManagerLink。
`customer_client`	`CustomerClient` 查询中引用的 CustomerClient。
`dynamic_search_ads_search_term_view`	`DynamicSearchAdsSearchTermView` 查询中引用的动态搜索广告搜索字词视图。
`gender_view`	`GenderView` 查询中引用的性别视图。
`geo_target_constant`	`GeoTargetConstant` 查询中引用的地理位置定位常量。
`keyword_view`	`KeywordView` 查询中引用的关键字视图。
`label`	`Label` 查询中引用的标签。
`language_constant`	`LanguageConstant` 查询中引用的语言常量。
`location_view`	`LocationView` 查询中引用的位置视图。
`product_bidding_category_constant`	`ProductBiddingCategoryConstant` 查询中引用的商品出价类别。
`product_group_view`	`ProductGroupView` 查询中引用的产品组视图。
`shopping_performance_view`	`ShoppingPerformanceView` 查询中引用的购物效果视图。
`user_list`	`UserList` 查询中引用的用户列表。
`user_location_view`	`UserLocationView` 查询中引用的用户位置视图。
`webpage_view`	`WebpageView` 查询中引用的网页视图。
`visit`	`Visit` 查询中引用的事件级访问。
`conversion`	`Conversion` 查询中引用的事件级转化。
`metrics`	`Metrics` 指标。
`segments`	`Segments` 细分。
`custom_columns[]`	`Value` 自定义列。

SearchSearchAds360FieldsRequest

SearchAds360FieldService.SearchSearchAds360Fields 的请求消息。

字段

字段
`query`	`string` 必需。查询字符串。
`page_token`	`string` 要检索的页面的令牌。如果未指定，则返回第一页结果。使用从上一个响应中的 `next_page_token` 获取的值来请求下一页结果。
`page_size`	`int32` 要在单个页面中检索的元素数量。如果请求的页面过大，服务器可能会决定进一步限制返回的资源数量。

query

string

必需。查询字符串。

page_token

string

要检索的页面的令牌。如果未指定，则返回第一页结果。使用从上一个响应中的 next_page_token 获取的值来请求下一页结果。

page_size

int32

要在单个页面中检索的元素数量。如果请求的页面过大，服务器可能会决定进一步限制返回的资源数量。

SearchSearchAds360FieldsResponse

SearchAds360FieldService.SearchSearchAds360Fields 的响应消息。

字段

字段
`results[]`	`SearchAds360Field` 与查询匹配的字段列表。
`next_page_token`	`string` 用于检索下一页结果的分页令牌。将此字符串的内容作为下一个请求的 `page_token` 属性传递。系统不会为最后一页返回 `next_page_token`。
`total_results_count`	`int64` 与查询匹配的结果的总数（忽略 LIMIT 子句）。

results[]

SearchAds360Field

与查询匹配的字段列表。

next_page_token

string

用于检索下一页结果的分页令牌。将此字符串的内容作为下一个请求的 page_token 属性传递。系统不会为最后一页返回 next_page_token。

total_results_count

int64

与查询匹配的结果的总数（忽略 LIMIT 子句）。

SearchSearchAds360Request

SearchAds360Service.Search 的请求消息。

字段
`customer_id`	`string` 必需。要查询的客户的 ID。
`query`	`string` 必需。查询字符串。
`page_token`	`string` 要检索的页面的令牌。如果未指定，则返回第一页结果。使用从上一个响应中的 `next_page_token` 获取的值来请求下一页结果。
`page_size`	`int32` 要在单个页面中检索的元素数量。如果请求的页面过大，服务器可能会决定进一步限制返回的资源数量。
`validate_only`	`bool` 如果为 true，则系统会验证该请求，但不会执行该请求。
`return_total_results_count`	`bool` 如果为 true，则响应中将包含与查询匹配的结果的总数（忽略 LIMIT 子句）。默认值为 false。
`summary_row_setting`	`SummaryRowSetting` 确定是否会返回摘要行。默认情况下，系统不会返回摘要行。如果请求，系统会在返回所有其他查询结果后单独在响应中发送摘要行。

SearchSearchAds360Response

SearchAds360Service.Search 的响应消息。

字段
`results[]`	`SearchAds360Row` 与查询匹配的行列表。
`next_page_token`	`string` 用于检索下一页结果的分页令牌。将此字符串的内容作为下一个请求的 `page_token` 属性传递。系统不会为最后一页返回 `next_page_token`。
`total_results_count`	`int64` 与忽略 LIMIT 子句的查询匹配的结果总数。
`field_mask`	`FieldMask` 表示用户请求了哪些字段的 FieldMask。
`summary_row`	`SearchAds360Row` 摘要行，其中包含结果中指标的摘要。指标摘要是指对所有结果中的指标进行汇总，汇总方式可以是求和、平均值、比率等。
`custom_column_headers[]`	`CustomColumnHeader` 结果中自定义列的标题。
`conversion_custom_metric_headers[]`	`ConversionCustomMetricHeader` 结果中转化自定义指标的标头。
`conversion_custom_dimension_headers[]`	`ConversionCustomDimensionHeader` 结果中转化自定义维度的标题。
`raw_event_conversion_metric_headers[]`	`RawEventConversionMetricHeader` 结果中原始事件转化指标的标题。
`raw_event_conversion_dimension_headers[]`	`RawEventConversionDimensionHeader` 结果中原始事件转化维度的标题。

SearchSearchAds360StreamRequest

SearchAds360Service.SearchStream 的请求消息。

字段
`customer_id`	`string` 必需。要查询的客户的 ID。
`query`	`string` 必需。查询字符串。
`batch_size`	`int32` 每个数据流响应批次中返回的行数。如果请求的批次过多，服务器可能会决定进一步限制返回的行数。
`summary_row_setting`	`SummaryRowSetting` 确定是否返回摘要行。默认情况下，系统不会返回摘要行。如果请求，系统会在返回所有其他查询结果后单独在响应中发送摘要行。

SearchSearchAds360StreamResponse

SearchAds360Service.SearchStream 的响应消息。

字段
`results[]`	`SearchAds360Row` 与查询匹配的行列表。
`field_mask`	`FieldMask` 表示用户请求了哪些字段的 FieldMask。
`summary_row`	`SearchAds360Row` 摘要行，其中包含结果中指标的摘要。指标摘要是指对所有结果中的指标进行汇总，汇总方式可以是求和、平均值、比率等。
`custom_column_headers[]`	`CustomColumnHeader` 结果中自定义列的标题。
`conversion_custom_metric_headers[]`	`ConversionCustomMetricHeader` 结果中转化自定义指标的标头。
`conversion_custom_dimension_headers[]`	`ConversionCustomDimensionHeader` 结果中转化自定义维度的标头。
`raw_event_conversion_metric_headers[]`	`RawEventConversionMetricHeader` 结果中原始事件转化指标的标头。
`raw_event_conversion_dimension_headers[]`	`RawEventConversionDimensionHeader` 结果中原始事件转化维度的标题。
`request_id`	`string` 请求的唯一 ID，用于调试目的。