Email Plugin - Google APIs and Scopes
From 360Works Product Documentation Wiki
(Difference between revisions)
(→Add Scopes To OAuth Consent Screen) |
|||
(One intermediate revision by one user not shown) | |||
Line 4: | Line 4: | ||
=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| | + | [[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| | + | [[File:GoogleLibrary SearchForGmail.png|x600px]] |
* Enable this API | * Enable this API | ||
− | [[File:GoogleLibrary_EnableAPI.png| | + | [[File:GoogleLibrary_EnableAPI.png|x600px]] |
=Add Scopes To OAuth Consent Screen= | =Add Scopes To OAuth Consent Screen= | ||
Line 16: | Line 16: | ||
: Hamburger Menu -> APIs And Services -> OAuth Consent Screen | : Hamburger Menu -> APIs And Services -> OAuth Consent Screen | ||
− | [[File:GoogleLibrary_BackToOAuth.png| | + | [[File:GoogleLibrary_BackToOAuth.png|x600px]] |
* Now click "Edit App" | * Now click "Edit App" | ||
− | [[File:GoogleOAuthConsent_EditApp.png| | + | [[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 26: | 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| | + | [[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| | + | [[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| | + | [[File:GoogleOAuthConsent_SelectGmailScope.png|x600px]] |
* Scroll down and click "Update" | * Scroll down and click "Update" | ||
− | [[File:GoogleOAuthConsent_UpdateScopes.png| | + | [[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| | + | [[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:
- Set up a Google Developer Account, project, and OAuth consent screen using the instructions here: Google - Set up OAuth Consent Screen
[edit] Enable Gmail APIs
- From the Google Developer Console Dashboard, select "Library" from the menu
- 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
- Enable this API
[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
- Now click "Edit App"
- Scroll down and click "Save And Continue" to advance to the next page.
- On the "Scopes" page, click the "Add or Remove Scopes" button
- (Optional) In the list of scopes, use the filter to narrow down the scopes to Gmail scopes only
- 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
- Scroll down and click "Update"
- You should now see the scope reflected in the "Restricted Scopes" section.
- Click "Save And Continue"
- Click "Save And Continue" again, then on the Summary screen click "Back To Dashboard"