Historia zmian interfejsu Google Analytics Management API

Co jakiś czas aktualizujemy interfejs API zarządzania Google Analytics, aby udostępniać nowe funkcje i naprawiać usterki wykryte w poprzednich wersjach. W większości przypadków zmiany te są przejrzyste dla deweloperów korzystających z interfejsów API. Czasami jednak musimy wprowadzać zmiany, które wymagają od programistów zmodyfikowania dotychczasowych aplikacji.

Na tej stronie znajdziesz informacje o wszystkich zmianach wprowadzonych w interfejsie Google Analytics Management API, które mogą mieć wpływ na Twoją aplikację. Zalecamy deweloperom korzystającym z interfejsów API sprawdzanie co jakiś czas tej listy, czy nie pojawiły się nowe ogłoszenia. Możesz też zasubskrybować zmiany za pomocą kanałów wymienionych w sekcji Subskrybuj poniżej.

Subskrybuj powiązane dzienniki zmian

Obejmuje wszystkie interfejsy API zbierania, konfiguracji i raportowania.

Obejmuje interfejs API do zarządzania i interfejs API do obsługi administracyjnej.

Ustawienia przechowywania danych użytkowników w interfejsie Management API

Można teraz programowo konfigurować ustawienia przechowywania danych użytkowników za pomocą nowych pól „dataPrzechowywanieTtl” i „dataPrzechowywanieResetOnNewActivity” dodanych do zasobu WebProperty.

Operacje zapisu w interfejsie Management API

Operacje zapisu w interfejsie Management API (np. tworzenie, aktualizowanie, usuwanie, poprawki) dla zasobów usługi internetowej, widoku danych (Profil) i celów nie wymagają już umieszczania na białej liście. Domyślny limit dzienny dla wszystkich operacji zapisu w interfejsie Management API to 50 zapisów dziennie. Więcej informacji znajdziesz na stronie Limity i limity.

Wskaźniki niestandardowe

Jest to wersja z poprawką błędów. Rozwiązano problem polegający na tym, że nie można było utworzyć danych niestandardowych typu TIME, gdy wartość parametru min_value nie była ustawiona. Żądania bez parametru min_value tworzą teraz dane niestandardowe z domyślną wartością min_value wynoszącą 0.

W tej wersji dodano listy odbiorców remarketingu do interfejsu Management API.

Odbiorcy remarketingu

Interfejs API zarządzania umożliwia tworzenie list odbiorców remarketingu (create, get, list, update i patch) w usłudze w Google Analytics. Więcej informacji o działaniu list odbiorców remarketingu znajdziesz w artykule Listy odbiorców remarketingu w Analytics – informacje w Centrum pomocy.

Niespróbkowane raporty

Interfejs API niespróbkowanych raportów nie ma już limitu 100 raportów dziennie. Interfejs API korzysta z tego samego systemu tokenów dla usługi i dziennie co przy tworzeniu niespróbkowanego raportu w interfejsie internetowym.

Niespróbkowane raporty

Niespróbkowane raporty, które są niedostępne dla bieżącego użytkownika, nie będą już miały linku do pobrania w odpowiedzi na żądanie interfejsu API zarządzania. Jest to teraz zgodne z funkcją panelu interfejsu, w której tylko właściciele raportów mogą zobaczyć link do pobierania wygenerowanego dokumentu.

Segmenty

To jest wersja z poprawką błędów. W tej wersji rozwiązaliśmy problem, który powodował, że segmenty z wartościami waluty w definicji wyświetlały się nieprawidłowo podczas wywoływania metody listy segmentów.

Segmenty

To jest wersja z poprawką błędów. W tej wersji rozwiązaliśmy problem, który powodował, że użytkownicy posiadający segmenty prywatne przypięte do wielu widoków (profili) podczas wywoływania metody listy segmentów wyświetlali komunikat o błędzie 500.

Grupowanie

W tej wersji oprócz ogólnej pomocy zbiorczej dodaliśmy specjalną obsługę interfejsu User Permissions API. Zbiorcze prośby o uprawnienia użytkowników pozwalają znacząco zwiększyć wydajność i zmniejszyć wykorzystanie limitu.

Wyświetlenia (profile)

W tej wersji właściwość Widok (profil) currency będzie teraz domyślnie ustawiona na USD, jeśli nie zostanie ustawiona podczas operacji insert. Również operacje get i list zwracają USD w widokach danych (profilach), które zostały wcześniej utworzone bez właściwości currency.

Filtry

