Method: accounts.reports.search

检索由搜索查询定义的报告。响应中包含的行数可能少于 pageSize 指定的行数。依赖 nextPageToken 来确定是否有更多行要请求。

HTTP 请求

POST https://merchantapi.googleapis.com/reports/v1beta/{parent=accounts/*}/reports:search

网址采用 gRPC 转码语法。

路径参数

参数
parent

string

必需。发出调用的账号的 ID。必须是独立账号或 MCA 子账号。格式：accounts/{account}

请求正文

请求正文中包含结构如下的数据：

JSON 表示法 
{
  "query": string,
  "pageSize": integer,
  "pageToken": string
}
字段
query

string

必需。用于定义要检索的报告的查询。

如需详细了解如何构建查询，请参阅“查询语言”指南。如需查看可用表格和字段的完整列表，请参阅“可用字段”。
pageSize

integer

可选。要在单个页面中检索的 ReportRows 的数量。默认值为 1000。大于 5000 的值会被强制转换为 5000。
pageToken

string

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

响应正文

ReportService.Search 方法的响应消息。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "results": [
    {
      object (ReportRow)
    }
  ],
  "nextPageToken": string
}
字段
results[]

object (ReportRow)

与搜索查询匹配的行。
nextPageToken

string

可作为 pageToken 发送以检索下一页的令牌。如果省略，则不存在后续页面。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/content

如需了解详情，请参阅 OAuth 2.0 概览。

ReportRow

从搜索查询返回的结果行。

响应中仅填充与查询的表对应的消息。在填充的消息中，系统只会填充查询中明确请求的字段。

JSON 表示法 
{
  "productPerformanceView": {
    object (ProductPerformanceView)
  },
  "nonProductPerformanceView": {
    object (NonProductPerformanceView)
  },
  "productView": {
    object (ProductView)
  },
  "priceCompetitivenessProductView": {
    object (PriceCompetitivenessProductView)
  },
  "priceInsightsProductView": {
    object (PriceInsightsProductView)
  },
  "bestSellersProductClusterView": {
    object (BestSellersProductClusterView)
  },
  "bestSellersBrandView": {
    object (BestSellersBrandView)
  },
  "competitiveVisibilityCompetitorView": {
    object (CompetitiveVisibilityCompetitorView)
  },
  "competitiveVisibilityTopMerchantView": {
    object (CompetitiveVisibilityTopMerchantView)
  },
  "competitiveVisibilityBenchmarkView": {
    object (CompetitiveVisibilityBenchmarkView)
  }
}
字段
productPerformanceView

object (ProductPerformanceView)

productPerformanceView 表中可供查询的字段。
nonProductPerformanceView

object (NonProductPerformanceView)

nonProductPerformanceView 表中可供查询的字段。
productView

object (ProductView)

productView 表中可供查询的字段。
priceCompetitivenessProductView

object (PriceCompetitivenessProductView)

priceCompetitivenessProductView 表中可供查询的字段。
priceInsightsProductView

object (PriceInsightsProductView)

priceInsightsProductView 表中可供查询的字段。
bestSellersProductClusterView

object (BestSellersProductClusterView)

bestSellersProductClusterView 表中可供查询的字段。
bestSellersBrandView

object (BestSellersBrandView)

“bestSellersBrandView”表中可供查询的字段。
competitiveVisibilityCompetitorView

object (CompetitiveVisibilityCompetitorView)

competitiveVisibilityCompetitorView 表中可供查询的字段。
competitiveVisibilityTopMerchantView

object (CompetitiveVisibilityTopMerchantView)

“competitiveVisibilityTopMerchantView”表中可供查询的字段。
competitiveVisibilityBenchmarkView

object (CompetitiveVisibilityBenchmarkView)

competitiveVisibilityBenchmarkView 表中可供查询的字段。

ProductPerformanceView

productPerformanceView 表中可供查询的字段。

您账号的商品效果数据，包括效果指标（例如 clicks）和用于对效果指标进行细分的维度（例如 offerId）。商品维度（例如 offerId）的值反映了商品在展示时所处的状态。

在查询中选择细分字段时，必须同时选择至少一个指标字段。

系统只会为请求的搜索查询中明确请求的字段设置值。

JSON 表示法 
{
  "date": {
    object (Date)
  },
  "week": {
    object (Date)
  },
  "conversionValue": {
    object (Price)
  },
  "marketingMethod": enum (MarketingMethodEnum),
  "customerCountryCode": string,
  "offerId": string,
  "title": string,
  "brand": string,
  "categoryL1": string,
  "categoryL2": string,
  "categoryL3": string,
  "categoryL4": string,
  "categoryL5": string,
  "productTypeL1": string,
  "productTypeL2": string,
  "productTypeL3": string,
  "productTypeL4": string,
  "productTypeL5": string,
  "customLabel0": string,
  "customLabel1": string,
  "customLabel2": string,
  "customLabel3": string,
  "customLabel4": string,
  "clicks": string,
  "impressions": string,
  "clickThroughRate": number,
  "conversions": number,
  "conversionRate": number
}
字段
date

