Google_Service_MapsEngine_Layers_Resource

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