W tej wersji usunęliśmy wycofane pola filtrów IS_MOBILE i IS_TABLET. Zastąp je wartościami DEVICE_CATEGORY=mobile i DEVICE_CATEGORY=tablet. Żądania wstawiania, aktualizacji i poprawek, które ustawiły pola filtra na potrzeby korzystania z pola IS_MOBILE, i IS_TABLET będą zwracać błąd.

Filtry

W tej wersji dodaliśmy obsługę używania wymiaru niestandardowego w polu filtra przez dodanie właściwości fieldIndex do wszystkich sekcji szczegółów filtra. Na przykład możesz teraz ustawić wyrażenie filtra z zastosowaniem "field": "CUSTOM_DIMENSION" i "fieldIndex": "1", aby filtr działał na pierwszym wymiarze niestandardowym.

Gole

W tej wersji rozwiązaliśmy też problem występujący, gdy nie można było utworzyć celu z użyciem funkcji "comparisonValue": "0".

Ta wersja jest ostatecznym wycofaniem i usunięciem zasobu dailyUpload. Zasób dailyUpload został oficjalnie wycofany 20 czerwca 2014 r. Importowanie danych o kosztach powinno odbywać się teraz za pomocą zasobu przesyłania.

W tej wersji do interfejsu Management API dodaliśmy 2 nowe kolekcje: Wymiary niestandardowe i Dane niestandardowe.

Wymiary i dane niestandardowe

Teraz za pomocą interfejsu API zarządzania możesz tworzyć, wyświetlać, pobierać, poprawiać i aktualizować niestandardowe wymiary i dane.

Odpowiedź metody list dotycząca wszystkich kolekcji zawiera teraz pustą listę dla właściwości items, jeśli zbiór nie zawiera żadnych zasobów. Wcześniej właściwość items była pomijana w odpowiedzi. Szczegółowe informacje o zapytaniach i odpowiedziach związanych z danymi konfiguracyjnymi Google Analytics znajdziesz w dokumentacji interfejsu API.

Poprawki błędów

W tej wersji wprowadziliśmy nowy zakres interfejsu Google Analytics Management API. – analytics.manage.users.readonly – Wyświetl uprawnienia użytkownika Google Analytics.

Dodano nowe pole filtrów DEVICE_CATEGORY, a opcje IS_MOBILE i IS_TABLET zostały wycofane. Należy użyć właściwości DEVICE_CATEGORY=mobile i DEVICE_CATEGORY=tablet.

Zasób Widok (Profil) zawiera teraz właściwość enhancedECommerceTracking, która wskazuje, czy Ulepszone e-commerce jest włączone (true), czy wyłączone (false).

Ta wersja zawiera nowe typy importu danych i wycofanie zasobu dailyUpload.

Import danych

Szczegółowe informacje o tym, jak importować dane na konto Google Analytics za pomocą interfejsu API zarządzania, znajdziesz w Przewodniku dla programistów ds. importu danych.

Przesłanie filmu

  • Zasób upload obsługuje teraz te typy przesyłania:
    • Dane kampanii
    • Dane o treści
    • Dane o kosztach
    • Dane produktu
    • Dane o zwrocie środków
    • Dane użytkownika
  • Zasób upload korzysta z nowej metody migrateDataImport, która pozwala przenieść istniejące dane o kosztach customDataSources.

Wycofanie codziennej liczby przesłanych filmów

  • Zasób dailyUpload został wycofany. W przewodniku po migracji znajdziesz więcej informacji o korzystaniu z funkcji Import danych.
  • Zasób dailyUpload będzie działać jeszcze przez 6 miesięcy. Gdy to nastąpi, pozostałe zasoby customDataSources z właściwością uploadType ustawioną na analytics#dailyUploads zostaną automatycznie przeniesione i będą działać tylko z zasobem upload.
  • Obecni użytkownicy zasobu dailyUpload powinni zaktualizować swój kod i jak najszybciej rozpocząć migrację do zasobu Prześlij.

W tej wersji dodaliśmy 2 nowe interfejsy API konfiguracji.

Filtry

Niespróbkowane raporty: interfejs API zarządzania

Do interfejsu API zarządzania zostaje dodany nowy zasób o nazwie Niespróbkowane raporty. Niespróbkowane raporty to raporty Google Analytics, które zostały wygenerowane na podstawie niespróbkowanych danych.Niespróbkowane raporty są obecnie dostępne tylko dla użytkowników Google Analytics Premium. 

Segmenty: interfejs API zarządzania w wersji 2.4 i 3.0

