sdksio / google-maps-platform-sdk
Get location data for over 200 million places, and add place details, search, and autocomplete to your apps.
Installs: 0
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 0
Forks: 0
Open Issues: 0
pkg:composer/sdksio/google-maps-platform-sdk
Requires
- php: ^7.2 || ^8.0
- ext-curl: *
- ext-json: *
- apimatic/core: ~0.3.17
- apimatic/core-interfaces: ~0.1.5
- apimatic/unirest-php: ^4.0.6
Requires (Dev)
- phan/phan: 5.4.5
- squizlabs/php_codesniffer: ^3.5
README
Introduction
API Specification for Google Maps Platform
Install the Package
Run the following command to install the package and automatically add the dependency to your composer.json file:
composer require "sdksio/google-maps-platform-sdk:1.0.0"
Or add it to the composer.json file manually as given below:
"require": { "sdksio/google-maps-platform-sdk": "1.0.0" }
You can also view the package at: https://packagist.org/packages/sdksio/google-maps-platform-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 |
| timeout | int |
Timeout for API calls in seconds. Default: 30 |
| enableRetries | bool |
Whether to enable retries and backoff feature. Default: false |
| numberOfRetries | int |
The number of retries to make. Default: 0 |
| retryInterval | float |
The retry time interval between the endpoint calls. Default: 1 |
| backOffFactor | float |
Exponential backoff factor to increase interval between retries. Default: 2 |
| maximumRetryWaitTime | int |
The maximum wait time in seconds for overall retrying requests. Default: 0 |
| retryOnTimeout | bool |
Whether to retry on request timeout. Default: true |
| httpStatusCodesToRetry | array |
Http status codes to retry against. Default: 408, 413, 429, 500, 502, 503, 504, 521, 522, 524 |
| httpMethodsToRetry | array |
Http methods to retry against. Default: 'GET', 'PUT' |
| loggingConfiguration | LoggingConfigurationBuilder |
Represents the logging configurations for API calls |
| proxyConfiguration | ProxyConfigurationBuilder |
Represents the proxy configurations for API calls |
| customQueryAuthenticationCredentials | CustomQueryAuthenticationCredentials |
The Credentials Setter for Custom Query Parameter |
The API client can be initialized as follows:
use GoogleMapsPlatformLib\Logging\LoggingConfigurationBuilder; use GoogleMapsPlatformLib\Logging\RequestLoggingConfigurationBuilder; use GoogleMapsPlatformLib\Logging\ResponseLoggingConfigurationBuilder; use Psr\Log\LogLevel; use GoogleMapsPlatformLib\Environment; use GoogleMapsPlatformLib\Authentication\CustomQueryAuthenticationCredentialsBuilder; use GoogleMapsPlatformLib\GoogleMapsPlatformClientBuilder; $client = GoogleMapsPlatformClientBuilder::init() ->customQueryAuthenticationCredentials( CustomQueryAuthenticationCredentialsBuilder::init( 'key' ) ) ->environment(Environment::PRODUCTION) ->loggingConfiguration( LoggingConfigurationBuilder::init() ->level(LogLevel::INFO) ->requestConfiguration(RequestLoggingConfigurationBuilder::init()->body(true)) ->responseConfiguration(ResponseLoggingConfigurationBuilder::init()->headers(true)) ) ->build();
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.
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
- ProxyConfigurationBuilder
- LoggingConfigurationBuilder
- RequestLoggingConfigurationBuilder
- ResponseLoggingConfigurationBuilder