Skip to main content

Google Sheets

This section is dedicated to the library for working with API Google Sheets. On this page, all the steps necessary to start working are described

important

If you're already using the API to interact with other Google Workspace services and have completed the initial setup, you can skip the steps for Creating a Project and Setting Up OAuth. You just need to enable the Google Sheets** service in your existing project and reacquire the token (the last two steps in the instructions).

Getting started​

Project creation​

  1. Go to the Google Cloud Console and create a project

BF

  1. Select the created project and in the side menu go to APIs and Services -> OAuth consent screen

BF

  1. Choose External

BF

  1. Fill in the fields: App name, User support email, and Email addresses (all fields with asterisks)

BF

  1. Click on Next and then Save and continue on the last tab

BF

  1. Click on Publish App

BF

OAuth settings​

  1. In the side menu, select Credentials -> Create Credentials -> OAuth client ID

BF

  1. Enter the name and choose Application type - Desktop app

BF

  1. Save ClientID and Client Secret

BF

Enable service - Google Sheets​

  1. Go to page Sheets in Marketplace

  2. Click Enable

BF

Token retrieval​

  1. Pass the ClientID to the function OPI_GoogleWorkspace.FormCodeRetrievalLink() with boolean parameters of the services you use. The function will result in a URL that needs to be opened in the browser. Authorize with your Google account

BF

  1. Copy the code from the URL after authorization

BF

  1. Use the obtained code, ClientID, and Client Secret to call the function OPI_GoogleWorkspace.GetTokenByCode(ClientID, ClientSecret, Code)
Result of the function GetTokenByCode() if converted to JSON

{
 "token_type": "Bearer",
 "refresh_token": "1//09au6OES3JN9oCgYIARAAGAkSNwF-L9Ir1B7uawfwafT1wE0FKO519Xj6JxawfawfyjMyJ_QlUZYLHZqw",
 "scope": "https://www.googleapis.com/auth/...",
 "expires_in": 3599,
 "access_token": "ya29.a0AfB_byA344tXkIawdawdwadadhyZQV8bSZn_snNXtY2HLb7l71awdawdawdad-ASgpzyOSWIvEmPruhUa_1yCCq6jvoD0r_q-fNEsARrH8zpJ3c6LNGWvwdg8CXsSxYaCgYKAWkSawfwafawfrCK0EP5kZY_A0171"
}

  1. Use the access_token to pass as a Token parameter when calling functions of the library, and the refresh_token - to obtain a new access_token (function OPI_GoogleWorkspace.RefreshToken(ClientID, ClientSecret, RefreshToken)), when the old one expires. When refreshing the token, the refresh_token is not updated - you can use the same one to get a new access_token each time.