object (Date)

指标适用的商家时区中的日期。细分。

WHERE 子句中必须包含对 date 的条件。
week

object (Date)

指标日期的一周的第一天（星期一），以商家时区为准。细分。
conversionValue

object (Price)

归因于该产品的转化的价值，在转化日期报告。指标。

仅适用于 FREE 流量来源。
marketingMethod

enum (MarketingMethodEnum)

指标适用的营销方式。细分。
customerCountryCode

string

事件发生时客户所在国家/地区的代码。以 ISO 3166 格式表示。细分。

如果无法确定客户所在的国家/地区，系统会返回特殊的“ZZ”代码。
offerId

string

商家提供的商品 ID。细分。
title

string

商品的名称。细分。
brand

string

商品的品牌。细分。
categoryL1

string

Google 商品类目中的商品类别（第 1 级）。细分。
categoryL2

string

Google 商品类目中的商品类别（第 2 级）。细分。
categoryL3

string

Google 商品类目中的商品类别（第 3 级）。细分。
categoryL4

string

Google 商品类目中的商品类别（第 4 级）。细分。
categoryL5

string

Google 商品类目中的商品类别（第 5 级）。细分。
productTypeL1

string

商家自有商品分类中的商品类型（第 1 级）。细分。
productTypeL2

string

商家自有商品分类中的商品类型（第 2 级）。细分。
productTypeL3

string

商家自有商品分类中的产品类型（第 3 级）。细分。
productTypeL4

string

商家自有商品分类中的商品类型（第 4 级）。细分。
productTypeL5

string

商家自有商品分类中的产品类型（第 5 级）。细分。
customLabel0

string

自定义标签 0，用于对商品进行自定义分组。细分。
customLabel1

string

自定义标签 1，用于自定义产品分组。细分。
customLabel2

string

自定义标签 2，用于对商品进行自定义分组。细分。
customLabel3

string

自定义标签 3，用于自定义商品分组。细分。
customLabel4

string

自定义标签 4，用于自定义商品分组。细分。
clicks

string (int64 format)

点击次数。指标。
impressions

string (int64 format)

商家商品的展示次数。指标。
clickThroughRate

number

点击率 - 商家商品获得的点击次数（点击次数）除以商品的展示次数（展示次数）。指标。
conversions

number

归因于产品的转化次数，报告为转化日期。根据归因模型的不同，转化可能会跨越多次点击进行分配，而每次点击都会获得自己的功劳。此指标是所有此类抵用金的总和。指标。

仅适用于 FREE 流量来源。
conversionRate

number

转化次数除以点击次数，报告为展示日期。指标。

仅适用于“FREE”流量来源。

MarketingMethodEnum

营销方式值。

枚举
MARKETING_METHOD_ENUM_UNSPECIFIED 未指定。
ORGANIC 自然营销。
ADS 基于广告的营销。

NonProductPerformanceView

nonProductPerformanceView 表中可供查询的字段。

指向非商品页面的图片和网店链接的效果数据。这包括效果指标（例如 clicks）和用于对效果指标进行细分的维度（例如 date）。

在查询中选择细分字段时，必须同时选择至少一个指标字段。

系统只会为请求的搜索查询中明确请求的字段设置值。

JSON 表示法 
{
  "date": {
    object (Date)
  },
  "week": {
    object (Date)
  },
  "clicks": string,
  "impressions": string,
  "clickThroughRate": number
}
字段
date

object (Date)

指标适用的商家时区中的日期。细分。

WHERE 子句中必须包含对 date 的条件。
week

object (Date)

指标日期的一周的第一天（星期一），以商家时区为准。细分。
clicks

string (int64 format)

将用户引向您非商品页面的图片和网店链接获得的点击次数。指标。
impressions

string (int64 format)

指向您非商品页面的图片和网店链接的展示次数。指标。
clickThroughRate

number

点击率 - 点击次数 (clicks) 除以指向非商品页面的图片和网店链接的展示次数 (impressions)。指标。

ProductView

productView 表中可供查询的字段。

当前商品目录中的商品。此表中的商品与商品子 API 中的商品相同，但此表中无法查询商品子 API 中的所有商品属性。与产品子 API 不同，此表允许您按商品属性过滤返回的商品列表。如需按 id 检索单个商品或列出所有商品，应使用 Products 子 API。

