Google API

ampeducator allows you to integrate with google workspace so that users can sign in using their google accounts and send emails using the gmail api you’ll need to set up both google sign in and gmail integration, which are handled within the same google cloud project getting started enable google api in ampeducator, go to institution config / general / google api set google api enabled to yes this will unlock the google sign in and gmail fields below create google cloud project open google cloud console https //console developers google com and sign in using a google workspace admin user account create a new project named something like ampeducator this same project will be used for configuring both google sign in and google gmail integration — do not create separate projects for each once these two steps are done, you can proceed with setting up google sign in and gmail below set up google sign in google sign in allows users to log in to ampeducator using their google workspace credentials this simplifies access for staff and helps maintain secure authentication across your institution if you expand the google sign in section, you’ll see all required steps along with the specific values and urls you need to enter step 1 configure oauth consent screen in the google cloud console https //console cloud google com , ensure your ampeducator project is selected from the left hand menu, go to apis & services > oauth consent screen set the user type to internal enter the following details (these values and urls can be viewed in the google sign in instructions in the api section application name ampeducator support email your admin email authorized domains ampeducator ca (for canadian clients) ampeducator com (for others) application homepage https //\[yourinstitution] ampeducator ca privacy policy http //www ampeducator com/privacy php terms of service http //www ampeducator com/terms php save and continue through the remaining steps (no scopes are required) click back to dashboard when finished step 2 create oauth client id in the cloud console, go to apis & services > credentials click + create credentials and choose oauth client id set the application type to web application name it ampeducator enter the authorized redirect uris (found in the google sign in instructions in the api section of ampeducator) it will look something like this https //\[yourinstitution] ampeducator ca/web/public/authenticate/google click create and copy the generated client id (you will need to paste this in ampeducator in the next step) to find the client secret , click the edit (pencil icon) next to your newly created oauth client id then, scroll to the client secret section, where you can also copy the client secret step 3 enter credentials in ampeducator in ampeducator, go to institution config / general / google api enter the client id and client secret click save if configured correctly, ampeducator will confirm your google sign in setup is complete set up gmail integration enabling gmail integration allows ampeducator to send and receive emails on behalf of users through the gmail api this setup supports tracking email activity with prospects and students while keeping messages tied to your school's google workspace managed domain to begin, go to institution config / general / google api and expand the google gmail section it includes a step by step breakdown with all the necessary links, values, and fields you’ll need to complete the setup step 1 enable gmail api in ampeducator enable google gmail to reveal additional configuration fields step 2 verify your domain with google search console go to the google search console https //search google com/search console add a new property and choose url prefix enter the url found in the google gmail instructions in ampeducator's api section it will look something like this https //\[yourinstitution] ampeducator ca/web/public/email/push choose html tag for verification and copy the meta tag do not click verify yet paste the tag into ampeducator’s domain verification tag field under the google gmail section click save in ampeducator return to the search console and click verify once verified, click go to property step 3 create a service account in the google cloud console https //console cloud google com , go to iam & admin > service accounts click + create service account enter a name like ampeducator email click create and continue assign the owner role skip granting user access and click done step 4 create and download a json key in the google cloud console , go to navigation menu > apis & services > credentials locate the service account you created and click the edit (pencil) icon next to it navigate to the keys tab click add key > create new key choose json as the key type and click create the json file will download automatically— save this file you’ll upload it to ampeducator later step 5 enable apis from the cloud console, go to apis & services > enabled apis & services click + enable apis and services search for and enable the following gmail api cloud pub/sub api step 6 enable domain wide delegation still in the service accounts section, click the name of your service account, and expand advanced settings check enable domain wide delegation click save copy the client id shown on the page step 7 add api access in google admin console go to the google admin console https //admin google com navigate to security > api controls > manage domain wide delegation click add new paste the client id from step 6 for the oauth scopes , enter https //mail google com/,https //www googleapis com/auth/pubsub click authorize step 8 upload the json file to ampeducator go back to institution config / general / google api > google gmail upload the json key file you downloaded earlier click save step 9 enable gmail for email in ampeducator go to institution config / general / email scroll to the email provider dropdown, and select gmail click save to apply the changes once setup is complete, each user will still need to verify their individual email address to begin sending through gmail part 3 verify each user's email once the gmail api integration is complete, each user must verify their email address before they can begin sending messages through gmail in ampeducator this ensures that emails are properly authorized and sent from their own google workspace account steps to verify each user should log into ampeducator and navigate to username / user account / custom email if the setup has not been completed yet, the custom email status will display as no the user will enter their email address using the domain assigned to the google workspace organization you have configured with your ampeducator account (e g , yourname\@yourschool edu) then click configure & test ampeducator will send a verification code to the email address entered the user will then retrieve the code from their inbox, enter it into the field provided in ampeducator, and click configure & test again if successful, the custom email field will update to yes , and the last updated date will appear below