Reference documentation and code samples for the Google Shopping Merchant Reports V1beta Client class CompetitiveVisibilityCompetitorView.
Fields available for query in competitive_visibility_competitor_view table.
Competitive visibility report with businesses with similar visibility. Values are only set for fields requested explicitly in the request's search query.
Generated from protobuf message google.shopping.merchant.reports.v1beta.CompetitiveVisibilityCompetitorView
Namespace
Google \ Shopping \ Merchant \ Reports \ V1betaMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ date |
Google\Type\Date
Date of this row. A condition on |
↳ domain |
string
Domain of your competitor or your domain, if 'is_your_domain' is true. Required in the |
↳ is_your_domain |
bool
True if this row contains data for your domain. Cannot be filtered on in the 'WHERE' clause. |
↳ report_country_code |
string
Country where impressions appeared. Required in the |
↳ report_category_id |
int|string
Google product category ID to calculate the report for, represented in Google's product taxonomy. Required in the |
↳ traffic_source |
int
Traffic source of impressions. Required in the |
↳ rank |
int|string
Position of the domain in the similar businesses ranking for the selected keys ( |
↳ ads_organic_ratio |
float
Ads / organic ratio shows how often the domain receives impressions from Shopping ads compared to organic traffic. The number is rounded and bucketed. Cannot be filtered on in the 'WHERE' clause. |
↳ page_overlap_rate |
float
Page overlap rate shows how frequently competing retailers’ offers are shown together with your offers on the same page. Cannot be filtered on in the 'WHERE' clause. |
↳ higher_position_rate |
float
Higher position rate shows how often a competitor’s offer got placed in a higher position on the page than your offer. Cannot be filtered on in the 'WHERE' clause. |
↳ relative_visibility |
float
Relative visibility shows how often your competitors’ offers are shown compared to your offers. In other words, this is the number of displayed impressions of a competitor retailer divided by the number of your displayed impressions during a selected time range for a selected product category and country. Cannot be filtered on in the 'WHERE' clause. |
getDate
Date of this row.
A condition on date is required in the WHERE clause.
| Returns | |
|---|---|
| Type | Description |
Google\Type\Date|null |
|
hasDate
clearDate
setDate
Date of this row.
A condition on date is required in the WHERE clause.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Type\Date
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDomain
Domain of your competitor or your domain, if 'is_your_domain' is true.
Required in the SELECT clause. Cannot be filtered on in the 'WHERE'
clause.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasDomain
clearDomain
setDomain
Domain of your competitor or your domain, if 'is_your_domain' is true.
Required in the SELECT clause. Cannot be filtered on in the 'WHERE'
clause.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIsYourDomain
True if this row contains data for your domain.
Cannot be filtered on in the 'WHERE' clause.
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasIsYourDomain
clearIsYourDomain
setIsYourDomain
True if this row contains data for your domain.
Cannot be filtered on in the 'WHERE' clause.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| 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 |
|
getRank
Position of the domain in the similar businesses ranking for the selected
keys (date, report_category_id, report_country_code,
traffic_source) based on impressions. 1 is the highest.
Cannot be filtered on in the 'WHERE' clause.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
hasRank
clearRank
setRank
Position of the domain in the similar businesses ranking for the selected
keys (date, report_category_id, report_country_code,
traffic_source) based on impressions. 1 is the highest.
Cannot be filtered on in the 'WHERE' clause.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAdsOrganicRatio
Ads / organic ratio shows how often the domain receives impressions from Shopping ads compared to organic traffic. The number is rounded and bucketed.
Cannot be filtered on in the 'WHERE' clause.
| Returns | |
|---|---|
| Type | Description |
float |
|
hasAdsOrganicRatio
clearAdsOrganicRatio
setAdsOrganicRatio
Ads / organic ratio shows how often the domain receives impressions from Shopping ads compared to organic traffic. The number is rounded and bucketed.
Cannot be filtered on in the 'WHERE' clause.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageOverlapRate
Page overlap rate shows how frequently competing retailers’ offers are shown together with your offers on the same page.
Cannot be filtered on in the 'WHERE' clause.
| Returns | |
|---|---|
| Type | Description |
float |
|
hasPageOverlapRate
clearPageOverlapRate
setPageOverlapRate
Page overlap rate shows how frequently competing retailers’ offers are shown together with your offers on the same page.
Cannot be filtered on in the 'WHERE' clause.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getHigherPositionRate
Higher position rate shows how often a competitor’s offer got placed in a higher position on the page than your offer.
Cannot be filtered on in the 'WHERE' clause.
| Returns | |
|---|---|
| Type | Description |
float |
|
hasHigherPositionRate
clearHigherPositionRate
setHigherPositionRate
Higher position rate shows how often a competitor’s offer got placed in a higher position on the page than your offer.
Cannot be filtered on in the 'WHERE' clause.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRelativeVisibility
Relative visibility shows how often your competitors’ offers are shown compared to your offers.
In other words, this is the number of displayed impressions of a competitor retailer divided by the number of your displayed impressions during a selected time range for a selected product category and country. Cannot be filtered on in the 'WHERE' clause.
| Returns | |
|---|---|
| Type | Description |
float |
|
hasRelativeVisibility
clearRelativeVisibility
setRelativeVisibility
Relative visibility shows how often your competitors’ offers are shown compared to your offers.
In other words, this is the number of displayed impressions of a competitor retailer divided by the number of your displayed impressions during a selected time range for a selected product category and country. Cannot be filtered on in the 'WHERE' clause.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this |
|