Class: Google::Apis::ContentV2_1::Collection

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

Overview

The collection message.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Collection

Returns a new instance of Collection.



1923
1924
1925
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 1923

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

Instance Attribute Details

#custom_label0 ⇒ String

Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns. Custom label Corresponds to the JSON property customLabel0

Returns:

  • (String) 


1840
1841
1842
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 1840

def custom_label0
  @custom_label0
end

#custom_label1 ⇒ String

Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns. Corresponds to the JSON property customLabel1

Returns:

  • (String) 


1846
1847
1848
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 1846

def custom_label1
  @custom_label1
end

#custom_label2 ⇒ String

Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns. Corresponds to the JSON property customLabel2

Returns:

  • (String) 


1852
1853
1854
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 1852

def custom_label2
  @custom_label2
end

#custom_label3 ⇒ String

Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns. Corresponds to the JSON property customLabel3

Returns:

  • (String) 


1858
1859
1860
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 1858

def custom_label3
  @custom_label3
end

#custom_label4 ⇒ String

Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns. Corresponds to the JSON property customLabel4

Returns:

  • (String) 


1864
1865
1866
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 1864

def custom_label4
  @custom_label4
end

#featured_product ⇒ Array<Google::Apis::ContentV2_1::CollectionFeaturedProduct>

This identifies one or more products associated with the collection. Used as a lookup to the corresponding product ID in your product feeds. Provide a maximum of 100 featuredProduct (for collections). Provide up to 10 featuredProduct (for Shoppable Images only) with ID and X and Y coordinates. featured_product attribute Corresponds to the JSON property featuredProduct

Returns:



1874
1875
1876
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 1874

def featured_product
  @featured_product
end

#headline ⇒ Array<String>

Your collection's name. headline attribute Corresponds to the JSON property headline

Returns:

  • (Array<String>) 


1880
1881
1882
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 1880

def headline
  @headline
end

#id ⇒ String

Required. The REST ID of the collection. Content API methods that operate on collections take this as their collectionId parameter. The REST ID for a collection is of the form collectionId. id attribute Corresponds to the JSON property id

Returns:

  • (String) 


1888
1889
1890
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 1888

def id
  @id
end

#image_link ⇒ Array<String>

The URL of a collection’s image. image_link attribute Corresponds to the JSON property imageLink

Returns:

  • (Array<String>) 


1894
1895
1896
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 1894

def image_link
  @image_link
end

#language ⇒ String

The language of a collection and the language of any featured products linked to the collection. language attribute Corresponds to the JSON property language

Returns:

  • (String) 


1901
1902
1903
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 1901

def language
  @language
end

#link ⇒ String

A collection’s landing page. URL directly linking to your collection's page on your website. link attribute Corresponds to the JSON property link

Returns:

  • (String) 


1908
1909
1910
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 1908

def link
  @link
end

#mobile_link ⇒ String

A collection’s mobile-optimized landing page when you have a different URL for mobile and desktop traffic. mobile_link attribute Corresponds to the JSON property mobileLink

Returns:

  • (String) 


1915
1916
1917
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 1915

def mobile_link
  @mobile_link
end

#product_country ⇒ String

product_country attribute Corresponds to the JSON property productCountry

Returns:

  • (String) 


1921
1922
1923
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 1921

def product_country
  @product_country
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 1928

def update!(**args)
  @custom_label0 = args[:custom_label0] if args.key?(:custom_label0)
  @custom_label1 = args[:custom_label1] if args.key?(:custom_label1)
  @custom_label2 = args[:custom_label2] if args.key?(:custom_label2)
  @custom_label3 = args[:custom_label3] if args.key?(:custom_label3)
  @custom_label4 = args[:custom_label4] if args.key?(:custom_label4)
  @featured_product = args[:featured_product] if args.key?(:featured_product)
  @headline = args[:headline] if args.key?(:headline)
  @id = args[:id] if args.key?(:id)
  @image_link = args[:image_link] if args.key?(:image_link)
  @language = args[:language] if args.key?(:language)
  @link = args[:link] if args.key?(:link)
  @mobile_link = args[:mobile_link] if args.key?(:mobile_link)
  @product_country = args[:product_country] if args.key?(:product_country)
end