W kolekcji segmentów wprowadzono te zmiany:

  • Segmenty użytkowników i sekwencji są teraz obsługiwane przez interfejs API.
  • Kolekcja Segmenty zawiera teraz wszystkie wbudowane i niestandardowe segmenty na poziomie sesji i na poziomie użytkownika.
  • Właściwość definition w przypadku segmentów będzie używać nowej składni segmentów. Obejmuje to definicje istniejących segmentów na poziomie sesji, które zmienią się z definition: "" na definition: "sessions::condition::".
  • Do zasobu Segment została dodana nowa usługa type, która wskazuje, czy segment to CUSTOM (tj. utworzony przez użytkownika w interfejsie internetowym) czy BUILT_IN (dostarczany przez Google Analytics).

Eksperymenty

Jako celów optymalizacji można teraz używać tych danych AdSense:

  • ga:adsenseAdsClicks – liczba kliknięć reklam AdSense w Twojej witrynie.
  • ga:adsenseAdsViewed – liczba wyświetlonych reklam AdSense. W jednej jednostce reklamowej może być wyświetlanych wiele reklam.
  • ga:adsenseRevenue – łączne przychody z reklam AdSense.

Nowa kolekcja podsumowań kont

  • Kolekcja AccountSummaries została dodana do interfejsu Management API. Zawiera podsumowanie informacji o każdym koncie, usłudze i widoku (profilu), do którego autoryzowany użytkownik ma dostęp, w ramach jednej, szybkiej prośby. Szczegółowe informacje znajdziesz w Przewodniku dla programistów podsumowań konta.

W segmentach domyślnych wprowadziliśmy te zmiany z powodu wycofania wymiarów ga:isMobile i ga:isTablet:

  • Nazwa segmentu gaid::-11 została zmieniona z Ruch z komórek na Ruch z komórek i tabletów. Definicja tego segmentu została zmieniona z ga:isMobile==Yes na ga:deviceCategory==mobile,ga:deviceCategory==tablet. Pamiętaj, że ga:isMobile uwzględnia ruch z tabletów, co jest odzwierciedlone w nowej definicji. Jeśli zależy Ci tylko na ruchu z urządzeń mobilnych, z wyłączeniem tabletów, przełącz się na nowy segment Ruch z komórek (gaid::-14).
  • Definicja segmentu gaid::-13 została zmieniona z ga:isTablet==Yes na ga:deviceCategory==tablet. Nadal odzwierciedla Ruch z tabletów.
  • Dodano segment gaid::-14. Nazwa segmentu to Ruch z komórek, a jego definicja to ga:deviceCategory==mobile.

Poprawki błędów:

  • Informacje o strefie czasowej w widokach (profilach) zostały naprawione. Szczegóły: przed wprowadzeniem tej poprawki w niektórych przypadkach wyświetlania listy widoków (profili) w interfejsie Management API zwracano nieprawidłowe informacje o strefie czasowej widoku (profilu). Teraz informacje o strefie czasowej w widokach (profilach) są spójne z informacjami w interfejsie administratora Google Analytics.

W tej wersji wprowadziliśmy operacje zapisu w zasobach usług internetowych, widoków (profili) i celów, a także zestaw 3 nowych zasobów umożliwiających zarządzanie uprawnieniami użytkowników.

Interfejsy API do zakładania i konfigurowania kont

  • Można teraz tworzyć, aktualizować, naprawiać i usuwać widoki danych (profile). Szczegółowe informacje o nowych metodach znajdziesz w dokumentacji widoku danych (profile).
  • Można teraz tworzyć, aktualizować i wprowadzać poprawki do usług internetowych i celów. Szczegółowe informacje o nowych metodach znajdziesz w informacjach o usługach internetowych i w dokumentacji celów.
  • Za pomocą metody get można teraz wysyłać żądania dotyczące pojedynczej usługi internetowej, widoku (profilu) lub celu.
  • Te funkcje są obecnie dostępne w wersji przedpremierowej dla deweloperów w ograniczonej wersji beta. Jeśli chcesz się zarejestrować, poproś o dostęp do wersji beta.

Uprawnienia użytkowników w interfejsie API zarządzania

W ramach wprowadzania nowych segmentów wprowadzimy w kolekcji segmentów następujące zmiany:

  • Wszystkie identyfikatory segmentów zostaną zmienione z dodatnich liczb całkowitych na ciągi alfanumeryczne. Jeśli masz zapisane identyfikatory segmentów użytkowników, zalecamy ich zaktualizowanie, tak aby zawierały nowe identyfikatory.
  • Kolekcja Segmenty zwróci tylko dotychczasowe segmenty na poziomie wizyty. Interfejs API nie obsługuje obecnie nowych segmentów użytkowników, kohort i sekwencji.
  • Kolekcja Segmenty będzie nadal zwracać istniejące segmenty domyślne o identycznych ujemnych identyfikatorach liczbowych, ale nowe segmenty domyślne nie są obecnie obsługiwane.

