Schema App Integrations

Modified on Wed, 22 Mar 2023 at 05:17 PM

Schema App has never encountered a website we couldn’t optimize

Introduction

Schema App is capable of integrating with any website. Read on to learn more about our integration options, and access resources to support selection, installation, and troubleshooting.

TABLE OF CONTENTS

Technical Design
CMS-Specific Integrations (Plugins)
JavaScript
- Option 1. JavaScript Directly on Page
- Option 2. JavaScript via Tag Managers
Selecting an Integration Method
- JavaScript Integration Considerations
Integrating with Multiple Sites

Technical Design

Once integrated, any Schema Markup authored using the Schema App Editor, Schema App Highlighter, or Merchant Center is saved to the Schema Markup Graph Database. From here, the JSON-LD can be exported and reused, or deployed to any website through our Schema Delivery Network by way of one of our integration methods.

Authoring Tools

Each authoring tool has different integration requirements. For more information, see our article: Schema App Integrations - By Authoring Tool.

CMS-Specific Integrations (Plugins)

If available, we recommend using a CMS-specific integration to deploy your Schema App markup. Not only do these plugins allow the Schema Markup to reside server side (faster load time) but they can also be read by all search engines.

As an added bonus, some of our plugins automatically generate Schema Markup to your website for specific classes and properties. If you'd like to add to or modify the auto-generated plugin markup, you can pair it up with the Schema App Editor and Highlighter.

Schema App currently offers the following CMS-Specific Integrations:

(** Works with Editor & Highlighter with a valid subscription)

For more information, see our article on Schema App Plugins.

JavaScript

JavaScript is the most common way of integrating Schema App's authoring tools with any CMS or website. Once the scripts are added, the JavaScript library asynchronously runs on page load, generating and rendering the markup. This method adds some overhead to the pages.

For more information see our Schema App JavaScript Page Impact Overview article.

Option 1. JavaScript Directly on Page

The JavaScript for your account can be added directly to all the pages on your website. This can be done on a page-by-page basis, or by adding it to your website's header so it appears across all pages. This will usually require IT support. If access to IT is limited, we recommend integrating via a Tag Manager instead.

Option 2. JavaScript via Tag Managers

Add a JavaScript element to your site with a Tag Manager or in your theme. This is the fastest method for rendering Schema Markup in your browser, any by far the most common integration method. This puts the digital marketing team in control of Schema Markup deployment, and provides them with the ability to do maintenance and updates outside of a development release.

Schema App's JavaScript tag can currently be added using the following Tag Managers:

Selecting an Integration Method

CMS-specific integrations should always be the first method to consider.

If this is not an option, there are multiple JavaScript integrations available, each of which have been created for different use cases. The primary concern when selecting the right JavaScript integration is site speed. Here is a breakdown of the pros and cons of each deployment method, as well as the total rendering time for each.

JavaScript Integration Considerations

Integration Method	Pros	Cons	Total Rendering Time
JavaScript Rendering/ Tag Manager	• Immediate updates to markup • Durable (most commonly used)	• AMP third party JavaScript not supported	• Initial attempt: 5-20 ms • Retries: 3-5ms • Tested example total time: 5-35ms
JavaScript + Caching	• Quick loading markup for slower page speeds • Nearly up-to-date markup (real time - 1 page load) • Content loaded from Schema App's CDN (no requirement for Webhooks)	• AMP third party JavaScript not supported • Updates less frequently than JavaScript rendering	• Load cached JSON-LD: 1-3ms • Initial attempt: 5-20ms • Retries: 3-5ms •Tested example total time: 5-35ms
JavaScript + Webhook Hybrid	• Nearly up-to-date markup (real time - 1 page load) • Supported by Schema App CMS integrations • Supports AMP	• Requires backend integration (unless using Schema App CMS integration, e.g. WordPress)	• Initial attempt: 5-20 ms • Retries: 3-5ms • Tested example total time: 5-35ms

For more information see our Schema App JavaScript Page Impact Overview article.

Integrating with Multiple Sites

If integrating multiple sites, a unique project will need to be created in Schema App for each domain and deployment method. Note that this does not apply to subfolders within the same website, as seen below with the example of "https://www.schemaapp.com/intl/".