系统只会为请求的搜索查询中明确请求的字段设置值。

JSON 表示法 
{
  "price": {
    object (Price)
  },
  "gtin": [
    string
  ],
  "creationTime": string,
  "expirationDate": {
    object (Date)
  },
  "itemIssues": [
    {
      object (ItemIssue)
    }
  ],
  "clickPotential": enum (ClickPotential),
  "id": string,
  "channel": enum (ChannelEnum),
  "languageCode": string,
  "feedLabel": string,
  "offerId": string,
  "title": string,
  "brand": string,
  "categoryL1": string,
  "categoryL2": string,
  "categoryL3": string,
  "categoryL4": string,
  "categoryL5": string,
  "productTypeL1": string,
  "productTypeL2": string,
  "productTypeL3": string,
  "productTypeL4": string,
  "productTypeL5": string,
  "condition": string,
  "availability": string,
  "shippingLabel": string,
  "itemGroupId": string,
  "thumbnailLink": string,
  "aggregatedReportingContextStatus": enum (AggregatedReportingContextStatus),
  "clickPotentialRank": string
}
字段
price

object (Price)

商品价格。如果没有商品价格信息，则不填。
gtin[]

string

商品的全球贸易项目代码 (GTIN) 列表。
creationTime

string (Timestamp format)

商家创建商品的时间（采用时间戳秒数形式）。
expirationDate

object (Date)

商品的下架日期，在插入时指定。
itemIssues[]

object (ItemIssue)

商品的商品问题列表。

此字段无法用于对结果进行排序。

只有此字段的部分属性（例如 itemIssues.severity.aggregated_severity）可用于过滤结果。
clickPotential

enum (ClickPotential)

与商家表现最好的商品相比，商品的预估效果潜力。
id

string

商品的 REST ID，格式为 channel~languageCode~feedLabel~offerId。对商品执行操作的 Merchant API 方法将此作为其 name 参数。

在 SELECT 子句中是必需的。
channel

enum (ChannelEnum)

产品的渠道。可以是 ONLINE 或 LOCAL。
languageCode

string

商品的语言代码，采用 BCP 47 格式。
feedLabel

string

商品的 Feed 标签。
offerId

string

商家提供的商品 ID。
title

string

商品的标题。
brand

string

商品的品牌。
categoryL1

string

Google 商品类目中的商品类别（第 1 级）。
categoryL2

string

Google 商品类目中的商品类别（第 2 级）。
categoryL3

string

Google 商品类目中的商品类别（第 3 级）。
categoryL4

string

Google 商品类目中的商品类别（第 4 级）。
categoryL5

string

Google 商品类目中的商品类别（第 5 级）。
productTypeL1

string

商家自有商品类目中的商品类型（第 1 级）。
productTypeL2

string

商家自己的商品类目中的商品类型（第 2 级）。
productTypeL3

string

商家自己的商品类目中的商品类型（第 3 级）。
productTypeL4

string

商家自有商品分类法中的商品类型（第 4 级）。
productTypeL5

string

商家自有商品分类中的商品类型（第 5 级）。
condition

string

商品的使用情况。
availability

string

商品的库存状况。
shippingLabel

string

数据源中指定的标准化配送标签。
itemGroupId

string

商家提供的商品组 ID，用于将款式/规格分为一组。
aggregatedReportingContextStatus

enum (AggregatedReportingContextStatus)

汇总状态。
clickPotentialRank

string (int64 format)

商品的点击潜力排名。在符合搜索查询条件的商家商品中，clickPotentialRank 为 1 的商品获得点击的潜力最高。

AggregatedReportingContextStatus

针对所有报告上下文汇总的商品状态。

以下示例说明了如何计算汇总状态：

非付费商品详情 购物广告 状态
已批准 已批准 有效
已批准 待处理 有效
已批准 已拒登 ELIGIBLE_LIMITED
待处理 待处理 待审批
已拒登 已拒登 NOT_ELIGIBLE_OR_DISAPPROVED
枚举
AGGREGATED_REPORTING_CONTEXT_STATUS_UNSPECIFIED 未指定。
NOT_ELIGIBLE_OR_DISAPPROVED 产品不符合使用任何报告环境的条件，或被拒批。
PENDING 商品在所有报告上下文中的状态均为“待处理”。
ELIGIBLE_LIMITED 商品适用于部分（但不是全部）报告上下文。
ELIGIBLE 产品可以在所有报告中使用。

ItemIssue

与商品相关的商品问题。

