How To: Integrate with Schema Performance Analytics

This document describes how to set up Schema Performance Analytics for a Schema App project. Schema Performance Analytics (SPA) is available to accounts with at least one Highlighter template.

TABLE OF CONTENTS

• Resources Required
• How To: Set Up Schema Performance Analytics on a New Project
  • Step 1: Navigate to Schema Performance Analytics
  • Step 2: Add Brand Keywords
  • Step 3: Authenticate with Google
  • Step 4: Register Property

Resources Required 

• A Schema App Project with at least one active Highlighter template
• A URL-prefix property in Google Search Console
• Owner Level permissions in Google Search Console
• A list of branded keywords

How To: Set Up Schema Performance Analytics on a New Project

This How-To will describe how to set up SPA for a new Project. If you are reconfiguring your settings, there may be additional considerations (e.g. clearing prior tokens). Contact support@schemaapp.com with any questions if you're unsure what to do.

Step 1: Navigate to Schema Performance Analytics

Once you log into your account, navigate to Reporting > Performance Analytics using the left sidebar navigation. Select the Aggregate Level or Page Level report and you'll be brought to the first of 4 authentication steps. 

Step 2: Add Brand Keywords

A branded keyword, or a branded search, is any search query that includes the name of your company, business or brand. Include common misspellings (e.g. we've added terms like 'SchemaAp', 'Schemaapp' or 'Schmea App'. The keywords are not case-sensitive.

Note: Search Queries that contain any Branded keyword strings will be counted as a branded query. For example, if we add "Highlight" as a branded keyword, then "Highlighter" and "Highlighter Extension",  would be considered branded queries. 

Once you've added all your brand keywords, click Next.

Note: You can add as many terms as you require. Although you can add branded keywords later via Settings, the branded keywords will only apply to data from that point forward.

Step 3: Authenticate with Google

For this step, you will require Owner Level permissions in Google Search Console. You can confirm your Ownership Verification in the Search Console Settings. The following example is a screenshot of insufficient permissions.

Click ‘Authenticate with Google’ to get started. A GSC login page will pop-up. Select ‘Allow’ to grant Schema App access to your Google Search Console API. Once you click "Allow" you will be redirected to Schema App. The tool will auto-select a property that matches the URL defined in the Project Settings but you can choose other properties associated with your GSC account.

Authenticate with Google
You have successfully authenticated with Google.
Remove Authentication 

Note: If you are authenticating multiple projects with the same Gmail account, we'll automatically reuse your email login provided you have the correct permission level for each Google Search Console property.

Note: Domain properties are not accepted in SPA due to impacts on data processing. If needed, you can create a URL-prefix property for the URL of the associated Schema App project

Step 4: Register Property

Confirm the details on the screen and click the button ‘Register Property'. For integration to happen successfully, youmust register a URL-prefix property. If you do not have URL-prefix property, you'll need to create one in Google Search Console.

The tool will look to match the URL from the project settings to a search property URL associated with your Google Search Console account. If the information is correct, selct "Register Search Property & Initiatlize".

If the integration process was successful, you will see a message that states “The search property is registered and SPA is running". 

Depending on your priority in the set-up queue, it should take between 2-7 days for your data to appear in Schema Performance Analytics. 

If you have any issue during this process, please contact support at support@schemaapp.com or contact your designated CSM.

Possible Errors and Troubleshooting

There are a few issues that may appear based on permission levels. They are listed below with suggestions on how to resolve them.

Lack of Sufficient Permissions

If you are not a verified user, you will receive the following error message. Either update your permissions in GSC or have another team member with sufficient permissions initialize SPA.

Authentication Process Failed

If there was an authentication issue, the following message will appear. Re-attempt authentication and/or review the documentation referenced. If the issue persists, contact support@schemaapp.com.