Choose Google Workspace Marketplace API scopes

AI-generated Key Takeaways

• This document provides Google Workspace Marketplace API-specific authorization and authentication information, advising developers to review general Google Workspace authentication information beforehand.

• Developers must configure OAuth 2.0 including the consent screen and scopes, which define user data access levels for the app.

• Marketplace API scopes are OAuth 2.0 URIs that specify app access to Google Workspace data, including user data, and require careful selection to ensure user privacy and trust.

• Applications using scopes with access to specific user data might require verification to avoid being flagged as "unverified app" during testing.

This document contains Google Workspace Marketplace API-specific authorization and authentication information. Before reading this document, be sure to read the Google Workspace's general authentication and authorization information at Learn about authentication and authorization.

Configure OAuth 2.0 for authorization

Configure the OAuth consent screen and choose scopes to define what information is displayed to users and app reviewers, and register your app so that you can publish it later.

Marketplace API scopes

To define the level of access granted to your app, you need to identify and declare authorization scopes. An authorization scope is an OAuth 2.0 URI string that contains the Google Workspace app name, what kind of data it accesses, and the level of access. Scopes are your app's requests to work with Google Workspace data, including users' Google Account data.

When your app is installed, a user is asked to validate the scopes used by the app. Generally, you should choose the most narrowly focused scope possible and avoid requesting scopes that your app doesn't require. Users more readily grant access to limited, clearly described scopes.

If your public application uses scopes that permit access to certain user data, it must complete a verification process. If you see unverified app on the screen when testing your application, you must submit a verification request to remove it. Find out more about unverified apps and get answers to frequently asked questions about app verification in the Help Center.

The Marketplace API supports the following scopes:

Scope	Meaning
https://www.googleapis.com/auth/appsmarketplace.license	View your installed application's licensing information.