You are here

Home » API reference » Facebook Instant Articles 3.x

fb_instant_articles.schema.yml in Facebook Instant Articles 3.x

Same filename and directory in other branches
  1. 8.2 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_entity_reference_entity_view:

  100.   type: mapping

  101.   label: 'Instant articles rendered entity element formatter settings'

  102.   mapping:

  103.     view_mode:

  104.       type: string

  105.       label: 'View mode'

  106. 

  107. field.formatter.settings.fbia_image:

  108.   type: mapping

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

  110.   mapping:

  111.     image_style:

  112.       type: string

  113.       label: 'Image style'

  114.     caption:

  115.       type: boolean

  116.       label: 'Caption'

  117.     presentation:

  118.       type: string

  119.       label: 'Presentation'

  120. 

  121. field.formatter.settings.fbia_interactive:

  122.   type: mapping

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

  124.   mapping:

  125.     source_type:

  126.       type: string

  127.       label: 'Source type'

  128.     width:

  129.       type: integer

  130.       label: 'Width'

  131.     height:

  132.       type: integer

  133.       label: 'Height'

  134.     margin:

  135.       type: string

  136.       label: 'Margin'

  137. 

  138. field.formatter.settings.fbia_interactive_link:

  139.   type: mapping

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

  141.   mapping:

  142.     width:

  143.       type: integer

  144.       label: 'Width'

  145.     height:

  146.       type: integer

  147.       label: 'Height'

  148.     margin:

  149.       type: string

  150.       label: 'Margin'

  151. 

  152. field.formatter.settings.fbia_list:

  153.   type: mapping

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

  155.   mapping:

  156.     is_ordered:

  157.       type: boolean

  158.       label: 'Ordered list'

  159. 

  160. field.formatter.settings.fbia_video:

  161.   type: mapping

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

  163.   mapping:

  164.     presentation:

  165.       type: string

  166.       label: 'Presentation'

  167.     controls:

  168.       type: boolean

  169.       label: 'Controls'

  170.     autoplay:

  171.       type: boolean

  172.       label: 'Autoplay'

  173.     feed_cover:

  174.       type: boolean

  175.       label: 'Feed cover'

  176.     use_description_as_link_text:

  177.       type: boolean

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

  179. 

  180. node.type.*.third_party.fb_instant_articles:

  181.   type: mapping

  182.   label: 'Facebook Instant Articles'

  183.   mapping:

  184.     fb_instant_articles_enabled:

  185.       type: boolean

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