Datafeeds

For a list of methods for this resource, see the end of this page.

Resource representations

Datafeed configuration data.

JSON

{
  "kind": "content#datafeed",
  "id": long,
  "name": string,
  "contentType": string,
  "attributeLanguage": string,
  "targets": [
    {
      "country": string,
      "language": string,
      "includedDestinations": [
        string
      ],
      "excludedDestinations": [
        string
      ]
    }
  ],
  "contentLanguage": string,
  "intendedDestinations": [
    string
  ],
  "fileName": string,
  "fetchSchedule": {
    "paused": boolean,
    "dayOfMonth": unsigned integer,
    "minuteOfHour": unsigned integer,
    "weekday": string,
    "hour": unsigned integer,
    "timeZone": string,
    "fetchUrl": string,
    "username": string,
    "password": string
  },
  "format": {
    "fileEncoding": string,
    "columnDelimiter": string,
    "quotingMode": string
  },
  "targetCountry": string
}
Property name Value Description Notes
attributeLanguage string The two-letter ISO 639-1 language in which the attributes are defined in the data feed. writable
contentLanguage 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. writable
contentType string 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"
  • "product inventory update"
  • "products"
 writable
fetchSchedule nested object Fetch schedule for the feed file. writable
fetchSchedule.dayOfMonth unsigned integer The day of the month the feed file should be fetched (1-31). writable
fetchSchedule.fetchUrl string The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols. writable
fetchSchedule.hour unsigned integer The hour of the day the feed file should be fetched (0-23). writable
fetchSchedule.minuteOfHour unsigned integer The minute of the hour the feed file should be fetched (0-59). Read-only.
fetchSchedule.password string An optional password for fetch_url. writable
fetchSchedule.paused boolean Whether the scheduled fetch is paused or not. writable
fetchSchedule.timeZone string Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles". writable
fetchSchedule.username string An optional user name for fetch_url. writable
fetchSchedule.weekday string The day of the week the feed file should be fetched.

Acceptable values are:
  • "monday"
  • "tuesday"
  • "wednesday"
  • "thursday"
  • "friday"
  • "saturday"
  • "sunday"
 writable
fileName string The filename of the feed. All feeds must have a unique file name. writable
format nested object Format of the feed file. writable
format.columnDelimiter string Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds.

Acceptable values are:
  • "pipe"
  • "tab"
  • "tilde"
format.fileEncoding string Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.

Acceptable values are:
  • "latin-1": Latin-1 encoding (also known as ISO-8859-1).
  • "utf-16be": UTF-16 big endian encoding.
  • "utf-16le": UTF-16 little endian encoding.
  • "utf-8": UTF-8 encoding.
  • "windows-1252": Windows-1252 encoding.
format.quotingMode string Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.

Acceptable values are:
  • "normal character": Double quotes have no special meaning and are treated like regular characters.
  • "value quoting": Values starting with a double quote extend to the next double quote and may include row, column, group, and value delimiters. Double quotes can be included in a value by doubling them, i.e., two consecutive double quotes do not terminate a quoted value.
id long The ID of the data feed.
intendedDestinations[] list [DEPRECATED] Please use targets[].includedDestinations instead. The list of intended destinations (corresponds to checked check boxes in Merchant Center). writable
kind string Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
name string A descriptive name of the data feed. writable
targetCountry 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. writable
targets[] list The targets this feed should apply to (country, language, destinations). writable
targets[].country string The country where the items in the feed will be included in the search index, represented as a CLDR territory code. writable
targets[].excludedDestinations[] list The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center). writable
targets[].includedDestinations[] list The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in the excluded_destination field. writable
targets[].language string The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targets[].country. writable

XML

<datafeed>
  <id>
    long
  </id>
  <name>
    string
  </name>
  <content_type>
    string
  </content_type>
  <attribute_language>
    string
  </attribute_language>
  <targets>
    (foreach)
      <target>
        <country>
          string
        </country>
        <language>
          string
        </language>
        <included_destinations>
          (foreach)
            <included_destination>
              string
            </included_destination>
          (/foreach)
        </included_destinations>
        <excluded_destinations>
          (foreach)
            <excluded_destination>
              string
            </excluded_destination>
          (/foreach)
        </excluded_destinations>
      </target>
    (/foreach)
  </targets>
  <content_language>
    string
  </content_language>
  <intended_destinations>
    (foreach)
      <destination>
        string
      </destination>
    (/foreach)
  </intended_destinations>
  <file_name>
    string
  </file_name>
  <fetch_schedule>
    <paused>
      boolean
    </paused>
    <day_of_month>
      unsigned integer
    </day_of_month>
    <weekday>
      string
    </weekday>
    <hour>
      unsigned integer
    </hour>
    <time_zone>
      string
    </time_zone>
    <fetch_url>
      string
    </fetch_url>
    <username>
      string
    </username>
    <password>
      string
    </password>
  </fetch_schedule>
  <format>
    <file_encoding>
      string
    </file_encoding>
    <column_delimiter>
      string
    </column_delimiter>
    <quoting_mode>
      string
    </quoting_mode>
  </format>
  <target_country>
    string
  </target_country>
