|
| 1 | +--- |
| 2 | +title: Show the correct map copyright attribution information |
| 3 | +titleSuffix: Microsoft Azure Maps |
| 4 | +description: The map copyright attribution information must be displayed in any applications that use the Render V2 API, including web and mobile applications. In this article, you'll learn how to display the correct attribution every time you display or update a tile. |
| 5 | +author: stevemunk |
| 6 | +ms.author: v-munksteve |
| 7 | +ms.date: 3/16/2022 |
| 8 | +ms.topic: how-to |
| 9 | +ms.service: azure-maps |
| 10 | +services: azure-maps |
| 11 | +--- |
| 12 | + |
| 13 | +# Show the correct copyright attribution |
| 14 | + |
| 15 | +When using the [Azure Maps Render service V2](/rest/api/maps/render-v2), either as a basemap or layer, you're required to display the appropriate data provider copyright attribution on the map. This information should be displayed in the lower right-hand corner of the map. |
| 16 | + |
| 17 | +:::image type="content" source="./media/how-to-show-attribution/attribution-road.png" border="false" alt-text="The above image is an example of a map from the Render service V2 showing the copyright attribution when using the road style"::: |
| 18 | + |
| 19 | +The above image is an example of a map from the Render service V2, displaying the road style. It shows the copyright attribution in the lower right-hand corner of the map. |
| 20 | + |
| 21 | +:::image type="content" source="./media/how-to-show-attribution/attribution-satellite.png" border="false" alt-text="The above image is an example of a map from the Render service V2 showing the copyright attribution when using the satellite style"::: |
| 22 | + |
| 23 | +The above image is an example of a map from the Render service V2, displaying the satellite style. note that there's another data provider listed. |
| 24 | + |
| 25 | +## The Get Map Attribution API |
| 26 | + |
| 27 | +The [Get Map Attribution API](/rest/api/maps/render-v2/get-map-attribution) enables you to request map copyright attribution information so that you can display in on the map within your applications. |
| 28 | + |
| 29 | +### When to use the Get Map Attribution API |
| 30 | + |
| 31 | +The map copyright attribution information must be displayed on the map in any applications that use the Render V2 API, including web and mobile applications. |
| 32 | + |
| 33 | +The attribution is automatically displayed and updated on the map When using any of the Azure Maps SDKs. This includes the [Web SDK](how-to-use-map-control.md), [Android SDK](how-to-use-android-map-control-library.md) and the [iOS SDK](how-to-use-ios-map-control-library.md). |
| 34 | + |
| 35 | +When using map tiles from the Render service in a third-party map, you must display and update the copyright attribution information on the map. |
| 36 | + |
| 37 | +Map content changes whenever an end user selects a different style, zooms in or out, or pans the map. Each of these user actions causes an event to fire. When any of these events fire, you need to call the Get Map Attribution API. Once you have the updated copyright attribution information, you then need to display it in the lower right-hand corner of the map. |
| 38 | + |
| 39 | +Since the data providers can differ depending on the *region* and *zoom* level, the Get Map Attribution API takes these parameters as input and returns the corresponding attribution text. |
| 40 | + |
| 41 | +### How to use the Get Map Attribution API |
| 42 | + |
| 43 | +You'll need the following information to run the `attribution` command: |
| 44 | + |
| 45 | +| Parameter | Type | Description | |
| 46 | +| ----------- | ------ | -------------------------------------------------------- | |
| 47 | +| api-version | string | Version number of Azure Maps API. Current version is 2.1 | |
| 48 | +| bounds | array | A string that represents the rectangular area of a bounding box. The bounds parameter is defined by the four bounding box coordinates. The first 2 are the WGS84 longitude and latitude defining the southwest corner and the last 2 are the WGS84 longitude and latitude defining the northeast corner. The string is presented in the following format: [SouthwestCorner_Longitude, SouthwestCorner_Latitude, NortheastCorner_Longitude, NortheastCorner_Latitude]. | |
| 49 | +| tilesetId | TilesetID | A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a tilesetId to use when making requests. The tilesetId for tilesets created using Azure Maps Creator are generated through the [Tileset Create API](/rest/api/maps/v2/tileset/create). There are ready-to-use tilesets supplied by Azure Maps, such as `microsoft.base.road`, `microsoft.base.hybrid` and `microsoft.weather.radar.main`, a complete list can be found the [Get Map Attribution](/rest/api/maps/render-v2/get-map-attribution#tilesetid) REST API documentation. | |
| 50 | +| zoom | integer | Zoom level for the selected tile. The valid range depends on the tile, see the [TilesetID](/rest/api/maps/render-v2/get-map-attribution#tilesetid) table for valid values for a specific tileset. For more information, see the [Zoom levels and tile grid](zoom-levels-and-tile-grid.md) article. | |
| 51 | +| subscription-key | string | One of the Azure Maps keys provided from an Azure Map Account. For more information, see the [Authentication with Azure Maps](azure-maps-authentication.md) article. | |
| 52 | + |
| 53 | +Run the following GET request to get the corresponding copyright attribution to display on the map: |
| 54 | + |
| 55 | +```http |
| 56 | +https://atlas.microsoft.com/map/attribution?subscription-key={Azure-Maps-Primary-Subscription-key}&api-version=2.1&tilesetId=microsoft.base&zoom=6&bounds=-122.414162,47.579490,-122.247157,47.668372 |
| 57 | +``` |
| 58 | + |
| 59 | +## Additional information |
| 60 | + |
| 61 | +* For more information, see the [Azure Maps Render service V2](/rest/api/maps/render-v2) documentation. |
0 commit comments