Weather - Get Daily Indices

Usługa:: Maps

Wersja interfejsu API:: 1.1

Użyj tej opcji, jeśli chcesz wiedzieć, czy warunki pogodowe są optymalne dla określonej aktywności, takiej jak uprawianie sportu na świeżym powietrzu, budownictwo lub rolnictwo (wyniki zawierają informacje o wilgotności gleby).

Interfejs Get Daily Indices API to żądanie HTTP GET zwracające wartości indeksu, które zawierają wskazówki pomocne podczas planowania przyszłych działań. Na przykład aplikacja mobilna dotycząca zdrowia może powiadamiać użytkowników, że dziś jest dobra pogoda do biegania lub innych aktywności na świeżym powietrzu, takich jak gra w golfa lub puszczanie latawca. Sklepy detaliczne mogą optymalizować swoje cyfrowe kampanie marketingowe na podstawie przewidywanych wartości indeksów. Usługa zwraca w indeksach dziennych wartości dla bieżących i następnych 5, 10 i 15 dni licząc od dnia bieżącego.

GET https://atlas.microsoft.com/weather/indices/daily/json?api-version=1.1&query={query}

Z parametrami opcjonalnymi:

GET https://atlas.microsoft.com/weather/indices/daily/json?api-version=1.1&query={query}&language={language}&duration={duration}&indexId={indexId}&indexGroupId={indexGroupId}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
format	path	True	JsonFormat	Żądany format odpowiedzi. Obsługiwany jest tylko format `json`.
api-version	query	True	string	Numer wersji interfejsu API usługi Azure Maps.
query	query	True	number[]	Odpowiednie zapytanie określone jako ciąg rozdzielony przecinkami składające się z szerokości geograficznej, po której następuje długość geograficzna, np. "47.641268,-122.125679". Informacje o pogodzie są ogólnie dostępne dla lokalizacji na lądzie, zbiorników wodnych otoczonych lądem oraz obszarów oceanu, które znajdują się w odległości około 50 mil morskich od linii brzegowej.
duration	query		integer	Określa, przez ile dni zwracane są indeksy dzienne. Domyślnie zwracane są dane indeksów z bieżącego dnia. W przypadku żądania danych dotyczących przyszłych indeksów, w odpowiedzi uwzględniany jest bieżący dzień jako dzień 1. Dostępne wartości to `1` - Zwraca dzienne dane indeksu dla bieżącego dnia. Wartość domyślna. `5` - Zwraca dzienne dane indeksu z 5 dni, zaczynając od dnia bieżącego. `10` - Zwraca dzienne dane indeksu z 10 dni, począwszy od dnia bieżącego. `15` - Zwraca dzienne dane indeksu z 15 dni, począwszy od dnia bieżącego.
indexGroupId	query		integer	Identyfikator grupy indeksów numerycznych, który może służyć do ograniczania zwracanych wyników do odpowiedniego podzbioru indeksów (grupy indeksów). Nie można sparować z `indexId`. Aby uzyskać szczegółowe informacje i zapoznać się z obsługiwanymi grupami indeksów, zapoznaj się z usługami pogodowymi w Azure Maps .
indexId	query		integer	Identyfikator indeksu liczbowego, którego można użyć do ograniczenia zwracanych wyników do odpowiedniego typu indeksu. Nie można sparować z `indexGroupId`. Zapoznaj się z usługami pogodowymi w Azure Maps , aby uzyskać szczegółowe informacje i zapoznać się z obsługiwanymi indeksami.
language	query		string	Język, w którym powinny być zwracane wyniki wyszukiwania. Powinien być jednym z obsługiwanych tagów języka IETF, bez uwzględniania wielkości liter. Jeśli dane w określonym języku nie są dostępne dla określonego pola, używany jest język domyślny. Aby uzyskać szczegółowe informacje, zobacz Obsługiwane języki.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
x-ms-client-id		string	Wskazuje konto przeznaczone do użycia z modelem zabezpieczeń Microsoft Entra ID. Ten unikatowy identyfikator konta Azure Maps można uzyskać z interfejsu API konta płaszczyzny zarządzania Azure Maps. Aby uzyskać więcej informacji na temat korzystania z zabezpieczeń Microsoft Entra ID w Azure Maps, zobacz Zarządzanie uwierzytelnianiem w Azure Maps.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	DailyIndicesResult	OK
Other Status Codes	ErrorResponse	Wystąpił nieoczekiwany błąd.

Zabezpieczenia

AADToken