JSON 表示法 
{
  "type": {
    object (ItemIssueType)
  },
  "severity": {
    object (ItemIssueSeverity)
  },
  "resolution": enum (ItemIssueResolution)
}
字段
type

object (ItemIssueType)

商品问题类型。
severity

object (ItemIssueSeverity)

商品问题的严重程度。
resolution

enum (ItemIssueResolution)

商品问题解决。

ItemIssueType

问题类型。

JSON 表示法 
{
  "code": string,
  "canonicalAttribute": string
}
字段
code

string

问题的错误代码，相当于商品问题的 code。
canonicalAttribute

string

特定于属性的问题的规范属性名称。

ItemIssueSeverity

问题对商品投放有何影响。

JSON 表示法 
{
  "severityPerReportingContext": [
    {
      object (IssueSeverityPerReportingContext)
    }
  ],
  "aggregatedSeverity": enum (AggregatedIssueSeverity)
}
字段
severityPerReportingContext[]

object (IssueSeverityPerReportingContext)

每个报告上下文的问题严重级别。
aggregatedSeverity

enum (AggregatedIssueSeverity)

针对问题所影响的所有报告上下文汇总的问题严重级别。

此字段可用于过滤结果。

IssueSeverityPerReportingContext

每个报告上下文的问题严重级别。

JSON 表示法 
{
  "disapprovedCountries": [
    string
  ],
  "demotedCountries": [
    string
  ],
  "reportingContext": enum (ReportingContextEnum)
}
字段
disapprovedCountries[]

string

报告上下文中的已拒登国家/地区列表，以 ISO 3166 格式表示。
demotedCountries[]

string

报告上下文中的已降级国家/地区列表，以 ISO 3166 格式表示。
reportingContext

enum (ReportingContextEnum)

问题适用的报告上下文。

AggregatedIssueSeverity

针对所有报告上下文汇总的问题严重级别。

枚举
AGGREGATED_ISSUE_SEVERITY_UNSPECIFIED 未指定。
DISAPPROVED 问题导致商品在至少一个报告上下文中被拒批。
DEMOTED 问题导致产品在其影响的所有报告环境中降级。
PENDING 问题解决方案为 PENDING_PROCESSING。

ItemIssueResolution

如何解决此问题。

枚举
ITEM_ISSUE_RESOLUTION_UNSPECIFIED 未指定。
MERCHANT_ACTION 商家必须解决此问题。
PENDING_PROCESSING 问题将自动解决（例如图片抓取），或通过 Google 审核解决。目前无需商家执行任何操作。解决方案可能会导致其他问题（例如抓取失败）。

ClickPotential

商品的获得点击的潜力用于估算其与商家表现最好的商品相比潜力如何。商品获得点击的潜力可帮助商家确定需要优先解决哪些商品的问题，以及对比商品的表现与其潜力相比如何。

枚举
CLICK_POTENTIAL_UNSPECIFIED 未知的预测点击次数影响。
LOW 与商家表现最好的商品相比，有可能获得相对较少的点击次数。
MEDIUM 与商家表现最好的商品相比，有可能获得适中的点击次数。
HIGH 与商家表现最好的商品相比，有可能获得大体相当的点击次数。

PriceCompetitivenessProductView

“priceCompetitivenessProductView”表中可供查询的字段。

价格竞争力报告。

系统只会为请求的搜索查询中明确请求的字段设置值。

JSON 表示法 
{
  "price": {
    object (Price)
  },
  "benchmarkPrice": {
    object (Price)
  },
  "reportCountryCode": string,
  "id": string,
  "offerId": string,
  "title": string,
  "brand": string,
  "categoryL1": string,
  "categoryL2": string,
  "categoryL3": string,
  "categoryL4": string,
  "categoryL5": string,
  "productTypeL1": string,
  "productTypeL2": string,
  "productTypeL3": string,
  "productTypeL4": string,
  "productTypeL5": string
}
字段
price

object (Price)

商品的当前价格。
benchmarkPrice

object (Price)

基准国家/地区中商品目录的最新可用价格基准。
reportCountryCode

string

价格基准的国家/地区。采用 ISO 3166 格式表示。

在 SELECT 子句中是必需的。
id

string

商品的 REST ID，格式为 channel~languageCode~feedLabel~offerId。可用于将数据与 productView 表联接。

在 SELECT 子句中是必需的。
offerId

string

商家提供的商品 ID。
title

string

商品的标题。
brand

string

商品的品牌。
categoryL1

string

Google 商品类目中的商品类别（第 1 级）。
categoryL2

string

Google 商品类目中的商品类别（第 2 级）。
categoryL3

string

Google 商品类目中的商品类别（第 3 级）。
categoryL4

string

Google 商品类目中的商品类别（第 4 级）。
categoryL5

