GoogleApi

Base abstract class for requests.

Base Url (abstract).

See .

The .

See .

The collection.

Base abstract class for responses.

See .

Base Response Stream.

Buffer.

Stream.

Address.

Constructor

The address.

Address Component.

short_name is an abbreviated textual name for the address component, if available. For example, an address component for the state of Alaska may have a long_name of "Alaska" and a short_name of "AK" using the 2-letter postal abbreviation.

long_name is the full text description or name of the address component as returned by the Geocoder.

types[] is an array indicating the type of the address component.

String Boolean Json Converter. Converter for a to a . If the string value is "1" then true, otherwise false.

String Enum List Json Converter. Converter for a comma separated of items, to a .

Converts a to an of type . If no enum member is found, default(T) it returned.

type.

Location.

Latitude.

Longitude.

Contructor intializing a location using and .

Location types.

Unknown is set when unmapped place location types is returned.

Indicates a precise street address.

Indicates a named route (such as "US 101").

Indicates a major intersection, usually of two major roads.

Indicates a political entity. Usually, this type indicates a polygon of some civil administration.

Indicates the national political entity, and is typically the highest order type returned by the Geocoder.

Indicates a first-order civil entity below the country level. Within the United States, these administrative levels are states. Not all nations exhibit these administrative levels.

Indicates a second-order civil entity below the country level. Within the United States, these administrative levels are counties. Not all nations exhibit these administrative levels.

Indicates a third-order civil entity below the country level. This type indicates a minor civil division. Not all nations exhibit these administrative levels.

Indicates a fourth-order civil entity below the country level. This type indicates a minor civil division. Not all nations exhibit these administrative levels.

Indicates a fifth-order civil entity below the country level. This type indicates a minor civil division. Not all nations exhibit these administrative levels.

Indicates a commonly-used alternative name for the entity.

Indicates an incorporated city or town political entity.

Ward indicates a specific type of Japanese locality, to facilitate distinction between multiple locality components within a Japanese address.

indicates an first-order civil entity below a locality

indicates an second-order civil entity below a locality

indicates an third-order civil entity below a locality

indicates an first-order civil entity below a locality

Indicates a named neighborhood

Indicates a named location, usually a building or collection of buildings with a common name

Indicates a first-order entity below a named location, usually a singular building within a collection of buildings with a common name

Indicates a postal code as used to address postal mail within the country.

Indicates a prominent natural feature.

Indicates an airport.

Indicates a named park.

Indicates the floor of a building address.

Establishment typically indicates a place that has not yet been categorized.

Indicates a named point of interest. Typically, these "POI"s are prominent local entities that don't easily fit in another category such as "Empire State Building" or "Statue of Liberty."

Parking indicates a parking lot or parking structure.

post_box indicates a specific postal box.

postal_town indicates a grouping of geographic areas, such as locality and sublocality, used for mailing addresses in some countries.

room indicates the room of a building address.

street_number indicates the precise street number.

Indicate the location of a bus stop.

Indicate the location of a train stop.

Indicate the location of a public transit stop.

Geocode.

Postal code prefix.

Postal code suffix.

Indicates an encoded location reference, derived from latitude and longitude. Plus codes can be used as a replacement for street addresses in places where they do not exist (where buildings are not numbered or streets are not named). See for details.

Business Status.

Operational.

Closed Temporarily.

Closed Permanently

The components that can be filtered.

Route matches long or short name of a route.

Locality matches against both locality and sublocality types.

Administrative_area matches all the administrative_area levels.

Postal_code matches postal_code and postal_code_prefix.

Country matches a country name or a two letter ISO 3166-1 country code.

Language Extension methods.

Gets the ISO-639-1 code for the specified .

The . The ISO-639-1 code matching the passed .

String Extensions.

Gets the for the specified ISO-639-1 code.

The ISO-639-1 code. The .

Supported Languages. By default the API will attempt to load the most appropriate language based on the users location or browser settings. Some APIs allow you to explicitly set a language when you make a request. https://developers.google.com/maps/faq#languagesupport

Afrikaans

Albanian

Amharic

Arabic

Armenian

Azerbaijani

Basque

Belarusian

Bengali

Bosnian

Bulgarian

Burmese

Catalan

Chinese

Chinese Simplified

Chinese Hong Kong

Chinese Traditional

Croatian

Czech

Danish

Dutch

English

English (Australian)

English (Great Britain)

Estonian

Farsi

Finnish

Filipino

French

French Canada

Galician

Georgian

German

Greek

Gujarati

Hebrew

Hindi

Hungarian

Icelandic

Indonesian

Italian

Japanese

Kannada

Kazakh

Khmer

Korean

Kyrgyz

Lao

Latvian

Lithuanian

Macedonian

Malay

Malayalam

Marathi

Mongolian

Nepali

Norwegian

Polish

Portuguese

Portuguese (Brazil)

Portuguese (Portugal)

Punjabi

Romanian

Russian

Serbian

Sinhalese

Slovak

Slovenian

Spanish

Spanish Latin America

Swahili

Swedish

Tamil

Telugu

Thai

Turkish

Ukrainian

Urdu

Uzbek

Vietnamese

Zulu

Place Location Types https://developers.google.com/places/supported_types#table1 https://developers.google.com/places/supported_types#table2

Unknown is set when unmapped place location types is returned.

Geocode instructs the Place Autocomplete service to return only geocoding results, rather than business results. Generally, you use this request to disambiguate results where the location specified may be indeterminate.

Indicates a precise street address.

Indicates a named route (such as "US 101").

Indicates a major intersection, usually of two major roads.

Indicates a political entity. Usually, this type indicates a polygon of some civil administration.

Indicates the national political entity, and is typically the highest order type returned by the Geocoder.

Indicates a first-order civil entity below the country level. Within the United States, these administrative levels are states. Not all nations exhibit these administrative levels.

Indicates a second-order civil entity below the country level. Within the United States, these administrative levels are counties. Not all nations exhibit these administrative levels.

Indicates a third-order civil entity below the country level. This type indicates a minor civil division. Not all nations exhibit these administrative levels.

Indicates a fourth-order civil entity below the country level. This type indicates a minor civil division. Not all nations exhibit these administrative levels.

Indicates a fifth-order civil entity below the country level. This type indicates a minor civil division. Not all nations exhibit these administrative levels.

Indicates a commonly-used alternative name for the entity.

Indicates an incorporated city or town political entity.

locality.

indicates an first-order civil entity below a locality.

indicates an second-order civil entity below a locality.

indicates an third-order civil entity below a locality.

indicates an first-order civil entity below a locality.

Indicates a named neighborhood

Indicates a named location, usually a building or collection of buildings with a common name.

Indicates a first-order entity below a named location, usually a singular building within a collection of buildings with a common name.

Indicates a postal code as used to address postal mail within the country.

Indicates a postal code prefix.

Indicates a postal code suffix.

Indicates a prominent natural feature.

Indicates a named point of interest. Typically, these "POI"s are prominent local entities that don't easily fit in another category such as "Empire State Building" or "Statue of Liberty."

Indicates the floor of a building address.

post_box indicates a specific postal box.

postal_town indicates a grouping of geographic areas, such as locality and sublocality, used for mailing addresses in some countries.

room indicates the room of a building address.

street_number indicates the precise street number.

Indicate the location of a public transit stop.

Accounting.

Airport.

Amusement Park.

Aquarium.

Art Gallery.

Atm.

Bakery.

Bank.

Bar.

Beauty Salon.

Bicycle Store.

Book Store.

Bowling Alley.

Bus Station.

Cafe.

Campground.

Car Dealer.

Car Rental.

Car Repair.

Car Wash.

Casino.

Cemetery.

Church.

City Hall.

Clothing Store.

Convenience Store.

Courthouse.

Dentist.

Department Store.

Doctor.

Electrician.

Electronics Store.

Embassy.

Establishment.

Finance.

Fire Station.

Florist.

Food.

Funeral Home.

Furniture Store.

Gas Station.

General Contractor.

Supermarket.

Grocery Or Supermarket.

Gym.

Hair Care.

Hardware Store.

Health.

Hindu Temple.

Home Goods Store.

Hospital.

Insurance Agency.

Jewelry Store.

Laundry.

Lawyer.

Library.

Liquor Store.

Local Government Office.

Locksmith.

Lodging.

Meal Delivery.

Mosque.

Movie Rental.

Movie Theater.

Moving Company.

Museum.

Night Club.

Painter.

Park.

Parking.

Pet Store.

Pharmacy.

Physiotherapist.

Place Of Worship.

Plumber.

Police.

Post Office.

Real Estate Agency.

Restaurant.

Roofing Contractor.

Rv Park.

School.

Shopping Mall.

Spa.

Stadium.

Storage.

Store-

Subway Station.

Synagogue.

Tourist Attracton.

Taxi Stand.

Train Station.

Travel Agency.

University.

VeterinaryCare.

Zoo.

Response status.

Set when deserialization fails (default).

Indicates that no errors occurred; the place was successfully detected and at least one result was returned.

Indicates that the request was successful but returned no results. This may occur if the search was passed a latlng in a remote location.

Indicates that you are over your quota.

Indicates that your request was denied.

Indicates that the query parameter (location or radius) is missing.

Indicates the allowed amount of elements has been exceeeded.

Indicates that too many waypointss were provided in the request The maximum allowed waypoints is 8, plus the origin, and destination. ( Google Maps Premier customers may contain requests with up to 23 waypoints.)

Indicates the requested route is too long and cannot be processed. This error occurs when more complex directions are returned. Try reducing the number of waypoints, turns, or instructions.

Indicates at least one of the locations specified in the requests's origin, destination, or waypoints could not be geocoded.

Indicates the request could not be processed due to a server error. The request may succeed if you try again.

Indicates the request resulted in a Http error code.

Indicates the request has none or an invalid key set.

Indicates any of the following: The API key is missing or invalid. Billing has not been enabled on your account. A self-imposed usage cap has been exceeded. The provided method of payment is no longer valid (for example, a credit card has expired).

Indicates that the number of origins or destinations exceeds the per-query limit.

DateTime extensions.

Unix Epoch value.

Converts a DateTime to a Unix timestamp.

Enum extensions.

Converts a value to string. If enum is a , values are separated by the passed .

The type. The to convert of . The separator inserted between each value if the . A representation of the enum value.

Converts the enum into a string, by getting the value.

The type. The enum value. A representation of the enum value.

List Extensions.

Adds a to generic .

The to add a to. The key. The value.

Geometry.

Location contains the geocoded latitude,longitude value. For normal address lookups, this field is typically the most important.

Bounds (optionally returned) stores the bounding box which can fully contain the returned result. Note that these bounds may not match the recommended viewport. (For example, San Francisco includes the Farallon islands, which are technically part of the city, but probably should not be returned in the viewport.)

Viewport contains the recommended viewport for displaying the returned result, specified as two latitude,longitude values defining the southwest and northeast corner of the viewport bounding box. Generally the viewport is used to frame a result when displaying it to a user.

Location type stores additional data about the specified location.

Plus Code.

Global Code. A 4 character area code.

Global Code. A 6 character or longer local code with an explicit location (CWC8+R9, Mountain View, CA, USA).

Constructor.

The global code. The local code (optional).

viewport contains the recommended viewport for displaying the returned result, specified as two latitude,longitude values defining the southwest and northeast corner of the viewport bounding box. Generally the viewport is used to frame a result when displaying it to a user.

South West.

North East.

Constructor.

The . The .

Base interface for requests.

Your application's API key (required). This key identifies your application for purposes of quota management and so that Places added from your application are made immediately available to your app. Visit the APIs Console to create an API Project and obtain your key. https://developers.google.com/maps/api-key-best-practices

The client ID provided to you by Google Enterprise Support, or null to disable URL signing. All client IDs begin with a "gme-" prefix.

Returns the Uri for the request.

The .

Get the query string collection of aggregated from all parameters added to the request.

The collection.

Indicates the Request is a Json payload request, using http post method.

Indicates the Request is a Query string requst, where parameters are passed through the querystring of the uri.

Base interface for responses.

Raw json of the response.

Raw querystring of the request.

The status returned with the response. indicates success.

When the status code is other than 'Ok', there may be an additional error_message field within the response object. This field contains more detailed information about the reasons behind the given status code. Note: This field is not guaranteed to be always present, and its content is subject to change.

html_attributions contain a set of attributions which must be displayed to the user.

Base abstract class for maps requests with channel property.

