google-maps-api-sdk 1.0.0

Google Maps API

Getting Started with Google Maps Platform

Introduction

API Specification for Google Maps Platform

Install the Package

The package is compatible with Python versions 3.7+. Install the package from PyPi using the following pip command:

pip install google-maps-api-sdk==1.0.0

You can also view the package at: https://pypi.python.org/pypi/google-maps-api-sdk/1.0.0

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

Parameter	Type	Description
environment	Environment	The API environment. Default: Environment.PRODUCTION
http_client_instance	Union[Session, HttpClientProvider]	The Http Client passed from the sdk user for making requests
override_http_client_configuration	bool	The value which determines to override properties of the passed Http Client from the sdk user
http_call_back	HttpCallBack	The callback value that is invoked before and after an HTTP call is made to an endpoint
timeout	float	The value to use for connection timeout. Default: 30
max_retries	int	The number of times to retry an endpoint call if it fails. Default: 0
backoff_factor	float	A backoff factor to apply between attempts after the second try. Default: 2
retry_statuses	Array of int	The http statuses on which retry is to be done. Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods	Array of string	The http methods on which retry is to be done. Default: ["GET", "PUT"]
proxy_settings	ProxySettings	Optional proxy configuration to route HTTP requests through a proxy server.
logging_configuration	LoggingConfiguration	The SDK logging configuration for API calls
custom_query_authentication_credentials	CustomQueryAuthenticationCredentials	The credential object for Custom Query Parameter

The API client can be initialized as follows:

Code-Based Client Initialization

import logging

from googlemapsplatform.configuration import Environment
from googlemapsplatform.googlemapsplatform_client import GooglemapsplatformClient
from googlemapsplatform.http.auth.custom_query_authentication import CustomQueryAuthenticationCredentials
from googlemapsplatform.logging.configuration.api_logging_configuration import LoggingConfiguration
from googlemapsplatform.logging.configuration.api_logging_configuration import RequestLoggingConfiguration
from googlemapsplatform.logging.configuration.api_logging_configuration import ResponseLoggingConfiguration

client = GooglemapsplatformClient(
    custom_query_authentication_credentials=CustomQueryAuthenticationCredentials(
        key='key'
    ),
    environment=Environment.PRODUCTION,
    logging_configuration=LoggingConfiguration(
        log_level=logging.INFO,
        request_logging_config=RequestLoggingConfiguration(
            log_body=True
        ),
        response_logging_config=ResponseLoggingConfiguration(
            log_headers=True
        )
    )
)

Environment-Based Client Initialization

from googlemapsplatform.googlemapsplatform_client import GooglemapsplatformClient

# Specify the path to your .env file if it’s located outside the project’s root directory.
client = GooglemapsplatformClient.from_environment(dotenv_path='/path/to/.env')

See the Environment-Based Client Initialization section for details.

Environments

The SDK can be configured to use a different environment for making API calls. Available environments are:

Fields

Name	Description
PRODUCTION	Default
ENVIRONMENT2	-
ENVIRONMENT3	-

Authorization

This API uses the following authentication schemes.

• ApiKeyAuth (Custom Query Parameter)

List of APIs

• Geolocation API
• Directions API
• Elevation API
• Geocoding API
• Time Zone API
• Roads API
• Distance Matrix API
• Places API
• Street View API

SDK Infrastructure

Configuration

• ProxySettings
• Environment-Based Client Initialization
• AbstractLogger
• LoggingConfiguration
• RequestLoggingConfiguration
• ResponseLoggingConfiguration

HTTP

• HttpResponse
• HttpRequest

Utilities

• ApiResponse
• ApiHelper
• HttpDateTime
• RFC3339DateTime
• UnixDateTime