Complete the steps described in the rest of this page to create a simple PHP command-line application that makes requests to the Google Sheets API.
Prerequisites
To run this quickstart, you need the following prerequisites:
- PHP 5.4 or greater with the command-line interface (CLI) and JSON extension installed
- The Composer dependency management tool
- A Google account
Step 1: Turn on the Google Sheets API
Click this button to create a new Cloud Platform project and automatically enable the Google Sheets API:
In resulting dialog click DOWNLOAD CLIENT CONFIGURATION and save the filecredentials.json
to your working directory.
Step 2: Install the Google Client Library
composer require google/apiclient:^2.0
See the library's installation page for the alternative installation options.
Step 3: Set up the sample
Create a file named quickstart.php
in your working directory and copy in the
following code:
Step 4: Run the sample
Run the sample using the following command:
php quickstart.php
The first time you run the sample, it will prompt you to authorize access:
Browse to the provided URL in your web browser.
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.
- Click the Accept button.
- Copy the code you're given, paste it into the command-line prompt, and press Enter.
Notes
- Authorization information is stored on the file system, so subsequent executions will not prompt for authorization.
- The authorization flow in this example is designed for a command-line application. For information on how to perform authorization in a web application, see Using OAuth 2.0 for Web Server Applications.
Further reading
- Google Developers Console help documentation
- Google APIs Client for PHP documentation
- Google Sheets API PHP reference documentation
- Sheets API reference documentation
Troubleshooting
This section describes some common issues that you may encounter while attempting to run this quickstart and suggests possible solutions.
SSL certificate problem: unable to get local issuer certificate
This error indicates that the underlying HTTP libraries can't find a certificate store, and are therefore unable to setup the SSL connection to Google's servers. See the Guzzle library's documentation for information on how to setup a certificate store on your machine.
Uncaught InvalidArgumentException: missing the required redirect URI
This error occurs when the credentials.json
file used contains a client
ID of the wrong type. This code requires an OAuth client ID of type Other,
which will be created for you when using the button in Step 1. If creating your
own client ID please ensure you select the correct type.
This app isn't verified.
The OAuth consent screen that is presented to the user may show the warning "This app isn't verified" if it is requesting scopes that provide access to sensitive user data. These applications must eventually go through the verification process to remove that warning and other limitations. During the development phase you can continue past this warning by clicking Advanced > Go to {Project Name} (unsafe).