Email Plugin - Google APIs and Scopes

From 360Works Product Documentation Wiki
(Difference between revisions)
Jump to: navigation, search
(Created page with "Pre-requisites: * Set up a Google Developer Account, project, and OAuth consent screen using the instructions here: Google_-_Set_up_OAuth_Consent_Screen =Enable Gmail API...")
 
(Add Scopes To OAuth Consent Screen)
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
Pre-requisites:
 
Pre-requisites:
* Set up a Google Developer Account, project, and OAuth consent screen using the instructions here: [[Google_-_Set_up_OAuth_Consent_Screen]]
+
* Set up a Google Developer Account, project, and OAuth consent screen using the instructions here: [[Google - Set up OAuth Consent Screen]]
  
 
=Enable Gmail APIs=
 
=Enable Gmail APIs=
 
* From the Google Developer Console Dashboard, select "Library" from the menu
 
* From the Google Developer Console Dashboard, select "Library" from the menu
[[File:GoogleLibrary_Start.png|x400px]]
+
[[File:GoogleLibrary_Start.png|x600px]]
  
 
* This will bring you to a page where you can search for APIs that you want to enable.  Search for "Gmail", then select the "Gmail API" result
 
* This will bring you to a page where you can search for APIs that you want to enable.  Search for "Gmail", then select the "Gmail API" result
[[File:GoogleLibrary SearchForGmail.png|x400px]]
+
[[File:GoogleLibrary SearchForGmail.png|x600px]]
  
 
* Enable this API
 
* Enable this API
[[File:GoogleLibrary_EnableAPI.png|x400px]]
+
[[File:GoogleLibrary_EnableAPI.png|x600px]]
  
 +
=Add Scopes To OAuth Consent Screen=
 
* Now that the API is enabled, we need to add the right scopes to our OAuth consent screen, head back to the dashboard.
 
* Now that the API is enabled, we need to add the right scopes to our OAuth consent screen, head back to the dashboard.
 
: Hamburger Menu -> APIs And Services -> OAuth Consent Screen
 
: Hamburger Menu -> APIs And Services -> OAuth Consent Screen
  
[[File:GoogleLibrary_BackToOAuth.png|x400px]]
+
[[File:GoogleLibrary_BackToOAuth.png|x600px]]
  
 
* Now click "Edit App"
 
* Now click "Edit App"
  
[[File:GoogleOAuthConsent_EditApp.png|x400px]]
+
[[File:GoogleOAuthConsent_EditApp.png|x600px]]
  
 
* Scroll down and click "Save And Continue" to advance to the next page.
 
* Scroll down and click "Save And Continue" to advance to the next page.
Line 25: Line 26:
 
* On the "Scopes" page, click the "Add or Remove Scopes" button
 
* On the "Scopes" page, click the "Add or Remove Scopes" button
  
[[File:GoogleOAuthConsent_AddScopes.png|x400px]]
+
[[File:GoogleOAuthConsent_AddScopes.png|x600px]]
  
 
* (Optional) In the list of scopes, use the filter to narrow down the scopes to Gmail scopes only
 
* (Optional) In the list of scopes, use the filter to narrow down the scopes to Gmail scopes only
  
[[File:GoogleOAuthConsent_FilterScopes.png|x400px]]
+
[[File:GoogleOAuthConsent_FilterScopes.png|x600px]]
  
 
* Select the scope "https://mail.google.com/".  The description for this scope will be:
 
* Select the scope "https://mail.google.com/".  The description for this scope will be:
 
: Read, compose, send, and permanently delete all your email from Gmail
 
: Read, compose, send, and permanently delete all your email from Gmail
  
[[File:GoogleOAuthConsent_SelectGmailScope.png|x400px]]
+
[[File:GoogleOAuthConsent_SelectGmailScope.png|x600px]]
  
 
* Scroll down and click "Update"
 
* Scroll down and click "Update"
  
[[File:GoogleOAuthConsent_UpdateScopes.png|x400px]]
+
[[File:GoogleOAuthConsent_UpdateScopes.png|x600px]]
  
 
* You should now see the scope reflected in the "Restricted Scopes" section.
 
* You should now see the scope reflected in the "Restricted Scopes" section.
 
* Click "Save And Continue"
 
* Click "Save And Continue"
  
[[File:GoogleOAuthConsent_SaveScopes.png|x400px]]
+
[[File:GoogleOAuthConsent_SaveScopes.png|x600px]]
  
 
* Click "Save And Continue" again, then on the Summary screen click "Back To Dashboard"
 
* Click "Save And Continue" again, then on the Summary screen click "Back To Dashboard"

Latest revision as of 16:41, 24 March 2021

Pre-requisites:

[edit] Enable Gmail APIs

  • From the Google Developer Console Dashboard, select "Library" from the menu

GoogleLibrary Start.png

  • This will bring you to a page where you can search for APIs that you want to enable. Search for "Gmail", then select the "Gmail API" result

GoogleLibrary SearchForGmail.png

  • Enable this API

GoogleLibrary EnableAPI.png

[edit] Add Scopes To OAuth Consent Screen

  • Now that the API is enabled, we need to add the right scopes to our OAuth consent screen, head back to the dashboard.
Hamburger Menu -> APIs And Services -> OAuth Consent Screen

GoogleLibrary BackToOAuth.png

  • Now click "Edit App"

GoogleOAuthConsent EditApp.png

  • Scroll down and click "Save And Continue" to advance to the next page.


  • On the "Scopes" page, click the "Add or Remove Scopes" button

GoogleOAuthConsent AddScopes.png

  • (Optional) In the list of scopes, use the filter to narrow down the scopes to Gmail scopes only

GoogleOAuthConsent FilterScopes.png

Read, compose, send, and permanently delete all your email from Gmail

GoogleOAuthConsent SelectGmailScope.png

  • Scroll down and click "Update"

GoogleOAuthConsent UpdateScopes.png

  • You should now see the scope reflected in the "Restricted Scopes" section.
  • Click "Save And Continue"

GoogleOAuthConsent SaveScopes.png

  • Click "Save And Continue" again, then on the Summary screen click "Back To Dashboard"
Personal tools
Namespaces

Variants
Actions
Plug-in Products
Other Products
Navigation
Toolbox