W tej wersji do zasobu usługi internetowej dodaliśmy 2 nowe usługi:

  • profileCount – zwraca liczbę profili dla usługi. Umożliwia to filtrowanie właściwości, które nie mają żadnych profili (np. profileCount = 0).
  • industryVertical – zwraca branżę/kategorię wybraną dla usługi.

Poprawki błędów:

  • Właściwość eCommerceTracking zasobu profilu jest teraz spójna z ustawieniami e-commerce w sekcji administracyjnej interfejsu internetowego. Zwraca wartość true, jeśli śledzenie e-commerce jest włączone, lub false, jeśli nie jest włączone.
  • Zasób usługi internetowej zawiera teraz usługę level, która wskazuje, czy określona usługa internetowa to PREMIUM czy STANDARD.
  • Do interfejsu Management API w wersji 3 dodano nowy punkt końcowy, który umożliwia dostęp do zasobów eksperymentów i ich modyfikowanie.
  • Zasób profilu zawiera teraz właściwość type, która wskazuje, czy profil jest skonfigurowany dla witryny czy aplikacji. Dwie możliwe wartości to: WEB lub APP.

W tej wersji dodaliśmy przydatne odpowiedzi na błędy do interfejsu Management API.

  • Do treści odpowiedzi na błędy interfejsu API dodaliśmy nowe kody błędów, przyczyny i opisy. Wszystkie kody zostały udokumentowane dla obu wersji – wersji 2.4 i wersji 3.0 – interfejsu API zarządzania.

Ta wersja dodaje dane, zmienia dotychczasowe funkcje i naprawia błąd.

Nowe dane

  • Kolekcja Zaawansowane segmenty zawiera teraz pole segmentId, które można wykorzystać w parametrze segment interfejsu API eksportu danych.

Zmiany

  • Typ danych max-results został zmieniony na integer.

  • Wartość domyślna i maksymalna parametru max-results została zmieniona na 1000.

Poprawki błędów

  • Konta, usługi internetowe i profile eksperymentów w Optymalizatorze witryny Google nie są już uwzględniane w odpowiadających im kolekcjach.

W tej wersji dodaliśmy 2 nowe wersje interfejsu API z wieloma nowymi funkcjami i wycofujemy starą. Zmiany wpływają na sposób wysyłania żądań i obsługi danych z interfejsu API.

Versja 3.0

  • To jest najnowsza główna wersja naszego interfejsu API. Nie jest zgodna wstecznie. Wszystkie przyszłe interfejsy API będą się opierać na tej wersji.

  • Nowe dane

    • Pełna reprezentacja celów zdarzeń
    • Wewnętrzny identyfikator usługi internetowej, który można wykorzystać na potrzeby precyzyjnego linku do interfejsu Google Analytics
    • Konfiguracje profili dla domyślnych parametrów zapytania dotyczących strony i witryny
  • Zmiany

Wersja 2.4

  • Jest to uaktualnienie wersji podrzędnej, które jest w większości zgodne wstecznie z dotychczasową wersją 2.3.

  • Zmiany

    • nowe zasady dotyczące limitów.
    • integracja z Konsolą interfejsów API Google w celu zarządzania dostępem do interfejsu API i zgłaszania prośby o zwiększenie limitu,
    • ciągła obsługa istniejących mechanizmów autoryzacji i protokołu protokołu OAuth 2.0.
    • Nowy adres URL, z którego można przesyłać prośby: https://www.googleapis.com/analytics/v2.4/management/…
    • Odpowiedzi tylko w formacie XML
    • Brak obsługi biblioteki klienta Google Data JavaScript
    • Dane wyjściowe XML zgodne z wersją 2.3, więc pozostałe biblioteki klienta danych Google będą nadal działać.

Wycofanie

  • Ogłaszamy wycofanie starszej wersji 2.3 interfejsu Management API. Będzie ona działać przez 2 miesiące. Po tym czasie wszystkie żądania w wersji 2.3 będą zwracać odpowiedź w wersji 2.4.

Oto wersja beta interfejsu Google Analytics Management API.

Nowe pliki danych

Zaktualizowane biblioteki klienta

  • Interfejs API zarządzania zostanie udostępniony w tej samej bibliotece co interfejs Google Analytics Data Export API. Zaktualizowaliśmy biblioteki Java Data i JavaScriptu w Google. Dostęp do każdego kanału można uzyskać, podając odpowiedni identyfikator URI pliku danych metody getManagementFeed() biblioteki.

Nowa dokumentacja