You are here

Home » API reference » Facebook Instant Articles 8.2

fb_instant_articles.schema.yml in Facebook Instant Articles 8.2

Same filename and directory in other branches
  1. 3.x config/schema/fb_instant_articles.schema.yml
config/schema/fb_instant_articles.schema.yml

File

config/schema/fb_instant_articles.schema.yml
View source 
  1. fb_instant_articles.settings:

  2.   type: config_object

  3.   mapping:

  4.     page_id:

  5.       type: string

  6.       label: 'Page ID'

  7.     page_name:

  8.       type: string

  9.       label: 'Page Name'

  10.     style:

  11.       type: string

  12.       label: 'Style'

  13.     ads:

  14.       type: mapping

  15.       label: 'Ads settings'

  16.       mapping:

  17.         type:

  18.           type: string

  19.           label: 'Ad type'

  20.         iframe_url:

  21.           type: uri

  22.           label: 'Ad source URL'

  23.         an_placement_id:

  24.           type: string

  25.           label: 'Audience network placement ID'

  26.         embed_code:

  27.           type: string

  28.           label: 'Ad embed code'

  29.         dimensions:

  30.           type: string

  31.           label: 'Ad dimensions'

  32.     analytics:

  33.       type: mapping

  34.       label: 'Analytics settings'

  35.       mapping:

  36.         embed_code:

  37.           type: string

  38.           label: 'Analytics embed code'

  39.     transformer_logging_level:

  40.       type: string

  41.       label: 'Transformer logging level'

  42.     canonical_url_override:

  43.       type: uri

  44.       label: 'Canonical URL override'

  45.     app_id:

  46.       type: string

  47.       label: 'App ID'

  48.     app_secret:

  49.       type: string

  50.       label: 'App secret'

  51.     access_token:

  52.       type: string

  53.       label: 'Access token'

  54.     page_access_token:

  55.       type: string

  56.       label: 'Page access token'

  57. 

  58. field.formatter.settings.fbia_ad:

  59.   type: mapping

  60.   label: 'Instant articles ad element formatter settings'

  61.   mapping:

  62.     source_type:

  63.       type: string

  64.       label: 'Source type'

  65.     width:

  66.       type: integer

  67.       label: 'Width'

  68.     height:

  69.       type: integer

  70.       label: 'Height'

  71. 

  72. field.formatter.settings.fbia_ad_link:

  73.   type: mapping

  74.   label: 'Instant articles ad element formatter settings'

  75.   mapping:

  76.     width:

  77.       type: integer

  78.       label: 'Width'

  79.     height:

  80.       type: integer

  81.       label: 'Height'

  82. 

  83. field.formatter.settings.fbia_analytics:

  84.   type: mapping

  85.   label: 'Instant articles analytics element formatter settings'

  86.   mapping:

  87.     source_type:

  88.       type: string

  89.       label: 'Source type'

  90. 

  91. field.formatter.settings.fbia_author_reference:

  92.   type: mapping

  93.   label: 'Instant articles author element formatter settings'

  94.   mapping:

  95.     link:

  96.       type: boolean

  97.       label: 'Link the author'

  98. 

  99. field.formatter.settings.fbia_image:

  100.   type: mapping

  101.   label: 'Instant articles image element formatter settings'

  102.   mapping:

  103.     image_style:

  104.       type: string

  105.       label: 'Image style'

  106.     caption:

  107.       type: boolean

  108.       label: 'Caption'

  109.     presentation:

  110.       type: string

  111.       label: 'Presentation'

  112. 

  113. field.formatter.settings.fbia_interactive:

  114.   type: mapping

  115.   label: 'Instant articles interactive element formatter settings'

  116.   mapping:

  117.     source_type:

  118.       type: string

  119.       label: 'Source type'

  120.     width:

  121.       type: integer

  122.       label: 'Width'

  123.     height:

  124.       type: integer

  125.       label: 'Height'

  126.     margin:

  127.       type: string

  128.       label: 'Margin'

  129. 

  130. field.formatter.settings.fbia_interactive_link:

  131.   type: mapping

  132.   label: 'Instant articles interactive element formatter settings'

  133.   mapping:

  134.     width:

  135.       type: integer

  136.       label: 'Width'

  137.     height:

  138.       type: integer

  139.       label: 'Height'

  140.     margin:

  141.       type: string

  142.       label: 'Margin'

  143. 

  144. field.formatter.settings.fbia_list:

  145.   type: mapping

  146.   label: 'Instant articles list element formatter settings'

  147.   mapping:

  148.     is_ordered:

  149.       type: boolean

  150.       label: 'Ordered list'

  151. 

  152. field.formatter.settings.fbia_video:

  153.   type: mapping

  154.   label: 'Instant articles video element formatter settings'

  155.   mapping:

  156.     presentation:

  157.       type: string

  158.       label: 'Presentation'

  159.     controls:

  160.       type: boolean

  161.       label: 'Controls'

  162.     autoplay:

  163.       type: boolean

  164.       label: 'Autoplay'

  165.     feed_cover:

  166.       type: boolean

  167.       label: 'Feed cover'

  168.     use_description_as_link_text:

  169.       type: boolean

  170.       label: 'Replace the file name by its description when available'

  171. 

  172. node.type.*.third_party.fb_instant_articles:

  173.   type: mapping

  174.   label: 'Facebook Instant Articles'

  175.   mapping:

  176.     fb_instant_articles_enabled:

  177.       type: boolean

  178.       label: 'Whether to enable Facebook Instant Articles for this content type'