Class: Google::Apis::MerchantapiReportsV1beta::ProductView

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/merchantapi_reports_v1beta/classes.rb,
lib/google/apis/merchantapi_reports_v1beta/representations.rb,
lib/google/apis/merchantapi_reports_v1beta/representations.rb

Overview

Fields available for query in product_view table. Products in the current inventory. Products in this table are the same as in Products sub-API but not all product attributes from Products sub-API are available for query in this table. In contrast to Products sub-API, this table allows to filter the returned list of products by product attributes. To retrieve a single product by id or list all products, Products sub-API should be used. Values are only set for fields requested explicitly in the request's search query.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ProductView

Returns a new instance of ProductView.



1613
1614
1615
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 1613

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#aggregated_reporting_context_status ⇒ String

Aggregated status. Corresponds to the JSON property aggregatedReportingContextStatus

Returns:

  • (String) 


1437
1438
1439
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 1437

def aggregated_reporting_context_status
  @aggregated_reporting_context_status
end

#availability ⇒ String

Availability of the product. Corresponds to the JSON property availability

Returns:

  • (String) 


1443
1444
1445
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 1443

def availability
  @availability
end

#brand ⇒ String

Brand of the product. Corresponds to the JSON property brand

Returns:

  • (String) 


1448
1449
1450
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 1448

def brand
  @brand
end

#category_l1 ⇒ String

Product category (1st level) in Google's product taxonomy. Corresponds to the JSON property categoryL1

Returns:

  • (String) 


1454
1455
1456
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 1454

def category_l1
  @category_l1
end

#category_l2 ⇒ String

Product category (2nd level) in Google's product taxonomy. Corresponds to the JSON property categoryL2

Returns:

  • (String) 


1460
1461
1462
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 1460

def category_l2
  @category_l2
end

#category_l3 ⇒ String

Product category (3rd level) in Google's product taxonomy. Corresponds to the JSON property categoryL3

Returns:

  • (String) 


1466
1467
1468
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 1466

def category_l3
  @category_l3
end

#category_l4 ⇒ String

Product category (4th level) in Google's product taxonomy. Corresponds to the JSON property categoryL4

Returns:

  • (String) 


1472
1473
1474
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 1472

def category_l4
  @category_l4
end

#category_l5 ⇒ String

Product category (5th level) in Google's product taxonomy. Corresponds to the JSON property categoryL5

Returns:

  • (String) 


1478
1479
1480
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 1478

def category_l5
  @category_l5
end

#channel ⇒ String

Channel of the product. Can be ONLINE or LOCAL. Corresponds to the JSON property channel

Returns:

  • (String) 


1483
1484
1485
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 1483

def channel
  @channel
end

#click_potential ⇒ String

Estimated performance potential compared to highest performing products of the merchant. Corresponds to the JSON property clickPotential

Returns:

  • (String) 


1489
1490
1491
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 1489

def click_potential
  @click_potential
end

#click_potential_rank ⇒ Fixnum

Rank of the product based on its click potential. A product with click_potential_rank 1 has the highest click potential among the merchant's products that fulfill the search query conditions. Corresponds to the JSON property clickPotentialRank

Returns:

  • (Fixnum) 


1496
1497
1498
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 1496

def click_potential_rank
  @click_potential_rank
end

#condition ⇒ String

Condition of the product. Corresponds to the JSON property condition

Returns:

  • (String) 


1502
1503
1504
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 1502

def condition
  @condition
end

#creation_time ⇒ String

The time the merchant created the product in timestamp seconds. Corresponds to the JSON property creationTime

Returns:

  • (String) 


1507
1508
1509
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 1507

def creation_time
  @creation_time
end

#expiration_date ⇒ Google::Apis::MerchantapiReportsV1beta::Date

Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type. TimeOfDay * google.type.DateTime * google.protobuf.Timestamp Corresponds to the JSON property expirationDate

Returns:



1519
1520
1521
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 1519

def expiration_date
  @expiration_date
end

#feed_label ⇒ String

Feed label of the product. Corresponds to the JSON property feedLabel

Returns:

  • (String) 


1524
1525
1526
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 1524

def feed_label
  @feed_label
end

#gtin ⇒ Array<String>

List of Global Trade Item Numbers (GTINs) of the product. Corresponds to the JSON property gtin

Returns:

  • (Array<String>) 


1529
1530
1531
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 1529

def gtin
  @gtin
end

#id ⇒ String

REST ID of the product, in the form of channel~languageCode~feedLabel~offerId . Merchant API methods that operate on products take this as their name parameter. Required in the SELECT clause. Corresponds to the JSON property id

Returns:

  • (String) 


1536
1537
1538
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 1536

def id
  @id
end

#item_group_id ⇒ String

Item group id provided by the merchant for grouping variants together. Corresponds to the JSON property itemGroupId

Returns:

  • (String) 


1541
1542
1543
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 1541

def item_group_id
  @item_group_id
end

#item_issues ⇒ Array<Google::Apis::MerchantapiReportsV1beta::ItemIssue>