string

Google 商品类目中的商品类别（第 5 级）。
productTypeL1

string

商家自有商品类目中的商品类型（第 1 级）。
productTypeL2

string

商家自有商品分类中的商品类型（第 2 级）。
productTypeL3

string

商家自有商品类目中的商品类型（第 3 级）。
productTypeL4

string

商家自有商品分类法中的商品类型（第 4 级）。
productTypeL5

string

商家自有商品分类中的商品类型（第 5 级）。

PriceInsightsProductView

priceInsightsProductView 表中可供查询的字段。

价格分析报告。

系统只会为请求的搜索查询中明确请求的字段设置值。

JSON 表示法 
{
  "price": {
    object (Price)
  },
  "suggestedPrice": {
    object (Price)
  },
  "effectiveness": enum (Effectiveness),
  "id": string,
  "offerId": string,
  "title": string,
  "brand": string,
  "categoryL1": string,
  "categoryL2": string,
  "categoryL3": string,
  "categoryL4": string,
  "categoryL5": string,
  "productTypeL1": string,
  "productTypeL2": string,
  "productTypeL3": string,
  "productTypeL4": string,
  "productTypeL5": string,
  "predictedImpressionsChangeFraction": number,
  "predictedClicksChangeFraction": number,
  "predictedConversionsChangeFraction": number
}
字段
price

object (Price)

商品的当前价格。
suggestedPrice

object (Price)

商品的最新建议价格。
effectiveness

enum (Effectiveness)

应用价格建议后的预计效果（分桶）。
id

string

商品的 REST ID，格式为 channel~languageCode~feedLabel~offerId。可用于将数据与 productView 表联接。

在 SELECT 子句中是必需的。
offerId

string

商家提供的商品 ID。
title

string

商品的标题。
brand

string

商品的品牌。
categoryL1

string

Google 商品类目中的商品类别（第 1 级）。
categoryL2

string

Google 商品类目中的商品类别（第 2 级）。
categoryL3

string

Google 商品类目中的商品类别（第 3 级）。
categoryL4

string

Google 商品类目中的商品类别（第 4 级）。
categoryL5

string

Google 商品类目中的商品类别（第 5 级）。
productTypeL1

string

商家自己的商品类目中的商品类型（第 1 级）。
productTypeL2

string

商家自有商品分类中的商品类型（第 2 级）。
productTypeL3

string

商家自己的商品类目中的商品类型（第 3 级）。
productTypeL4

string

商家自己的商品类目中的商品类型（第 4 级）。
productTypeL5

string

商家自有商品分类中的商品类型（第 5 级）。
predictedImpressionsChangeFraction

number

采用建议的价格后预计获得的展示次数与当前有效价格相比的变化幅度（以小数表示）。例如，0.05 表示预计展示次数会增加 5%。
predictedClicksChangeFraction

number

采用建议的价格后预计获得的点击次数与当前有效价格相比的变化幅度（以小数表示）。例如，0.05 表示预计点击次数会增加 5%。
predictedConversionsChangeFraction

number

采用建议价格后预计的转化次数变化（与当前有效价格相比），以小数表示。例如，0.05 表示转化次数预计会增加 5%）。

效果

预测的效果分桶。

有效性可指明哪些商品将从价格变动中受益最多。此评分会考虑调整促销价以及当前价格与建议价格之间的差值预计会提升的效果。具有HIGH有效性的价格建议预计能最大限度地提升广告效果。

枚举
EFFECTIVENESS_UNSPECIFIED 效果未知。
LOW 效果较差。
MEDIUM 效果中等。
HIGH 效果出色。

BestSellersProductClusterView

bestSellersProductClusterView 表中可供查询的字段。

畅销商品报告包含热门商品集群。商品集群是指代表同一商品（例如 Google Pixel 7）的不同商品和款式/规格的分组。

系统只会为请求的搜索查询中明确请求的字段设置值。

JSON 表示法 
{
  "reportDate": {
    object (Date)
  },
  "variantGtins": [
    string
  ],
  "reportGranularity": enum (ReportGranularityEnum),
  "reportCountryCode": string,
  "reportCategoryId": string,
  "title": string,
  "brand": string,
  "categoryL1": string,
  "categoryL2": string,
  "categoryL3": string,
  "categoryL4": string,
  "categoryL5": string,
  "inventoryStatus": enum (InventoryStatus),
  "brandInventoryStatus": enum (InventoryStatus),
  "rank": string,
  "previousRank": string,
  "relativeDemand": enum (RelativeDemandEnum),
  "previousRelativeDemand": enum (RelativeDemandEnum),
  "relativeDemandChange": enum (RelativeDemandChangeTypeEnum)
}
字段
reportDate

