Stay organized with collections
Save and categorize content based on your preferences.
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.
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.
The Marketplace API supports the following scopes:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-04 UTC."],[[["\u003cp\u003eThis document provides Google Workspace Marketplace API-specific authorization and authentication information, advising developers to review general Google Workspace authentication information beforehand.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers must configure OAuth 2.0 including the consent screen and scopes, which define user data access levels for the app.\u003c/p\u003e\n"],["\u003cp\u003eMarketplace 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.\u003c/p\u003e\n"],["\u003cp\u003eApplications using scopes with access to specific user data might require verification to avoid being flagged as "unverified app" during testing.\u003c/p\u003e\n"]]],["The core actions involve configuring OAuth 2.0 by defining the consent screen and choosing scopes, which determine the level of access your app has to user data. Apps must declare authorization scopes, specifying the Google Workspace app, the data type, and access level. Users validate these scopes upon app installation. Public apps accessing user data need to undergo a verification process to avoid being labeled as \"unverified\". The provided scope `https://www.googleapis.com/auth/appsmarketplace.license` allows viewing installed application's licensing information.\n"],null,["This document contains Google Workspace Marketplace API-specific authorization and\nauthentication information. Before reading this document, be sure to read the\nGoogle Workspace's general authentication and authorization information at\n[Learn about authentication and authorization](/workspace/guides/auth-overview).\n\nConfigure OAuth 2.0 for authorization\n\n[Configure the OAuth consent screen and choose scopes](/workspace/guides/configure-oauth-consent)\nto define what information is displayed to users and app reviewers, and register\nyour app so that you can publish it later.\n\nMarketplace API scopes\n\nTo define the level of access granted to your app, you need to identify and\ndeclare *authorization scopes*. An authorization scope is an OAuth 2.0 URI string\nthat contains the Google Workspace app name, what kind of data it accesses, and\nthe level of access. Scopes are your app's requests to work with Google Workspace data, including\nusers' Google Account data.\n\n\nWhen your app is installed, a user is asked to validate the scopes used\nby the app. Generally, you should choose the most narrowly focused scope\npossible and avoid requesting scopes that your app doesn't require. Users more\nreadily grant access to limited, clearly described scopes.\n| If your public application uses scopes that permit access to certain user data, it must complete a verification process. If you see **unverified\n| app** on the screen when testing your application, you must submit a verification request to remove it. Find out more about [unverified apps](https://support.google.com/cloud/answer/7454865) and get answers to [frequently asked questions about app verification](https://support.google.com/cloud/answer/9110914) in the Help Center.\n\nThe Marketplace API supports the following scopes:\n\n| Scope | Meaning |\n|-----------------------------------------------------------|----------------------------------------------------------|\n| `https://www.googleapis.com/auth/appsmarketplace.license` | View your installed application's licensing information. |"]]