List of item issues for the product. This field cannot be used for sorting the results. Only selected attributes of this field (for example, item_issues.severity.aggregated_severity) can be used for filtering the results. Corresponds to the JSON property itemIssues

Returns:



1549
1550
1551
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 1549

def item_issues
  @item_issues
end

#language_code ⇒ String

Language code of the product in BCP 47 format. Corresponds to the JSON property languageCode

Returns:

  • (String) 


1554
1555
1556
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 1554

def language_code
  @language_code
end

#offer_id ⇒ String

Merchant-provided id of the product. Corresponds to the JSON property offerId

Returns:

  • (String) 


1559
1560
1561
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 1559

def offer_id
  @offer_id
end

#price ⇒ Google::Apis::MerchantapiReportsV1beta::Price

The price represented as a number and currency. Corresponds to the JSON property price

Returns:



1564
1565
1566
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 1564

def price
  @price
end

#product_type_l1 ⇒ String

Product type (1st level) in merchant's own product taxonomy. Corresponds to the JSON property productTypeL1

Returns:

  • (String) 


1570
1571
1572
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 1570

def product_type_l1
  @product_type_l1
end

#product_type_l2 ⇒ String

Product type (2nd level) in merchant's own product taxonomy. Corresponds to the JSON property productTypeL2

Returns:

  • (String) 


1576
1577
1578
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 1576

def product_type_l2
  @product_type_l2
end

#product_type_l3 ⇒ String

Product type (3rd level) in merchant's own product taxonomy. Corresponds to the JSON property productTypeL3

Returns:

  • (String) 


1582
1583
1584
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 1582

def product_type_l3
  @product_type_l3
end

#product_type_l4 ⇒ String

Product type (4th level) in merchant's own product taxonomy. Corresponds to the JSON property productTypeL4

Returns:

  • (String) 


1588
1589
1590
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 1588

def product_type_l4
  @product_type_l4
end

#product_type_l5 ⇒ String

Product type (5th level) in merchant's own product taxonomy. Corresponds to the JSON property productTypeL5

Returns:

  • (String) 


1594
1595
1596
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 1594

def product_type_l5
  @product_type_l5
end

#shipping_label ⇒ String

Normalized shipping label specified in the data source. Corresponds to the JSON property shippingLabel

Returns:

  • (String) 


1600
1601
1602
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 1600

def shipping_label
  @shipping_label
end

#thumbnail_link ⇒ String

Link to the processed image of the product, hosted on the Google infrastructure. Corresponds to the JSON property thumbnailLink

Returns:

  • (String) 


1606
1607
1608
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 1606

def thumbnail_link
  @thumbnail_link
end

#title ⇒ String

Title of the product. Corresponds to the JSON property title

Returns:

  • (String) 


1611
1612
1613
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 1611

def title
  @title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 1618

def update!(**args)
  @aggregated_reporting_context_status = args[:aggregated_reporting_context_status] if args.key?(:aggregated_reporting_context_status)
  @availability = args[:availability] if args.key?(:availability)
  @brand = args[:brand] if args.key?(:brand)
  @category_l1 = args[:category_l1] if args.key?(:category_l1)
  @category_l2 = args[:category_l2] if args.key?(:category_l2)
  @category_l3 = args[:category_l3] if args.key?(:category_l3)
  @category_l4 = args[:category_l4] if args.key?(:category_l4)
  @category_l5 = args[:category_l5] if args.key?(:category_l5)
  @channel = args[:channel] if args.key?(:channel)
  @click_potential = args[:click_potential] if args.key?(:click_potential)
  @click_potential_rank = args[:click_potential_rank] if args.key?(:click_potential_rank)
  @condition = args[:condition] if args.key?(:condition)
  @creation_time = args[:creation_time] if args.key?(:creation_time)
  @expiration_date = args[:expiration_date] if args.key?(:expiration_date)
  @feed_label = args[:feed_label] if args.key?(:feed_label)
  @gtin = args[:gtin] if args.key?(:gtin)
  @id = args[:id] if args.key?(:id)
  @item_group_id = args[:item_group_id] if args.key?(:item_group_id)
  @item_issues = args[:item_issues] if args.key?(:item_issues)
  @language_code = args[:language_code] if args.key?(:language_code)
  @offer_id = args[:offer_id] if args.key?(:offer_id)
  @price = args[:price] if args.key?(:price)
  @product_type_l1 = args[:product_type_l1] if args.key?(:product_type_l1)
  @product_type_l2 = args[:product_type_l2] if args.key?(:product_type_l2)
  @product_type_l3 = args[:product_type_l3] if args.key?(:product_type_l3)
  @product_type_l4 = args[:product_type_l4] if args.key?(:product_type_l4)
  @product_type_l5 = args[:product_type_l5] if args.key?(:product_type_l5)
  @shipping_label = args[:shipping_label] if args.key?(:shipping_label)
  @thumbnail_link = args[:thumbnail_link] if args.key?(:thumbnail_link)
  @title = args[:title] if args.key?(:title)
end