Class: Google::Shopping::Merchant::Reports::V1beta::ProductPerformanceView

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/shopping/merchant/reports/v1beta/reports.rb

Overview

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.

Instance Attribute Summary collapse

Instance Attribute Details

#brand ⇒ ::String

Returns Brand of the product. Segment.

Returns:

  • (::String) —

    Brand of the product. Segment.



241
242
243
244
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 241

class ProductPerformanceView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#category_l1 ⇒ ::String

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

Returns:



241
242
243
244
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 241

class ProductPerformanceView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#category_l2 ⇒ ::String

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

Returns:



241
242
243
244
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 241

class ProductPerformanceView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#category_l3 ⇒ ::String

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

Returns:



241
242
243
244
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 241

class ProductPerformanceView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#category_l4 ⇒ ::String

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

Returns:



241
242
243
244
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 241

class ProductPerformanceView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#category_l5 ⇒ ::String

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

Returns:



241
242
243
244
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 241

class ProductPerformanceView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#click_through_rate ⇒ ::Float

Returns 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:

  • (::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.



241
242
243
244
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 241

class ProductPerformanceView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#clicks ⇒ ::Integer

Returns Number of clicks. Metric.

Returns:

  • (::Integer) —

    Number of clicks. Metric.



241
242
243
244
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 241

class ProductPerformanceView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#conversion_rate ⇒ ::Float

Returns Number of conversions divided by the number of clicks, reported on the impression date. Metric.

Available only for the FREE traffic source.

Returns:

  • (::Float) —

    Number of conversions divided by the number of clicks, reported on the impression date. Metric.

    Available only for the FREE traffic source.



241
242
243
244
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 241

class ProductPerformanceView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#conversion_value ⇒ ::Google::Shopping::Type::Price

Returns Value of conversions attributed to the product, reported on the conversion date. Metric.

Available only for the FREE traffic source.

Returns:

  • (::Google::Shopping::Type::Price) —

    Value of conversions attributed to the product, reported on the conversion date. Metric.

    Available only for the FREE traffic source.



241
242
243
244
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 241

class ProductPerformanceView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#conversions ⇒ ::Float

Returns 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.

Returns:

  • (::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.



241
242
243
244
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 241

class ProductPerformanceView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#custom_label0 ⇒ ::String

Returns Custom label 0 for custom grouping of products. Segment.

Returns:

  • (::String) —

    Custom label 0 for custom grouping of products. Segment.



241
242
243
244
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 241

class ProductPerformanceView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#custom_label1 ⇒ ::String

Returns Custom label 1 for custom grouping of products. Segment.

Returns:

  • (::String) —

    Custom label 1 for custom grouping of products. Segment.



241
242
243
244
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 241

class ProductPerformanceView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#custom_label2 ⇒ ::String

Returns Custom label 2 for custom grouping of products. Segment.

Returns:

  • (::String) —

    Custom label 2 for custom grouping of products. Segment.



241
242
243
244
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 241

class ProductPerformanceView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#custom_label3 ⇒ ::String

Returns Custom label 3 for custom grouping of products. Segment.

Returns:

  • (::String) —

    Custom label 3 for custom grouping of products. Segment.



241
242
243
244
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 241

class ProductPerformanceView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#custom_label4 ⇒ ::String

Returns Custom label 4 for custom grouping of products. Segment.

Returns:

  • (::String) —

    Custom label 4 for custom grouping of products. Segment.



241
242
243
244
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 241

class ProductPerformanceView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#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.

Returns:

  • (::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.



241
242
243
244
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 241

class ProductPerformanceView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#date ⇒ ::Google::Type::Date

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

Condition on date is required in the WHERE clause.

Returns:

  • (::Google::Type::Date) —

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

    Condition on date is required in the WHERE clause.



241
242
243
244
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 241

class ProductPerformanceView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#impressions ⇒ ::Integer

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

Returns:

  • (::Integer) —

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



241
242
243
244
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 241

class ProductPerformanceView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#marketing_method ⇒ ::Google::Shopping::Merchant::Reports::V1beta::MarketingMethod::MarketingMethodEnum

Returns Marketing method to which metrics apply. Segment.

Returns:



241
242
243
244
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 241

class ProductPerformanceView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#offer_id ⇒ ::String

Returns Merchant-provided id of the product. Segment.

Returns:

  • (::String) —

    Merchant-provided id of the product. Segment.



241
242
243
244
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 241

class ProductPerformanceView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#product_type_l1 ⇒ ::String

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

Returns:



241
242
243
244
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 241

class ProductPerformanceView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#product_type_l2 ⇒ ::String

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

Returns:



241
242
243
244
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 241

class ProductPerformanceView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#product_type_l3 ⇒ ::String

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

Returns:



241
242
243
244
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 241

class ProductPerformanceView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#product_type_l4 ⇒ ::String

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

Returns:



241
242
243
244
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 241

class ProductPerformanceView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#product_type_l5 ⇒ ::String

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

Returns:



241
242
243
244
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 241

class ProductPerformanceView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#title ⇒ ::String

Returns Title of the product. Segment.

Returns:

  • (::String) —

    Title of the product. Segment.



241
242
243
244
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 241

class ProductPerformanceView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#week ⇒ ::Google::Type::Date

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

Returns:

  • (::Google::Type::Date) —

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



241
242
243
244
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 241

class ProductPerformanceView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end