Są to przepływy Microsoft Entra OAuth 2.0. Po połączeniu z dostępem opartym na rolach platformy Azure kontroli może służyć do kontrolowania dostępu do interfejsów API REST usługi Azure Maps. Mechanizmy kontroli dostępu opartej na rolach platformy Azure służą do wyznaczania dostępu do co najmniej jednego konta zasobu usługi Azure Maps lub zasobów podrzędnych. Każdy użytkownik, grupa lub jednostka usługi mogą mieć dostęp za pośrednictwem wbudowanej roli lub roli niestandardowej składającej się z co najmniej jednego uprawnienia do interfejsów API REST usługi Azure Maps.

Aby zaimplementować scenariusze, zalecamy wyświetlenie koncepcji uwierzytelniania . Podsumowując, ta definicja zabezpieczeń zawiera rozwiązanie do modelowania aplikacji za pośrednictwem obiektów, które mogą kontrolować dostęp do określonych interfejsów API i zakresów.

Notatki

Ta definicja zabezpieczeń wymaga użycia nagłówka x-ms-client-id w celu wskazania, do którego zasobu usługi Azure Maps aplikacja żąda dostępu. Można to uzyskać za pomocą interfejsu API zarządzania Maps.

Authorization URL jest specyficzna dla wystąpienia chmury publicznej platformy Azure. Suwerenne chmury mają unikatowe adresy URL autoryzacji i konfiguracje identyfikatorów Entra firmy Microsoft. * Kontrola dostępu oparta na rolach platformy Azure jest konfigurowana na podstawie płaszczyzny zarządzania platformy Azure za pośrednictwem witryny Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsów API REST. * Użycie zestawu Web SDK usługi Azure Maps umożliwia konfigurację opartą na konfiguracji aplikacji w wielu przypadkach użycia.

Aby uzyskać więcej informacji na temat platformy tożsamości firmy Microsoft, zobacz Microsoft identity platform overview.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresów

Nazwa	Opis
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Jest to klucz wspólny aprowizowany podczas tworzenie konta usługi Azure Maps w witrynie Azure Portal lub przy użyciu programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsu API REST.

Za pomocą tego klucza każda aplikacja może uzyskiwać dostęp do całego interfejsu API REST. Innymi słowy, ten klucz może służyć jako klucz główny na koncie, w którym są wystawiane.

W przypadku publicznie uwidocznionych aplikacji zalecamy użycie poufnych aplikacji klienckich podejście do uzyskiwania dostępu do interfejsów API REST usługi Azure Maps, aby klucz mógł być bezpiecznie przechowywany.

Typ: apiKey
W: query

SAS Token

Jest to token sygnatury dostępu współdzielonego tworzony na podstawie operacji List SAS na zasobie usługi Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem witryny Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsów API REST.

Dzięki temu tokenowi każda aplikacja jest autoryzowana do uzyskiwania dostępu za pomocą kontroli dostępu opartej na rolach platformy Azure i szczegółowej kontroli wygaśnięcia, szybkości i regionów użycia dla określonego tokenu. Innymi słowy, token SAS może służyć do umożliwienia aplikacjom kontrolowania dostępu w sposób bardziej zabezpieczony niż klucz wspólny.

W przypadku publicznie uwidocznionych aplikacji zalecamy skonfigurowanie określonej listy dozwolonych źródeł w zasobie Mapowanie konta w celu ograniczenia nadużyć renderowania i regularnego odnawiania tokenu SAS.

Typ: apiKey
W: header

Przykłady

Successfully retrieve daily indices values from current day

Przykładowe zapytanie

HTTP

GET https://atlas.microsoft.com/weather/indices/daily/json?api-version=1.1&query=43.84745,-79.37849&indexGroupId=11

Przykładowa odpowiedź

Kod stanu:: 200

