Reference documentation and code samples for the Google Shopping Merchant Reports V1beta Client class PriceCompetitivenessProductView.
Fields available for query in price_competitiveness_product_view table.
Price competitiveness report. Values are only set for fields requested explicitly in the request's search query.
Generated from protobuf message google.shopping.merchant.reports.v1beta.PriceCompetitivenessProductView
Namespace
Google \ Shopping \ Merchant \ Reports \ V1betaMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ report_country_code |
string
Country of the price benchmark. Represented in the ISO 3166 format. Required in the |
↳ id |
string
REST ID of the product, in the form of |
↳ offer_id |
string
Merchant-provided id of the product. |
↳ title |
string
Title of the product. |
↳ brand |
string
Brand of the product. |
↳ category_l1 |
string
Product category (1st level) in Google's product taxonomy. |
↳ category_l2 |
string
Product category (2nd level) in Google's product taxonomy. |
↳ category_l3 |
string
Product category (3rd level) in Google's product taxonomy. |
↳ category_l4 |
string
Product category (4th level) in Google's product taxonomy. |
↳ category_l5 |
string
Product category (5th level) in Google's product taxonomy. |
↳ product_type_l1 |
string
Product type (1st level) in merchant's own product taxonomy. |
↳ product_type_l2 |
string
Product type (2nd level) in merchant's own product taxonomy. |
↳ product_type_l3 |
string
Product type (3rd level) in merchant's own product taxonomy. |
↳ product_type_l4 |
string
Product type (4th level) in merchant's own product taxonomy. |
↳ product_type_l5 |
string
Product type (5th level) in merchant's own product taxonomy. |
↳ price |
Google\Shopping\Type\Price
Current price of the product. |
↳ benchmark_price |
Google\Shopping\Type\Price
Latest available price benchmark for the product's catalog in the benchmark country. |
getReportCountryCode
Country of the price benchmark. Represented in the ISO 3166 format.
Required in the SELECT clause.
| Returns | |
|---|---|
| Type | Description |
string | |
hasReportCountryCode
clearReportCountryCode
setReportCountryCode
Country of the price benchmark. Represented in the ISO 3166 format.
Required in the SELECT clause.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getId
REST ID of the product, in the form of
channel~languageCode~feedLabel~offerId. Can be used to join data with the
product_view table.
Required in the SELECT clause.
| Returns | |
|---|---|
| Type | Description |
string | |
hasId
clearId
setId
REST ID of the product, in the form of
channel~languageCode~feedLabel~offerId. Can be used to join data with the
product_view table.
Required in the SELECT clause.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getOfferId
Merchant-provided id of the product.
| Returns | |
|---|---|
| Type | Description |
string | |
hasOfferId
clearOfferId
setOfferId
Merchant-provided id of the product.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTitle
Title of the product.
| Returns | |
|---|---|
| Type | Description |
string | |
hasTitle
clearTitle
setTitle
Title of the product.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getBrand
Brand of the product.
| Returns | |
|---|---|
| Type | Description |
string | |
hasBrand
clearBrand
setBrand
Brand of the product.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCategoryL1
Product category (1st level) in Google's product taxonomy.
| Returns | |
|---|---|
| Type | Description |
string | |
hasCategoryL1
clearCategoryL1
setCategoryL1
Product category (1st level) in Google's product taxonomy.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCategoryL2
Product category (2nd level) in Google's product taxonomy.
| Returns | |
|---|---|
| Type | Description |
string | |
hasCategoryL2
clearCategoryL2
setCategoryL2
Product category (2nd level) in Google's product taxonomy.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCategoryL3
Product category (3rd level) in Google's product taxonomy.
| Returns | |
|---|---|
| Type | Description |
string | |
hasCategoryL3
clearCategoryL3
setCategoryL3
Product category (3rd level) in Google's product taxonomy.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCategoryL4
Product category (4th level) in Google's product taxonomy.
| Returns | |
|---|---|
| Type | Description |
string | |
hasCategoryL4
clearCategoryL4
setCategoryL4
Product category (4th level) in Google's product taxonomy.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCategoryL5
Product category (5th level) in Google's product taxonomy.
| Returns | |
|---|---|
| Type | Description |
string | |
hasCategoryL5
clearCategoryL5
setCategoryL5
Product category (5th level) in Google's product taxonomy.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getProductTypeL1
Product type (1st level) in merchant's own product taxonomy.
| Returns | |
|---|---|
| Type | Description |
string | |
hasProductTypeL1
clearProductTypeL1
setProductTypeL1
Product type (1st level) in merchant's own product taxonomy.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getProductTypeL2
Product type (2nd level) in merchant's own product taxonomy.
| Returns | |
|---|---|
| Type | Description |
string | |
hasProductTypeL2
clearProductTypeL2
setProductTypeL2
Product type (2nd level) in merchant's own product taxonomy.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getProductTypeL3
Product type (3rd level) in merchant's own product taxonomy.
| Returns | |
|---|---|
| Type | Description |
string | |
hasProductTypeL3
clearProductTypeL3
setProductTypeL3
Product type (3rd level) in merchant's own product taxonomy.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getProductTypeL4
Product type (4th level) in merchant's own product taxonomy.
| Returns | |
|---|---|
| Type | Description |
string | |
hasProductTypeL4
clearProductTypeL4
setProductTypeL4
Product type (4th level) in merchant's own product taxonomy.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getProductTypeL5
Product type (5th level) in merchant's own product taxonomy.
| Returns | |
|---|---|
| Type | Description |
string | |
hasProductTypeL5
clearProductTypeL5
setProductTypeL5
Product type (5th level) in merchant's own product taxonomy.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPrice
Current price of the product.
| Returns | |
|---|---|
| Type | Description |
Google\Shopping\Type\Price|null | |
hasPrice
clearPrice
setPrice
Current price of the product.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Shopping\Type\Price
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getBenchmarkPrice
Latest available price benchmark for the product's catalog in the benchmark country.
| Returns | |
|---|---|
| Type | Description |
Google\Shopping\Type\Price|null | |
hasBenchmarkPrice
clearBenchmarkPrice
setBenchmarkPrice
Latest available price benchmark for the product's catalog in the benchmark country.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Shopping\Type\Price
|
| Returns | |
|---|---|
| Type | Description |
$this | |