JavaScript Quickstart

Complete the steps described in the rest of this page, and in about five minutes you'll have a simple JavaScript application that makes requests to the Gmail API.


To run this quickstart, you'll need:

  • Python 2.4 or greater (to provide a web server).
  • Access to the internet and a web browser.
  • A Google account with Gmail enabled.

Step 1: Turn on the Gmail API

  1. Use this wizard to create or select a project in the Google Developers Console and automatically turn on the API. Click Continue, then Go to credentials.
  2. On the Add credentials to your project page, click the Cancel button.
  3. At the top of the page, select the OAuth consent screen tab. Select an Email address, enter a Product name if not already set, and click the Save button.
  4. Select the Credentials tab, click the Create credentials button and select OAuth client ID.
  5. Select the application type Web application.
  6. In the Authorized JavaScript origins field, enter the URL http://localhost:8000. You can leave the Authorized redirect URIs field blank.
  7. Click the Create button.
  8. Take note of the client ID in the resulting dialog. You will need it in a later step.
  9. Click OK to dismiss the resulting dialog.

Step 2: Set up the sample

Create a file named quickstart.html and copy in the following code:

<!DOCTYPE html>
    <title>Gmail API Quickstart</title>
    <meta charset='utf-8' />
    <p>Gmail API Quickstart</p>

    <!--Add buttons to initiate auth sequence and sign out-->
    <button id="authorize-button" style="display: none;">Authorize</button>
    <button id="signout-button" style="display: none;">Sign Out</button>

    <pre id="content"></pre>

    <script type="text/javascript">
      // Client ID and API key from the Developer Console
      var CLIENT_ID = '<YOUR_CLIENT_ID>';

      // Array of API discovery doc URLs for APIs used by the quickstart
      var DISCOVERY_DOCS = [""];

      // Authorization scopes required by the API; multiple scopes can be
      // included, separated by spaces.
      var SCOPES = '';

      var authorizeButton = document.getElementById('authorize-button');
      var signoutButton = document.getElementById('signout-button');

       *  On load, called to load the auth2 library and API client library.
      function handleClientLoad() {
        gapi.load('client:auth2', initClient);

       *  Initializes the API client library and sets up sign-in state
       *  listeners.
      function initClient() {
          discoveryDocs: DISCOVERY_DOCS,
          clientId: CLIENT_ID,
          scope: SCOPES
        }).then(function () {
          // Listen for sign-in state changes.

          // Handle the initial sign-in state.
          authorizeButton.onclick = handleAuthClick;
          signoutButton.onclick = handleSignoutClick;

       *  Called when the signed in status changes, to update the UI
       *  appropriately. After a sign-in, the API is called.
      function updateSigninStatus(isSignedIn) {
        if (isSignedIn) {
 = 'none';
 = 'block';
        } else {
 = 'block';
 = 'none';

       *  Sign in the user upon button click.
      function handleAuthClick(event) {

       *  Sign out the user upon button click.
      function handleSignoutClick(event) {

       * Append a pre element to the body containing the given message
       * as its text node. Used to display the results of the API call.
       * @param {string} message Text to be placed in pre element.
      function appendPre(message) {
        var pre = document.getElementById('content');
        var textContent = document.createTextNode(message + '\n');

       * Print all Labels in the authorized user's inbox. If no labels
       * are found an appropriate message is printed.
      function listLabels() {{
          'userId': 'me'
        }).then(function(response) {
          var labels = response.result.labels;

          if (labels && labels.length > 0) {
            for (i = 0; i < labels.length; i++) {
              var label = labels[i];
          } else {
            appendPre('No Labels found.');


    <script async defer src=""
      onreadystatechange="if (this.readyState === 'complete') this.onload()">

Replace the placeholder <YOUR_CLIENT_ID> in the copied code with the client ID you created in Step 1.

Step 3: Run the sample

  1. Start the web server using the following command from your working directory:

Python 2.x

python -m SimpleHTTPServer 8000

Python 3.x

python -m http.server 8000

  1. Load the URL http://localhost:8000/quickstart.html into your browser.

The first time you run the sample, it will prompt you to authorize access:

  1. Click the Authorize button to open the authorization window.

    If you are not already logged into your Google account, you will be prompted to log in. If you are logged into multiple Google accounts, you will be asked to select one account to use for the authorization.

  2. Click the Accept button.


  • After the initial user authorization, calls to gapi.auth.authorize that use immediate:true mode will obtain an auth token without user interaction.

Further reading


Error: origin_mismatch

This error will occur during the authorization flow if the host and port used to serve the web page doesn't match an allowed JavaScript origin on your Google Developers Console project. Make sure you completed the Step 1.e and that the URL in your browser matches.

Send feedback about...