{
  "results": [
    {
      "indexName": "Running Forecast",
      "indexId": 1,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 9.2,
      "category": "Excellent",
      "categoryValue": 5,
      "ascending": true,
      "description": "This is an excellent day for outdoor running!"
    },
    {
      "indexName": "Jogging Forecast",
      "indexId": 2,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 9.4,
      "category": "Excellent",
      "categoryValue": 5,
      "ascending": true,
      "description": "Conditions are excellent for jogging outdoors!"
    },
    {
      "indexName": "Hiking Forecast",
      "indexId": 3,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 9.8,
      "category": "Excellent",
      "categoryValue": 5,
      "ascending": true,
      "description": "Conditions are excellent for hiking!"
    },
    {
      "indexName": "Bicycling Forecast",
      "indexId": 4,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 9.9,
      "category": "Excellent",
      "categoryValue": 5,
      "ascending": true,
      "description": "Conditions are excellent for bicycling outdoors!"
    },
    {
      "indexName": "Golf Weather Forecast",
      "indexId": 5,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 10,
      "category": "Excellent",
      "categoryValue": 5,
      "ascending": true,
      "description": "This is a great day for golf."
    },
    {
      "indexName": "Tennis Forecast",
      "indexId": 6,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 9.2,
      "category": "Excellent",
      "categoryValue": 5,
      "ascending": true,
      "description": "This is an excellent day for playing tennis!"
    },
    {
      "indexName": "Skateboarding Forecast",
      "indexId": 7,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 9.9,
      "category": "Excellent",
      "categoryValue": 5,
      "ascending": true,
      "description": "This is an excellent day for skateboarding!"
    },
    {
      "indexName": "Outdoor Concert Forecast",
      "indexId": 8,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 9.7,
      "category": "Excellent",
      "categoryValue": 5,
      "ascending": true,
      "description": "Conditions are excellent for attending an outdoor concert!"
    },
    {
      "indexName": "Kite Flying Forecast",
      "indexId": 9,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 8.5,
      "category": "Very Good",
      "categoryValue": 4,
      "ascending": true,
      "description": "Conditions are very good today for kite-flying."
    },
    {
      "indexName": "Beach & Pool Forecast",
      "indexId": 10,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 8.6,
      "category": "Very Good",
      "categoryValue": 4,
      "ascending": true,
      "description": "Conditons will be very good for a visit to the beach or pool."
    },
    {
      "indexName": "Sailing Forecast",
      "indexId": 11,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 8.3,
      "category": "Very Good",
      "categoryValue": 4,
      "ascending": true,
      "description": "Conditions will be very good for sailing."
    },
    {
      "indexName": "Stargazing Forecast",
      "indexId": 12,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 9.5,
      "category": "Excellent",
      "categoryValue": 5,
      "ascending": true,
      "description": "This is a great night to be stargazing!"
    },
    {
      "indexName": "Fishing Forecast",
      "indexId": 13,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 3.5,
      "category": "Fair",
      "categoryValue": 2,
      "ascending": true,
      "description": "Expect only fair conditions for fishing."
    },
    {
      "indexName": "Ski Weather Forecast",
      "indexId": 15,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 0,
      "category": "Poor",
      "categoryValue": 1,
      "ascending": true,
      "description": "Expect poor conditions for skiing."
    },
    {
      "indexName": "Mosquito Activity Forecast",
      "indexId": 17,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 7,
      "category": "Very High",
      "categoryValue": 4,
      "ascending": true,
      "description": "The weather is favorable for a very high level of mosquito activity. Plan activities and insect repellents accordingly."
    },
    {
      "indexName": "Hunting Forecast",
      "indexId": 20,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 4.5,
      "category": "Fair",
      "categoryValue": 2,
      "ascending": true,
      "description": "Expect only fair conditions for hunting."
    },
    {
      "indexName": "Outdoor Barbecue",
      "indexId": 24,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 9.8,
      "category": "Excellent",
      "categoryValue": 5,
      "ascending": true,
      "description": "This is a great day for an outdoor barbecue!"
    },
    {
      "indexName": "Lawn Mowing Forecast",
      "indexId": 28,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 9.6,
      "category": "Excellent",
      "categoryValue": 5,
      "ascending": true,
      "description": "This is a great day for lawn mowing!"
    },
    {
      "indexName": "Outdoor Activity Forecast",
      "indexId": 29,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 8.7,
      "category": "Very Good",
      "categoryValue": 4,
      "ascending": true,
      "description": "Conditions will be very good for outdoor activities."
    }
  ]
}

Definicje

Nazwa	Opis
DailyIndex	Obiekt DailyIndex pomaga użytkownikom planować aktywności na świeżym powietrzu w oparciu o warunki pogodowe, podając nazwę aktywności, na przykład "Ski Weather Forecast"; ocena numeryczna od 0,0 do 10,0 wskazująca na przydatność; ocena tekstowa, taka jak "Słaby"; oraz krótki opis warunków, na przykład "Spodziewaj się złych warunków na narciarstwo."
DailyIndicesResult	Ten obiekt jest zwracany po pomyślnym wywołaniu funkcji Pobierz dzienne indeksy.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
JsonFormat	Żądany format odpowiedzi. Obsługiwany jest tylko format `json`.

DailyIndex

Sprzeciwiać się

