Google_Service_MapsEngine_Maps_Resource

The "maps" collection of methods.

Defined (1)

The class is defined in the following location(s).

/includes/api-libs/Google/Service/MapsEngine.php  
  1. class Google_Service_MapsEngine_Maps_Resource extends Google_Service_Resource 
  2.  
  3. /** 
  4. * Create a map asset. (maps.create) 
  5. * @param Google_Map $postBody 
  6. * @param array $optParams Optional parameters. 
  7. * @return Google_Service_MapsEngine_Map 
  8. */ 
  9. public function create(Google_Service_MapsEngine_Map $postBody, $optParams = array()) 
  10. $params = array('postBody' => $postBody); 
  11. $params = array_merge($params, $optParams); 
  12. return $this->call('create', array($params), "Google_Service_MapsEngine_Map"); 
  13.  
  14. /** 
  15. * Delete a map. (maps.delete) 
  16. * @param string $id The ID of the map. Only the map creator or project owner 
  17. * are permitted to delete. If the map is published the request will fail. 
  18. * Unpublish the map prior to deleting. 
  19. * @param array $optParams Optional parameters. 
  20. */ 
  21. public function delete($id, $optParams = array()) 
  22. $params = array('id' => $id); 
  23. $params = array_merge($params, $optParams); 
  24. return $this->call('delete', array($params)); 
  25.  
  26. /** 
  27. * Return metadata for a particular map. (maps.get) 
  28. * @param string $id The ID of the map. 
  29. * @param array $optParams Optional parameters. 
  30. * @opt_param string version Deprecated: The version parameter indicates which 
  31. * version of the map should be returned. When version is set to published, the 
  32. * published version of the map will be returned. Please use the 
  33. * maps.getPublished endpoint instead. 
  34. * @return Google_Service_MapsEngine_Map 
  35. */ 
  36. public function get($id, $optParams = array()) 
  37. $params = array('id' => $id); 
  38. $params = array_merge($params, $optParams); 
  39. return $this->call('get', array($params), "Google_Service_MapsEngine_Map"); 
  40.  
  41. /** 
  42. * Return the published metadata for a particular map. (maps.getPublished) 
  43. * @param string $id The ID of the map. 
  44. * @param array $optParams Optional parameters. 
  45. * @return Google_Service_MapsEngine_PublishedMap 
  46. */ 
  47. public function getPublished($id, $optParams = array()) 
  48. $params = array('id' => $id); 
  49. $params = array_merge($params, $optParams); 
  50. return $this->call('getPublished', array($params), "Google_Service_MapsEngine_PublishedMap"); 
  51.  
  52. /** 
  53. * Return all maps readable by the current user. (maps.listMaps) 
  54. * @param array $optParams Optional parameters. 
  55. * @opt_param string modifiedAfter An RFC 3339 formatted date-time value (e.g. 
  56. * 1970-01-01T00:00:00Z). Returned assets will have been modified at or after 
  57. * this time. 
  58. * @opt_param string createdAfter An RFC 3339 formatted date-time value (e.g. 
  59. * 1970-01-01T00:00:00Z). Returned assets will have been created at or after 
  60. * this time. 
  61. * @opt_param string processingStatus 
  62. * @opt_param string projectId The ID of a Maps Engine project, used to filter 
  63. * the response. To list all available projects with their IDs, send a Projects: 
  64. * list request. You can also find your project ID as the value of the 
  65. * DashboardPlace:cid URL parameter when signed in to mapsengine.google.com. 
  66. * @opt_param string tags A comma separated list of tags. Returned assets will 
  67. * contain all the tags from the list. 
  68. * @opt_param string search An unstructured search string used to filter the set 
  69. * of results based on asset metadata. 
  70. * @opt_param string maxResults The maximum number of items to include in a 
  71. * single response page. The maximum supported value is 100. 
  72. * @opt_param string pageToken The continuation token, used to page through 
  73. * large result sets. To get the next page of results, set this parameter to the 
  74. * value of nextPageToken from the previous response. 
  75. * @opt_param string creatorEmail An email address representing a user. Returned 
  76. * assets that have been created by the user associated with the provided email 
  77. * address. 
  78. * @opt_param string bbox A bounding box, expressed as "west, south, east, north". 
  79. * If set, only assets which intersect this bounding box will be returned. 
  80. * @opt_param string modifiedBefore An RFC 3339 formatted date-time value (e.g. 
  81. * 1970-01-01T00:00:00Z). Returned assets will have been modified at or before 
  82. * this time. 
  83. * @opt_param string createdBefore An RFC 3339 formatted date-time value (e.g. 
  84. * 1970-01-01T00:00:00Z). Returned assets will have been created at or before 
  85. * this time. 
  86. * @opt_param string role The role parameter indicates that the response should 
  87. * only contain assets where the current user has the specified level of access. 
  88. * @return Google_Service_MapsEngine_MapsListResponse 
  89. */ 
  90. public function listMaps($optParams = array()) 
  91. $params = array(); 
  92. $params = array_merge($params, $optParams); 
  93. return $this->call('list', array($params), "Google_Service_MapsEngine_MapsListResponse"); 
  94.  
  95. /** 
  96. * Return all published maps readable by the current user. (maps.listPublished) 
  97. * @param array $optParams Optional parameters. 
  98. * @opt_param string pageToken The continuation token, used to page through 
  99. * large result sets. To get the next page of results, set this parameter to the 
  100. * value of nextPageToken from the previous response. 
  101. * @opt_param string maxResults The maximum number of items to include in a 
  102. * single response page. The maximum supported value is 100. 
  103. * @opt_param string projectId The ID of a Maps Engine project, used to filter 
  104. * the response. To list all available projects with their IDs, send a Projects: 
  105. * list request. You can also find your project ID as the value of the 
  106. * DashboardPlace:cid URL parameter when signed in to mapsengine.google.com. 
  107. * @return Google_Service_MapsEngine_PublishedMapsListResponse 
  108. */ 
  109. public function listPublished($optParams = array()) 
  110. $params = array(); 
  111. $params = array_merge($params, $optParams); 
  112. return $this->call('listPublished', array($params), "Google_Service_MapsEngine_PublishedMapsListResponse"); 
  113.  
  114. /** 
  115. * Mutate a map asset. (maps.patch) 
  116. * @param string $id The ID of the map. 
  117. * @param Google_Map $postBody 
  118. * @param array $optParams Optional parameters. 
  119. */ 
  120. public function patch($id, Google_Service_MapsEngine_Map $postBody, $optParams = array()) 
  121. $params = array('id' => $id, 'postBody' => $postBody); 
  122. $params = array_merge($params, $optParams); 
  123. return $this->call('patch', array($params)); 
  124.  
  125. /** 
  126. * Publish a map asset. (maps.publish) 
  127. * @param string $id The ID of the map. 
  128. * @param array $optParams Optional parameters. 
  129. * @opt_param bool force If set to true, the API will allow publication of the 
  130. * map even if it's out of date. If false, the map must have a processingStatus 
  131. * of complete before publishing. 
  132. * @return Google_Service_MapsEngine_PublishResponse 
  133. */ 
  134. public function publish($id, $optParams = array()) 
  135. $params = array('id' => $id); 
  136. $params = array_merge($params, $optParams); 
  137. return $this->call('publish', array($params), "Google_Service_MapsEngine_PublishResponse"); 
  138.  
  139. /** 
  140. * Unpublish a map asset. (maps.unpublish) 
  141. * @param string $id The ID of the map. 
  142. * @param array $optParams Optional parameters. 
  143. * @return Google_Service_MapsEngine_PublishResponse 
  144. */ 
  145. public function unpublish($id, $optParams = array()) 
  146. $params = array('id' => $id); 
  147. $params = array_merge($params, $optParams); 
  148. return $this->call('unpublish', array($params), "Google_Service_MapsEngine_PublishResponse");