object (Date)

报告日期。此字段的值只能是以下值之一：

  • 每周报告的第一天（星期一）
  • 每月报告的开始日期（即当月第一天）。

在 SELECT 子句中是必需的。如果查询中未指定 reportDate 的 WHERE 条件，则系统会返回最新的可用周报或月报。
variantGtins[]

string

商品集群示例款式/规格的 GTIN。
reportGranularity

enum (ReportGranularityEnum)

报告的粒度。排名可以按一周或一个月的时间范围进行。

SELECT 子句中必需的。WHERE 子句中必须包含对 reportGranularity 的条件。
reportCountryCode

string

计算排名的国家/地区。以 ISO 3166 格式表示。

SELECT 子句中必需的。WHERE 子句中必须包含对 reportCountryCode 的条件。
reportCategoryId

string (int64 format)

用于计算排名的 Google 商品类别 ID，以 Google 商品类目中的表示法表示。

SELECT 子句中必需的。如果查询中未指定对 reportCategoryId 的 WHERE 条件，则系统会返回所有顶级类别的排名。
title

string

商品集群的名称。
brand

string

商品集合的品牌。
categoryL1

string

商品集群的商品类别（第 1 级），以 Google 商品类目中的表示方式表示。
categoryL2

string

商品组的商品类别（第 2 级），以 Google 的商品类目表示。
categoryL3

string

商品组的商品类别（第 3 级），以 Google 的商品类目表示。
categoryL4

string

商品集群的商品类别（第 4 级），以 Google 商品类目中的表示法表示。
categoryL5

string

商品集群的商品类别（第 5 级），以 Google 的商品类目表示。
inventoryStatus

enum (InventoryStatus)

商品集群在至少一个国家/地区的商品数据源中的状态是否为 IN_STOCK，在所有国家/地区的商品数据源中的状态是否为 OUT_OF_STOCK，或者是否为 NOT_IN_INVENTORY。

此字段不考虑畅销商品报告的国家/地区过滤条件。
brandInventoryStatus

enum (InventoryStatus)

无论当前在至少一个国家/地区的商品数据来源中是否有品牌的至少一件商品IN_STOCK，所有商品在所有国家/地区的商品数据来源中都处于“OUT_OF_STOCK”状态，或者“NOT_IN_INVENTORY”。

此字段不考虑畅销商品报告的国家/地区过滤条件。
rank

string (int64 format)

在选定的类别和国家/地区中，商品集群在 Google Ads 和自然平台上的受欢迎程度（以估算的售出商品数量为依据）。
previousRank

string (int64 format)

前一周或前一个月的热门程度排名。
relativeDemand

enum (RelativeDemandEnum)

相对于同一类别和国家/地区中热门程度排名最高的商品集群的预计需求量。
previousRelativeDemand

enum (RelativeDemandEnum)

相对于同一类别和国家/地区中热门程度排名最高的商品集群，商品集群的预计需求量。
relativeDemandChange

enum (RelativeDemandChangeTypeEnum)

预计需求的变化。是上涨、下跌还是持平。

ReportGranularityEnum

报告粒度值。

枚举
REPORT_GRANULARITY_ENUM_UNSPECIFIED 未指定。
WEEKLY 报告是根据一周的时间范围计算得出的。
MONTHLY 报告以一个月为时间范围进行计算。

InventoryStatus

商品集合或品牌在您的商品目录中的状态。

枚举
INVENTORY_STATUS_UNSPECIFIED 未指定。
IN_STOCK 您有此商品集合或品牌的商品在售。
OUT_OF_STOCK 商品目录中有一个适用于此商品集群或品牌的商品，但目前缺货。
NOT_IN_INVENTORY 您的商品目录中没有此产品集群或品牌的商品。

RelativeDemandEnum

相对需求值。

枚举
RELATIVE_DEMAND_ENUM_UNSPECIFIED 未指定。
VERY_LOW 需求量相当于排名最高的商品集合或品牌需求量的 0-5%。
LOW 需求量相当于排名最高的商品集合或品牌需求量的 6-10%。
MEDIUM 需求是排名最高的产品组或品牌需求量的 11-20%。
HIGH 需求量相当于排名最高的商品集合或品牌需求量的 21-50%。
VERY_HIGH 需求量相当于排名最高的商品集合或品牌需求量的 51-100%。

RelativeDemandChangeTypeEnum

相对需求变化类型值。

枚举
RELATIVE_DEMAND_CHANGE_TYPE_ENUM_UNSPECIFIED 未指定。
SINKER 相对需求低于上一时间段。
FLAT 相对需求与上一时间段相同。
RISER 相对需求高于上一时间段。

