Tworzenie eksportu list odbiorców

Listy odbiorców w Google Analytics 4 umożliwiają dzielenie użytkowników na segmenty według znaczenia dla Twojej firmy. Dzięki listom odbiorców możesz grupować użytkowników witryny lub aplikacji według wspólnych atrybutów.

Listy odbiorców, w tym podsumowanie ich użytkowników, możesz eksportować za pomocą interfejsu Data API.

Ważne informacje o danych, które widzisz w eksportach list odbiorców, znajdziesz w przewodniku Oczekiwania dotyczące eksportu danych o odbiorcach.

Przegląd

Aby utworzyć eksport list odbiorców i wysłać do niego zapytanie, wykonaj te żądania do interfejsu Data API:

  1. Wywołaj metodę audienceExports.create, aby utworzyć eksport list odbiorców.
  2. Wywołaj metodę audienceExports.query, która służy do pobierania użytkowników z listy odbiorców.

Aby uzyskać więcej informacji, możesz wywołać metodę audienceExports.get, aby pobrać metadane konfiguracji określonego eksportu odbiorców, i wywołać audienceExports.list, aby wyświetlić wszystkie eksporty list odbiorców z konkretnej usługi.

Wybierz podmiot zgłaszający

Wszystkie metody interfejsu Data API wymagają określenia identyfikatora usługi w Google Analytics 4 w ścieżce żądania adresu URL w postaci properties/GA4_PROPERTY_ID. Oto przykład:

  POST  https://analyticsdata.googleapis.com/v1beta/properties/GA4_PROPERTY_ID/audienceExports

Raport jest generowany na podstawie danych o zdarzeniach Google Analytics zebranych przez określoną usługę w Google Analytics 4.

Jeśli korzystasz z jednej z bibliotek klienta interfejsu Data API, nie musisz zmieniać ścieżki adresu URL żądania. Większość klientów interfejsu API udostępnia parametr property, który oczekuje ciągu znaków w postaci properties/GA4_PROPERTY_ID. Przykłady korzystania z bibliotek klienta znajdziesz w krótkim przewodniku.

Tworzenie eksportu list odbiorców

Aby utworzyć eksport list odbiorców, wywołaj metodę audienceExports.create za pomocą obiektu AudienceExport w żądaniu. Wymagane są te parametry:

  • W polu audience podana jest prawidłowa nazwa listy odbiorców w formacie properties/{propertyId}/audiences/{audienceId}. Aby uzyskać tę wartość, możesz użyć metody audiences.list z interfejsu Google Analytics Admin API w wersji 1. Pole Audience.name odpowiedzi audiences.list zawiera nazwę listy odbiorców.
  • Prawidłowa lista wymiarów w polu dimensions. Listę wymiarów obsługiwanych przez tę metodę znajdziesz w dokumentacji schematu eksportu odbiorców. Eksport listy odbiorców obejmuje tylko dane z wymiarów wymienionych w tym polu.

Oto przykładowe żądanie utworzenia eksportu list odbiorców:

Żądanie HTTP

POST https://analyticsdata.googleapis.com/v1beta/properties/1234567/audienceExports
{
  "audience": "properties/1234567/audiences/12345",
  "dimensions": [
    {
      "dimensionName": "deviceId"
    }
  ]
}

Odpowiedź metody audienceExports.create zawiera w polu name nazwę eksportu odbiorców, np. properties/1234567/audienceExports/123. Oto przykładowa odpowiedź:

Odpowiedź HTTP

{
  "response": {
    "@type": "type.googleapis.com/google.analytics.data.v1alpha.AudienceExport",
    "name": "properties/1234567/audienceExports/123",
    "audience": "properties/1234567/audiences/12345",
    "audienceDisplayName": "Purchasers",
    "dimensions": [
      {
        "dimensionName": "deviceId"
      }
    ],
    "state": "CREATING",
    "beginCreatingTime": "2023-06-22T23:35:28.787910949Z"
  }
}

Za pomocą name możesz wysyłać zapytania do użytkowników z eksportu list odbiorców.

Wysyłanie zapytania o stan gotowości eksportu list odbiorców

Po wywołaniu audienceExports.create wygenerowanie eksportu list odbiorców może potrwać kilka minut.

Stan gotowości eksportu list odbiorców możesz sprawdzić, wywołując metodę audienceExports.get.

Aby określić w żądaniu eksport list odbiorców, użyj nazwy z odpowiedzi audienceExports.create.

Oto przykładowe żądanie:

Żądanie HTTP

GET https://analyticsdata.googleapis.com/v1beta/properties/1234567/audienceExports/123

Stan gotowości do eksportu odbiorców jest zwracany w polu state odpowiedzi. Po zakończeniu generowania eksportu list odbiorców jego stan zmienia się z CREATING na ACTIVE.

Oto przykładowa odpowiedź:

Odpowiedź HTTP

{
  "name": "properties/1234567/audienceExports/123",
  "audience": "properties/1234567/audiences/12345",
  "audienceDisplayName": "Purchasers",
  "dimensions": [
    {
      "dimensionName": "deviceId"
    }
  ],
  "state": "CREATING",
  "beginCreatingTime": "2023-06-22T23:35:28.787910949Z"
}

Stan wszystkich eksportów list odbiorców możesz uzyskać, wywołując metodę audienceExports.list.

Pobieranie użytkowników z eksportu list odbiorców

Po wygenerowaniu eksportu list odbiorców wywołaj metodę audienceExports.query i określ name eksportu list odbiorców w żądaniu.

Oto przykładowe żądanie:

Żądanie HTTP

POST https://analyticsdata.googleapis.com/v1beta/properties/1234567/audienceExports/123:query

Jeśli eksport list odbiorców jest gotowy, wywołanie zwróci listę użytkowników na tej liście.

Oto przykładowa odpowiedź:

Odpowiedź HTTP

{
  "audienceExport": {
    "name": "properties/1234567/audienceExports/123",
    "audience": "properties/1234567/audiences/12345",
    "audienceDisplayName": "Purchasers",
    "dimensions": [
      {
        "dimensionName": "deviceId"
      }
    ],
    "state": "ACTIVE",
    "beginCreatingTime": "2023-06-22T23:35:28.787910949Z"
  },
  "audienceRows": [
    {
      "dimensionValues": [
        {
          "value": "1000276123.1681742376"
        }
      ]
    },
    {
      "dimensionValues": [
        {
          "value": "1000374452.1668627377"
        }
      ]
    },
    {
      "dimensionValues": [
        {
          "value": "1000391956.1652750758"
        }
      ]
    },
    {
      "dimensionValues": [
        {
          "value": "1000410539.1682018694"
        }
      ]
    },
    {
      "dimensionValues": [
        {
          "value": "1000703969.1666725875"
        }
      ]
    }
  ],
  "rowCount": 5
}