</datafeed>
Property name Value Description Notes
datafeed object Datafeed configuration data.
datafeed/attribute_language string The two-letter ISO 639-1 language in which the attributes are defined in the data feed. writable
datafeed/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. writable
datafeed/content_type string 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"
  • "product inventory update"
  • "products"
 writable
datafeed/fetch_schedule object Fetch schedule for the feed file. 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. writable
datafeed/fetch_schedule/day_of_month unsigned integer The day of the month the feed file should be fetched (1-31). writable
datafeed/fetch_schedule/fetch_url string The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols. writable
datafeed/fetch_schedule/hour unsigned integer The hour of the day the feed file should be fetched (0-23). writable
datafeed/fetch_schedule/password string An optional password for fetch_url. writable
datafeed/fetch_schedule/paused boolean Whether the scheduled fetch is paused or not. writable
datafeed/fetch_schedule/time_zone string Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles". writable
datafeed/fetch_schedule/username string An optional user name for fetch_url. writable
datafeed/fetch_schedule/weekday string The day of the week the feed file should be fetched.

Acceptable values are:
  • "monday"
  • "tuesday"
  • "wednesday"
  • "thursday"
  • "friday"
  • "saturday"
  • "sunday"
 writable
datafeed/file_name string The filename of the feed. All feeds must have a unique file name. writable
datafeed/format object Format of the feed file. writable
datafeed/format/column_delimiter string Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds. Possible delimiters in a DSV file.

Acceptable values are:
  • "pipe"
  • "tab"
  • "tilde"
datafeed/format/file_encoding string Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.

Acceptable values are:
  • "latin-1": Latin-1 encoding (also known as ISO-8859-1).
  • "utf-16be": UTF-16 big endian encoding.
  • "utf-16le": UTF-16 little endian encoding.
  • "utf-8": UTF-8 encoding.
  • "windows-1252": Windows-1252 encoding.
datafeed/format/quoting_mode string Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds. Possible quoting modes for processing a DSV file.

Acceptable values are:
  • "normal character": Double quotes have no special meaning and are treated like regular characters.
  • "value quoting": Values starting with a double quote extend to the next double quote and may include row, column, group, and value delimiters. Double quotes can be included in a value by doubling them, i.e., two consecutive double quotes do not terminate a quoted value.
datafeed/id long The ID of the data feed.
datafeed/intended_destinations object
datafeed/intended_destinations/destination string [DEPRECATED] Please use targets[].includedDestinations instead. The list of intended destinations (corresponds to checked check boxes in Merchant Center). writable
datafeed/name string A descriptive name of the data feed. writable
datafeed/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. writable
datafeed/targets object
datafeed/targets/target object The targets this feed should apply to (country, language, destinations). writable
datafeed/targets/target/country string The country where the items in the feed will be included in the search index, represented as a CLDR territory code. writable
datafeed/targets/target/excluded_destinations object
datafeed/targets/target/excluded_destinations/excluded_destination string The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center). writable
datafeed/targets/target/included_destinations object
datafeed/targets/target/included_destinations/included_destination string The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in the excluded_destination field. writable
datafeed/targets/target/language string The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targets[].country. writable

Methods

custombatch
Deletes, fetches, gets, inserts and updates multiple datafeeds in a single request.
delete
Deletes a datafeed configuration from your Merchant Center account.
fetchnow
Invokes a fetch for the datafeed in your Merchant Center account.
get
Retrieves a datafeed configuration from your Merchant Center account.
insert
Registers a datafeed configuration with your Merchant Center account.
list
Lists the configurations for datafeeds in your Merchant Center account.
patch
Updates a datafeed configuration of your Merchant Center account. This method supports patch semantics.
update
Updates a datafeed configuration of your Merchant Center account.

Send feedback about...

This page
Documentation feedback
Content API for Shopping
Product feedback