Google_Service_MapsEngine_Maps_Resource Class Reference

The "maps" collection of methods. More...

Inheritance diagram for Google_Service_MapsEngine_Maps_Resource:

Public Member Functions
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.
	create (Google_Service_MapsEngine_Map $postBody, $optParams=array())
	Create a map asset.
	delete ($id, $optParams=array())
	Delete a map.
	get ($id, $optParams=array())
	Return metadata for a particular map.
	getPublished ($id, $optParams=array())
	Return the published metadata for a particular map.
	listMaps ($optParams=array())
	Return all maps readable by the current user.
	listPublished ($optParams=array())
	Return all published maps readable by the current user.
	patch ($id, Google_Service_MapsEngine_Map $postBody, $optParams=array())
	Mutate a map asset.
	publish ($id, $optParams=array())
	Publish a map asset.
	unpublish ($id, $optParams=array())
	Unpublish a map asset.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "maps" collection of methods.

Typical usage is: $mapsengineService = new Google_Service_MapsEngine(...); $maps = $mapsengineService->maps;

Member Function Documentation

call()

Google_Service_Resource::call ( $name, $arguments, $expected_class = null )

inherited

TODO: This function needs simplifying.

Parameters

$name
$arguments
$expected_class	- optional, the expected class name

Return values

Google_Http_Request|expected_class

Exceptions

Google_Exception

create()

Google_Service_MapsEngine_Maps_Resource::create	(	Google_Service_MapsEngine_Map	$postBody,
			$optParams = array() )

Create a map asset.

(maps.create)

Parameters

Google_Map	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_MapsEngine_Map

delete()

Google_Service_MapsEngine_Maps_Resource::delete	(		$id,
			$optParams = array() )

Delete a map.

(maps.delete)

Parameters

string	$id	The ID of the map. Only the map creator or project owner are permitted to delete. If the map is published the request will fail. Unpublish the map prior to deleting.
array	$optParams	Optional parameters.

get()

Google_Service_MapsEngine_Maps_Resource::get	(		$id,
			$optParams = array() )

Return metadata for a particular map.

(maps.get)

Parameters

string	$id	The ID of the map.
array	$optParams	Optional parameters.

@opt_param string version Deprecated: The version parameter indicates which version of the map should be returned. When version is set to published, the published version of the map will be returned. Please use the maps.getPublished endpoint instead.

Return values

Google_Service_MapsEngine_Map

getPublished()

Google_Service_MapsEngine_Maps_Resource::getPublished	(		$id,
			$optParams = array() )

Return the published metadata for a particular map.

(maps.getPublished)

Parameters

string	$id	The ID of the map.
array	$optParams	Optional parameters.

Return values

Google_Service_MapsEngine_PublishedMap

listMaps()

Google_Service_MapsEngine_Maps_Resource::listMaps

(

$optParams = array()

)

Return all maps readable by the current user.

(maps.listMaps)

Parameters

array

$optParams

Optional parameters.

@opt_param string modifiedAfter An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or after this time. @opt_param string createdAfter An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or after this time. @opt_param string processingStatus @opt_param string projectId The ID of a Maps Engine project, used to filter the response. To list all available projects with their IDs, send a Projects: list request. You can also find your project ID as the value of the DashboardPlace:cid URL parameter when signed in to mapsengine.google.com. @opt_param string tags A comma separated list of tags. Returned assets will contain all the tags from the list. @opt_param string search An unstructured search string used to filter the set of results based on asset metadata. @opt_param string maxResults The maximum number of items to include in a single response page. The maximum supported value is 100. @opt_param string pageToken The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response. @opt_param string creatorEmail An email address representing a user. Returned assets that have been created by the user associated with the provided email address. @opt_param string bbox A bounding box, expressed as "west,south,east,north". If set, only assets which intersect this bounding box will be returned. @opt_param string modifiedBefore An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or before this time. @opt_param string createdBefore An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or before this time. @opt_param string role The role parameter indicates that the response should only contain assets where the current user has the specified level of access.

Return values

Google_Service_MapsEngine_MapsListResponse

listPublished()

Google_Service_MapsEngine_Maps_Resource::listPublished

(

$optParams = array()

)

Return all published maps readable by the current user.

(maps.listPublished)

Parameters

array

$optParams

Optional parameters.

@opt_param string pageToken The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response. @opt_param string maxResults The maximum number of items to include in a single response page. The maximum supported value is 100. @opt_param string projectId The ID of a Maps Engine project, used to filter the response. To list all available projects with their IDs, send a Projects: list request. You can also find your project ID as the value of the DashboardPlace:cid URL parameter when signed in to mapsengine.google.com.

Return values

Google_Service_MapsEngine_PublishedMapsListResponse

patch()

Google_Service_MapsEngine_Maps_Resource::patch	(		$id,
		Google_Service_MapsEngine_Map	$postBody,
			$optParams = array() )

Mutate a map asset.

(maps.patch)

Parameters

string	$id	The ID of the map.
Google_Map	$postBody
array	$optParams	Optional parameters.

publish()

Google_Service_MapsEngine_Maps_Resource::publish	(		$id,
			$optParams = array() )

Publish a map asset.

(maps.publish)

Parameters

string	$id	The ID of the map.
array	$optParams	Optional parameters.

@opt_param bool force If set to true, the API will allow publication of the map even if it's out of date. If false, the map must have a processingStatus of complete before publishing.

Return values

Google_Service_MapsEngine_PublishResponse

unpublish()

Google_Service_MapsEngine_Maps_Resource::unpublish	(		$id,
			$optParams = array() )

Unpublish a map asset.

(maps.unpublish)

Parameters

string	$id	The ID of the map.
array	$optParams	Optional parameters.

Return values

Google_Service_MapsEngine_PublishResponse

---

The documentation for this class was generated from the following file:

• lib/google/src/Google/Service/MapsEngine.php