Obiekt DailyIndex pomaga użytkownikom planować aktywności na świeżym powietrzu w oparciu o warunki pogodowe, podając nazwę aktywności, na przykład "Ski Weather Forecast"; ocena numeryczna od 0,0 do 10,0 wskazująca na przydatność; ocena tekstowa, taka jak "Słaby"; oraz krótki opis warunków, na przykład "Spodziewaj się złych warunków na narciarstwo."

Nazwa	Typ	Opis
ascending	boolean	Wskazuje kierunek `value` i `categoryValue` własności. Gdy jest to prawda, najsłabsza wartość indeksu to 0, a najlepsza wartość indeksu to 10. Gdy jest fałszywe, najsłabsza wartość indeksu to 10, a najlepsza wartość indeksu to 0.
category	string	Zapewnia jakościową ocenę indeksu, opisując `categoryValue` własność. Kategorie różnią się w zależności od indeksu i mogą obejmować wartości takie jak Doskonałe, Bardzo Dobre, Dobre, Średnie i Słabe.
categoryValue	integer (int32)	Zapewnia numeryczne przedstawienie właściwości kategorii, wskazujące jakościową ocenę indeksu. Wartości wahają się od 1 do 5 i powinny być używane wraz z rosnącą flagą, ponieważ mogą się różnić między indeksami. Na przykład dla aktywności komarów: Niska=1, Umiarkowana=2, Wysoka = 3, Bardzo wysoka = 4, Ekstremalna = 5.
dateTime	string (date-time)	Data i godzina obserwacji w formacie ISO 8601 (yyyy-mm-ddThh:mm:ss-hh:mm). Na przykład 2025-04-29T07:00:00-07:00.
description	string	Zapewnia krótkie, przyjazne dla użytkownika wyjaśnienie wartości indeksu, pomagając użytkownikom zrozumieć jej znaczenie w odniesieniu do konkretnych warunków pogodowych lub aktywności. Na przykład, jeśli wartość indeksu dla grilla na zewnątrz to 'Doskonałe', opis będzie brzmiał: 'To świetny dzień na grill na świeżym powietrzu!'
indexId	integer (int32)	Identyfikator numeryczny, który jednoznacznie reprezentuje określony typ indeksu, rozróżniający różne indeksy dla różnych aktywności na świeżym powietrzu. Na przykład 'indexId' równy 1 odpowiada indeksowi 'Running', a 'indexId' 5 odpowiada indeksowi 'Golfing'. Więcej informacji można znaleźć w artykule o identyfikatorach indeksu w artykule o koncepcjach usługi pogodowej w Azure Maps .
indexName	string	Nazwa indeksu wskazuje rodzaj aktywności lub schorzenia, do którego się odnosi, takie jak bieganie, gra w golfa czy inne aktywności na świeżym powietrzu. Więcej informacji można znaleźć w artykule o identyfikatorach indeksu w artykule o koncepcjach usługi pogodowej w Azure Maps .
value	number (float)	Wartość indeksu liczbowego w zakresie od 0,0 do 10,0, która określa przydatność warunków pogodowych do konkretnej aktywności lub warunku, takiego jak bieganie czy golf. Wyższe wartości zazwyczaj oznaczają korzystniejsze warunki, w zależności od wartości `ascending` nieruchomości. Na przykład wartość 8 dla indeksu 'Bieganie' sugeruje bardzo dobrą pogodę do biegania, podczas gdy wartość 6 dla indeksu 'Golfing' oznacza dobre, ale nieco mniej idealne warunki. Więcej informacji można znaleźć w artykule o codziennych zestawach zakresu indeksu w artykule o koncepcjach usługi pogodowej w Azure Maps .

DailyIndicesResult

Sprzeciwiać się

Ten obiekt jest zwracany po pomyślnym wywołaniu funkcji Pobierz dzienne indeksy.

Nazwa	Typ	Opis
results	DailyIndex[]	Lista wszystkich indeksów dziennych dla poszukiwanej lokalizacji.

ErrorAdditionalInfo

Sprzeciwiać się

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Sprzeciwiać się

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Sprzeciwiać się

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

JsonFormat

Wyliczenie

Żądany format odpowiedzi. Obsługiwany jest tylko format json.

Wartość	Opis
json	format wymiany danych notacji obiektów JavaScript

Udostępnij przez

Weather - Get Daily Indices

Parametry identyfikatora URI

Nagłówek żądania

Odpowiedzi

Zabezpieczenia

AADToken

Notatki

Zakresów

subscription-key

SAS Token

Przykłady

Successfully retrieve daily indices values from current day

Przykładowe zapytanie

Przykładowa odpowiedź

Definicje

DailyIndex

DailyIndicesResult

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

JsonFormat