Class: Google::Apis::ContentV2::Datafeed

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

Overview

Datafeed configuration data.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Datafeed

Returns a new instance of Datafeed.



1845
1846
1847
 
# File 'lib/google/apis/content_v2/classes.rb', line 1845

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

Instance Attribute Details

#attribute_language ⇒ String

The two-letter ISO 639-1 language in which the attributes are defined in the data feed. Corresponds to the JSON property attributeLanguage

Returns:

  • (String) 


1777
1778
1779
 
# File 'lib/google/apis/content_v2/classes.rb', line 1777

def attribute_language
  @attribute_language
end

#content_language ⇒ String

[DEPRECATED] Please use targets[].language instead. The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targetCountry . Corresponds to the JSON property contentLanguage

Returns:

  • (String) 


1784
1785
1786
 
# File 'lib/google/apis/content_v2/classes.rb', line 1784

def content_language
  @content_language
end

#content_type ⇒ String

Required. The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported. Acceptable values are: - " local products" - "product inventory" - "products" Corresponds to the JSON property contentType

Returns:

  • (String) 


1791
1792
1793
 
# File 'lib/google/apis/content_v2/classes.rb', line 1791

def content_type
  @content_type
end

#fetch_schedule ⇒ Google::Apis::ContentV2::DatafeedFetchSchedule

The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required. Corresponds to the JSON property fetchSchedule

Returns:



1799
1800
1801
 
# File 'lib/google/apis/content_v2/classes.rb', line 1799

def fetch_schedule
  @fetch_schedule
end

#file_name ⇒ String

Required. The filename of the feed. All feeds must have a unique file name. Corresponds to the JSON property fileName

Returns:

  • (String) 


1804
1805
1806
 
# File 'lib/google/apis/content_v2/classes.rb', line 1804

def file_name
  @file_name
end

#format ⇒ Google::Apis::ContentV2::DatafeedFormat

Format of the feed file. Corresponds to the JSON property format

Returns:



1809
1810
1811
 
# File 'lib/google/apis/content_v2/classes.rb', line 1809

def format
  @format
end

#id ⇒ Fixnum

Required for update. The ID of the data feed. Corresponds to the JSON property id

Returns:

  • (Fixnum) 


1814
1815
1816
 
# File 'lib/google/apis/content_v2/classes.rb', line 1814

def id
  @id
end

#intended_destinations ⇒ Array<String>

[DEPRECATED] Please use targets[].includedDestinations instead. The list of intended destinations (corresponds to checked check boxes in Merchant Center). Corresponds to the JSON property intendedDestinations

Returns:

  • (Array<String>) 


1820
1821
1822
 
# File 'lib/google/apis/content_v2/classes.rb', line 1820

def intended_destinations
  @intended_destinations
end

#kind ⇒ String

Identifies what kind of resource this is. Value: the fixed string "content# datafeed" Corresponds to the JSON property kind

Returns:

  • (String) 


1826
1827
1828
 
# File 'lib/google/apis/content_v2/classes.rb', line 1826

def kind
  @kind
end

#name ⇒ String

Required for insert. A descriptive name of the data feed. Corresponds to the JSON property name

Returns:

  • (String) 


1831
1832
1833
 
# File 'lib/google/apis/content_v2/classes.rb', line 1831

def name
  @name
end

#target_country ⇒ String

[DEPRECATED] Please use targets[].country instead. The country where the items in the feed will be included in the search index, represented as a CLDR territory code. Corresponds to the JSON property targetCountry

Returns:

  • (String) 


1838
1839
1840
 
# File 'lib/google/apis/content_v2/classes.rb', line 1838

def target_country
  @target_country
end

#targets ⇒ Array<Google::Apis::ContentV2::DatafeedTarget>

The targets this feed should apply to (country, language, destinations). Corresponds to the JSON property targets

Returns:



1843
1844
1845
 
# File 'lib/google/apis/content_v2/classes.rb', line 1843

def targets
  @targets
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
 
# File 'lib/google/apis/content_v2/classes.rb', line 1850

def update!(**args)
  @attribute_language = args[:attribute_language] if args.key?(:attribute_language)
  @content_language = args[:content_language] if args.key?(:content_language)
  @content_type = args[:content_type] if args.key?(:content_type)
  @fetch_schedule = args[:fetch_schedule] if args.key?(:fetch_schedule)
  @file_name = args[:file_name] if args.key?(:file_name)
  @format = args[:format] if args.key?(:format)
  @id = args[:id] if args.key?(:id)
  @intended_destinations = args[:intended_destinations] if args.key?(:intended_destinations)
  @kind = args[:kind] if args.key?(:kind)
  @name = args[:name] if args.key?(:name)
  @target_country = args[:target_country] if args.key?(:target_country)
  @targets = args[:targets] if args.key?(:targets)
end