Tworzenie eksportu list odbiorców

Listy odbiorców w Google Analytics pozwalają podzielić użytkowników na segmenty w sposób odpowiadający potrzebom Twojej firmy. Dzięki listom odbiorców możesz grupować użytkowników swojej witryny lub aplikacji na podstawie wspólnych atrybutów.

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

Ważne informacje o danych widocznych w eksportach list odbiorców znajdziesz w artykule Oczekiwania dotyczące danych eksportowanych z list odbiorców.

Przegląd

Aby utworzyć i wykonać zapytanie dotyczące eksportu list odbiorców, wyślij te żądania do interfejsu Data API:

1. Aby utworzyć eksport list odbiorców, wywołaj metodę audienceExports.create.
2. Wywołaj metodę audienceExports.query, aby pobrać użytkowników z listy odbiorców.

Aby dowiedzieć się więcej, możesz wywołać metodę audienceExports.get, która pobiera metadane konfiguracji dotyczące konkretnego eksportu list odbiorców, oraz metodę audienceExports.list, która wyświetla listę wszystkich eksportów list odbiorców w przypadku danej usługi.

Wybierz podmiot raportujący

Wszystkie metody interfejsu Data API wymagają podania identyfikatora usługi w Google Analytics w ścieżce żądania adresu URL w formacie properties/GA_PROPERTY_ID. Oto przykład:

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

Raport jest generowany na podstawie danych zdarzeń Google Analytics zebranych w określonej usłudze w Google Analytics.

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

Tworzenie eksportu list odbiorców

Aby utworzyć eksport listy odbiorców, wywołaj metodę audienceExports.create, używając w żądaniu obiektu AudienceExport. Wymagane są te parametry:

• Prawidłowa nazwa listy odbiorców w polu audience w formacie properties/{propertyId}/audiences/{audienceId}. Aby uzyskać tę wartość, możesz użyć metody audiences.list 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 list odbiorców. W eksportowanych danych o odbiorcach uwzględniane są tylko dane dotyczące wymiarów wymienionych w tym polu.

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

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

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

{
  "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"
  }
}

Możesz użyć name, aby wysłać zapytanie o użytkowników z eksportu list odbiorców.

Sprawdzanie stanu gotowości eksportu listy odbiorców

Wygenerowanie eksportu listy odbiorców po wywołaniu audienceExports.create może potrwać kilka minut.

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

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

Oto przykładowe żądanie:

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

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

Oto przykładowa odpowiedź:

{
  "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 listy odbiorców wywołaj metodę audienceExports.query i w żądaniu podaj name eksportu listy odbiorców.

Oto przykładowe żądanie:

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

Jeśli eksport listy odbiorców jest gotowy, to wywołanie zwraca listę użytkowników na liście odbiorców.

Oto przykładowa odpowiedź:

{
  "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
}