BestSellersBrandView

bestSellersBrandView 表中可供查询的字段。

畅销商品报告，其中包含热门品牌。

仅为请求的搜索查询中明确请求的字段设置值。

JSON 表示法 
{
  "reportDate": {
    object (Date)
  },
  "reportGranularity": enum (ReportGranularityEnum),
  "reportCountryCode": string,
  "reportCategoryId": string,
  "brand": string,
  "rank": string,
  "previousRank": string,
  "relativeDemand": enum (RelativeDemandEnum),
  "previousRelativeDemand": enum (RelativeDemandEnum),
  "relativeDemandChange": enum (RelativeDemandChangeTypeEnum)
}
字段
reportDate

object (Date)

报告日期。此字段的值只能是以下值之一：

  • 每周报告的第一天（星期一）
  • 每月报告的开始日期（即当月第一天）。

SELECT 子句中必需的。如果查询中未指定针对 reportDate 的 WHERE 条件，则返回最新的每周或每月报告。
reportGranularity

enum (ReportGranularityEnum)

报告的粒度。排名可以按一周或一个月的时间范围进行。

SELECT 子句中必需的。WHERE 子句中必须包含对 reportGranularity 的条件。
reportCountryCode

string

计算排名的国家/地区。以 ISO 3166 格式表示。

SELECT 子句中必需的。WHERE 子句中必须包含对 reportCountryCode 的条件。
reportCategoryId

string (int64 format)

用于计算排名的 Google 商品类别 ID，以 Google 商品类目表示。

SELECT 子句中必需的。如果查询中未指定针对 reportCategoryId 的 WHERE 条件，则返回所有顶级类别的排名。
brand

string

品牌名称。
rank

string (int64 format)

品牌在 Google Ads 和自然平台上的受欢迎程度（在选定的类别和国家/地区），以估算的售出商品数量为依据。
previousRank

string (int64 format)

热门程度排名（前一周或前一个月）。
relativeDemand

enum (RelativeDemandEnum)

相对于同一类别和国家/地区中热门程度排名最高的品牌的预计需求量。
previousRelativeDemand

enum (RelativeDemandEnum)

与同一类别和国家/地区中热门程度排名最高的品牌相比，品牌的预计需求量。
relativeDemandChange

enum (RelativeDemandChangeTypeEnum)

预计需求的变化。是上涨、下跌还是持平。

CompetitiveVisibilityCompetitorView

“competitiveVisibilityCompetitorView”表中可供查询的字段。

竞争洞察报告，其中包含曝光度相近的商家。

系统只会为请求的搜索查询中明确请求的字段设置值。

JSON 表示法 
{
  "date": {
    object (Date)
  },
  "domain": string,
  "isYourDomain": boolean,
  "reportCountryCode": string,
  "reportCategoryId": string,
  "trafficSource": enum (TrafficSourceEnum),
  "rank": string,
  "adsOrganicRatio": number,
  "pageOverlapRate": number,
  "higherPositionRate": number,
  "relativeVisibility": number
}
字段
date

object (Date)

此行的日期。

WHERE 子句中必须包含针对 date 的条件。
domain

string

竞争对手的域名，或您的域名（如果“isYourDomain”为 true）。

SELECT 子句中必需的。无法在“WHERE”子句中进行过滤。
isYourDomain

boolean

如果此行包含您网域的数据，则为“true”。

无法在“WHERE”子句中进行过滤。
reportCountryCode

string

展示发生的国家/地区。

SELECT 子句中必需的。WHERE 子句中必须包含针对 reportCountryCode 的条件。
reportCategoryId

string (int64 format)

要为其计算报告的 Google 商品类别 ID，以 Google 商品类目中的表示法表示。

SELECT 子句中必需的。WHERE 子句中必须包含针对 reportCategoryId 的条件。
trafficSource

enum (TrafficSourceEnum)

展示的流量来源。

在 SELECT 子句中是必需的。
rank

string (int64 format)

在根据展示次数对所选关键字（date、reportCategoryId、reportCountryCode、trafficSource）进行的类似商家排名中，域名的排名。1 表示最高。

无法在“WHERE”子句中进行过滤。
adsOrganicRatio

number

广告流量 / 自然流量比率：与从自然流量获得展示次数相比，网域从购物广告获得展示次数的频率。数值经过四舍五入和分区。

无法在“WHERE”子句中进行过滤。
pageOverlapRate

number

同页重叠率是指竞争对手的商品与您的商品在同一页面中同时展示的频率。

无法在“WHERE”子句中进行过滤。
higherPositionRate

number

