Magento Google Drive Sync

User Guide & Documentation

Installation

This extension can be installed in a few minutes, by going through the following steps:

• Download/purchase the extension
• Unzip the file in a temporary directory
• Copy folder "app" and paste it in your Magento installation root directory. This extension will NOT replace existing code.
• Go to your admin panel andclear cache. Hit refresh on any of your Magento pages and you're done.

Creating Google Drive App

In order to function properly, the extension requires you to create a new application on Google. This could be challanging for the first time and that's why we've summarized all the required steps in a simple visual wizard below.

Step 1 - Prerequisites

Before you continue, you should have a standard Google Account and extension installed properly.

Step 2 - Creating a new project on Google

To create a new project on Google go to https://code.google.com/apis/console and click "Create Project". See Fig. 1

Fig. 1

Step 3 - Enabling Drive API

To enable Drive API, go to your Project dashboard and click "Enable an API". You will be presented by a list of available APIs. Select Drive API and change it's status to "ON". Your project may have other APIs enabled by default. It's save to disable them. See Fig. 2

Fig. 2

Step 4 - Creating Client ID

To create a new Client ID, click on your project title and then go to APIs & Auth -> Credentials. Click on "Create new Client ID". A dialog window will appear. Fill in the settings as shown on Fig. 3.

Fig. 3

Step 5 - Creating API Key

To create a new API key, click "Create new key". A dialog window will appear. Fill in the settings as shown on Fig. 3

Fig. 4

Step 6 - Authorizing extension

To allow the extension to send data to Google Drive you need to authorize your application with certain privileges. Google have a special tool called Google OAuth Playground. It's a tool that allows developers to test the API. It can also be used for exchanging authorization code for access token and refresh token as well.

Getting an access token requires a few steps outline below:

Go to Google OAuth Playground available on https://developers.google.com/oauthplayground/ and click the "Gear" icon located in your top right corner of the window. A dialog window will appear. Fill in the fields as shown below. See Fig. 5

Fig. 5

Check "Use your own OAuth credentials" and then in OAuth Client ID and OAuth Client Secret fill in the data generated in Step 3. Then click "Close"

Once the OAuth Playground is configured properly you need to go through the steps available on the left. First, a scope must be selected. The application needs to have 2 scopes selected: (see Fig. 6)

Drive API v2 -> https://www.googleapis.com/auth/drive
Spreadsheets v3 -> https://spreadsheets.google.com/feeds/

Fig. 7

Once scopes are selected, click "Authorize APIs". The tool will generate an authorization code on the next screen. See Fig. 7

Fig. 7

Once the Authorization code is generated, you can exchange it for access tokens. Click "Exchange authorization code for tokens". The tool will generate an access token and show them on the next screen. See Fig. 8

Fig. 8

Once access tokens are available to you, use them to configure the extension. It will use these tokens to access Google Drive and save data successfully. The extension cannot work without valid access tokens and if invalid tokens are provided, data won't be recorded properly on Google Drive.

Google may occasionally expire refresh tokens. Once this happens you need to repeat the process to obtain a new access and refresh tokens accordingly. If tokens are expired the extension will display a message in your Magento admin panel.