Show navigation ≫
≪ Hide navigation
Structure > Source File

Definition

A Connected Web Source File is a JSON or JSONP encoded file which contains the information of the source of a Feed file. Hence it always requires to be linked from a Content List file.

This file is used to understand better which kind of contents does the source produce, in order to help Connected Web parsers to index and organize better information for end users.

File structure

Optional parameters are indicated as "(Optional)"

Parameter Meaning Notes
type (string) The type of file.
  • Must be source
cwversion (float) The version of the Connected Web format.
  • It helps a file parser to understand with which version of the Connected Web format should be this file parsed.
name (string) The name of the source.
  • Keep it shorter than 55 characters. If longer, some platforms will cut it.
description (string) (optional) The description of the source.
  • This value will help platforms to understand better which kind of contents is your source producing.
  • It's suggested to keep it shorter than 160 characters. If longer, some Connected Web parsers will cut it.
keywords (array) (optional) A list of keywords which identifies the source.
  • This value will help platforms to understand better which kind of contents is the source producing.
  • It's suggested to set no more than 5 tags, otherwise some Connected Web parsers will exclude the remaining ones.
url (string) (optional) The url of the homepage of the source.
  • Only public http or https urls are supported.
img (image_object) (optional) The logo / image of the source.
  • This parameter requires a Connected Web Image Object. See the Object > Image documentation to understand more.
Understand a Contents List file
Show navigation ≫
≪ Hide navigation