排名较您高出率是指，竞争对手的商品较您的商品在同一页面上获得更高排名的频率。

无法在“WHERE”子句中进行过滤。
relativeVisibility

number

相对曝光度是指相较于您的商品，竞争对手商品的展示频率。换句话说，相对曝光度是指在所选时间范围内针对特定商品类别和国家/地区，竞争对手获得的展示次数除以您的展示次数所得到的值。

无法在“WHERE”子句中进行过滤。

TrafficSourceEnum

流量来源值。

枚举
TRAFFIC_SOURCE_ENUM_UNSPECIFIED 未指定。
ORGANIC 自然流量。
ADS 广告流量。
ALL 自然流量和广告流量。

CompetitiveVisibilityTopMerchantView

competitiveVisibilityTopMerchantView 表中可供查询的字段。

竞争洞察报告，其中显示曝光度最高的商家。

系统只会为请求的搜索查询中明确请求的字段设置值。

JSON 表示法 
{
  "date": {
    object (Date)
  },
  "domain": string,
  "isYourDomain": boolean,
  "reportCountryCode": string,
  "reportCategoryId": string,
  "trafficSource": enum (TrafficSourceEnum),
  "rank": string,
  "adsOrganicRatio": number,
  "pageOverlapRate": number,
  "higherPositionRate": number
}
字段
date

object (Date)

此行的日期。

无法在 SELECT 子句中选择。WHERE 子句中必须包含针对 date 的条件。
domain

string

竞争对手的域名，或您的域名（如果“isYourDomain”为 true）。

SELECT 子句中必需的。无法在“WHERE”子句中进行过滤。
isYourDomain

boolean

如果此行包含您网域的数据，则为“true”。

无法在“WHERE”子句中进行过滤。
reportCountryCode

string

展示发生的国家/地区。

在 SELECT 子句中是必需的。WHERE 子句中必须包含针对 reportCountryCode 的条件。
reportCategoryId

string (int64 format)

用于计算报告的 Google 商品类别 ID，以 Google 的商品类目表示。

SELECT 子句中必需的。WHERE 子句中必须包含针对 reportCategoryId 的条件。
trafficSource

enum (TrafficSourceEnum)

展示的流量来源。

在 SELECT 子句中是必需的。
rank

string (int64 format)

在按展示次数排名的所选关键字（date、reportCategoryId、reportCountryCode、trafficSource）中，相应网域在前 10 名商家中的排名。1 表示最高。

无法在“WHERE”子句中进行过滤。
adsOrganicRatio

number

广告流量 / 自然流量比率：与从自然流量获得展示次数相比，网域从购物广告获得展示次数的频率。数值经过四舍五入和分区。

无法在“WHERE”子句中进行过滤。
pageOverlapRate

number

同页重叠率显示的是竞争对手的商品与您的商品在同一页面上同时展示的频率。

无法在“WHERE”子句中进行过滤。
higherPositionRate

number

排名较您高出率是指，竞争对手的商品较您的商品在同一页面上获得更高排名的频率。

无法在“WHERE”子句中进行过滤。

CompetitiveVisibilityBenchmarkView

competitiveVisibilityBenchmarkView 表中可供查询的字段。

竞争洞察报告，其中包含类别基准。

系统只会为请求的搜索查询中明确请求的字段设置值。

JSON 表示法 
{
  "date": {
    object (Date)
  },
  "reportCountryCode": string,
  "reportCategoryId": string,
  "trafficSource": enum (TrafficSourceEnum),
  "yourDomainVisibilityTrend": number,
  "categoryBenchmarkVisibilityTrend": number
}
字段
date

object (Date)

此行的日期。

SELECT 子句中必需的。WHERE 子句中必须包含针对 date 的条件。
reportCountryCode

string

展示发生的国家/地区。

SELECT 子句中必需的。WHERE 子句中必须包含针对 reportCountryCode 的条件。
reportCategoryId

string (int64 format)

要为其计算报告的 Google 商品类别 ID，以 Google 商品类目中的表示法表示。

SELECT 子句中必需的。WHERE 子句中必须包含针对 reportCategoryId 的条件。
trafficSource

enum (TrafficSourceEnum)

展示的流量来源。

在 SELECT 子句中是必需的。
yourDomainVisibilityTrend

number

您网域的展示次数变化，相对于所选时间范围的起始日期（或展示次数非零的第一天）而言。

无法在“WHERE”子句中进行过滤。
categoryBenchmarkVisibilityTrend

number

与所选时间段的开始日期（或展示次数不为零的第一天）相比，曝光度变化（基于展示次数）。此指标基于一组曝光度最高且接近市场的商家计算得出。

无法在“WHERE”子句中进行过滤。