Google Shopping Merchant Reports V1beta Client - Class ProductPerformanceView (0.5.0)

Reference documentation and code samples for the Google Shopping Merchant Reports V1beta Client class ProductPerformanceView.

Fields available for query in product_performance_view table.

Product performance data for your account, including performance metrics (for example, clicks) and dimensions according to which performance metrics are segmented (for example, offer_id). Values of product dimensions, such as offer_id, reflect the state of a product at the time of the impression. Segment fields cannot be selected in queries without also selecting at least one metric field. Values are only set for fields requested explicitly in the request's search query.

Generated from protobuf message google.shopping.merchant.reports.v1beta.ProductPerformanceView

Namespace

Google \ Shopping \ Merchant \ Reports \ V1beta

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ marketing_method`	`int` Marketing method to which metrics apply. Segment.
`↳ date`	`Google\Type\Date` Date in the merchant timezone to which metrics apply. Segment. Condition on `date` is required in the `WHERE` clause.
`↳ week`	`Google\Type\Date` First day of the week (Monday) of the metrics date in the merchant timezone. Segment.
`↳ customer_country_code`	`string` Code of the country where the customer is located at the time of the event. Represented in the ISO 3166 format. Segment. If the customer country cannot be determined, a special 'ZZ' code is returned.
`↳ offer_id`	`string` Merchant-provided id of the product. Segment.
`↳ title`	`string` Title of the product. Segment.
`↳ brand`	`string` Brand of the product. Segment.
`↳ category_l1`	`string` Product category (1st level) in Google's product taxonomy. Segment.
`↳ category_l2`	`string` Product category (2nd level) in Google's product taxonomy. Segment.
`↳ category_l3`	`string` Product category (3rd level) in Google's product taxonomy. Segment.
`↳ category_l4`	`string` Product category (4th level) in Google's product taxonomy. Segment.
`↳ category_l5`	`string` Product category (5th level) in Google's product taxonomy. Segment.
`↳ product_type_l1`	`string` Product type (1st level) in merchant's own product taxonomy. Segment.
`↳ product_type_l2`	`string` Product type (2nd level) in merchant's own product taxonomy. Segment.
`↳ product_type_l3`	`string` Product type (3rd level) in merchant's own product taxonomy. Segment.
`↳ product_type_l4`	`string` Product type (4th level) in merchant's own product taxonomy. Segment.
`↳ product_type_l5`	`string` Product type (5th level) in merchant's own product taxonomy. Segment.
`↳ custom_label0`	`string` Custom label 0 for custom grouping of products. Segment.
`↳ custom_label1`	`string` Custom label 1 for custom grouping of products. Segment.
`↳ custom_label2`	`string` Custom label 2 for custom grouping of products. Segment.
`↳ custom_label3`	`string` Custom label 3 for custom grouping of products. Segment.
`↳ custom_label4`	`string` Custom label 4 for custom grouping of products. Segment.
`↳ clicks`	`int\|string` Number of clicks. Metric.
`↳ impressions`	`int\|string` Number of times merchant's products are shown. Metric.
`↳ click_through_rate`	`float` Click-through rate - the number of clicks merchant's products receive (clicks) divided by the number of times the products are shown (impressions). Metric.
`↳ conversions`	`float` Number of conversions attributed to the product, reported on the conversion date. Depending on the attribution model, a conversion might be distributed across multiple clicks, where each click gets its own credit assigned. This metric is a sum of all such credits. Metric. Available only for the `FREE` traffic source.
`↳ conversion_value`	`Google\Shopping\Type\Price` Value of conversions attributed to the product, reported on the conversion date. Metric. Available only for the `FREE` traffic source.
`↳ conversion_rate`	`float` Number of conversions divided by the number of clicks, reported on the impression date. Metric. Available only for the `FREE` traffic source.

getMarketingMethod

Marketing method to which metrics apply. Segment.

Returns
Type	Description
`int`

hasMarketingMethod

clearMarketingMethod

setMarketingMethod

Marketing method to which metrics apply. Segment.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getDate

Date in the merchant timezone to which metrics apply. Segment.

Condition on date is required in the WHERE clause.

Returns
Type	Description
`Google\Type\Date\|null`

hasDate

clearDate

setDate

Date in the merchant timezone to which metrics apply. Segment.

Condition on date is required in the WHERE clause.

Parameter
Name	Description
`var`	`Google\Type\Date`

Returns
Type	Description
`$this`

getWeek

First day of the week (Monday) of the metrics date in the merchant timezone. Segment.

Returns
Type	Description
`Google\Type\Date\|null`

hasWeek

clearWeek

setWeek

First day of the week (Monday) of the metrics date in the merchant timezone. Segment.

Parameter
Name	Description
`var`	`Google\Type\Date`

Returns
Type	Description
`$this`

getCustomerCountryCode

Code of the country where the customer is located at the time of the event.

Represented in the ISO 3166 format. Segment. If the customer country cannot be determined, a special 'ZZ' code is returned.

Returns
Type	Description
`string`

hasCustomerCountryCode

clearCustomerCountryCode

setCustomerCountryCode

Code of the country where the customer is located at the time of the event.

Represented in the ISO 3166 format. Segment. If the customer country cannot be determined, a special 'ZZ' code is returned.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getOfferId

Merchant-provided id of the product. Segment.

Returns
Type	Description
`string`

hasOfferId

clearOfferId

setOfferId

Merchant-provided id of the product. Segment.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getTitle

Title of the product. Segment.

Returns
Type	Description
`string`

hasTitle

clearTitle

setTitle

Title of the product. Segment.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getBrand

Brand of the product. Segment.

Returns
Type	Description
`string`

hasBrand

clearBrand

setBrand

Brand of the product. Segment.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCategoryL1

Product category (1st level) in Google's product taxonomy. Segment.

Returns
Type	Description
`string`

hasCategoryL1

clearCategoryL1

setCategoryL1

Product category (1st level) in Google's product taxonomy. Segment.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCategoryL2

Product category (2nd level) in Google's product taxonomy. Segment.

Returns
Type	Description
`string`

hasCategoryL2

clearCategoryL2

setCategoryL2

Product category (2nd level) in Google's product taxonomy. Segment.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCategoryL3

Product category (3rd level) in Google's product taxonomy. Segment.

Returns
Type	Description
`string`

hasCategoryL3

clearCategoryL3

setCategoryL3

Product category (3rd level) in Google's product taxonomy. Segment.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCategoryL4

Product category (4th level) in Google's product taxonomy. Segment.

Returns
Type	Description
`string`

hasCategoryL4

clearCategoryL4

setCategoryL4

Product category (4th level) in Google's product taxonomy. Segment.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCategoryL5

Product category (5th level) in Google's product taxonomy. Segment.

Returns
Type	Description
`string`

hasCategoryL5

clearCategoryL5

setCategoryL5

Product category (5th level) in Google's product taxonomy. Segment.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getProductTypeL1

Product type (1st level) in merchant's own product taxonomy. Segment.

Returns
Type	Description
`string`

hasProductTypeL1

clearProductTypeL1

setProductTypeL1

Product type (1st level) in merchant's own product taxonomy. Segment.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getProductTypeL2

Product type (2nd level) in merchant's own product taxonomy. Segment.

Returns
Type	Description
`string`

hasProductTypeL2

clearProductTypeL2

setProductTypeL2

Product type (2nd level) in merchant's own product taxonomy. Segment.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getProductTypeL3

Product type (3rd level) in merchant's own product taxonomy. Segment.

Returns
Type	Description
`string`

hasProductTypeL3

clearProductTypeL3

setProductTypeL3

Product type (3rd level) in merchant's own product taxonomy. Segment.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getProductTypeL4

Product type (4th level) in merchant's own product taxonomy. Segment.

Returns
Type	Description
`string`

hasProductTypeL4

clearProductTypeL4

setProductTypeL4

Product type (4th level) in merchant's own product taxonomy. Segment.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getProductTypeL5

Product type (5th level) in merchant's own product taxonomy. Segment.

Returns
Type	Description
`string`

hasProductTypeL5

clearProductTypeL5

setProductTypeL5

Product type (5th level) in merchant's own product taxonomy. Segment.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCustomLabel0

Custom label 0 for custom grouping of products. Segment.

Returns
Type	Description
`string`

hasCustomLabel0

clearCustomLabel0

setCustomLabel0

Custom label 0 for custom grouping of products. Segment.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCustomLabel1

Custom label 1 for custom grouping of products. Segment.

Returns
Type	Description
`string`

hasCustomLabel1

clearCustomLabel1

setCustomLabel1

Custom label 1 for custom grouping of products. Segment.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCustomLabel2

Custom label 2 for custom grouping of products. Segment.

Returns
Type	Description
`string`

hasCustomLabel2

clearCustomLabel2

setCustomLabel2

Custom label 2 for custom grouping of products. Segment.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCustomLabel3

Custom label 3 for custom grouping of products. Segment.

Returns
Type	Description
`string`

hasCustomLabel3

clearCustomLabel3

setCustomLabel3

Custom label 3 for custom grouping of products. Segment.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCustomLabel4

Custom label 4 for custom grouping of products. Segment.

Returns
Type	Description
`string`

hasCustomLabel4

clearCustomLabel4

setCustomLabel4

Custom label 4 for custom grouping of products. Segment.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getClicks

Number of clicks. Metric.

Returns
Type	Description
`int\|string`

hasClicks

clearClicks

setClicks

Number of clicks. Metric.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getImpressions

Number of times merchant's products are shown. Metric.

Returns
Type	Description
`int\|string`

hasImpressions

clearImpressions

setImpressions

Number of times merchant's products are shown. Metric.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getClickThroughRate

Click-through rate - the number of clicks merchant's products receive (clicks) divided by the number of times the products are shown (impressions). Metric.

Returns
Type	Description
`float`

hasClickThroughRate

clearClickThroughRate

setClickThroughRate

Click-through rate - the number of clicks merchant's products receive (clicks) divided by the number of times the products are shown (impressions). Metric.

Parameter
Name	Description
`var`	`float`

Returns
Type	Description
`$this`

getConversions

Number of conversions attributed to the product, reported on the conversion date. Depending on the attribution model, a conversion might be distributed across multiple clicks, where each click gets its own credit assigned. This metric is a sum of all such credits. Metric.