Tworzenie eksportu list odbiorców

Listy odbiorców w Google Analytics pozwalają dzielić użytkowników na segmenty odpowiadające wymaganiom Twojej firmy. Listy odbiorców umożliwiają grupowanie użytkowników witryny lub aplikacji na podstawie wspólnych atrybutów.

Możesz eksportować listy odbiorców, w tym migawkę ich użytkowników, za pomocą interfejsu Data API.

W przewodniku dotyczącym oczekiwań związanych z danymi eksportowanymi z list odbiorców znajdziesz ważne informacje o danych, które widzisz w eksportach list odbiorców.

Przegląd

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

1. Aby utworzyć eksport listy odbiorców, wywołaj metodę audienceExports.create.
2. Wywołanie metody audienceExports.query służy do pobierania użytkowników z listy odbiorców.

Więcej informacji znajdziesz, dzwoniąc pod numer audienceExports.get, aby pobrać metadane konfiguracji dotyczące konkretnego eksportu listy odbiorców, oraz pod numer audienceExports.list, aby wyświetlić listę wszystkich eksportów list odbiorców w przypadku konkretnej usługi.

Wybierz podmiot raportujący

Wszystkie metody interfejsu Data API wymagają podania identyfikatora usługi w Google Analytics w ścieżce żądania 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 o zdarzeniach w 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 URL żądania. Większość klientów interfejsu API udostępnia parametr property, który oczekuje ciągu w formie properties/GA_PROPERTY_ID. Przykłady użycia bibliotek klienta znajdziesz w przewodniku dla początkujących.

Tworzenie eksportu listy 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 w 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. Eksportowanie listy odbiorców obejmuje 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. 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 wyeksportowanej listy odbiorców.

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

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

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

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

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 listy odbiorców jego stan zmieni się z CREATING na ACTIVE.

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 listy odbiorców

Po wygenerowaniu eksportu listy odbiorców wywołaj metodę audienceExports.query i w żądaniu podaj name eksportu listy odbiorców.

Przykładowe żądanie:

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

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

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
}