Repository files navigation

This is theGoogle API Python client libraryfor Google's discovery based APIs. To get started, please see thedocs folder.

This library is considered complete and is in maintenance mode. This meansthat we will address critical bugs and security issues but will not add anynew features.

This library is officially supported by Google. However, the maintainers ofthis repository recommend usingCloud Client Libraries for Python,where possible, for new code development. For more information, please visitClient Libraries Explained.

The 2.0 release ofgoogle-api-python-client includes a substantial reliabilityimprovement, compared with 1.x, as discovery documents are now cached in the libraryrather than fetched dynamically. It is highly recommended to upgrade from v1.x to v2.x.

Only python 3.7 and newer is supported. If you are not able to upgrade python, thenplease continue to use version 1.x as we will continue supporting python 2.7+ inv1.

Discovery documents will no longer be retrieved dynamically whenyou calldiscovery.build(). The discovery documents will instead be retrievedfrom the client library directly. New versions of this library are released weekly.As a result of caching the discovery documents, the size of this package is at least50 MB larger compared to the previous version.

Please see theMigration Guidefor more information.

See thedocs folder for more detailed instructions and additional documentation.

The maintainers of this repository recommend usingCloud Client Libraries for Python,where possible, for new code development due to the following reasons:

WithCloud Client Libraries for Python:

• There is a separate client library for each API, so you can choosewhich client libraries to download. Whereas,google-api-python-client is asingle client library for all APIs. As a result, the total package size forgoogle-api-python-client exceeds 50MB.
• There are stricter controls for breaking changes to the underlying APIsas each client library is focused on a specific API.
• There are more features in these Cloud Client Libraries as each library isfocused on a specific API, and in some cases, the libraries are owned by teamwho specialized in that API.
• Developers will benefit from intellisense.

For more information, please visitClient Libraries Explained.

Although there are many benefits to moving toCloud Client Libraries for Python,the maintainers want to emphasize thatgoogle-api-python-client will continueto be supported.

For Google Ads API, we recommend usingGoogle Ads API Client Library for Python.

For Google Firebase Admin API, we recommend usingFirebase Admin Python SDK.

Install this library in avirtualenv using pip. virtualenv is a tool tocreate isolated Python environments. The basic problem it addresses is one ofdependencies and versions, and indirectly permissions.

With virtualenv, it's possible to install this library without needing systeminstall permissions, and without clashing with the installed systemdependencies.

pip3 install virtualenvvirtualenv<your-env>source<your-env>/bin/activate<your-env>/bin/pip install google-api-python-client

pip install virtualenvvirtualenv<your-env><your-env>\Scripts\activate<your-env>\Scripts\pip.exe install google-api-python-client

Python 3.7, 3.8, 3.9, 3.10, 3.11, 3.12 and 3.13, 3.14 are fully supported and tested. This library may work on later versions of 3, but we do not currently run tests against those versions.

Python < 3.7

The following libraries will be installed when you install the client library:

• httplib2
• uritemplate

For development you will also need the following libraries:

• WebTest
• pyopenssl

Please see ourContribution Guide.In particular, we love pull requests - but please make sure to signthe contributor license agreement.