Google Shopping Merchant Reports V1 Client - Class CompetitiveVisibilityBenchmarkView (1.1.1)

Reference documentation and code samples for the Google Shopping Merchant Reports V1 Client class CompetitiveVisibilityBenchmarkView.

Fields available for query in competitive_visibility_benchmark_view table.

Competitive visibility report with the category benchmark. Values are only set for fields requested explicitly in the request's search query.

Generated from protobuf message google.shopping.merchant.reports.v1.CompetitiveVisibilityBenchmarkView

Namespace

Google \ Shopping \ Merchant \ Reports \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ date Google\Type\Date

Date of this row. Required in the SELECT clause. A condition on date is required in the WHERE clause.
↳ report_country_code string

Country where impressions appeared. Required in the SELECT clause. A condition on report_country_code is required in the WHERE clause.
↳ report_category_id int|string

Google product category ID to calculate the report for, represented in Google's product taxonomy. Required in the SELECT clause. A condition on report_category_id is required in the WHERE clause.
↳ traffic_source int

Traffic source of impressions. Required in the SELECT clause.
↳ your_domain_visibility_trend float

Change in visibility based on impressions for your domain with respect to the start of the selected time range (or first day with non-zero impressions). Cannot be filtered on in the 'WHERE' clause.
↳ category_benchmark_visibility_trend float

Change in visibility based on impressions with respect to the start of the selected time range (or first day with non-zero impressions) for a combined set of merchants with highest visibility approximating the market. Cannot be filtered on in the 'WHERE' clause.

getDate

Date of this row.

Required in the SELECT clause. A condition on date is required in the WHERE clause.

Returns
Type Description
Google\Type\Date|null

hasDate

clearDate

setDate

Date of this row.

Required in the SELECT clause. A condition on date is required in the WHERE clause.

Parameter
Name Description
var Google\Type\Date
Returns
Type Description
$this

getReportCountryCode

Country where impressions appeared.

Required in the SELECT clause. A condition on report_country_code is required in the WHERE clause.

Returns
Type Description
string

hasReportCountryCode

clearReportCountryCode

setReportCountryCode

Country where impressions appeared.

Required in the SELECT clause. A condition on report_country_code is required in the WHERE clause.

Parameter
Name Description
var string
Returns
Type Description
$this

getReportCategoryId

Google product category ID to calculate the report for, represented in Google's product taxonomy.

Required in the SELECT clause. A condition on report_category_id is required in the WHERE clause.

Returns
Type Description
int|string

hasReportCategoryId

clearReportCategoryId

setReportCategoryId

Google product category ID to calculate the report for, represented in Google's product taxonomy.

Required in the SELECT clause. A condition on report_category_id is required in the WHERE clause.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getTrafficSource

Traffic source of impressions.

Required in the SELECT clause.

Returns
Type Description
int

hasTrafficSource

clearTrafficSource

setTrafficSource

Traffic source of impressions.

Required in the SELECT clause.

Parameter
Name Description
var int
Returns
Type Description
$this

getYourDomainVisibilityTrend

Change in visibility based on impressions for your domain with respect to the start of the selected time range (or first day with non-zero impressions).

Cannot be filtered on in the 'WHERE' clause.

Returns
Type Description
float

hasYourDomainVisibilityTrend

clearYourDomainVisibilityTrend

setYourDomainVisibilityTrend

Change in visibility based on impressions for your domain with respect to the start of the selected time range (or first day with non-zero impressions).

Cannot be filtered on in the 'WHERE' clause.

Parameter
Name Description
var float
Returns
Type Description
$this

getCategoryBenchmarkVisibilityTrend

Change in visibility based on impressions with respect to the start of the selected time range (or first day with non-zero impressions) for a combined set of merchants with highest visibility approximating the market.

Cannot be filtered on in the 'WHERE' clause.

Returns
Type Description
float

hasCategoryBenchmarkVisibilityTrend

clearCategoryBenchmarkVisibilityTrend

setCategoryBenchmarkVisibilityTrend

Change in visibility based on impressions with respect to the start of the selected time range (or first day with non-zero impressions) for a combined set of merchants with highest visibility approximating the market.

Cannot be filtered on in the 'WHERE' clause.

Parameter
Name Description
var float
Returns
Type Description
$this