API Reference

To materiały referencyjne interfejsu API są uporządkowane według typu zasobu. Każdy typ zasobu ma co najmniej 1 reprezentację danych i co najmniej 1 metodę.

Typy zasobów

  1. Users.dataSources
  2. Users.dataSources.dataPointChanges
  3. Users.dataSources.datasets
  4. Users.dataset
  5. Users.sessions

Users.dataSources

Szczegółowe informacje o zasobie Users.dataSources znajdziesz na stronie dotyczącej reprezentacji zasobów.

Metoda Żądanie HTTP Opis
Identyfikatory URI są względne w stosunku do https://www.googleapis.com/fitness/v1/users, chyba że zaznaczono inaczej
create (utwórz) POST  /userId/dataSources Tworzy nowe źródło danych, które będzie unikalne we wszystkich źródłach danych należących do tego użytkownika.

Źródło danych to niepowtarzalne źródło danych z czujnika. Źródła danych mogą udostępniać nieprzetworzone dane pochodzące z czujników sprzętowych na urządzeniach lokalnych lub towarzyszących. Mogą też udostępniać dane pochodne utworzone przez przekształcenie lub scalanie innych źródeł danych. Ten sam typ danych może obejmować wiele źródeł danych. Każdy punkt danych w każdym zbiorze danych wstawiony do interfejsu Fitness API lub z niego odczytywany ma powiązane źródło danych.

Każde źródło danych generuje unikalny strumień aktualizacji zbioru danych z unikalnym identyfikatorem źródła danych. Nie wszystkie zmiany w źródle danych wpływają na identyfikator strumienia danych. Dlatego informacje zbierane przez zaktualizowane wersje tej samej aplikacji lub tego samego urządzenia można nadal uznać za należące do tego samego źródła.

Źródła danych są identyfikowane za pomocą ciągu tekstowego wygenerowanego przez serwer na podstawie treści tworzonego źródła. Podczas wywoływania tej metody nie należy ustawiać pola dataStreamId. Zostanie on automatycznie wygenerowany przez serwer w prawidłowym formacie. Jeśli ustawiono dataStreamId, musi on być zgodny z formatem wygenerowanym przez serwer. Ten format stanowi kombinację niektórych pól ze źródła danych i ma określoną kolejność. Jeśli te dane nie są zgodne, żądanie zakończy się błędem.

Wskazanie nieznanego typu danych (zaczynającego się od „com.google.”) spowoduje utworzenie źródła danych z niestandardowym typem danych. Niestandardowe typy danych są odczytywane tylko przez aplikację, która je utworzyła. Niestandardowe typy danych są wycofane. Zamiast nich używaj standardowych typów danych.

Oprócz pól źródła danych uwzględnionych w identyfikatorze źródła danych podany jest też numer projektu dewelopera, który jest uwierzytelniany podczas tworzenia źródła danych. Ten numer projektu dewelopera jest zaciemniony podczas odczytywania innego programisty, który odczytuje typy danych publicznych.
usuń DELETE  /userId/dataSources/dataSourceId Usuwa określone źródło danych. Żądanie się nie powiedzie, jeśli źródło danych zawiera jakiekolwiek punkty danych.
pobierz GET  /userId/dataSources/dataSourceId Zwraca określone źródło danych.
list GET  /userId/dataSources Zawiera listę wszystkich źródeł danych, które są widoczne dla dewelopera przy użyciu dostępnych zakresów OAuth. Lista nie jest pełna. Użytkownik może mieć prywatne źródła danych, które są widoczne tylko dla innych deweloperów, lub wywołania używające innych zakresów.
aktualizacja PUT  /userId/dataSources/dataSourceId Aktualizuje określone źródło danych. Nie można modyfikować właściwości dataStreamId, dataType, type, dataStreamName i device (z wyjątkiem właściwości version).

Źródła danych są identyfikowane za pomocą atrybutu dataStreamId.

Users.dataSources.dataPointChanges

Szczegółowe informacje o zasobie Users.dataSources.dataPointChanges znajdziesz na stronie poświęconej reprezentacji zasobów.

Metoda Żądanie HTTP Opis
Identyfikatory URI są względne w stosunku do https://www.googleapis.com/fitness/v1/users, chyba że zaznaczono inaczej
list GET  /userId/dataSources/dataSourceId/dataPointChanges Zapytania dotyczące punktów danych użytkownika zmieniają się w przypadku określonego źródła danych.

Users.dataSources.datasets

Informacje o zasobach dotyczące Users.dataSources.datasets znajdziesz na stronie poświęconej reprezentacji zasobów.

Metoda Żądanie HTTP Opis
Identyfikatory URI są względne w stosunku do https://www.googleapis.com/fitness/v1/users, chyba że zaznaczono inaczej
usuń DELETE  /userId/dataSources/dataSourceId/datasets/datasetId Wykonuje operację włącznie z usunięciem wszystkich punktów danych, których czasy rozpoczęcia i zakończenia pokrywają się z zakresem czasowym określonym przez identyfikator zbioru danych. W przypadku większości typów danych cały punkt danych zostanie usunięty. W przypadku typów danych, w których przedział czasu przedstawia stałą wartość (np. com.google.activity.segment), a punkt danych znajduje się w jednym z punktów końcowych zbioru danych, usunięta zostanie tylko część tego punktu danych, która pokrywa się z nim.
pobierz GET  /userId/dataSources/dataSourceId/datasets/datasetId Zwraca zbiór danych zawierający wszystkie punkty danych, których czasy rozpoczęcia i zakończenia pokrywają się z określonym zakresem minimalnego i maksymalnego czasu zakończenia zbioru danych. W szczególności dotyczy to każdego punktu danych, którego czas rozpoczęcia jest krótszy lub równy czasowi zakończenia zbioru danych i który czas zakończenia jest późniejszy lub równy czasowi rozpoczęcia zbioru danych.
poprawka PATCH  /userId/dataSources/dataSourceId/datasets/datasetId Dodaje punkty danych do zbioru danych. Zbiór danych nie musi być utworzony wcześniej. Wszystkie punkty w danym zbiorze danych zostaną zwrócone wraz z kolejnymi wywołaniami służącymi do pobrania tego zbioru danych. Punkty danych mogą należeć do więcej niż 1 zbioru danych.

Ta metoda nie korzysta z semantyki poprawki: podane punkty danych są tylko wstawiane, a istniejące dane nie są zastępowane.

Users.dataset

Informacje o zasobach na karcie Users.dataset znajdziesz na stronie poświęconej reprezentacji zasobów.

Metoda Żądanie HTTP Opis
Identyfikatory URI są względne w stosunku do https://www.googleapis.com/fitness/v1/users, chyba że zaznaczono inaczej
zagregowane, POST  /userId/dataset:aggregate Agreguje dane określonego typu lub strumienia w zasobniki podzielone przez określony typ granicy. Dokładnie 1 typ zasobnika można połączyć z wieloma zbiorami danych różnych typów i z wielu źródeł na żądanie.

Users.sessions

Szczegółowe informacje o zasobie Users.sessions znajdziesz na stronie poświęconej reprezentacji zasobów.

Metoda Żądanie HTTP Opis
Identyfikatory URI są względne w stosunku do https://www.googleapis.com/fitness/v1/users, chyba że zaznaczono inaczej
usuń DELETE  /userId/sessions/sessionId Usuwa sesję określoną przez podany identyfikator sesji.
list GET  /userId/sessions Wyświetla listę utworzonych wcześniej sesji.
aktualizacja PUT  /userId/sessions/sessionId Aktualizuje lub wstaw dane sesji.