To track usage across different applications using the same client ID, you can use the channel parameter with your API requests. By specifying different channel values for different aspects of your application, you can determine precisely how your application is used. For example, your external website might access an API using a channel set to customer, while your internal marketing department might use a channel set to mkting. Your reports will break down usage of the API by those channel values. Make sure the channel value in your requests meets the following requirements: Must be an ASCII alphanumeric string. Can include a period(.), underscore(_) and hyphen(-) character. Is case-insensitive: Upper-case and mixed-case channel parameters are merged into their lower-case equivalent.For example, usage on the CUSTOMER channel will be combined with the usage of the customer channel. Must be a static and assigned per application instance(it can't be generated dynamically). For example, you can't use channel values to track individual users.

Base abstract class for maps requests.

CoordinateEx.

Heading.

Use Side Of Road.

Overrdden ToString method for default conversion to Google compatible string. If is true, 'side_of_road:' will prepended to the location. If is true and is not null, the heading will be prepended to the location.

The location string.

Distance.

Value indicates the distance in meters

Text contains a human-readable representation of the distance, displayed in units as used at the origin, in the language specified in the request. (For example, miles and feet will be used for any origin within the United States.) Note that regardless of what unit system is displayed as text, the distance.value field always contains a value expressed in meters.

Duration indicates the total duration of this leg These fields may be absent if the duration is unknown.

Text contains a human-readable representation of the duration.

Value in seconds.

Contains the time zone of this station. The value is the name of the time zone as defined in the IANA Time Zone Database, e.g. "America/New_York".

Avoid Way restrictions.

Nothing

Avoid tolls

Avoid highways

Avoid indoor

Avoid ferries

Traffic Model.

Best guess (default), indicates that the returned duration_in_traffic should be the best estimate of travel time given what is known about both historical traffic conditions and live traffic. Live traffic becomes more important the closer the departure_time is to now.

Pessimistic, indicates that the returned duration_in_traffic should be longer than the actual travel time on most days, though occasional days with particularly bad traffic conditions may exceed this value.

Optimistic, indicates that the returned duration_in_traffic should be shorter than the actual travel time on most days, though occasional days with particularly good traffic conditions may be faster than this value.

Transit mode.

Indicates that the calculated route should prefer travel by subway.

Indicates that the calculated route should prefer travel by train.

Indicates that the calculated route should prefer travel by tram and light rail.

Indicates that the calculated route should prefer travel by bus.

Indicates that the calculated route should prefer travel by train, tram, light rail, and subway. This is equivalent to transit_mode=train|tram|subway.

Transit Routing Preference.

No TransitRoutingPreference.

Indicates that the calculated route should prefer limited amounts of walking.

Indicates that the calculated route should prefer a limited number of transfers.

Travel mode.

Indicates distance calculation using the road network.

Requests distance calculation for walking via pedestrian paths and sidewalks (where available).

Requests distance calculation for bicycling via bicycle paths and preferred streets (where available).

transit requests distance calculation via public transit routes (where available). This value may only be specified if the request includes an API key or a Google Maps API for Work client ID. If you set the mode to transit you can optionally specify either a departure_time or an arrival_time. If neither time is specified, the departure_time defaults to now (that is, the departure time defaults to the current time). You can also optionally include a transit_mode and/or a transit_routing_preference.

Units.

Metric (default) returns distances in kilometers and meters.

Imperial returns distances in miles and feet.

Error.

This is the same as the HTTP status of the response.

A short description of the error.

Collection of errors.

Error Detail.

The domain assocaited with the error.

The error reason.

A short description of the error.

Fare.

An ISO 4217 currency code indicating the currency that the amount is expressed in.

The total fare amount, in the currency.

The total fare amount, formatted in the requested language.

Location.

Location String.

Location Ex.

Location String.

Constructor.

The .

Constructor.

The .

Constructor.

The .

Constructor.

The .

Map Size.

Width.

Height.

Constructor.

The width. The height.

Returns the x .

The string representation.

Place.

The place Id.

Constructor.

The place id.

Tostring with added prefix. "{prefix}:{placeid}"

The prefix. The prefixed placeid.

Directions Request.

origins — The starting point for calculating travel distance and time. You can supply one or more locations separated by the pipe character (|), in the form of an address, latitude/longitude coordinates, or a placeID. If you pass an address, the service geocodes the string and converts it to a latitude/longitude coordinate to calculate distance. This coordinate may be different from that returned by the Google Maps Geocoding API, for example a building entrance rather than its center. Example: "origins=Bobcaygeon+ON|24+Sussex+Drive+Ottawa+ON". If you pass latitude/longitude coordinates, they are used unchanged to calculate distance. Ensure that no space exists between the latitude and longitude values. If you supply a place ID, you must prefix it with place_id. Example: "origins= 41.43206,-81.38992|-33.86748,151.20699". You can only specify a placeID if the request includes an API key or a Google Maps APIs Premium Plan client ID. You can retrieve place IDs from the Google Maps Geocoding API and the Google Places API (including Place Autocomplete). For an example using place IDs from Place Autocomplete, see Place Autocomplete and Directions.For more about place IDs, see the place ID overview. "origins= place_id:ChIJ3S-JXmauEmsRUcIaWtf4MzE".

The address, textual latitude/longitude value, or place ID to which you wish to calculate directions. The options for the destination parameter are the same as for the parameter, described above.

Specifies the region code, specified as a ccTLD ("top-level domain") two-character value. (For more information see Region Biasing below.)

Language (optional) — The language in which to return results. See the supported list of domain languages. Note that we often update supported languages so this list may not be exhaustive. If language is not supplied, the Directions service will attempt to use the native language of the browser wherever possible. You may also explicitly bias the results by using localized domains of http://map.google.com. See Region Biasing for more information.

Directions results contain text within distance fields to indicate the distance of the calculated route. The unit system to use can be specified: Units=metric (default) returns distances in kilometers and meters. Units=imperial returns distances in miles and feet. * Note: this unit system setting only affects the text displayed within distance fields. The distance fields also contain values which are always expressed in meters

(optional, defaults to driving) — specifies what mode of transport to use when calculating directions. Valid values are specified in Travel Modes.

Traffic mdel (defaults to best_guess). Specifies the assumptions to use when calculating time in traffic. This setting affects the value returned in the duration_in_traffic field in the response, which contains the predicted time in traffic based on historical averages. The traffic_model parameter may only be specified for requests where the travel mode is driving, and where the request includes a departure_time, and only if the request includes an API key or a Google Maps APIs Premium Plan client ID.The available values for this parameter are:

Specifies one or more preferred modes of transit. This parameter may only be specified for requests where the mode is transit. The parameter supports the following arguments

Specifies preferences for transit requests. Using this parameter, you can bias the options returned, rather than accepting the default best route chosen by the API. This parameter may only be specified for requests where the mode is transit. The parameter supports the following arguments:

The time of arrival. Required when TravelMode = Transit Specifies the desired time of arrival for transit directions, in seconds since midnight, January 1, 1970 UTC. You can specify either departure_time or arrival_time, but not both. Note that arrival_time must be specified as an integer.

The time of departure. Required when TravelMode = Transit Specifies the desired time of departure. You can specify the time as an integer in seconds since midnight, January 1, 1970 UTC. Alternatively, you can specify a value of now, which sets the departure time to the current time (correct to the nearest second). The departure time may be specified in two cases: 1. For requests where the travel mode is transit: You can optionally specify one of departure_time or arrival_time. If neither time is specified, the departure_time defaults to now (that is, the departure time defaults to the current time). 2. For requests where the travel mode is driving: You can specify the departure_time to receive a route and trip duration (response field: duration_in_traffic) that take traffic conditions into account. This option is only available if the request contains a valid API key, or a valid Google Maps APIs Premium Plan client ID and signature. The departure_time must be set to the current time or some time in the future. It cannot be in the past.

Waypoints (optional) specifies an array of waypoints. Waypoints alter a route by routing it through the specified location(s). A waypoint is specified as either a latitude/longitude coordinate or as an address which will be geocoded. (For more information on waypoints, see Using Waypoints in Routes below.) If you'd like to influence the route using waypoints without adding a stopover, prefix the waypoint with via:' Waypoints prefixed with via: will not add an entry to the legs array, but will instead route the journey through the provided waypoint. The via: prefix is most effective when creating routes in response to the user dragging the waypoints on the map. Doing so allows the user to see how the final route may look in real-time and helps ensure that waypoints are placed in locations that are accessible to the Google Maps Directions API. Caution: Using the via: prefix to avoid stopovers results in directions that are very strict in their interpretation of the waypoint. This may result in severe detours on the route or ZERO_RESULTS in the response status code if the Google Maps Directions API is unable to create directions through that point.

Optimize the provided route by rearranging the waypoints in a more efficient order. (This optimization is an application of the Travelling Salesman Problem.) Default: false. http://en.wikipedia.org/wiki/Travelling_salesman_problem

Alternatives (optional), if set to true, specifies that the Directions service may provide more than one route alternative in the response. Note that providing route alternatives may increase the response time from the server. Default: false.

WayPoint.

Location.

IsVia. The via: prefix is most effective when creating routes in response to the user dragging the waypoints on the map. Doing so allows the user to see how the final route may look in real-time and helps ensure that waypoints are placed in locations that are accessible to the Directions API. Caution: Using the via: prefix to avoid stopovers results in directions that are strict in their interpretation of the waypoint. This interprestation may result in severe detours on the route or ZERO_RESULTS in the response status code if the Directions API is unable to create directions through that point.

Constructor.

The . is prefixed with 'via:'

Directions Response.

"routes" contains an array of routes from the origin to the destination. See Routes below.

WayPoints. Details about the geocoding of every waypoint, as well as origin and destination, can be found in the (JSON) geocoded_waypoints array. These can be used to infer why the service would return unexpected or no routes. Elements in the geocoded_waypoints array correspond, by their zero-based position, to the origin, the waypoints in the order they are specified, and the destination.Each element includes the following details about the geocoding operation for the corresponding waypoint

Maneuver Action.

Unknown.

Turn_Slight_Left.

Sharp_Left.

Uturn_Left.

Turn_Left.

Turn_Slight_Right.

Turn_Sharp_Right.

Uturn_Right.

Turn_Right.

Straight.

Ramp_Left.

Ramp_Right.

Merge.

Fork_Left.

Fork_Right.

Ferry.

Ferry_Train.

Roundabout_Left.

Roundabout_Right.

Keep_Left.

Keep_Right.

VehicleType.

All other vehicles will return this type.

Rail.

Light rail transit.

Underground light rail.

Above ground light rail.

Monorail.

Heavy rail.

Commuter Train.

High speed train.

Bus.

Intercity bus.

Trolleybus.

Share taxi is a kind of bus with the ability to drop off and pick up passengers anywhere on its route.

Ferry.

A vehicle that operates on a cable, usually on the ground. Aerial cable cars may be of the type GONDOLA_LIFT.

An aerial cable car.

A vehicle that is pulled up a steep incline by a cable. A Funicular typically consists of two cars, with each car acting as a counterweight for the other.

Long Distance Train.

Each element in the legs array specifies a single leg of the journey from the origin to the destination in the calculated route. For routes that contain no waypoints, the route will consist of a single "leg," but for routes that define one or more waypoints, the route will consist of one or more legs, corresponding to the specific legs of the journey.

steps[] contains an array of steps denoting information about each separate step of the leg of the journey. (See Directions Steps below.)

Via-WayPoints.

distance indicates the total distance covered by this leg

duration indicates the total duration of this leg,

Duration_in_traffic indicates the total duration of this leg, taking into account current traffic conditions. The duration in traffic will only be returned if all of the following are true: 1.The directions request includes a departure_time parameter set to a value within a few minutes of the current time. 2.The request includes a valid Maps for Business client and signature parameter. 3.Traffic conditions are available for the requested route. 4.The directions request does not include stopover waypoints.

The time of arrival. Only avaliable when using TravelMode = Transit

The time of departure. Only avaliable when using TravelMode = Transit

start_location contains the latitude/longitude coordinates of the origin of this leg. Because the Directions API calculates directions between locations by using the nearest transportation option (usually a road) at the start and end points, start_location may be different than the provided origin of this leg if, for example, a road is not near the origin.

end_location contains the latitude/longitude coordinates of the given destination of this leg. Because the Directions API calculates directions between locations by using the nearest transportation option (usually a road) at the start and end points, end_location may be different than the provided destination of this leg if, for example, a road is not near the destination.

start_address contains the human-readable address (typically a street address) reflecting the start_location of this leg.

end_addresss contains the human-readable address (typically a street address) reflecting the end_location of this leg.

Line

Contains the full name of this transit line. eg. "7 Avenue Express".

Contains the short name of this transit line. This will normally be a line number, such as "M7" or "355".

Contains the color commonly used in signage for this transit line. The color will be specified as a hex string such as: #FF0033.

Contains a List of TransitAgency objects that each provide information about the operator of the line.

Contains the URL for this transit line as provided by the transit agency.

Contains the URL for the icon associated with this line.

Contains the color of text commonly used for signage of this line. The color will be specified as a hex string.

Contains the type of vehicle used on this line.

Contains the encoded and decoded data returned in the overview_polyline field.

Points. The encoded string containing the raw overview polyline.

Decoded PolyLine. The decocded polyline from the points. An array of Location objects representing the points in the encoded overview polyline.

Route Request.

summary contains a short textual description for the route, suitable for naming and disambiguating the route from alternatives.

legs[] contains an array which contains information about a leg of the route, between two locations within the given route. A separate leg will be present for each waypoint or destination specified. (A route with no waypoints will contain exactly one leg within the legs array.) Each leg consists of a series of steps. (See Directions Legs below.)

waypoint_order contains an array indicating the order of any waypoints in the calculated route. This waypoints may be reordered if the request was passed optimize:true within its waypoints parameter.

overview_path contains an object holding an array of encoded points and levels that represent an approximate (smoothed) path of the resulting directions.

copyrights contains the copyrights text to be displayed for this route. You must handle and display this information yourself.

warnings[] contains an array of warnings to be displayed when showing these directions. You must handle and display these warnings yourself.

If present, contains the total fare (that is, the total ticket costs) on this route. This property is only returned for transit requests and only for transit providers where fare information is available.

Bounds contains the viewport bounding box of the overview_polyline.

Each element in the steps array defines a single step of the calculated directions. A step is the most atomic unit of a direction's route, containing a single step describing a specific, single instruction on the journey. E.g. "Turn left at W. 4th St." The step not only describes the instruction but also contains distance and duration information relating to how this step relates to the following step. For example, a step denoted as "Merge onto I-80 West" may contain a duration of "37 miles" and "40 minutes," indicating that the next step is 37 miles/40 minutes from this step.

html_instructions contains formatted instructions for this step, presented as an HTML text string.

distance contains the distance covered by this step until the next step. (See the discussion of this field in Directions Legs above.) This field may be undefined if the distance is unknown.

duration contains the typical time required to perform the step, until the next step (See the description in Directions Legs above.) This field may be undefined if the duration is unknown.

start_location contains the location of the starting point of this step, as a single set of lat and lng fields.

end_location contains the location of the starting point of this step, as a single set of lat and lng fields.

Maneuver contains the action to take for the current step (turn left, merge, straight, etc.). This field is used to determine which icon to display, and can contain one of the following values: turn-slight-left, turn-sharp-left, uturn-left, turn-left, turn-slight-right, turn-sharp-right, uturn-right, turn-right, straight, ramp-left, ramp-right, merge, fork-left, fork-right, ferry, ferry-train, roundabout-left, roundabout-right. Values in this list are subject to change.

TravelMode. The mode of transport to use when calculating directions.

Contains an object holding an array of encoded points that represent an approximate (smoothed) path of the resulting directions.

More information about the step. Only avaliable when TravelMode = Transit

steps contains detailed directions for walking or driving steps in transit directions. Substeps are only available when travel_mode is set to "transit". The inner steps array is of the same type as steps.

Contains information about the stop/station for this part of the trip

The name of the transit station/stop. eg. "Union Square".

The location of the transit station/stop, represented as lattitude and longitude.

Information about the transit agency. Note: You must display the names and URLs of the transit agencies servicing the trip results.

Contains the name of the transit agency.

Contains the URL for the transit agency.

Contains the phone number of the transit agency.

Transit Details.

Contains information about the stop/station for this part of the trip

Contains information about the stop/station for this part of the trip.

Contain the arrival times for this leg of the journey

Contain the departure times for this leg of the journey

Specifies the direction in which to travel on this line, as it is marked on the vehicle or at the departure stop. This will often be the terminus station.

Specifies the expected number of seconds between departures from the same stop at this time. For example, with a headway value of 600, you would expect a ten minute wait if you should miss your bus.

Contains the number of stops in this step, counting the arrival stop, but not the departure stop. For example, if your directions involve leaving from Stop A, passing through stops B and C, and arriving at stop D, num_stops will return 3.

Contains information about the transit line used in this step.

Vehicle

Contains the name of the vehicle on this line. eg. "Subway."

Contains the URL for an icon associated with this vehicle type.

Contains the type of vehicle that runs on this line.

Via-WayPoint.

Location.

Step Index.

Step Interpolation.

Way Point.

"geocoder_status" indicates the status code resulting from the geocoding operation. This field may contain the following values.

"partial_match" indicates that the geocoder did not return an exact match for the original request, though it was able to match part of the requested address. You may wish to examine the original request for misspellings and/or an incomplete address. Partial matches most often occur for street addresses that do not exist within the locality you pass in the request. Partial matches may also be returned when a request matches two or more locations in the same locality.For example, "21 Henr St, Bristol, UK" will return a partial match for both Henry Street and Henrietta Street. Note that if a request includes a misspelled address component, the geocoding service may suggest an alternative address. Suggestions triggered in this way will also be marked as a partial match.

is a unique identifier that can be used with other Google APIs. For example, you can use the place_id from a Google Place Autocomplete response to calculate directions to a local business.

"types" indicates the address type of the geocoding result used for calculating directions.

Distance Matrix Request.

One or more addresses and/or textual latitude/longitude values, separated with the pipe (|) character, from which to calculate distance and time. If you pass an address as a string, the service will geocode the string and convert it to a latitude/longitude coordinate to calculate directions. If you pass coordinates, ensure that no space exists between the latitude and longitude values.

One or more addresses and/or textual latitude/longitude values, separated with the pipe (|) character, to which to calculate distance and time. If you pass an address as a string, the service will geocode the string and convert it to a latitude/longitude coordinate to calculate directions. If you pass coordinates, ensure that no space exists between the latitude and longitude values

Distance Matrix results contain text within distance fields to indicate the distance of the calculated route. The unit system to use can be specified: Units=metric (default) returns distances in kilometers and meters. Units=imperial returns distances in miles and feet. * Note: this unit system setting only affects the text displayed within distance fields. The distance fields also contain values which are always expressed in meters

avoid (optional) indicates that the calculated route(s) should avoid the indicated features. Currently, this parameter supports the following two arguments: tolls indicates that the calculated route should avoid toll roads/bridges. highways indicates that the calculated route should avoid highways. (For more information see Route Restrictions below.) Restrictions: Directions may be calculated that adhere to certain restrictions. Restrictions are indicated by use of the avoid parameter, and an argument to that parameter indicating the restriction to avoid. The following estrictions are supported

(optional, defaults to driving) — specifies what mode of transport to use when calculating directions. Valid values are specified in Travel Modes.

Specifies one or more preferred modes of transit. This parameter may only be specified for requests where the mode is transit. The parameter supports the following arguments

The desired time of departure. You can specify the time as an integer in seconds since midnight, January 1, 1970 UTC. Alternatively, you can specify a value of now, which sets the departure time to the current time (correct to the nearest second). The departure time may be specified in two cases: - For requests where the travel mode is transit: You can optionally specify one of departure_time or arrival_time. If neither time is specified, the departure_time defaults to now (that is, the departure time defaults to the current time). - For requests where the travel mode is driving: Google Maps API for Work customers can specify the departure_time to receive trip duration considering current traffic conditions. The departure_time must be set to within a few minutes of the current time. Note: Requests that include the departure_time parameter are limited to 100 elements Note: You can specify either DepartureTime or ArrivalTime, but not both

Specifies the desired time of arrival for transit requests, in seconds since midnight, January 1, 1970 UTC. Note: You can specify either DepartureTime or ArrivalTime, but not both

language (optional) — The language in which to return results. See the supported list of domain languages. Note that we often update supported languages so this list may not be exhaustive. If language is not supplied, the Directions service will attempt to use the native language of the browser wherever possible. You may also explicitly bias the results by using localized domains of http://map.google.com. See Region Biasing for more information.

region (optional) — The region code, specified as a ccTLD (country code top-level domain - https://en.wikipedia.org/wiki/CcTLD) two-character value. Most ccTLD codes are identical to ISO 3166-1 codes, with some exceptions. This parameter will only influence, not fully restrict, results from the geocoder. If more relevant results exist outside of the specified region, they may be included.

DistanceMatrix Response.

OriginAddresses contains an array of addresses as returned by the API from your original request. These are formatted by the geocoder and localized according to the language parameter passed with the request.

DestinationAddresses contains an array of addresses as returned by the API from your original request. As with origin_addresses, these are localized if appropriate.

Rows contains an array of elements, which in turn each contain a status, duration, and distance element.

Element.

Status: See Status Codes for a list of possible status codes.

Duration: The duration of this route, expressed in seconds (the value field) and as text. The textual representation is localized according to the query's language parameter.

The length of time it takes to travel this route, based on current and historical traffic conditions. See the traffic_model request parameter for the options you can use to request that the returned value is optimistic, pessimistic, or a best-guess estimate. The duration is expressed in seconds (the value field) and as text.The textual representation is localized according to the query's language parameter. The duration in traffic is returned only if all of the following are true: - The request includes a departure_time parameter. - The request includes a valid API key, or a valid Google Maps APIs Premium Plan client ID and signature. - Traffic conditions are available for the requested route. - The mode parameter is set to driving.

Distance: The total distance of this route, expressed in meters (value) and as text. The textual value uses the unit system specified with the unit parameter of the original request, or the origin's region.

When the Distance Matrix API returns results, it places them within a JSON rows array. Even if no results are returned (such as when the origins and/or destinations don't exist), it still returns an empty array. Rows are ordered according to the values in the origin parameter of the request. Each row corresponds to an origin, and each element within that row corresponds to a pairing of the origin with a destination value. Each row array contains one or more element entries, which in turn contain the information about a single origin-destination pairing.

Each row array contains one or more element entries, which in turn contain the information about a single origin-destination pairing.

Elevation Request.

Sampled path requests are indicated through use of the path and samples parameters, indicating a request for elevation data along a path at specified intervals. As with positional requests using the locations parameter, the path parameter specifies a set of latitude and longitude values. Unlike a positional request, however, the path specifies an ordered set of vertices. Rather than return elevation data only at the vertices, path requests are sampled along the length of the path, based on the number of samples specified (inclusive of the endpoints). The path parameter may take either of the following arguments: An array of two or more comma-separated coordinate text strings separated using the pipe ('|') character: path=40.714728,-73.998672|-34.397,150.644 Encoded coordinates using the Encoded Polyline Algorithm: path=enc:gfo}EtohhUxD@bAxJmGF Latitude and longitude coordinate strings are defined using numerals within a comma-separated text string. For example, "40.714728,-73.998672|-34.397, 150.644" is a valid path value. Latitude and longitude values must correspond to a valid location on the face of the earth. Latitudes can take any value between -90 and 90 while longitude values can take any value between -180 and 180. If you specify an invalid latitude or longitude value, your request will be rejected as a bad request. You may pass any number of multiple coordinates within an array or encoded polyline, as long as you don't exceed the service quotas, while still constructing a valid URL. Note that when passing multiple coordinates, the accuracy of any returned data may be of lower resolution than when requesting data for a single coordinate

Locations defines the location(s) on the earth from which to return elevation data. This parameter takes either a single location as a comma-separated {latitude,longitude} pair (e.g. "40.714728,-73.998672") or multiple latitude/longitude pairs passed as an array or as an encoded polyline. For more information. Note: Either this or Path property must be set, this overrides the Path.

Required when using the Path, and specifies the number of sample points along a path for which to return elevation data. The samples parameter divides the given path into an ordered set of equidistant points along the path.

Elevation Response.

Results.

Result.

A location element (containing lat and lng elements) of the position for which elevation data is being computed. Note that for path requests, the set of location elements will contain the sampled points along the path.

An elevation element indicating the elevation of the location in meters.

A resolution value, indicating the maximum distance between data points from which the elevation was interpolated, in meters. This property will be missing if the resolution is not known. Note that elevation data becomes more coarse (larger resolution values) when multiple points are passed. To obtain the most accurate elevation value for a point, it should be queried independently.

Geocoding Request.

Address (required). The street address or plus code that you want to geocode. Specify addresses in accordance with the format used by the national postal service of the country concerned. Additional address elements such as business names and unit, suite or floor numbers should be avoided

Region (optional) — The region code, specified as a ccTLD ("top-level domain") two-character value. (For more information see Region Biasing below.) The bounds and region parameters will only influence, not fully restrict, results from the geocoder.

Bounds (optional) — The bounding box of the viewport within which to bias geocode results more prominently. (For more information see Viewport Biasing below.) The bounds and region parameters will only influence, not fully restrict, results from the geocoder. For more information see: https://developers.google.com/maps/documentation/geocoding/intro#Viewports

Components. The component filters, separated by a pipe (|). Each component filter consists of a component:value pair and will fully restrict the results from the geocoder. For more information see Component Filtering: https://developers.google.com/maps/documentation/geocoding/intro#ComponentFiltering

Base Geocoding Request.

language (optional) — The language in which to return results. See the supported list of domain languages. Note that we often update supported languages so this list may not be exhaustive. If language is not supplied, the geocoder will attempt to use the native language of the domain from which the request is sent wherever possible.

Location Type.

Indicates that the returned result is a precise geocode for which we have location information accurate down to street address precision.

Indicates that the returned result reflects an approximation (usually on a road) interpolated between two precise points (such as intersections). Interpolated results are generally returned when rooftop geocodes are unavailable for a street address.

Indicates that the returned result is the geometric center of a result such as a polyline (for example, a street) or polygon (region).

Indicates that the returned result is approximate.

When the geocoder returns results, it places them within a (JSON) results array. Even if the geocoder returns no results (such as if the address doesn't exist) it still returns an empty results array. (XML responses consist of zero or more result elements.)

place_id is a unique identifier that can be used with other Google APIs. For example, you can use the place_id in a Google Places API request to get details of a local business, such as phone number, opening hours, user reviews, and more. See the place ID overview.

Geometry.

Formatted address is a string containing the human-readable address of this location. Often this address is equivalent to the "postal address," which sometimes differs from country to country. (Note that some countries, such as the United Kingdom, do not allow distribution of true postal addresses due to licensing restrictions.) This address is generally composed of one or more address components. For example, the address "111 8th Avenue, New York, NY" contains separate address components for "111" (the street number, "8th Avenue" (the route), "New York" (the city) and "NY" (the US state). These address components contain additional information as noted below.

partial_match indicates that the geocoder did not return an exact match for the original request, though it was able to match part of the requested address. You may wish to examine the original request for misspellings and/or an incomplete address. Partial matches most often occur for street addresses that do not exist within the locality you pass in the request. Partial matches may also be returned when a request matches two or more locations in the same locality. For example, "21 Henr St, Bristol, UK" will return a partial match for both Henry Street and Henrietta Street. Note that if a request includes a misspelled address component, the geocoding service may suggest an alternative address. Suggestions triggered in this way will also be marked as a partial match.

plus_code is an encoded location reference, derived from latitude and longitude coordinates, that represents an area: 1/8000th of a degree by 1/8000th of a degree(about 14m x 14m at the equator) or smaller. Plus codes can be used as a replacement for street addresses in places where they do not exist (where buildings are not numbered or streets are not named). The plus code is formatted as a global code and a compound code: - global_code is a 4 character area code and 6 character or longer local code(849VCWC8+R9). - compound_code is a 6 character or longer local code with an explicit location (CWC8+R9, Mountain View, CA, USA). Typically, both the global code and compound code are returned.However, if the result is in a remote location(for example, an ocean or desert) only the global code may be returned. See further details about pkus codes here: https://en.wikipedia.org/wiki/Open_Location_Code and https://plus.codes.

postcode_localities[] is an array denoting all the localities contained in a postal code. This is only present when the result is a postal code that contains multiple localities.

The types[] array indicates the type of the returned result. This array contains a set of one or more tags identifying the type of feature returned in the result. For example, a geocode of "Chicago" returns "locality" which indicates that "Chicago" is a city, and also returns "political" which indicates it is a political entity.

address_components[] is an array containing the separate address components

Geocode Response.

Results. When the geocoder returns results, it places them within a (JSON) results array. Even if the geocoder returns no results (such as if the address doesn't exist) it still returns an empty results array.

Reverse Geocoding Request.

Latlng (required). The textual latitude/longitude value for which you wish to obtain the closest, human-readable address. If you pass a latlng, the geocoder performs what is known as a reverse geocode.

result_type — A filter of one or more address types, separated by a pipe (|). If the parameter contains multiple address types, the API returns all addresses that match any of the types. A note about processing: The result_type parameter does not restrict the search to the specified address type(s). Rather, the result_type acts as a post-search filter: the API fetches all results for the specified latlng, then discards those results that do not match the specified address type(s). Note: This parameter is available only for requests that include an API key or a client ID.

location_type — A filter of one or more location types, separated by a pipe (|). If the parameter contains multiple location types, the API returns all addresses that match any of the types. A note about processing: The location_type parameter does not restrict the search to the specified location type(s). Rather, the location_type acts as a post-search filter: the API fetches all results for the specified latlng, then discards those results that do not match the specified location type(s). Note: This parameter is available only for requests that include an API key or a client ID.

Place Geocoding Request.

PlaceId (required). The place ID of the place for which you wish to obtain the human-readable address. The place ID is a unique identifier that can be used with other Google APIs. For example, you can use the placeID returned by the Google Maps Roads API to get the address for a snapped point. For more information about place IDs, see the place ID overview. The place ID may only be specified if the request includes an API key or a Google Maps APIs Premium Plan client ID.

Global Code. The global code part of a plus code.

Code.

Constructor.

The code.

Local Code And Locality. The local code part of a plus code, and a locality.

Code.

Locality.

Constructor.

The local code. The locality.

Location.

Constructor.

The .

Constructor.

The .

Plus Code Request.

The Address. The address to encode. This can be any of the following (if the ekey parameter is also provided): - A latitude/longitude - A street address - A global code - A local code and locality

language (optional) — The language in which to return results. See the supported list of domain languages. Note that we often update supported languages so this list may not be exhaustive. If language is not supplied, the geocoder will attempt to use the native language of the domain from which the request is sent wherever possible.

Email. Provide an email address that can be used to contact you.

Use Encrypted Key. The request will send the 'ekey' parameter instead of 'key'. See https://github.com/google/open-location-code/wiki/Plus-codes-API#securing-your-api-key

See .

The collection.

Locality.

Address.

Place Id.

Plus Code.

Global Code.

Local Code.

Best Street Address.

Locality.

Plus Code Response.

Plus Code.

The request body's cellTowers array contains zero or more cell tower objects.

Required. Unique identifier of the cell. On GSM, this is the Cell ID (CID); CDMA networks use the Base Station ID (BID). WCDMA networks use the UTRAN/GERAN Cell Identity (UC-Id), which is a 32-bit value concatenating the Radio Network Controller (RNC) and Cell ID. Specifying only the 16-bit Cell ID value in WCDMA networks may return inaccurate results.

Required. The Location Area Code (LAC) for GSM and WCDMAnetworks. The Network ID (NID) for CDMA networks.

Required. The cell tower's Mobile Country Code (MCC).

Required. The cell tower's Mobile Network Code. This is the MNC for GSM and WCDMA; CDMA uses the System ID (SID).

The number of milliseconds since this cell was primary. If age is 0, the cellId represents a current measurement.

Radio signal strength measured in dBm.

The timing advance value.

Radio Type.

Lte.

Gsm.

Cdma.

Wcdma.

Geolocation Request.

The carrier name.

The mobile country code (MCC) for the device's home network.

The mobile network code (MNC) for the device's home network.

The mobile radio type. Supported values are lte, gsm, cdma, and wcdma. While this field is optional, it should be included if a value is available, for more accurate results.

Specifies whether to fall back to IP geolocation if wifi and cell tower signals are not available. Note that the IP address in the request header may not be the IP of the device. Defaults to true. Set considerIp to false to disable fallback.

An array of cell tower objects. See .

An array of WiFi access point objects. See .

The request body's wifiAccessPoints array must contain two or more WiFi access point objects. MacAddress is required. All other fields are optional.

Required. The MAC address of the WiFi node. Separators must be : (colon).

The current signal strength measured in dBm.

The number of milliseconds since this access point was detected.

The channel over which the client is communicating with the access point.

The current signal to noise ratio measured in dB.

Geocoding Response.

The user’s estimated latitude and longitude, in degrees. Contains one lat and one lng subfield.

The accuracy of the estimated location, in meters. This represents the radius of a circle around the given location.

Error, if any occured.

Base abstract roads response.

A warning message about the result quality, typically populated if the input points were too sparse

An array of snapped points.

A list of errors which occurred.

Location (Roads only).

Latitude.

Longitude.

Default Constructor.

Contructor intializing a valid Location.

Overrdden ToString method for default conversion to Google compatible string.

Speed Units.

Miles per hour.

Kilometers per hour.

Error.

This is the same as the HTTP status of the response.

A short description of the error.

The status of the request. See .

Error details.

Error Detail.

The type of error.

Links associated with the errors.

Link.

Description of the link.

the url.

Snapped point.

Location — Contains a latitude and longitude value.

OriginalIndex — An integer that indicates the corresponding value in the original request. Each value in the request should map to a snapped value in the response. However, if you've set interpolate=true, then it's possible that the response will contain more coordinates than the request. Interpolated values will not have an originalIndex. These values are indexed from 0, so a point with an originalIndex of 4 will be the snapped value of the 5th latitude/longitude passed to the path parameter.

PlaceId — A unique identifier for a place. All place IDs returned by the Google Maps Roads API correspond to road segments. Place IDs can be used with other Google APIs, including the Google Places API and the Google Maps JavaScript API. For example, if you need to get road names for the snapped points returned by the Google Maps Roads API, you can pass the placeId to the Google Places API or the Google Maps Geocoding API. Within the Google Maps Roads API, you can pass the placeId to the speedLimit method to determine the speed limit along that road segment.

NearestRoads request.

points — A list of latitude/longitude pairs. Latitude and longitude values should be separated by commas. Coordinates should be separated by the pipe character: "|". For example: points=60.170880,24.942795|60.170879,24.942796|60.170877,24.942796.

NearestRoads Response.

SnapToRoads request.

path — The path to be snapped (required). The path parameter accepts a list of latitude/longitude pairs. Latitude and longitude values should be separated by commas. Coordinates should be separated by the pipe character: "|". For example: path=60.170880,24.942795|60.170879,24.942796|60.170877,24.942796.

Interpolate — Whether to interpolate a path to include all points forming the full road-geometry. When true, additional interpolated points will also be returned, resulting in a path that smoothly follows the geometry of the road, even around corners and through tunnels. Interpolated paths will most likely contain more points than the original path. Defaults to false.

SnapToRoads Response.

Speed limits request.

path — The path to be snapped (required or PlaceIds). The path parameter accepts a list of latitude/longitude pairs. Latitude and longitude values should be separated by commas. Coordinates should be separated by the pipe character: "|". For example: path=60.170880,24.942795|60.170879,24.942796|60.170877,24.942796.

placeId — The place ID of the road segment. Place IDs are returned by the snapToRoads method. You can pass up to 100 placeIds with each request.

units (optional) — Whether to return speed limits in kilometers or miles per hour. This can be set to either KPH or MPH. Defaults to KPH.

Speed Limit. Each element consists of the following fields.

SpeedLimit — The speed limit for that road segment.

units — Returns either KPH or MPH.

SpeedLimits Response.

SpeedLimits — A collection of road metadata.

Anchor Coordinate.

Constructor.

The x coordinate. The y coordinate.

Returns a string representation of a .

The string representation.

Anchor.

Top.

Bottom.

Left.

Right.

Center.

Top Left.

Top Right.

Bottom Left.

Bottom Right.

Image Format Extensions.

Gets the parameter name used for querying.

The . The parameter name.

Image Format.

Specifies the 8-bit PNG format (default).

specifies the 32-bit PNG format.

specifies the GIF format.

specifies the JPEG compression format.

specifies a non-progressive JPEG compression format.

Map Scale.

Normal (default).

Large. Twice has many pixels as normal.

Huge. Twice as many pixels as large. Only available to Google Maps APIs Premium Plan customers

Map Type. The Google Static Maps API creates maps in several formats, listed below.

roadmap (default) specifies a standard roadmap image, as is normally shown on the Google Maps website. If no maptype value is specified, the Google Static Maps API serves roadmap tiles by default.

Satellite specifies a satellite image.

Hybrid specifies a hybrid of the satellite and roadmap image, showing a transparent layer of major streets and place names on the satellite image.

Terrain specifies a physical relief map image, showing terrain and vegetation.

Specifies the size of marker from the set {tiny, mid, small}. If no size parameter is set, the marker will appear in its default (normal) size.

Normal (default).

Tiny.

Mid.

Small.

Elements are subdivisions of a feature. A road, for example, consists of the graphical line (the geometry) on the map, and also the text denoting its name (a label). The following elements are available, but note that a specific feature may support none, some, or all, of the elements:

selects all elements of the specified feature. (default)

selects all geometric elements of the specified feature.

selects only the fill of the feature's geometry.

selects only the stroke of the feature's geometry.

selects the textual labels associated with the specified feature.

selects only the icon displayed within the feature's label.

selects only the text of the label.

selects only the fill of the label. The fill of a label is typically rendered as a colored outline that surrounds the label text.

selects only the stroke of the label's text.

Features, or feature types, are geographic characteristics on the map, including roads, parks, bodies of water, businesses, and more. The features form a category tree, with all as the root.If you don't specify a feature, all features are selected. Specifying a feature of all has the same effect. Some features contain child features you specify using a dot notation.For example, landscape.natural or road.local. If you specify only the parent feature, such as road, the styles you specify for the parent apply to all its children, such as road.local and road.highway. Note that parent features may include some elements that are not included in all of their child features.

Selects all features.

selects all administrative areas. Styling affects only the labels of administrative areas, not the geographical borders or fill.

selects countries.

selects land parcels.

selects localities.

selects neighborhoods.

selects provinces.

selects all landscapes.

selects man-made features, such as buildings and other structures.

selects natural features, such as mountains, rivers, deserts, and glaciers.

selects land cover features, the physical material that covers the earth's surface, such as forests, grasslands, wetlands, and bare ground.

selects terrain features of a land surface, such as elevation, slope, and orientation.

selects all points of interest.

selects tourist attractions.

selects businesses.

selects government buildings.

selects emergency services, including hospitals, pharmacies, police, doctors, and others.

selects parks.

selects places of worship, including churches, temples, mosques, and others.

selects schools.

selects sports complexes.

selects all roads.

selects arterial roads.

selects highways.

selects highways with controlled access.

selects local roads.

selects all transit stations and lines.

selects transit lines.

selects all transit stations.

selects airports.

selects bus stops.

selects rail stations.

selects bodies of water.

Style Visibility.

On.

Off.

Simplified.

Represents a set of location markers to be drawn on a map with certain style properties.

Label (optional) specifies a single uppercase alphanumeric character from the set {A-Z, 0-9}. The requirement for uppercase characters is new to this version of the API. Note that default and mid sized markers are the only markers capable of displaying an alphanumeric-character parameter. Tiny and small markers are not capable of displaying an alphanumeric-character.

Color (optional). Specifies a color either as a 24-bit (example: color=0xFFFFCC) or 32-bit hexadecimal value (example: color=0xFFFFCCFF), or from the set {black, brown, green, purple, yellow, blue, gray, orange, red, white}. When a 32-bit hex value is specified, the last two characters specify the 8-bit alpha transparency value. This value varies between 00 (completely transparent) and FF (completely opaque). Note that transparencies are supported in paths, though they are not supported for markers.

Size: (optional) specifies the size of marker from the set {tiny, mid, small}. If no size parameter is set, the marker will appear in its default (normal) size.

Rather than use Google's marker icons, you are free to use your own custom icons instead. You can use up to five unique custom icons per request. This limitation does not mean that you are limited to only 5 marked locations on your map. Each unique icon may be used with more than one markers location on your map.

Each marker descriptor must contain a set of one or more locations defining where to place the marker on the map. These locations may be either specified as latitude/longitude values or as addresses. These locations are separated using the pipe character (|). The location parameters define the marker's location on the map. If the location is off the map, that marker will not appear in the constructed image provided that center and zoom parameters are supplied. However, if these parameters are not supplied, the Google Static Maps API server will automatically construct an image which contains the supplied markers.

Returns a string representation of a .

The string representation.

Map Marker Icon. Rather than use Google's marker icons, you are free to use your own custom icons instead.

Rather than use Google's marker icons, you are free to use your own custom icons instead. Custom icons are specified using the icon descriptor in the markers parameter. For example: markers=icon:URLofIcon|markerLocation. Specify the icon using a URL(which should be URL-encoded). You can use URLs created by URL-shortening services such as https://goo.gl. Most URL-shortening services have the advantage of automatically encoding URLs. You may specify an anchor point for the custom icon. Icon images may be in PNG, JPEG or GIF formats, though PNG is recommended. Icons may be up to 4096 pixels maximum size (64x64 for square images).

The anchor point sets how the icon is placed in relation to the specified markers locations. By default, the anchor point of a custom icon is the bottom center of the icon image. You can specify a different anchor point using the anchor descriptor in conjunction with your icon. Set the anchor as an x, y point of the icon (such as 10,5), or as a predefined alignment using one of the following values: top, bottom, left, right, center, topleft, topright, bottomleft, or bottomright.For example: markers= anchor:bottomright|icon:URLofIcon|markerLocation1|markerLocation2

Overrides , by a specific anchor coordinate.

Constructor.

The url

Returns a string representation of a .

The string representation.

Map Path. Defines a single path of two or more connected points to overlay on the image at specified locations.

Weight (optional) specifies the thickness of the path in pixels. If no weight parameter is set, the path will appear in its default thickness (5 pixels).

Geodesic: (optional) indicates that the requested path should be interpreted as a geodesic line that follows the curvature of the earth. When false, the path is rendered as a straight line in screen space. Defaults to false.

Color (optional) specifies a color either as a 24-bit (example: color=0xFFFFCC) or 32-bit hexadecimal value (example: color=0xFFFFCCFF), or from the set {black, brown, green, purple, yellow, blue, gray, orange, red, white}. When a 32-bit hex value is specified, the last two characters specify the 8-bit alpha transparency value. This value varies between 00 (completely transparent) and FF (completely opaque). Note that transparencies are supported in paths, though they are not supported for markers.

Fillcolor (optional) indicates both that the path marks off a polygonal area and specifies the fill color to use as an overlay within that area. The set of locations following need not be a "closed" loop; the Google Static Maps API server will automatically join the first and last points. Note, however, that any stroke on the exterior of the filled area will not be closed unless you specifically provide the same beginning and end location.

Gets or sets the collection of points for this path

Returns a string representation of a .

The string representation.

Customize the presentation of the standard Google map by applying your own styles when using the Google Static Maps API. You can change the visual display of features such as roads, parks, built-up areas, and other points of interest.Change their color or style to emphasize particular content, complement surrounding content on the page, or even hide features completely. Each style declaration may contain the following arguments, separated by pipe characters ("|"). https://developers.google.com/maps/documentation/static-maps/styling

Feature (optional) indicates the features to select for this style modification. Features include things on the map, like roads, parks, or other points of interest. If no features is present, the specified style applies to all features.

element(optional) indicates the element(s) of the specified feature to select for this style modification. Elements are characteristics of a feature, such as geometry or labels. If no element argument is present, the style applies to all elements of the specified feature.

A set of style rules (mandatory) to apply to the specified feature(s) and element(s). The API applies the rules in the order in which they appear in the style declaration. You can include any number of rules, within the normal URL-length constraints of the Google Static Maps API.

Returns a string representation of a .

The string representation.

Static Map Request. The Google Static Maps API lets you embed a Google Maps image on your web page without requiring JavaScript or any dynamic page loading. The Google Static Maps API service creates your map based on URL parameters sent through a standard HTTP request and returns the map as an image you can display on your web page.

center (required if markers not present) defines the center of the map, equidistant from all edges of the map. This parameter takes a location as either a comma-separated {latitude,longitude} pair (e.g. "40.714728,-73.998672") or a string address (e.g. "city hall, new york, ny") identifying a unique location on the face of the earth. For more information, see Locations below.

Zoom (required if markers not present) defines the zoom level of the map, which determines the magnification level of the map. This parameter takes a numerical value corresponding to the zoom level of the region desired. For more information, see zoom levels below. Maps on Google Maps have an integer 'zoom level' which defines the resolution of the current view. Zoom levels between 0 (the lowest zoom level, in which the entire world can be seen on one map) and 21+ (down to streets and individual buildings) are possible within the default roadmap view. Building outlines, where available, appear on the map around zoom level 17. This value differs from area to area and can change over time as the data evolves. Google Maps sets zoom level 0 to encompass the entire earth.Each succeeding zoom level doubles the precision in both horizontal and vertical dimensions. Note: not all zoom levels appear at all locations on the earth. Zoom levels vary depending on location, as data in some parts of the globe is more granular than in other locations. If you send a request for a zoom level at which no map tiles are available, the Google Static Maps API will return a map showing the maximum zoom level available at that location. The following list shows the approximate level of detail you can expect to see at each zoom level: - 1: World - 5: Landmass/continent - 10: City - 15: Streets - 20: Buildings

Size (required) defines the rectangular dimensions of the map image. This parameter takes a string of the form {horizontal_value}x{vertical_value}. For example, 500x400 defines a map 500 pixels wide by 400 pixels high. Maps smaller than 180 pixels in width will display a reduced-size Google logo. This parameter is affected by the scale parameter, described below; the final output size is the product of the size and scale values.

Defines the type of map to construct. There are several possible maptype values, including roadmap, satellite, hybrid, and terrain. (optional)

http://code.google.com/apis/maps/documentation/staticmaps/#MapTypes

Scale (optional) affects the number of pixels that are returned. scale=2 returns twice as many pixels as scale=1 while retaining the same coverage area and level of detail (i.e. the contents of the map don't change). This is useful when developing for high-resolution displays, or when generating a map for printing. The default value is 1. Accepted values are 2 and 4 (4 is only available to Google Maps APIs Premium Plan customers.) See Scale Values for more information: https://developers.google.com/maps/documentation/static-maps/intro#scale_values

Format (optional) defines the format of the resulting image. By default, the Google Static Maps API creates PNG images. There are several possible formats including GIF, JPEG and PNG types. Which format you use depends on how you intend to present the image. JPEG typically provides greater compression, while GIF and PNG provide greater detail. For more information, see Image Formats. greater compression, while GIF and PNG provide greater detail. (optional)

Language (optional) defines the language to use for display of labels on map tiles. Note that this parameter is only supported for some country tiles; if the specific language requested is not supported for the tile set, then the default language for that tileset will be used.

region (optional) defines the appropriate borders to display, based on geo-political sensitivities. Accepts a region code specified as a two-character ccTLD ('top-level domain') value

Paths (optional) defines a single path of two or more connected points to overlay on the image at specified locations. This parameter takes a string of point definitions separated by the pipe character (|), or an encoded polyline using the enc: prefix within the location declaration of the path. You may supply additional paths by adding additional path parameters. Note that if you supply a path for a map, you do not need to specify the (normally required) center and zoom parameters. For more information, see Google Static Maps API Paths below. https://developers.google.com/maps/documentation/static-maps/intro#Paths

Style (optional) defines a custom style to alter the presentation of specific features (roads, parks, and other features) of the map. This parameter takes features and element arguments identifying the features to style, and a set of style operations to apply to the selected features. You can supply multiple styles by adding additional style parameters. For more information, see the guide to styled maps.

Visibles (optional) specifies one or more locations that should remain visible on the map, though no markers or other indicators will be displayed. Use this parameter to ensure that certain features or map locations are shown on the Google Static Maps API.

Markers (optional) define one or more markers to attach to the image at specified locations. This parameter takes a single marker definition with parameters separated by the pipe character (|). Multiple markers may be placed within the same markers parameter as long as they exhibit the same style; you may add additional markers of differing styles by adding additional markers parameters. Note that if you supply markers for a map, you do not need to specify the (normally required) center and zoom parameters. For more information, see Google Static Maps API Markers below. https://developers.google.com/maps/documentation/static-maps/intro#Markers

Style rules are formatting options which are applied to the features and elements specified within each style declaration.

hue(an RGB hex string of format #RRGGBB) indicates the basic color. Note: This option sets the hue while keeping the saturation and lightness specified in the default Google style(or in other style options you define on the map). The resulting color is relative to the style of the base map. If Google makes any changes to the base map style, the changes affect your map's features styled with hue. It's better to use the absolute color styler if you can.

lightness(a floating point value between -100 and 100) indicates the percentage change in brightness of the element. Negative values increase darkness (where -100 specifies black) while positive values increase brightness(where +100 specifies white). Note: This option sets the lightness while keeping the saturation and hue specified in the default Google style(or in other style options you define on the map). The resulting color is relative to the style of the base map. If Google makes any changes to the base map style, the changes affect your map's features styled with lightness. It's better to use the absolute color styler if you can.

saturation(a floating point value between -100 and 100) indicates the percentage change in intensity of the basic color to apply to the element. Note: This option sets the saturation while keeping the hue and lightness specified in the default Google style(or in other style options you define on the map). The resulting color is relative to the style of the base map. If Google makes any changes to the base map style, the changes affect your map's features styled with saturation. It's better to use the absolute color styler if you can.

gamma(a floating point value between 0.01 and 10.0, where 1.0 applies no correction) indicates the amount of gamma correction to apply to the element. Gamma corrections modify the lightness of colors in a non-linear fashion, while not affecting white or black values.Gamma correction is typically used to modify the contrast of multiple elements. For example, you can modify the gamma to increase or decrease the contrast between the edges and interiors of elements. Note: This option adjusts the lightness relative to the default Google style, using a gamma curve. If Google makes any changes to the base map style, the changes affect your map's features styled with gamma. It's better to use the absolute color styler if you can.

invert_lightness(if true) inverts the existing lightness. This is useful, for example, for quickly switching to a darker map with white text. Note: This option simply inverts the default Google style. If Google makes any changes to the base map style, the changes affect your map's features styled with invert_lightness. It's better to use the absolute color styler if you can.

visibility(on, off, or simplified) indicates whether and how the element appears on the map. A simplified visibility removes some style features from the affected features; roads, for example, are simplified into thinner lines without outlines, while parks lose their label text but retain the label icon.

color(an RGB hex string of format #RRGGBB) sets the color of the feature. weight(an integer value, greater than or equal to zero) sets the weight of the feature, in pixels. Setting the weight to a high value may result in clipping near tile borders.

weight(an integer value, greater than or equal to zero) sets the weight of the feature, in pixels. Setting the weight to a high value may result in clipping near tile borders.

Returns a string representation of a .

The string representation.

Static Maps Response.

Source

default uses the default sources for Street View; searches are not limited to specific sources.

outdoor limits searches to outdoor collections. Indoor collections are not included in search results. Note that outdoor panoramas may not exist for the specified location. Also note that the search only returns panoramas where it's possible to determine whether they're indoors or outdoors. For example, PhotoSpheres are not returned because it's unknown whether they are indoors or outdoors.

Street View Request.

location can be either a text string (such as Chagrin Falls, OH) or a lat/lng value (40.457375,-80.009353). The Google Street View Image API will snap to the panorama photographed closest to this location. When an address text string is provided, the API may use a different camera location to better display the specified location. When a lat/lng is provided, the API searches a 50 meter radius for a photograph closest to this location. Because Street View imagery is periodically refreshed, and photographs may be taken from slightly different positions each time, it's possible that your location may snap to a different panorama when imagery is updated.

Pano is a specific panorama ID. These are generally stable Either Address, Location or Pano is required.

Size specifies the output size of the image in pixels. Required. Size is specified as {width}x{height} - for example, size=600x400 returns an image 600 pixels wide, and 400 high.

Pitch (default is 0) specifies the up or down angle of the camera relative to the Street View vehicle. This is often, but not always, flat horizontal. Positive values angle the camera up (with 90 degrees indicating straight up); negative values angle the camera down (with -90 indicating straight down).

Heading indicates the compass heading of the camera. Accepted values are from 0 to 360 (both values indicating North, with 90 indicating East, and 180 South). If no heading is specified, a value will be calculated that directs the camera towards the specified location, from the point at which the closest photograph was taken.

Fov (default is 90) determines the horizontal field of view of the image. The field of view is expressed in degrees, with a maximum allowed value of 120. When dealing with a fixed-size viewport, as with a Street View image of a set size, field of view in essence represents zoom, with smaller numbers indicating a higher level of zoom.

radius(default is 50) sets a radius, specified in meters, in which to search for a panorama, centered on the given latitude and longitude.Valid values are non-negative integers.

return_error_code indicates whether the API should return an error code when no image is found(404 NOT FOUND), or in response to an invalid request(400 BAD REQUEST). Valid values are true and false. If set to true, an error message is returned in place of the generic gray image. This eliminates the need to make a separate call to check for image availability.

source (default is default) limits Street View searches to selected sources. Valid values are

Street View Response.

TimeZone request.

A comma-separated lat,lng tuple (eg. location=-33.86,151.20), representing the location to look up

Timestamp specifies the desired time as seconds since midnight, January 1, 1970 UTC. The Time Zone API uses the timestamp to determine whether or not Daylight Savings should be applied. Times before 1970 can be expressed as negative values.

The language in which to return results. See the list of supported domain languages. Note that we often update supported languages so this list may not be exhaustive. Defaults to en.

TimeZone Response.

DstOffset: the offset for daylight-savings time in seconds. This will be zero if the time zone is not in Daylight Savings Time during the specified timestamp.

RawOffset: the offset from UTC (in seconds) for the given location. This does not take into effect daylight savings.

TimeZoneId: a string containing the ID of the time zone, such as "America/Los_Angeles" or "Australia/Sydney".

TimeZoneName: a string containing the long form name of the time zone. This field will be localized if the language parameter is set. eg. "Pacific Daylight Time" or "Australian.

You may restrict results from a Place Autocomplete request to be of a certain type by passing a types parameter. The parameter specifies a type or a type collection, as listed in the supported types below. If nothing is specified, all types are returned. In general only a single type is allowed. The exception is that you can safely mix the geocode and establishment types, but note that this will have the same effect as specifying no types. https://developers.google.com/places/supported_types#table3

Address instructs the Place Autocomplete service to return only geocoding results with a precise address. Generally, you use this request when you know the user will be looking for a fully specified address.

Establishment instructs the Place Autocomplete service to return only business results.

The (regions) type collection instructs the Places service to return any result matching the following types: locality, sublocality, postal_code, country, administrative_area_level_1, administrative_area_level_2

The (cities) type collection instructs the Places service to return results that match locality or administrative_area_level_3.

The Google Places API is a service that returns information about a "place" (hereafter referred to as a Place) — defined within this API as an establishment, a geographic location, or prominent point of interest — using an HTTP request. Place requests specify locations as latitude/longitude coordinates. Two basic Place requests are available: a Place Search request and a Place Details request. Generally, a Place Search request is used to return candidate matches, while a Place Details request returns more specific information about a Place. This service is designed for processing place requests generated by a user for placement of application content on a map; this service is not designed to respond to batch of offline queries, which are a violation of its terms of use.

Base Url.

The text string on which to search. The Place service will return candidate matches based on this string and order results based on their perceived relevance.

The character position in the input term at which the service uses text for predictions. For example, if the input is 'Googl' and the completion point is 3, the service will match on 'Goo'. The offset should generally be set to the position of the text caret. If no offset is supplied, the service will use the entire term.

Place Autocomplete can use session tokens to group together autocomplete requests for billing purposes. A session consists of the activities required to resolve user input to a place. When a session token is passed (using the optional sessiontoken parameter), autocompleterequests are not billed independently, but are instead billed once after a full autocompleteresult is returned. If the sessiontoken parameter is omitted, each request is billed independently. See the pricing sheet for details.

The point around which you wish to retrieve Place information.

The origin point from which to calculate straight-line distance to the destination (returned as distance_meters). If this value is omitted, straight-line distance will not be returned. Must be specified as latitude,longitude.

The distance (in meters) within which to return Place results. Note that setting a radius biases results to the indicated area, but may not fully restrict results to the specified area. See Location Biasing below.

Strictbounds. Returns only those places that are strictly within the region defined by location and radius. This is a restriction, rather than a bias, meaning that results outside this region will not be returned even if they match the user input.

The language in which to return results. See the supported list of domain languages. Note that we often update supported languages so this list may not be exhaustive. If language is not supplied, the Place service will attempt to use the native language of the domain from which the request is sent.

The types of Place results to return. See Place Types below. If no type is specified, all types will be returned. https://developers.google.com/places/supported_types#table3

The component filters, separated by a pipe (|). Each component filter consists of a component:value pair and will fully restrict the results from the geocoder. For more information see Component Filtering.

When the Places service returns JSON results from a search, it places them within a predictions array.

Contains an array of predictions, with information about the prediction.

Base abstract class for Places requests.

Base Url.

See .

The collection.

Base abstract class for places responses.

Alternative Place.

PlaceId — The most likely reason for a place to have an alternative place ID is if your application adds a place and receives an application-scoped place ID, then later receives a Google-scoped place ID after passing the moderation process.

Scope — Indicates the scope of the Alternative PlaceId. The scope of an alternative place ID will always be APP, indicating that the alternative place ID is recognised by your application only.

Specifies the order in which results are listed for place searches.

Free.

Inexpensive.

Moderate.

Expensive.

Very Expensive.

Scope.

The place ID is recognised by your application only. This is because your application added the place, and the place has not yet passed the moderation process.

The place ID is available to other applications and on Google Maps

The location of the entered term in the prediction result text, so that the term can be highlighted if desired.

Offset.

Length.

Opening Hours.

OpenNow is a boolean value indicating if the Place is open at the current time.

periods[] is an array of opening periods covering seven days, starting from Sunday, in chronological order.

WeekdayTexts is an array of seven strings representing the formatted opening hours for each day of the week. If a language parameter was specified in the Place Details request, the Places Service will format and localize the opening hours appropriately for that language. The ordering of the elements in this array depends on the language parameter. Some languages start the week on Monday while others start on Sunday.

Photo.

PhotoReference — a string used to identify the photo when you perform a Photo request.

Height — the maximum height of the image.

Width — the maximum width of the image.

HtmlAttributions — contains any required attributions. This field will always be present, but may be empty.

Prediction.

PlaceId is a textual identifier that uniquely identifies a place. To retrieve information about the place, pass this identifier in the placeId field of a Google Places API Web Service request

Description contains the human-readable name for the returned result. For establishment results, this is usually the business name.

Structured formatting.

Terms contains an array of terms identifying each section of the returned description (a section of the description is generally terminated with a comma). Each entry in the array has a value field, containing the text of the term, and an offset field, defining the start position of this term in the description, measured in Unicode characters.

Types is an array indicating the type of the prediction.

MatchedSubstring contains an offset value and a length. These describe the location of the entered term in the prediction result text, so that the term can be highlighted if desired.

Structured formatting.

Main text. Contains the main text of a prediction, usually the name of the place.

Main text matched substrings. Contains an array with offset value and length. These describe the location of the entered term in the prediction result text, so that the term can be highlighted if desired.

Secondary text. Contains the secondary text of a prediction, usually the location of the place.

Secondary text matched substrings.

Term.

Containing the text of the term.

Defining the start position of this term in the description, measured in Unicode characters.

Extensions.

None.

Includes a rich and concise review curated by Google's editorial staff.

Field Types.

Address Component (billing: basic).

Adr Address (billing: basic).

Formatted Address (billing: basic).

Geometry (billing: basic).

Icon (billing: basic).

Id (billing: basic).

Name (billing: basic).

Photo (billing: basic).

Place_Id (billing: basic).

Plus_Code (billing: basic).

Type (billing: basic).

Url (billing: basic).

Utc Offset (billing: basic).

Vicinity (billing: basic).

Formatted Phone Number (billing: contact).

International Phone Number (billing: contact).

Opening Hours (billing: contact).

Website (billing: contact).

Price Level (billing: atmosphere)

Rating (billing: atmosphere).

Review (billing: atmosphere).

User Ratings Total (billing: atmosphere).

Business Status.

Basic (all).

Contact (all).

Atmosphere (all).

Places Details Request.

Base Url.

A textual identifier that uniquely identifies a place, returned from a Place Search.

The region code, specified as a ccTLD ("top-level domain") two-character value. Most ccTLD codes are identical to ISO 3166-1 codes, with some notable exceptions. For example, the United Kingdom's ccTLD is "uk" (.co.uk) while its ISO 3166-1 code is "gb" (technically for the entity of "The United Kingdom of Great Britain and Northern Ireland").

A random string which identifies an autocomplete session for billing purposes. The session begins when the user starts typing a query, and concludes when they select a place and a call to Place Details is made.Each session can have multiple queries, followed by one place selection.The API key(s) used for each request within a session must belong to the same Google Cloud Console project. Once a session has concluded, the token is no longer valid; your app must generate a fresh token for each session. If the sessiontoken parameter is omitted, or if you reuse a session token, the session is charged as if no session token was provided (each request is billed separately).

Language (optional) — The language code, indicating in which language the results should be returned, if possible. See the list of supported languages and their codes: https://developers.google.com/maps/faq#languagesupport Note that we often update supported languages so this list may not be exhaustive.

Fields (optional). Defaults to 'Basic'. One or more fields, specifying the types of place data to return, separated by a comma. Fields correspond to Place Details results, and are divided into three billing categories: Basic, Contact, and Atmosphere. Basic fields are billed at base rate, and incur no additional charges.Contact and Atmosphere fields are billed at a higher rate. See the pricing sheet for more information. Attributions (html_attributions) are always returned with every call, regardless of whether it has been requested.

Aspect.

Aspects contains a collection of AspectRating objects, each of which provides a rating of a single attribute of the establishment. The first object in the collection is considered the primary aspect. Each AspectRating is described as:

Aspect Rating.

Type the name of the aspect that is being rated. E.g. atmosphere, service, food, overall, etc.

Rating the user's rating for this particular aspect, from 0 to 3.

DayTime.

Day a number from 0–6, corresponding to the days of the week, starting on Sunday. For example, 2 means Tuesday.

Time may contain a time of day in 24-hour hhmm format (values are in the range 0000–2359). The time will be reported in the Place’s timezone

Details Result.

address_components[] is an array of separate address components used to compose a given address. For example, the address "111 8th Avenue, New York, NY" contains separate address components for "111" (the street number, "8th Avenue" (the route), "New York" (the city) and "NY" (the US state). Each address_component typically contains: ◦types[] is an array indicating the type of the address component.

Formatted_address is a string containing the human-readable address of this place. Often this address is equivalent to the "postal address," which sometimes differs from country to country. This address is generally composed of one or more address_component fields.

formatted_phone_number contains the Place's phone number in its local format. For example, the formatted_phone_number for Google's Sydney, Australia office is (02) 9374 4000.

adr_address is a representation of the place's address in the adr microformat. http://microformats.org/wiki/adr

Geometry contains a location.

icon contains the URL of a suggested icon which may be displayed to the user when indicating this result on a map

international_phone_number contains the Place's phone number in international format. International format includes the country code, and is prefixed with the plus (+) sign. For example, the formatted_phone_number for Google's Sydney, Australia office is +61 2 9374 4000.

name contains the human-readable name for the returned result. For establishment results, this is usually the canonicalized business name.

opening_hours may contain information about the place opening hours.

A textual identifier that uniquely identifies a place. To retrieve information about the place, pass this identifier in the placeId field of a Places API request

An array of photo objects, each containing a reference to an image. A Place Details request may return up to ten photos.

price_level — The price level of the place, on a scale of 0 to 4. The exact amount indicated by a specific value will vary from region to region. Price levels are interpreted as follows:

Business Status.

rating contains the Place's rating, from 0.0 to 5.0, based on user reviews. For more granular ratings, inspect the contents of the aspects collection.

The total number of user ratings.

Reviews, array of up to five reviews. If a language parameter was specified in the Place Details request, the Places Service will bias the results to prefer reviews written in that language.

Types contains an array of feature types describing the given result. See the list of supported types for more information. XML responses include multiple type elements if more than one type is assigned to the result.

Url contains the official Google Place Page URL of this establishment. Applications must link to or embed the Google Place page on any screen that shows detailed results about this Place to the user.

Vicinity lists a simplified address for the Place, including the street name, street number, and locality, but not the province/state, postal code, or country. For example, Google's Sydney, Australia office has a vicinity value of 48 Pirrama Road, Pyrmont.

UtcOffset contains the number of minutes this Place’s current timezone is offset from UTC. For example, for Places in Sydney, Australia during daylight saving time this would be 660 (+11 hours from UTC), and for Places in California outside of daylight saving time this would be -480 (-8 hours from UTC).

Website lists the authoritative website for this Place, such as a business' homepage.

Period.

Open contains a pair of day and time objects describing when the Place opens.

Open contains a pair of day and time objects describing when the Place closes.

Places Details Response.

Results contains an array of places, with information about the place. See Place Search Results for information about these results. The Places API returns up to 20 establishment results. Additionally, political results may be returned which serve to identify the area of the request.

Review.

aspects contains a collection of AspectRating objects, each of which provides a rating of a single attribute of the establishment. The first object in the collection is considered the primary aspect.

author_name the name of the user who submitted the review. Anonymous reviews are attributed to "A Google user".

author_url the URL to the users Google+ profile, if available.

Language an IETF language code indicating the language used in the user's review. This field contains the main language tag only, and not the secondary tag indicating country or region. For example, all the English reviews are tagged as 'en', and not 'en-AU' or 'en-UK' and so on.

Rating the user's overall rating for this place. This is a whole number, ranging from 1 to 5.

Text contains the user's review. When reviewing a location with Google Places, text reviews are considered optional; therefore, this field may by empty.

The url to the photo.

The relative time, in human language description.

Time the time that the review was submitted, measured in the number of seconds since since midnight, January 1, 1970 UTC.

Places Photos Request.

Base Url.

maxwidth — Specifies the maximum desired width, in pixels, of the image returned by the Place Photos service. If the image is smaller than the values specified, the original image will be returned. If the image is larger in either dimension, it will be scaled to match the smaller of the two dimensions, restricted to its original aspect ratio. Both the maxwidth properties accept an integer between 1 and 1600.

maxheight — Specifies the maximum desired height, in pixels, of the image returned by the Place Photos service. If the image is smaller than the values specified, the original image will be returned. If the image is larger in either dimension, it will be scaled to match the smaller of the two dimensions, restricted to its original aspect ratio. Both the maxheight properties accept an integer between 1 and 1600.

photoreference (required) — A string identifier that uniquely identifies a photo. Photo references are returned from either a Place Search or Place Details request.

Places Photos Response.

Places QueryAutoComplete Request.

Base Url.

The text string on which to search. The Place service will return candidate matches based on this string and order results based on their perceived relevance.

The point around which you wish to retrieve Place information. Must be specified as latitude,longitude.

Places QueryAutoComplete Response.

Contains an array of predictions, with information about the prediction.

BasePlace Result.

Icon contains the URL of a recommended icon which may be displayed to the user when indicating this result.

Geometry contains geometry information about the result, generally including the location (geocode) of the place and (optionally) the viewport identifying its general area of coverage.

Name contains the human-readable name for the returned result. For establishment results, this is usually the business name.

OpeningHours may contain the following information:

Photos — an array of photo objects, each containing a reference to an image. A Place Search will return at most one photo object. Performing a Place Details request on the place may return up to ten photos. More information about Place Photos and how you can use the images in your application can be found in the Place Photos documentation.

PlaceId — a textual identifier that uniquely identifies a place. To retrieve information about the place, pass this identifier in the placeId field of a Places API request. For more information about place IDs, see the place ID overview.

Scope — Indicates the scope of the placeId. Note: The scope field is included only in Nearby Search results and Place Details results. You can only retrieve app-scoped places via the Nearby Search and the Place Details requests. If the scope field is not present in a response, it is safe to assume the scope is GOOGLE

AlternativePlaceIds — An array of zero, one or more alternative place IDs for the place, with a scope related to each alternative ID. Note: This array may be empty or not present.

price_level — The price level of the place, on a scale of 0 to 4. The exact amount indicated by a specific value will vary from region to region.

Business Status.

Rating contains the place's rating, from 1.0 to 5.0, based on aggregated user reviews.

The total number of user ratings.

Place Types https://developers.google.com/places/supported_types#table1

Accounting.

Airport.

Amusement Park.

Aquarium.

Art Gallery.

Atm.

Bakery.

Bank.

Bar.

Beauty Salon.

Bicycle Store.

Book Store.

Bowling Alley.

Bus Station.

Cafe.

Campground.

Car Dealer.

Car Rental.

Car Repair.

Car Wash.

Casino.

Cemetery.

Church.

City Hall.

Clothing Store.

Convenience Store.

Courthouse.

Dentist.

Department Store.

Doctor.

Embassy.

Electrician

Electronics Store.

Fire Station.

Florist.

Funeral Home.

Furniture Store.

Gas Station.

Gym.

Hair Care.

Hardware Store.

Hindu Temple.

Home Goods Store.

Hospital.

Insurance Agency.

Jewelry Store.

Laundry.

Lawyer.

Library.

Liquor Store.

Local Government Office.

Locksmith

Lodging.

Meal Delivery.

Meal Takeaway.

Mosque.

Movie Rental.

Movie Theater.

Moving Company.

Museum.

Night Club.

Painter.

Park.

Parking.

Pet Store.

Pharmacy.

Physiotherapist.

Plumber.

Police.

Post Office.

Primary School.

Real Estate Agency.

Restaurant.

Roofing Contractor.

Rv Park.

School.

Secondary School.

Shoe Store.

Shopping Mall.

Spa.

Stadium.

Storage.

Store.

Subway Station.

Synagogue.

Taxi Stand.

Train Station.

Travel Agency.

University.

Veterinary Care.

Zoo.

Opening Hours.

OpenNow is a boolean value indicating if the place is open at the current time.

Field Types.

Formatted Address (billing: basic).

Geometry (billing: basic).

Icon (billing: basic).

Name (billing: basic).

Photos (billing: basic).

Place_Id (billing: basic).

Plus_Code (billing: basic).

Types (billing: basic).

Opening Hours (billing: contact).

Price Level (billing: atmosphere)

Rating (billing: atmosphere).

User Ratings Total (billing: atmosphere).

Business Status.

Basic (all).

Contact (all).

Atmosphere (all).

Input Type.

Text Query.

Phone Number.

Places Find Search Request.

Base Url.

Input. The text input specifying which place to search for (for example, a name, address, or phone number)

Type. The type of input.This can be one of either textquery or phonenumber.

Language (optional). The language code, indicating in which language the results should be returned, if possible. Searches are also biased to the selected language; results in the selected language may be given a higher ranking. See the list of supported languages and their codes: https://developers.google.com/maps/faq#languagesupport Note that we often update supported languages so this list may not be exhaustive.

Fields (optional). Defaults to 'place_id'. The fields specifying the types of place data to return, separated by a comma. Note, if you omit the fields parameter from a Find Place request, only the place_id for the result will be returned.

Radius (optional). Defines the radius of cirkular location bias. Ignored if is null.

Bounds (optional). Sets the bias to the defined bounds. 'rectangle:south, west|north, east.' Note that east/west values are wrapped to the range -180, 180, and north/south values are clamped to the range -90, 90. Ignored if is not null.

Location (optional). The results are biased based on th location (point). If is specified as well, the bias is a circle having the center on the location and the radius in size. - A single lat/lng coordinate.Use the following format: 'point:lat, lng' - Circular: A string specifying radius in meters, plus lat/lng in decimal degrees. Format: 'circle:radius @lat, lng.'

Candidate.

Name contains the human-readable name for the returned result. For establishment results, this is usually the canonicalized business name.

icon contains the URL of a suggested icon which may be displayed to the user when indicating this result on a map

A textual identifier that uniquely identifies a place.

FormatedAddress is a string containing the human-readable address of this place. Often this address is equivalent to the "postal address". The formatted_address property is only returned for a Text Search.

Geometry contains a location.

opening_hours may contain information about the place opening hours.

Business Status.

Rating the user's overall rating for this place. This is a whole number, ranging from 1 to 5.

The total number of user ratings.

Photos. An array of photo objects, each containing a reference to an image. A Place Details request may return up to ten photos.

An array of types for this place

Places Find Search Response.

Candidates.

Specifies the order in which results are listed for place searches.

This option sorts results based on their importance. Ranking will favor prominent places within the specified area. Prominence can be affected by a place's ranking in Google's index, global popularity, and other factors.

This option biases search results in ascending order by their distance from the specified location. When distance is specified, one or more of keyword, name, or types is required

Places NearBySearch Request.

Base Url.

name — One or more terms to be matched against the names of places, separated with a space character. Results will be restricted to those containing the passed name values. Note that a place may have additional names associated with it, beyond its listed name. The API will try to match the passed name value against all of these names. As a result, places may be returned in the results whose listed names do not match the search term, but whose associated names do.

keyword — A term to be matched against all content that Google has indexed for this place, including but not limited to name, type, and address, as well as customer reviews and other third-party content.

rankby — Specifies the order in which results are listed. Possible values are: - prominence (default). This option sorts results based on their importance. Ranking will favor prominent places within the specified area. - Prominence, can be affected by a place's ranking in Google's index, global popularity, and other factors. - Distance. This option biases search results in ascending order by their distance from the specified location. When distance is specified, one or more of keyword, name, or types is required. If rankby=distance is specified, then one or more of keyword, name, or types is required.

opennow (optional). Returns only those places that are open for business at the time the query is sent. Places that do not specify opening hours in the Google Places database will not be returned if you include this parameter in your query.

(optional) The language in which to return results. See the supported list of domain languages. Note that we often update supported languages so this list may not be exhaustive. If language is not supplied, the Place service will attempt to use the native language of the domain from which the request is sent.

Minprice (optional). Restricts results to only those places within the specified range. Valid values range between 0 (most affordable) to 4 (most expensive), inclusive. The exact amount indicated by a specific value will vary from region to region.

Maxprice (optional). Restricts results to only those places within the specified range. Valid values range between 0 (most affordable) to 4 (most expensive), inclusive. The exact amount indicated by a specific value will vary from region to region.

Type (optional). Restricts the results to places matching the specified type. Only one type may be specified (if more than one type is provided, all types following the first entry are ignored).

Location (optional). The latitude/longitude around which to retrieve place information. If you specify a location parameter, you must also specify a radius parameter.

Radius (Radius). Defines the distance (in meters) within which to bias place results. The maximum allowed radius is 50 000 meters. Results inside of this region will be ranked higher than results outside of the search circle; however, prominent results from outside of the search radius may be included

pagetoken — Returns the next 20 results from a previously run search. Setting a pagetoken parameter will execute a search with the same parameters used previously — all parameters other than pagetoken will be ignored.

NearBy Result.

Vicinity contains a feature name of a nearby location. Often this feature refers to a street or neighborhood within the given results. The vicinity property is only returned for a Nearby Search.

Places NearbySearch Response.

Contains an array of places, with information about each. See Search Results for information about these results. The Places API returns up to 20 establishment results per query. Additionally, political results may be returned which serve to identify the area of the request.

Contains a token that can be used to return up to 20 additional results. A next_page_token will not be returned if there are no additional results to display. The maximum number of results that can be returned is 60. There is a short delay between when a next_page_token is issued, and when it will become valid.

Places TextSearch Request.

Base Url.

Query — The text string on which to search, for example: "restaurant". The Google Places service will return candidate matches based on this string and order the results based on their perceived relevance.

Type (optional). Restricts the results to places matching the specified type. Only one type may be specified (if more than one type is provided, all types following the first entry are ignored).

Location (optional). The latitude/longitude around which to retrieve place information. If you specify a location parameter, you must also specify a radius parameter.

Places TextSearch Response.

Results.

Text Result.

FormattedAddress is a string containing the human-readable address of this place. Often this address is equivalent to the "postal address". The formatted_address property is only returned for a Text Search.

Base abstract class for Search requests.

BaseUrl property overriden.

Alt - Data format for the response. (only json supported) Valid values: json, atom Default value: json

Allowed values are web or image. If unspecified, results are limited to webpages.

Required. Use the q query parameter to specify your search expression.

Callback function. Name of the JavaScript callback function that handles the response. Used in JavaScript JSON-P requests

fields - Selector specifying a subset of fields to include in the response. For more information, see the partial response section in the Performance Tips document. Use for better performance. https://developers.google.com/custom-search/json-api/v1/performance#partial

PrettyPrint - Returns response with indentations and line breaks. Returns the response in a human-readable format if true. Default value: true. When this is false, it can reduce the response payload size, which might lead to better performance in some environments.

userIp IP address of the end user for whom the API call is being made. Lets you enforce per-user quotas when calling the API from a server-side application. Learn more about Capping API usage. https://support.google.com/cloud/answer/7035610

quotaUser Alternative to userIp. Lets you enforce per-user quotas from a server-side application even in cases when the user's IP address is unknown. This can occur, for example, with applications that run cron jobs on App Engine on a user's behalf. You can choose any arbitrary string that uniquely identifies a user, but it is limited to 40 characters. Overrides userIp if both are provided. Learn more about Capping API usage. https://support.google.com/cloud/answer/7035610

See .

The collection.

Base abstract class for Search responses.

Unique identifier for the type of current object. For this API, it is customsearch#search.

The OpenSearch URL element that defines the template for this API.

Metadata about the particular search engine that was used for performing the search query.

Encapsulates a corrected query.

Encapsulates all information about the search.

The current set of search results.

The set of promotions. Present only if the custom search engine's configuration files define any promotions for the given query. https://developers.google.com/custom-search/docs/promotions.

Contains about the executed request.

Contains about the next page of the executed request.

Contains about the previous page of the executed request.

Contains one or more sets of query metadata, keyed by role name. The possible role names are defined by the OpenSearch query roles and by two custom roles: nextPage and previousPage. http://www.opensearch.org/Specifications/OpenSearch/1.1#OpenSearch_Query_element

Body line.

The block object's text, if it has text.

The block object's html text, if it has text.

The anchor text of the block object's link, if it has a link.

The URL of the block object's link, if it has one

Metadata about the particular search engine that was used for performing the search query.

The name of the search engine that was used for the query.

A set of facet objects (refinements) you can use for refining a search. https://developers.google.com/custom-search/docs/refinements#create

Date Restrict Json Converter. Converter for .

Sort Expression Json Converter. Converter for .

Restricts search results to documents originating in a particular country.

The expresssions of the country restriction.

Converts the to a , compatible with the format used by Google search country restriction request.

A .

An expression that is part of a or nested expression associated with another object.

The NOT operator (.) removes all results that are in the collection immediately following the minus("-") operator. This example removes all results that are originating from France: Example: cr= -countryFR

The to restrict in the search.

The to apply after this expression and before the next. If this expression is the last of nested expressions, the operator will be placed outside the ending perenthese. if this is the last expression the will be ignored. Default is .

Nested , that expressions will be appended inside parantheses after this .

Converts the to a , compatible with the format used by Google search country restriction request.

A .

Date Restrict.

Type - Restricts results to URLs based on date.

Number - Requests results from the specified number of past days, weeks, months or years.

Returns the to .

The object as .

Converts a into a .

The formatted as a valid . The converted

Data format for the response.

Json format.

Atom format.

Color Type

Color.

Grayscale.

Black and white.

Country.

Afghanistan

Albania

Algeria

American Samoa

Andorra

Angola

Anguilla

Antarctica

Antigua and Barbuda

Argentina

Armenia

Aruba

Australia

Austria

Azerbaijan

Bahamas

Bahrain

Bangladesh

Barbados

Belarus

Belgium

Belize

Benin

Bermuda

Bhutan

Bolivia

Bosnia and Herzegovina

Botswana

Bouvet Island

Brazil

British Indian Ocean Territory

Brunei Darussalam

Bulgaria

Burkina Faso

Burundi

Cambodia

Cameroon

Canada

Cape Verde

Cayman Islands

Central African Republic

Chad

Chile

China

Christmas Island

Cocos (Keeling) Islands

Colombia

Comoros

Congo

Congo, the Democratic Republic of the

Cook Islands

Costa Rica

Cote D'ivoire

Croatia (Hrvatska)

Cuba

Cyprus

Czech Republic

Denmark

Djibouti

Dominica

Dominican Republic

East Timor

Ecuador

Egypt

El Salvador

Equatorial Guinea

Eritrea

Estonia

Ethiopia

European Union

Falkland Islands (Malvinas)

Faroe Islands

Fiji

Finland

France

France, Metropolitan

French Guiana

French Polynesia

French Southern Territories

Gabon

Gambia

Georgia

Germany

Ghana

Gibraltar

Greece

Greenland

Grenada

Guadeloupe

Guam

Guatemala

Guinea

Guinea-Bissau

Guyana

Haiti

Heard Island and Mcdonald Islands

Holy See (Vatican City State)

Honduras

Hong Kong

Hungary

Iceland

India

Indonesia

Iran, Islamic Republic of

Iraq

Ireland

Israel

Italy

Jamaica

Japan

Jordan

Kazakhstan

Kenya

Kiribati

Korea, Democratic People's Republic of

Korea, Republic of

Kuwait

Kyrgyzstan

Lao People's Democratic Republic

Latvia

Lebanon

Lesotho

Liberia

Libyan Arab Jamahiriya

Liechtenstein

Lithuania

Luxembourg

Macao

Macedonia, the Former Yugosalv Republic of

Madagascar

Malawi

Malaysia

Maldives

Mali

Malta

Marshall Islands

Martinique

Mauritania

Mauritius

Mayotte

Mexico

Micronesia, Federated States of

Moldova, Republic of

Monaco

Mongolia

Montserrat

Morocco

Mozambique

Myanmar

Namibia

Nauru

Nepal

Netherlands

Netherlands Antilles

New Caledonia

New Zealand

Nicaragua

Niger

Nigeria

Niue

Norfolk Island

Northern Mariana Islands

Norway

Oman

Pakistan

Palau

Palestinian Territory

Panama

Papua New Guinea

Paraguay

Peru

Philippines

Pitcairn

Poland

Portugal

Puerto Rico

Qatar

Reunion

Romania

Russian Federation

Rwanda

Saint Helena

Saint Kitts and Nevis

Saint Lucia

Saint Pierre and Miquelon

Saint Vincent and the Grenadines

Samoa

San Marino

Sao Tome and Principe

Saudi Arabia

Senegal

Serbia and Montenegro

Seychelles

Sierra Leone

Singapore

Slovakia

Slovenia

Solomon Islands

Somalia

South Africa

South Georgia and the South Sandwich Islands

Spain

Sri Lanka

Sudan

Suriname

Svalbard and Jan Mayen

Swaziland

Sweden

Switzerland

Syrian Arab Republic

Taiwan, Province of China

Tajikistan

Tanzania, United Republic of

Thailand

Togo

Tokelau

Tonga

Trinidad and Tobago

Tunisia

Turkey

Turkmenistan

Turks and Caicos Islands

Tuvalu

Uganda

Ukraine

United Arab Emirates

United Kingdom

United States

United States Minor Outlying Islands

Uruguay

Uzbekistan

Vanuatu

Venezuela

Vietnam

Virgin Islands, British

Virgin Islands, U.S.

Wallis and Futuna

Western Sahara

Yemen

Yugoslavia

Zambia

Zimbabwe

Date restriction type.

Days restriction.

Weeks restriction.

Months restriction.

Years restriction.

Color Type

Black.

Blue.

Brown.

Gray.

Green.

Purple.

Teal.

White.

Yellow.

Encoding Types.

Unicode(UTF-8)

Arabic(Windows-1256)

Central European Latin-2 (ISO-8859-2)

Central European(Windows-1250)

Central European(CP852)

Chinese Simplified(GB2312)

Chinese Simplified(GB18030)

Chinese Traditional(Big5)

Cyrillic(ISO-8859-5)

Cyrillic(KOI8-R)

Cyrillic(Windows-1251)

Cyrillic/Russian(CP-866)

Greek(ISO-8859-7)

Hebrew(ISO-8859-8-I)

Hebrew(Windows-1255)

Japanese(Shift_JIS)

Japanese(EUC-JP)

Japanese(ISO-2022-JP)

Korean(EUC-KR)

Nordic Latin-6 (ISO-8859-10)

South European Latin-3 (ISO-8859-3)

Turkish Latin-5 (ISO-8859-9)

Turkish(Windows-1254)

Vietnamese(Windows-1258)

West European Latin-1 (ISO-8859-1)

West European Latin-9 (ISO-8859-15)

Country Extension methods.

Returns the Country restriction.

The . The representation of the as 'cr' request parameter.

Date Restrict Type Extension.

Converts enum value to string.

The enum to convert. The string representation of the enum value for the search request.

Encoding type Extension methods.

Returns the encoding type code.

The . Encoded name as string.

Country Extension methods.

Return the GeoLocation code.

The . The representation of the as 'gl' request parameter.

Language Extension methods.

Return the Language code.

Determines whether the supports safe search filter.

The . Boolean, indicating if the passed supports safe search filter.

Operator extensions.

Converts an to a for a country restriction expression.

The to convert. The representation of the .

Site Search Filter Extension.

Converts enum value to string.

The enum to convert. The string representation of the enum value for the search request.

File Types. https://support.google.com/webmasters/answer/35287?hl=en

Unknown.

Adobe Flash (.swf)

Adobe Portable Document Format (.pdf)

Adobe PostScript (.ps)

Autodesk Design Web Format (.dwf)

Google Earth (.kml, .kmz, .gpx)

Hancom Hanword (.hwp)

HTML (.htm, .html, other file extensions)

Microsoft Excel (.xls, .xlsx)

Microsoft PowerPoint (.ppt, .pptx)

Microsoft Word (.doc, .docx)

OpenOffice presentation (.odp)

OpenOffice Spreadsheet (.ods)

OpenOffice Text (.odt)

Rich Text Format (.rtf)

Scalable Vector Graphics (.svg)

TeX/LaTeX (.tex)

Text (.txt, .text, other file extensions), including source code in common programming languages:

Basic source code (.bas)

C/C++ source code (.c, .cc, .cpp, .cxx, .h, .hpp)

C# source code (.cs)

Java source code (.java)

Perl source code (.pl)

Python source code (.py)

Wireless Markup Language (.wml, .wap)

XML (.xml)

GeoLocation.

Afghanistan

Albania

Algeria

American Samoa

Andorra

Angola

Anguilla

Antarctica

Antigua and Barbuda

Argentina

Armenia

Aruba

Australia

Austria

Azerbaijan

Bahamas

Bahrain

Bangladesh

Barbados

Belarus

Belgium

Belize

Benin

Bermuda

Bhutan

Bolivia

Bosnia and Herzegovina

Botswana

Bouvet Island

Brazil

British Indian Ocean Territory

Brunei Darussalam

Bulgaria

Burkina Faso

Burundi

Cambodia

Cameroon

Canada

Cape Verde

Cayman Islands

Central African Republic

Chad

Chile

China

Christmas Island

Cocos (Keeling) Islands

Colombia

Comoros

Congo

Congo, the Democratic Republic of the

Cook Islands

Costa Rica

Cote D'ivoire

Croatia (Hrvatska)

Cuba

Cyprus

Czech Republic

Denmark

Djibouti

Dominica

Dominican Republic

East Timor

Ecuador

Egypt

El Salvador

Equatorial Guinea

Eritrea

Estonia

Ethiopia

European Union

Falkland Islands (Malvinas)

Faroe Islands

Fiji

Finland

France

France, Metropolitan

French Guiana

French Polynesia

French Southern Territories

Gabon

Gambia

Georgia

Germany

Ghana

Gibraltar

Greece

Greenland

Grenada

Guadeloupe

Guam

Guatemala

Guinea

Guinea-Bissau

Guyana

Haiti

Heard Island and Mcdonald Islands

Holy See (Vatican City State)

Honduras

Hong Kong

Hungary

Iceland

India

Indonesia

Iran, Islamic Republic of

Iraq

Ireland

Israel

Italy

Jamaica

Japan

Jordan

Kazakhstan

Kenya

Kiribati

Korea, Democratic People's Republic of

Korea, Republic of

Kuwait

Kyrgyzstan

Lao People's Democratic Republic

Latvia

Lebanon

Lesotho

Liberia

Libyan Arab Jamahiriya

Liechtenstein

Lithuania

Luxembourg

Macao

Macedonia, the Former Yugosalv Republic of

Madagascar

Malawi

Malaysia

Maldives

Mali

Malta

Marshall Islands

Martinique

Mauritania

Mauritius

Mayotte

Mexico

Micronesia, Federated States of

Moldova, Republic of

Monaco

Mongolia

Montserrat

Morocco

Mozambique

Myanmar

Namibia

Nauru

Nepal

Netherlands

Netherlands Antilles

New Caledonia

New Zealand

Nicaragua

Niger

Nigeria

Niue

Norfolk Island

Northern Mariana Islands

Norway

Oman

Pakistan

Palau

Palestinian Territory

Panama

Papua New Guinea

Paraguay

Peru

Philippines

Pitcairn

Poland

Portugal

Puerto Rico

Qatar

Reunion

Romania

Russian Federation

Rwanda

Saint Helena

Saint Kitts and Nevis

Saint Lucia

Saint Pierre and Miquelon

Saint Vincent and the Grenadines

Samoa

San Marino

Sao Tome and Principe

Saudi Arabia

Senegal

Serbia and Montenegro

Seychelles

Sierra Leone

Singapore

Slovakia

Slovenia

Solomon Islands

Somalia

South Africa

South Georgia and the South Sandwich Islands

Spain

Sri Lanka

Sudan

Suriname

Svalbard and Jan Mayen

Swaziland

Sweden

Switzerland

Syrian Arab Republic

Taiwan, Province of China

Tajikistan

Tanzania, United Republic of

Thailand

Togo

Tokelau

Tonga

Trinidad and Tobago

Tunisia

Turkey

Turkmenistan

Turks and Caicos Islands

Tuvalu

Uganda

Ukraine

United Arab Emirates

United Kingdom

United States

United States Minor Outlying Islands

Uruguay

Uzbekistan

Vanuatu

Venezuela

Vietnam

Virgin Islands, British

Virgin Islands, U.S.

Wallis and Futuna

Western Sahara

Yemen

Yugoslavia

Zambia

Zimbabwe

Image Type

Icon.

Small.

Medium.

Large.

Xlarge.

Xxlarge.

Huge.

Image Type

Clipart.

Face.

Lineart.

News.

Photo.

Supported Interface Languages. Google supports more than 80 languages. The default interface language is English. The following list identifies all of the interface languages that Google supports. https://developers.google.com/custom-search/docs/xml_results_appendices#interfaceLanguages

Afrikaans

Albanian

Amharic

Arabic

Azerbaijani

Basque

Belarusian

Bengali

Bihari

Bosnian

Bulgarian

Catalan

Chinese.

Chinese (Simplified)

Chinese (Traditional)

Croatian

Czech

Danish

Dutch

English

Esperanto

Estonian

Faroese

Finnish

French

Frisian

Galician

Georgian

German

Greek

Gujarati

Hebrew

Hindi

Hungarian

Icelandic

Indonesian

Interlingua

Irish

Italian

Japanese

Javanese

Kannada

Korean

Latin

Latvian

Lithuanian

Macedonian

Malay

Malayam

Maltese

Marathi

Nepali

Norwegian

Norwegian (Nynorsk)

Occitan

Persian

Polish

Portuguese (Brazil)

Portuguese (Portugal)

Punjabi

Romanian

Russian

Scots Gaelic

Serbian

Sinhalese

Slovak

Slovenian

Spanish

Sudanese

Swahili

Swedish

Tagalog

Tamil

Telugu

Thai

Tigrinya

Turkish

Ukrainian

Urdu

Uzbek

Vietnamese

Welsh

Xhosa

Zulu

Operator.

The AND operator (.) returns results that are in the intersection of the collections to either side of the "." operator. This example removes all results originating from France or Italy: Example: cr= (-countryFR).(-countryIT)

The OR operator (.) returns results that are in either the collection to the left or the collection to the right of the pipe("|") operator. This example returns all results that originate from France or Italy: cr= countryFR | countryIT

Rights - Filters based on licensing.

Cc_PublicDomain.

Cc_Attribute.

Cc_ShareAlike.

Cc_NonCommercial.

Cc_NonDerived.

Search safety level.

Disables SafeSearch filtering. (default)

Enables moderate SafeSearch filtering.

Enables highest level of SafeSearch filtering.

Search Type.

Web.

Image.

Video.

Site Search Filter.

Include.

Exclude.

The sort expression to apply to the results.

Rank.

Date.

The direction to sort the search results, either Ascending or Descending.

Ascending.

Descending.

A facet object (refinements) you can use for refining a search. https://developers.google.com/custom-search/docs/refinements#create

The displayable name of the item, which you should use when displaying the item to a human.

The label of the given facet item, which you can use to refine your search.

Label With Op.

A search result item.

A unique identifier for the type of current object. For this API, it is customsearch#result.

The title of the search result, in plain text.

The title of the search result, in HTML.

The full URL to which the search result is pointing, e.g.http://www.example.com/foo/bar.

An abridged version of this search result’s URL, e.g.www.example.com.

The snippet of the search result, in plain text.

The snippet of the search result, in HTML.

Indicates the ID of Google's cached version of the search result.

The MIME type of the search result.

The file format of the search results.

The URL displayed after the snippet for each search result.

The HTML-formatted URL displayed after the snippet for each search result.

Contains PageMap information for this search result.

Encapsulates all information about an image returned in search results.

Encapsulates all information about refinement labels.

A URL pointing to the webpage hosting the image.

Image width in pixels.

Image height in pixels.

The size of the image, in pixels.

A URL to the thumbnail image.

The height of the thumbnail image, in pixels.

The width of the thumbnail image, in pixels.

Label.

The name of a refinement label, which you can use to refine searches. Don't display this in your user interface; instead, use displayName.

The display name of a refinement label. This is the name you should display in your user interface.

Label With Op.

PageMap information.

PageMap information, keyed by the name of this PageMap.

The set of promotions. Present only if the custom search engine's configuration files define any promotions for the given query. https://developers.google.com/custom-search/docs/promotions.

The title of the promotion.

The html title of the promotion.

The URL of the promotion.

An abridged version of this search's result URL, e.g. www.example.com.

An array of block objects for this promotion. See Google WebSearch Protocol reference for more information.

Image associated with this promotion, if there is one.

URL of the image for this promotion link.

Image width in pixels.

Image height in pixels.

Query Information.

A description of the query.

Estimated number of total search results. May not be accurate.

The search terms entered by the user.

Number of search results returned in this set.

Start - The index of the first result to return.

The page number of this set of results, where the page length is set by the count property.

The language of the search results.

The character encoding supported for search request.

The character encoding supported for search results.

Specifies the SafeSearch level used for filtering out adult results. This is a custom property not defined in the OpenSearch spec.Valid parameter values are: - off: Disable SafeSearch (default) - medium: Enable SafeSearch - high: Enable a stricter version of SafeSearch

The identifier of a custom search engine created using the Custom Search Control Panel, if specified in request. This is a custom property not defined in the OpenSearch spec.

Specifies that results should be sorted according to the specified expression. For example, sort by date.

Activates or deactivates the automatic filtering of Google search results. See Automatic Filtering for more information about Google's search results filters. https://developers.google.com/custom-search/docs/xml_results#automaticFiltering The default value for the filter parameter is 1, which indicates that the feature is enabled.Valid values for this parameter are: - 0: Disabled - 1: Enabled Note: By default, Google applies filtering to all search results to improve the quality of those results.

Boosts search results whose country of origin matches the parameter value. See Country Codes for a list of valid values. https://developers.google.com/custom-search/docs/xml_results#countryCodes Specifying a gl parameter value in WebSearch requests should improve the relevance of results. This is particularly true for international customers and, even more specifically, for customers in English-speaking countries other than the United States.

Restricts search results to documents originating in a particular country. You may use Boolean operators in the cr parameter's value. https://developers.google.com/custom-search/docs/xml_results#booleanOperators Google WebSearch determines the country of a document by analyzing the following: The top-level domain(TLD) of the document's URL. The geographic location of the web server's IP address. See Country(cr) Parameter Values for a list of valid values for this parameter. https://developers.google.com/custom-search/docs/xml_results#countryCollections

Specifies the Google domain (for example, google.com, google.de, or google.fr) to which the search should be limited.

Enables or disables the Simplified and Traditional Chinese Search feature. Supported values are: - 0: enabled(default) - 1: disabled

Appends the specified query terms to the query, as if they were combined with a logical AND operator.

Specifies the interface language (host language) of your user interface. Explicitly setting this parameter improves the performance and the quality of your search results. See the Interface Languages section of Internationalizing Queries and Results Presentation for more information, and Supported Interface Languages for a list of supported languages. https://developers.google.com/custom-search/docs/xml_results#wsInterfaceLanguages

Specifies all search results should be pages either included or excluded, from a given site.

Identifies a phrase that all documents in the search results must contain.

Identifies a word or phrase that should not appear in any documents in the search results.

Specifies that all results should contain a link to a specific URL.

Provides additional search terms to check for in a document, where each document in the search results must contain at least one of the additional search terms. You can also use the Boolean OR query term for this type of query.

Specifies that all search results should be pages that are related to the specified URL. The parameter value should be a URL.

Restricts results to URLs based on date. Supported values include: - d[number]: requests results from the specified number of past days. - w[number]: requests results from the specified number of past weeks. - m[number]: requests results from the specified number of past months. - y[number]: requests results from the specified number of past years.

Specifies the starting value for a search range. Use cse:lowRange and cse:highrange to append an inclusive search range of lowRange...highRange to the query.

Specifies the ending value for a search range. Use cse:lowRange and cse:highrange to append an inclusive search range of lowRange...highRange to the query.

Restricts results to files of a specified extension. A list of file types indexable by Google can be found in Search Console Help Center. https://support.google.com/webmasters/answer/35287?hl=en Additional filetypes may be added in the future. An up-to-date list can always be found in Google's file type FAQ.

Rights - Filters based on licensing. Supported values include: - cc_publicdomain - cc_attribute - cc_sharealike - cc_noncommercial - cc_nonderived - and combinations of these.

Allowed values are web or image. If unspecified, results are limited to webpages.

Restricts results to images of a specified size.

Restricts results to images of a specified type.

Restricts results to images of a specified color type.

Restricts results to images with a specific dominant color.

Search Image Options.

Type - Returns images of a type.

Size - Returns images of a specified size.

ColorType - Returns black and white, grayscale, or color images: mono, gray, and color.

DominantColor - Returns images of a specific dominant color.

Encapsulates all information about the search.

The time taken for the server to return search results.

The time taken for the server to return search results, formatted according to locale style.

The total number of search results returned by the query.

The total number of search results, formatted according to locale style.

Define properties of your search, like the search expression, number of results, language etc.

Enables or disables the Simplified and Traditional Chinese Search feature. The default value for this parameter is true, meaning that the feature is enabled.

Restricts search results to documents originating in a particular country. You may use Boolean operators in the cr parameter's value. Google Search determines the country of a document by analyzing: the top-level domain(TLD) of the document's URL the geographic location of the Web server's IP address See the Country Parameter Values page for a list of valid values for this parameter. https://developers.google.com/custom-search/docs/xml_results_appendices#countryCollections

Restricts results to URLs based on date. Supported values include:d[number]: requests results from the specified number of past days. w[number]: requests results from the specified number of past weeks. m[number]: requests results from the specified number of past months. y[number]: requests results from the specified number of past years.

ExactTerms - Identifies a phrase that all documents in the search results must contain.

ExcludeTerms - Identifies a word or phrase that should not appear in any documents in the search results.

FileType - Restricts results to files of a specified extension. A list of file types indexable by Google can be found in Search Console Help Center. https://support.google.com/webmasters/answer/35287?hl=en

Filter - Controls turning on or off the duplicate content filter. See Automatic Filtering for more information about Google's search results filters. Note that host crowding filtering applies only to multi-site searches. By default, Google applies filtering to all search results to improve the quality of those results. https://developers.google.com/custom-search/docs/xml_results#automaticFiltering.

Geolocation of end user. The geolocation parameter value is a two-letter country code.The gl parameter boosts search results whose country of origin matches the parameter value. See the Country Codes page for a list of valid values. https://developers.google.com/custom-search/docs/xml_results#countryCodes Specifying a geolocation parameter value should lead to more relevant results. This is particularly true for international customers and, even more specifically, for customers in English- speaking countries other than the United States.

Googlehost - The local Google domain (for example, google.com, google.de, or google.fr) to use to perform the search.

HighRange - Specifies the ending value for a search range. Use lowRange and highRange to append an inclusive search range of lowRange...highRange to the query.

Language - Sets the user interface language. Explicitly setting this parameter improves the performance and the quality of your search results. See the Interface Languages section of Internationalizing Queries and Results Presentation for more information, and Supported Interface Languages for a list of supported languages. https://developers.google.com/custom-search/docs/xml_results#interfaceLanguages

AndTerms - string Appends the specified query terms to the query, as if they were combined with a logical AND operator.

LinkSite - Specifies that all search results should contain a link to a particular URL.

LowRange - Specifies the starting value for a search range. Use lowRange and highRange to append an inclusive search range of lowRange...highRange to the query.

Number of search results to return. Valid values are integers between 1 and 10, inclusive.

OrTerms - Provides additional search terms to check for in a document, where each document in the search results must contain at least one of the additional search terms.

RelatedSite - Specifies that all search results should be pages that are related to the specified URL.

Rights - Filters based on licensing. Supported values include: cc_publicdomain, cc_attribute, cc_sharealike, cc_noncommercial, cc_nonderived, and combinations of these.

SafetyLevel - Search safety level. Acceptable values are: - "off": Disables SafeSearch filtering. (default) - "medium": Enables moderate SafeSearch filtering. - "high": Enables highest level of SafeSearch filtering.

SiteSearch - Specifies all search results should be pages either included or excluded, from a given site.

The sort expression to apply to the results.

Start - The index of the first result to return.

Site Search.

Site - Specifies all search results should be pages from a given site.

Filter - Controls whether to include or exclude results from the site named in the siteSearch parameter. Acceptable values are: - "e": exclude - "i": include

The sort expression to apply to the results.

The direction to sort the search results, either Ascending or Descending.

The default value of the expression, if no field is present and cannot be calculated for a document. A text value must be specified for text sorts. A numeric value must be specified for numeric sorts.

Returns the to .

The object as .

Converts a into a .

The formatted as a valid . The converted

Encapsulates a corrected query.

The corrected query.

The corrected query, formatted in HTML.

The OpenSearch URL element that defines the template for the API.

The MIME type of the OpenSearch URL template for the Custom Search API.

The actual OpenSearch template for this API.

Image Search Request.

Search Image Options.

Default Constructor.

See .

The collection.

Base Video Search Request (abstract).

BaseUrl property overriden.

The part parameter specifies a comma-separated list of one or more search resource properties that the API response will include. Cannot be set. Currently, the implementation only support response part 'snippet'.

The location parameter, in conjunction with the locationRadius parameter, defines a circular geographic area and also restricts a search to videos that specify, in their metadata, a geographic location that falls within that area. The parameter value is a string that specifies latitude/longitude coordinates e.g. (37.42307,-122.08427). The location parameter value identifies the point at the center of the area. The locationRadius parameter specifies the maximum distance that the location associated with a video can be from that point for the video to still be included in the search results. The API returns an error if your request specifies a value for the location parameter but does not also specify a value for the locationRadius parameter.

The locationRadius parameter, in conjunction with the location parameter, defines a circular geographic area. The parameter value must be a floating point number followed by a measurement unit.Valid measurement units are m, km, ft, and mi. For example, valid parameter values include 1500m, 5km, 10000ft, and 0.75mi. The API does not support locationRadius parameter values larger than 1000 kilometers. Note: See the definition of the location parameter for more information.

The maxResults parameter specifies the maximum number of items that should be returned in the result set. Acceptable values are 0 to 50, inclusive. The default value is 5.

The order parameter specifies the method that will be used to order resources in the API response. The default value is relevance.

The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.

The publishedAfter parameter indicates that the API response should only contain resources created at or after the specified time. The value is an RFC 3339 formatted date-time value(1970-01-01T00:00:00Z).

The publishedBefore parameter indicates that the API response should only contain resources created before or at the specified time. The value is an RFC 3339 formatted date-time value(1970-01-01T00:00:00Z).

The regionCode parameter instructs the API to return search results for videos that can be viewed in the specified country. The parameter value is an ISO 3166-1 alpha-2 country code.

The relevanceLanguage parameter instructs the API to return search results that are most relevant to the specified language. The parameter value is typically an ISO 639-1 two-letter language code. However, you should use the values zh-Hans for simplified Chinese and zh-Hant for traditional

The safeSearch parameter indicates whether the search results should include restricted content as well as standard content.

The topicId parameter indicates that the API response should only contain resources associated with the specified topic.

See .

The collection.

Base Video Search Response (abstract).

Kind.

ETag.

Page Token.

Region Code.

Page Info.

Items.

Channel Search Request.

Channel Search Response.

Channel Type.

Any. Return all channels.

Show. Only retrieve shows.

Country.

Afghanistan

Albania

Algeria

American Samoa

Andorra

Angola

Anguilla

Antarctica

Antigua and Barbuda

Argentina

Armenia

Aruba

Australia

Austria

Azerbaijan

Bahamas

Bahrain

Bangladesh

Barbados

Belarus

Belgium

Belize

Benin

Bermuda

Bhutan

Bolivia

Bosnia and Herzegovina

Botswana

Bouvet Island

Brazil

British Indian Ocean Territory

Brunei Darussalam

Bulgaria

Burkina Faso

Burundi

Cambodia

Cameroon

Canada

Cape Verde

Cayman Islands

Central African Republic

Chad

Chile

China

Christmas Island

Cocos (Keeling) Islands

Colombia

Comoros

Congo

Congo, the Democratic Republic of the

Cook Islands

Costa Rica

Cote D'ivoire

Croatia (Hrvatska)

Cuba

Cyprus

Czech Republic

Denmark

Djibouti

Dominica

Dominican Republic

East Timor

Ecuador

Egypt

El Salvador

Equatorial Guinea

Eritrea

Estonia

Ethiopia

European Union

Falkland Islands (Malvinas)

Faroe Islands

Fiji

Finland

France

France, Metropolitan

French Guiana

French Polynesia

French Southern Territories

Gabon

Gambia

Georgia

Germany

Ghana

Gibraltar

Greece

Greenland

Grenada

Guadeloupe

Guam

Guatemala

Guinea

Guinea-Bissau

Guyana

Haiti

Heard Island and Mcdonald Islands

Holy See (Vatican City State)

Honduras

Hong Kong

Hungary

Iceland

India

Indonesia

Iran, Islamic Republic of

Iraq

Ireland

Israel

Italy

Jamaica

Japan

Jordan

Kazakhstan

Kenya

Kiribati

Korea, Democratic People's Republic of

Korea, Republic of

Kuwait

Kyrgyzstan

Lao People's Democratic Republic

Latvia

Lebanon

Lesotho

Liberia

Libyan Arab Jamahiriya

Liechtenstein

Lithuania

Luxembourg

Macao

Macedonia, the Former Yugosalv Republic of

Madagascar

Malawi

Malaysia

Maldives

Mali

Malta

Marshall Islands

Martinique

Mauritania

Mauritius

Mayotte

Mexico

Micronesia, Federated States of

Moldova, Republic of

Monaco

Mongolia

Montserrat

Morocco

Mozambique

Myanmar

Namibia

Nauru

Nepal

Netherlands

Netherlands Antilles

New Caledonia

New Zealand

Nicaragua

Niger

Nigeria

Niue

Norfolk Island

Northern Mariana Islands

Norway

Oman

Pakistan

Palau

Palestinian Territory

Panama

Papua New Guinea

Paraguay

Peru

Philippines

Pitcairn

Poland

Portugal

Puerto Rico

Qatar

Reunion

Romania

Russian Federation

Rwanda

Saint Helena

Saint Kitts and Nevis

Saint Lucia

Saint Pierre and Miquelon

Saint Vincent and the Grenadines

Samoa

San Marino

Sao Tome and Principe

Saudi Arabia

Senegal

Serbia and Montenegro

Seychelles

Sierra Leone

Singapore

Slovakia

Slovenia

Solomon Islands

Somalia

South Africa

South Georgia and the South Sandwich Islands

Spain

Sri Lanka

Sudan

Suriname

Svalbard and Jan Mayen

Swaziland

Sweden

Switzerland

Syrian Arab Republic

Taiwan, Province of China

Tajikistan

Tanzania, United Republic of

Thailand

Togo

Tokelau

Tonga

Trinidad and Tobago

Tunisia

Turkey

Turkmenistan

Turks and Caicos Islands

Tuvalu

Uganda

Ukraine

United Arab Emirates

United Kingdom

United States

United States Minor Outlying Islands

Uruguay

Uzbekistan

Vanuatu

Venezuela

Vietnam

Virgin Islands, British

Virgin Islands, U.S.

Wallis and Futuna

Western Sahara

Yemen

Yugoslavia

Zambia

Zimbabwe

Event Type.

Completed. Only include completed broadcasts.

Live. Only include active broadcasts.

Upcoming. Only include upcoming broadcasts.

Country Extension methods.

Returns the Country code.

The . The country code.

Order.

Resources are sorted in reverse chronological order based on the date they were created.

Resources are sorted from highest to lowest rating.

Resources are sorted based on their relevance to the search query.This is the default value for this parameter.

Resources are sorted alphabetically by title..

Channels are sorted in descending order of their number of uploaded videos.

Resources are sorted from highest to lowest number of views. For live broadcasts, videos are sorted by number of concurrent viewers while the broadcasts are ongoing.

Part Type.

Snippet.

Content Details.

File Details.

Player.

Processing Details.

Recording Details.

Statistics.

Status.

Suggestions.

Topic Details.

Safe Search.

None. YouTube will not filter the search result set.

Moderate. YouTube will filter some content from search results and, at the least, will filter content that is restricted in your locale. Based on their content, search results could be removed from search results or demoted in search results. This is the default parameter value.

YouTube will try to exclude all restricted content from the search result set. Based on their content, search results could be removed from search results or demoted in search results.

Id.

Kind.

Video Id.

Item.

Video Id.

Kind.

ETag.

Snippet.

Page Info.

Total Results.

Results Per Page.

Title.

Description.

Channel Id.

Channel Title.

Live Broadcast Content.

Category Id.

Published At.

Thumbnails.

Thumbnail.

Width.

Height.

Url.

Thumbnails.

Default.

Medium.

High.

Playlist Search Request.

The channelId parameter indicates that the API response should only contain resources created by the channel. Note: Search results are constrained to a maximum of 500 videos if your request specifies a value for the channelId parameter and sets the type parameter value to video, but it does not also set one of the forContentOwner, forDeveloper, or forMine filters.

The channelType parameter lets you restrict a search to a particular type of channel.

Playlist Search Response.

Video Caption Type.

Any. Do not filter results based on caption availability. This is the default value.

Closed Caption. Only include videos that have captions.

None. Only include videos that do not have captions.

Video Definition Type.

Any. Return all videos, regardless of their resolution. This is the default value.

High. Only retrieve HD videos.

Standard. Only retrieve videos in standard definition.

Video Dimension Type.

Any. Include both 3D and non-3D videos in returned results. This is the default value.

Two Dimensional (2D). Restrict search results to exclude 3D videos.

Three Dimensional (3D). Restrict search results to only include 3D videos.

Video Duration Type.

Any. Do not filter video search results based on their duration. This is the default value.

Short. Only include videos that are less than four minutes long.

Medium. Only include videos that are between four and 20 minutes long (inclusive).

Long. Only include videos longer than 20 minutes.

Video Embeddable Type.

Any. Return all videos, syndicated or not. This is the default value.

True. Only retrieve syndicated videos.

Video License Type.

Any. Return all videos, regardless of which license they have, that match the query parameters. This is the default value.

Creative Common. Only return videos that have a Creative Commons license.Users can reuse videos with this license in other videos that they create.Learn more.

YouTube. Only return videos that have the standard YouTube license.

Video Syndicated Type.

Any. Return all videos, embeddable or not. This is the default value.

True. Only retrieve embeddable videos.

Video Type.

Any. Return all videos. This is the default value.

Episode. Only retrieve episodes of shows.

Episode. Only retrieve movies.

Video Options.

The videoCategoryId parameter filters video search results based on their category. If you specify a value for this parameter, you must also set the type parameter's value to video.

The videoCaption parameter indicates whether the API should filter video search results based on whether they have captions. If you specify a value for this parameter, you must also set the type parameter's value to video.

The videoDefinition parameter lets you restrict a search to only include either high definition (HD) or standard definition (SD) videos. HD videos are available for playback in at least 720p, though higher resolutions, like 1080p, might also be available. If you specify a value for this parameter, you must also set the type parameter's value to video.

The videoDimension parameter lets you restrict a search to only retrieve 2D or 3D videos. If you specify a value for this parameter, you must also set the type parameter's value to video.

The videoDuration parameter filters video search results based on their duration. If you specify a value for this parameter, you must also set the type parameter's value to video.

The videoEmbeddable parameter lets you to restrict a search to only videos that can be embedded into a webpage. If you specify a value for this parameter, you must also set the type parameter's value to video.

The videoLicense parameter filters search results to only include videos with a particular license. YouTube lets video uploaders choose to attach either the Creative Commons license or the standard YouTube license to each of their videos. If you specify a value for this parameter, you must also set the type parameter's value to video.

The videoSyndicated parameter lets you to restrict a search to only videos that can be played outside youtube.com. If you specify a value for this parameter, you must also set the type parameter's value to video.

The videoType parameter lets you restrict a search to a particular type of videos. If you specify a value for this parameter, you must also set the type parameter's value to video.

Video Search Request.

The relatedToVideoId parameter retrieves a list of videos that are related to the video that the parameter value identifies. The parameter value must be set to a YouTube video ID and, if you are using this parameter, the type parameter must be set to video. NOTE, that if the relatedToVideoId parameter is set, the only other supported parameters are - part, - maxResults, - pageToken, - regionCode, - relevanceLanguage, - safeSearch, - type (which must be set to video), - and fields.

The eventType parameter restricts a search to broadcast events. If you specify a value for this parameter, you must also set the type parameter's value to video.

The channelType parameter lets you restrict a search to a particular type of channel.

Options. Additional video options.

Default Constructor.

See .

The collection.

Video Search Response.

Web Search Request.

BaseUrl property overriden.

Required. Search engine created for a site with the Google Control Panel To create a Google Custom Search engine that searches the entire web: 1. From the Google Custom Search homepage (http://www.google.com/cse), click Create a Custom Search Engine. 2. Type a name and description for your search engine. 3. Under Define your search engine, in the Sites to Search box, enter at least one valid URL (For now, just put www.anyurl.com to get past this screen.More on this later). 4. Select the CSE edition you want and accept the Terms of Service, then click Next.Select the layout option you want, and then click Next. 5. Click any of the links under the Next steps section to navigate to your Control panel. 6. In the left-hand menu, under Control Panel, click Basics. 7. In the Search Preferences section, select Search the entire web but emphasize included sites. 8. Click Save Changes. 9. In the left-hand menu, under Control Panel, click Sites. 10. Delete the site you entered during the initial setup process. 11. Now your custom search engine will search the entire web.

Define properties of your search, like the search expression, number of results, language etc.

See .

The collection.

Base abstract translate request.

Language Extensions.

Gets the ISO-639-1 code for the specified .

The . The ISO-639-1 code matching the passed .

Determines whether the passed is comptabile with . https://cloud.google.com/translate/docs/languages

The to evaluate. True, if compatable with , otherwise false.

String Extensions.

Gets the for the specified ISO-639-1/(2) code.

The ISO-639-1 code. the matching the passed .

The Translation API's recognition engine supports a wide variety of languages for the Phrase-Based Machine Translation (PBMT) and Neural Machine Translation (NMT) models. These languages are specified within a recognition request using language code parameters as noted on this page. Most language code parameters conform to ISO-639-1 identifiers, except where noted.

Afrikaans.

Albanian.

Amharic.

Arabic.

Armenian.

Azeerbaijani.

Basque.

Belarusian.

Bengali.

Bosnian.

Bulgarian.

Catalan.

Cebuano. (ISO-639-2)

Chichewa.

Chinese.

Chinese simplified. (BCP-47)

Chinese traditional. (BCP-47)

Corsican.

Croatian.

Czech.

Danish.

Dutch.

English.

Esperanto.

Estonian.

Filipino.

Finnish.

French.

Frisian.

Galician.

Georgian.

German.

Greek.

Gujarati.

Haitian_Creole.

Hausa.

Hawaiian. (ISO-639-2)

Hebrew. (2nd ISO-631-1 code)

Hebrew.

Hindi.

Hmong. (ISO-639-2)

Hungarian.

Icelandic.

Igbo.

Indonesian.

Irish.

Italian.

Japanese.

Javanese.

Kannada.

Kazakh.

Khmer.

Kinyarwanda.

Korean.

Kurdish.

Kyrgyz.

Lao.

Latin.

Latvian.

Lithuanian.

Luxembourgish.

Macedonian.

Malagasy.

Malay.

Malayalam.

Maltese.

Maori.

Marathi.

Mongolian.

Burmese.

Nepali.

Norwegian.

Odia.

Pashto.

Persian.

Polish.

Portuguese.

Punjabi.

Romanian.

Russian.

Samoan.

Scots_Gaelic.

Serbian.

Sesotho.

Shona.

Sindhi.

Sinhala.

Slovak.

Slovenian.

Somali.

Spanish.

Sundanese.

Swahili.

Swedish.

Tajik.

Tamil.

Tatar.

Telugu.

Thai.

Turkish.

Turkmen.

Ukrainian.

Urdu.

Uyghur.

Uzbek.

Vietnamese.

Welsh.

Xhosa.

Yiddish.

Yoruba.

Zulu.

The translation model.

Base, Phrase-Based Machine Translation (PBMT) model

Nmt, Neural Machine Translation (NMT) model.

Detect Request.

Required. The input text upon which to perform language detection. Repeat this parameter to perform language detection on multiple text inputs.

The list of detection responses. This list will contain a language detection response for each query (q) sent in the language detection request.

A response list contains a list of separate language detection responses. Language detection results for each input text piece. For backward compatibility, this list must be expressed as an array of arrays, which requires using ListValue in proto3.

Language detection result.

Indicates whether the language detection result is reliable.

The confidence of the detection result for this language.

The detected language.

Detect Response.

Container for the detected results.

Languages Request.

The target language code for the results.If specified, then the language names are returned in the name field of the response, localized in the target language.If you do not supply a target language, then the name field is omitted from the response and only the language codes are returned.

A list of supported language responses. This list will contain an entry for each language supported by the Translation API

The set of supported languages.

Languages Response.

Container for the languages results.

A single supported language response corresponds to information related to one supported language.

Human readable name of the language localized to the target language.

Supported language code, generally consisting of its ISO 639-1 identifier. (E.g. 'en', 'ja'). In certain cases, BCP-47 codes including language + region identifiers are returned(e.g. 'zh-TW' and 'zh-CH')

The format of the source text, in either HTML (default) or plain-text.

Html format.

Plain text format.

Translate Request.

The language of the source text, set to one of the language codes listed in Language Support. If the source language is not specified, the API will attempt to detect the source language automatically and return it within the response.

Required. The language to use for translation of the input text, set to one of the language codes listed in Language Support.

Required. The input text to translate. Repeat this parameter to perform translation operations on multiple text inputs.

The translation model. Can be either base to use the Phrase-Based Machine Translation (PBMT) model, or nmt to use the Neural Machine Translation (NMT) model. If omitted, then nmt is used. If the model is nmt, and the requested language translation pair is not supported for the NMT model, then the request is translated using the base model. Languages supported by the NMT model can only be translated to or from English(en).

The format of the source text, in either HTML (default) or plain-text. A value of html indicates HTML and a value of text indicates plain-text. Default: format=html.

The list of language translation responses. This list contains a language translation response for each query (q) sent in the language translation request.

Contains list of translation results of the supplied text.

Translate Response.

Container for the translated results.

Translation result of a supplied text.

The source language detected by google when not supplied in the request.

The translation model. Can be either base for the Phrase-Based Machine Translation(PBMT) model, or nmt for the Neural Machine Translation(NMT) model. If you did not include a model parameter with your request, then this field is not included in the response.

The source language of the initial request, detected automatically, if no source language was passed within the initial request. If the source language was passed, auto-detection of the language will not occur and this field will be omitted.

Exception that is thrown when Google returns a status code

Constructor, accepting a error message and a optional status.

The error message.

Constructor, accepting a error message and a optional status.

The error message. The inner exception.

Polyline encoding is a lossy compression algorithm that allows you to store a series of coordinates as a single string. Point coordinates are encoded using signed values. If you only have a few static points, you may also wish to use the interactive polyline encoding utility. The encoding process converts a binary value into a series of character codes for ASCII characters using the familiar base64 encoding scheme: to ensure proper display of these characters, encoded values are summed with 63 (the ASCII character '?') before converting them into ASCII. The algorithm also checks for additional character codes for a given point by checking the least significant bit of each byte group; if this bit is set to 1, the point is not yet fully formed and additional data must follow. Additionally, to conserve space, points only include the offset from the previous point (except of course for the first point). All points are encoded in Base64 as signed integers, as latitudes and longitudes are signed values. The encoding format within a polyline needs to represent two coordinates representing latitude and longitude to a reasonable precision. Given a maximum longitude of +/- 180 degrees to a precision of 5 decimal places (180.00000 to -180.00000), this results in the need for a 32 bit signed binary integer value. Note that the backslash is interpreted as an escape character within string literals. Any output of this utility should convert backslash characters to double-backslashes within string literals. See https://developers.google.com/maps/documentation/utilities/polylinealgorithm

Encode a list of locations into a polyline string.

Merge polylines into one encoded polyline string.

Decode a polyline string into locations.

The Google Maps Web Services are a collection of HTTP interfaces to Google services providing geographic data for your maps applications. - Google Maps Directions API - Google Maps Distance Matrix API - Google Maps Elevation API - Google Maps Geocoding API - Google Maps Geolocation API - Google Maps Roads API - Google Maps Time Zone API Documentation: https://developers.google.com/maps/documentation

Geocoding is the process of converting addresses (like "1600 Amphitheatre Parkway, Mountain View, CA") into geographic coordinates (like latitude 37.423021 and longitude -122.083739), which you can use to place markers on a map, or position the map. This is the process of converting a place id into a address.

Geocoding is the process of converting addresses (like "1600 Amphitheatre Parkway, Mountain View, CA") into geographic coordinates (like latitude 37.423021 and longitude -122.083739), which you can use to place markers on a map, or position the map. https://developers.google.com/maps/documentation/geocoding/intro#geocoding

The term geocoding generally refers to translating a human-readable address into a location on a map. The process of doing the opposite, translating a location on the map into a human-readable address, is known as reverse geocoding. https://developers.google.com/maps/documentation/geocoding/intro#ReverseGeocoding

The pluscode api is the process of converting a location (lat/lng or address) to a plus code (including the bounding box and the center). This API is experimental. As of December 2016, we are soliciting feedback on the functionality, in order to inform proposals to geocoding API providers such as Google. You can discuss the API in the public mailing list or create an issue in the issue tracker. https://github.com/google/open-location-code/wiki/Plus-codes-API

The Google Maps Geolocation API returns a location and accuracy radius based on information about cell towers and WiFi nodes that the mobile client can detect. This document describes the protocol used to send this data to the server and to return a response to the client. Communication is done over HTTPS using POST. Both request and response are formatted as JSON, and the content type of both is application/json. Before you start developing with the Geolocation API, review the authentication requirements (you need an API key) and the API usage limits. https://developers.google.com/maps/documentation/geolocation/intro

The Google Maps Elevation API provides you a simple interface to query locations on the earth for elevation data. Additionally, you may request sampled elevation data along paths, allowing you to calculate elevation changes along routes. https://developers.google.com/maps/documentation/elevation/intro

Google Maps Directions API is a service that calculates directions between locations using an HTTP request. You can search for directions for several modes of transportation, include transit, driving, walking or cycling. Directions may specify origins, destinations and waypoints either as text strings (e.g. "Chicago, IL" or "Darwin, NT, Australia") or as latitude/longitude coordinates. The Directions API can return multi-part directions using a series of waypoints. This service is generally designed for calculating directions for static (known in advance) addresses for placement of application content on a map; this service is not designed to respond in real time to user input, for example. For dynamic directions calculations (for example, within a user interface element), consult the documentation for the Google Maps JavaScript API Directions Service. Calculating directions is a time and resource intensive task. Whenever possible, calculate known addresses ahead of time (using the service described here) and store your results in a temporary cache of your own design. https://developers.google.com/maps/documentation/directions/intro

The Google Maps Distance Matrix API is a service that provides travel distance and time for a matrix of origins and destinations. The information returned is based on the recommended route between start and end points, as calculated by the Google Maps API, and consists of rows containing duration and distance values for each pair. https://developers.google.com/maps/documentation/distance-matrix/intro

The Google Maps Time Zone API provides a simple interface to request the time zone for a location on the earth, as well as that location's time offset from UTC. The Google Maps Time Zone API provides time offset data for locations on the surface of the earth. Requesting the time zone information for a specific Latitude/Longitude pair will return the name of that time zone, the time offset from UTC, and the Daylight Savings offset. https://developers.google.com/maps/documentation/timezone/intro

The snapToRoads method takes up to 100 GPS points collected along a route, and returns a similar set of data, with the points snapped to the most likely roads the vehicle was traveling along. Optionally, you can request that the points be interpolated, resulting in a path that smoothly follows the geometry of the road. https://developers.google.com/maps/documentation/roads/snap

The Google Maps Roads API takes takes up to 100 independent coordinates, and returns the closest road segment for each point. The points passed do not need to be part of a continuous path. NOTE: If you are working with sequential GPS points, use Snap to Roads. https://developers.google.com/maps/documentation/roads/nearest

The speedLimits method returns the posted speed limit for a given road segment. In the case of road segments with variable speed limits, the default speed limit for the segment is returned. The accuracy of speed limit data returned by the Google Maps Roads API cannot be guaranteed. The speed limit data provided is not real-time, and may be estimated, inaccurate, incomplete, and/or outdated. Inaccuracies in our data may be reported through the Google Map Maker service. https://developers.google.com/maps/documentation/roads/speed-limits

The Google Street View Image API lets you embed a static (non-interactive) Street View panorama or thumbnail into your web page, without the use of JavaScript. The viewport is defined with URL parameters sent through a standard HTTP request, and is returned as a static image. https://developers.google.com/maps/documentation/streetview/intro

The Google Static Maps API lets you embed a Google Maps image on your web page without requiring JavaScript or any dynamic page loading. The Google Static Maps API service creates your map based on URL parameters sent through a standard HTTP request and returns the map as an image you can display on your web page. https://developers.google.com/maps/documentation/static-maps/intro

Methods to access Google Places Api: https://developers.google.com/places/web-service/intro

The Place Photo service, part of the Google Places API Web Service, is a read-only API that allows you to add high quality photographic content to your application. The Place Photo service gives you access to the millions of photos stored in the Places and Google+ Local database. When you get place information using a Place Details request, photo references will be returned for relevant photographic content. The Nearby Search and Text Search requests also return a single photo reference per place, when relevant. Using the Photo service you can then access the referenced photos and resize the image to the optimal size for your application. https://developers.google.com/places/web-service/photos

The Google Places API Find Search Service is a web service that returns information about a set of places based on an input. A Find Place request takes a text input, and returns a place. The text input can be any kind of Places data, for example, a name, address, or phone number. https://developers.google.com/places/web-service/search#FindPlaceRequests

The Google Places API Text Search Service is a web service that returns information about a set of places based on a string — for example "pizza in New York" or "shoe stores near Ottawa". The service responds with a list of places matching the text string and any location bias that has been set. The search response will include a list of places, you can send a Place Details request for more information about any of the places in the response. https://developers.google.com/places/web-service/search

A Nearby Search lets you search for places within a specified area. You can refine your search request by supplying keywords or specifying the type of place you are searching for https://developers.google.com/places/web-service/search

Once you have a place_id from a Place Search, you can request more details about a particular establishment or point of interest by initiating a Place Details request. A Place Details request returns more comprehensive information about the indicated place such as its complete address, phone number, user rating and reviews. https://developers.google.com/places/web-service/details

The Query Autocomplete service can be used to provide a query prediction for text-based geographic searches, by returning suggested queries as you type. https://developers.google.com/places/web-service/query

The Place Autocomplete service is a web service that returns place predictions in response to an HTTP request. The request specifies a textual search string and optional geographic bounds. The service can be used to provide autocomplete functionality for text-based geographic searches, by returning places such as businesses, addresses and points of interest as a user types. https://developers.google.com/places/web-service/autocomplete

The JSON/Atom Custom Search API lets you develop websites and applications to retrieve and display search results from Google Custom Search programmatically. With this API, you can use RESTful requests to get either web search or image search results in JSON or Atom format. https://developers.google.com/custom-search/docs/overview By calling the API user issues requests against an existing instance of a Custom Search Engine. Therefore, before using the API, you need to create one in the Control Panel (https://cse.google.com/cse/all). Follow the tutorial to learn more about different configuration options. You can find the engine's ID in the Setup > Basics > Details section of the Control Panel. REST Api: https://developers.google.com/custom-search/json-api/v1/overview There are also two external documents that are helpful resources for using this API: - Google WebSearch Protocol(XML): The JSON/Atom Custom Search API provides a subset of the functionality provided by the XML API, but it instead returns data in JSON or Atom format. (https://developers.google.com/custom-search/docs/xml_results) - OpenSearch 1.1 Specification: This API uses the OpenSearch specification to describe the search engine and provide data regarding the results.Because of this, you can write your code so that it can support any OpenSearch engine, not just Google's custom search engine. There is currently no other JSON implementation of OpenSearch, so all the examples in the OpenSearch spec are in XML. (http://www.opensearch.org/Specifications/OpenSearch/1.1)

Web Search. You can retrieve results for a particular search by sending an HTTP GET request to its URI. You pass in the details of the search request as query parameters.

Image Search. You can retrieve results for a particular search by sending an HTTP GET request to its URI. You pass in the details of the search request as query parameters.

Video Search (nested class).

Video Search. You can retrieve results for a particular search by sending an HTTP GET request to its URI. You pass in the details of the search request as query parameters. Docs: https://developers.google.com/youtube/v3/getting-started

Video Channel Search You can retrieve results for a particular search by sending an HTTP GET request to its URI. You pass in the details of the search request as query parameters. Docs: https://developers.google.com/youtube/v3/getting-started

Video Playlist Search You can retrieve results for a particular search by sending an HTTP GET request to its URI. You pass in the details of the search request as query parameters. Docs: https://developers.google.com/youtube/v3/getting-started

Google Translate dynamically translates text between thousands of language pairs. https://cloud.google.com/translate/docs/reference/rest Supported Languages: https://cloud.google.com/translate/docs/languages

Translates input text, returning translated text. https://cloud.google.com/translate/docs/reference/translate

Detects the language of text within a request. https://cloud.google.com/translate/docs/reference/detect

Returns a list of supported languages for translation. https://cloud.google.com/translate/docs/reference/languages

Http Engine (abstract).

Http Client.

Proxy property that will be used for all requests.

Disposes.

Disposes of the , if is true.

Whether to dispose resources or not.

Http Engine. Manges the http connections, and is responsible for invoking requst and handling responses.

Query.

The request that will be sent. The . The .

Query Async.

The request that will be sent. The . The .

Query Async.

The request that will be sent. The The . The .

Http Engine Options.

Throw On Bad Request.