Podstawy raportowania zadań

Za pomocą zadań raportowania możesz uruchomić długotrwałe żądanie asynchroniczne, aby utworzyć dostosowany raport z danymi o zdarzeniach w Google Analytics,

Zasób zadania raportowania wygenerowany na podstawie tego żądania może zostać użyty do uzyskania dostępu dostosowane raporty przez wszystkich użytkowników z uprawnieniami do odczytu Twojego konta Google Analytics usłudze.

Raport niestandardowy będzie dostępny przez 72 godziny od momentu, gdy będzie gotowy. Po tym okresu, odpowiedni zasób zadania raportu oraz jego zawartość zostaną usunięte automatycznie.

Utwórz zadanie związane z raportem

Interfejs Google Analytics Data API w wersji 1 korzysta z metody asynchronicznej do tworzenia zadań raportowania. Po pierwsze, żądanie reportTasks.create jest niezbędna do utworzenia zadania raportowania. Następnie funkcja reportTasks.query służy do pobrania wygenerowanego niestandardowego raportu.

Dodatkowo możesz użyć funkcji reportTasks.get pobierania metadanych konfiguracji określonego zadania raportowania oraz reportTasks.list aby wyświetlić listę wszystkich zadań raportowania w danej usłudze.

Wybierz podmiot zgłaszający

Wszystkie metody interfejsu Data API v1 wymagają Identyfikator usługi w Google Analytics ma być określony w ścieżce żądania adresu URL w formacie properties/GA_PROPERTY_ID, na przykład:

  POST  https://analyticsdata.googleapis.com/v1alpha/properties/GA_PROPERTY_ID/reportTasks

Raport jest generowany na podstawie zdarzenia Google Analytics zebrane w wybranej usłudze w Google Analytics.

Jeśli używasz jednej z bibliotek klienta interfejsu Data API, nie trzeba ręcznie modyfikować ścieżki adresu URL żądania. Większość klientów interfejsu API udostępnia parametr property, który oczekuje jako ciąg properties/GA_PROPERTY_ID. Przykłady znajdziesz w krótkim przewodniku dla początkujących. korzystania z bibliotek klienta.

Poproś o utworzenie zadania dotyczącego raportowania

Aby utworzyć zadanie związane z raportowaniem, wywołaj funkcję reportTasks.create za pomocą funkcji ReportTask do wybranego obiektu w żądaniu. Wymagane są te parametry:

Przykładowe żądanie utworzenia zadania tworzenia raportów:

Żądanie HTTP
POST https://analyticsdata.googleapis.com/v1alpha/properties/1234567/reportTasks
{
  "reportDefinition": {
    "dateRanges": [{ "startDate": "2024-05-01"", "endDate": "2024-05-15" }],
    "dimensions": [{ "name": "country" }],
    "metrics": [{ "name": "activeUsers" }]
  }
}

Odpowiedź metody reportTasks.create zawiera raport Nazwa zadania w polu name (np. properties/1234567/reportTasks/123), których można użyć w kolejnych zapytań w celu uzyskania stanu zadania raportowania i pobrania danych raport, który generuje raport.

Odpowiedź HTTP
{
  "response": {
    "@type": "type.googleapis.com/google.analytics.data.v1alpha.ReportTask",
    "name": "properties/1234567/reportTasks/123",
    "reportDefinition": {
      "dimensions": [
        {
          "name": "country"
        }
      ],
      "metrics": [
        {
          "name": "activeUsers"
        }
      ],
      "dateRanges": [
        {
          "startDate": "2024-05-01",
          "endDate": "2024-05-15"
        }
      ]
    },
    "reportMetadata": {
      "state": "CREATING",
      "beginCreatingTime": "2024-05-16T00:00:01.133612336Z"
    }
  }
}

Pobieranie stanu gotowości zadania związanego z raportowaniem

Wygenerowanie raportu może potrwać kilka minut. reportTasks.create . Stan gotowości do zadania raportowania możesz sprawdzić, wywołując metodę reportTasks.get .

Użyj nazwy zadania raportowania (np. properties/1234567/reportTasks/123) otrzymane w odpowiedzi reportTasks.create, aby określić Zgłoś zadanie.

Przykład:

Żądanie HTTP
GET https://analyticsdata.googleapis.com/v1alpha/properties/1234567/reportTasks/123

Stan gotowości zadania raportowania jest zwracany w state odpowiedzi. Po wygenerowaniu raportu stan zadania związanego z raportowaniem zmienia się z CREATING na ACTIVE.

reportMetadata zawiera ogólne informacje o wygenerowanym raporcie, takie jak liczba wierszy i liczba obciążeń za tokeny limitu.

Odpowiedź HTTP
{
  "reportDefinition": {
    "dimensions": [
      {
        "name": "country"
      }
    ],
    "metrics": [
      {
        "name": "activeUsers"
      }
    ],
    "dateRanges": [
      {
        "startDate": "2024-05-01",
        "endDate": "2024-05-15"
      }
    ]
  },
  "reportMetadata": {
    "state": "ACTIVE",
    "beginCreatingTime": "2024-05-16T00:00:01.133612336Z",
    "creationQuotaTokensCharged": 6,
    "taskRowCount": 167,
    "errorMessage": "",
    "totalRowCount": 167
  }
}

Stan wszystkich zadań raportowania możesz sprawdzić, wywołując metodę reportTasks.list .

Pobieranie wygenerowanego raportu

Po utworzeniu zadania do raportowania za pomocą reportTasks.create , wywołaj metodę reportTasks.query i podaj nazwę zadania raportowania. (na przykład properties/1234567/reportTasks/123).

Żądanie HTTP
POST https://analyticsdata.googleapis.com/v1alpha/properties/1234567/reportTasks/123:query

Jeśli zadanie raportowania jest gotowe, zwracana jest odpowiedź zawierająca wygenerowany raport:

Odpowiedź HTTP
{
  "dimensionHeaders": [
    {
      "name": "country"
    }
  ],
  "metricHeaders": [
    {
      "name": "activeUsers",
      "type": "TYPE_INTEGER"
    }
  ],
  "rows": [

...

  ],
  "rowCount": 167,
  "metadata": {
    "currencyCode": "USD",
    "timeZone": "America/Los_Angeles"
  }
}