Tworzenie eksportu list odbiorców

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

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

Ważne informacje o danych widocznych w eksportach list odbiorców znajdziesz w przewodniku dotyczącym oczekiwań co do danych eksportowanych list odbiorców Audience export data expectations.

Przegląd

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

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

Więcej informacji znajdziesz, wywołując metodę audienceExports.get, aby pobrać metadane konfiguracji dotyczące konkretnego eksportu listy odbiorców, oraz metodę audienceExports.list, aby wyświetlić wszystkie eksporty list odbiorców w przypadku konkretnej usługi.

Wybieranie jednostki raportowania

Wszystkie metody interfejsu Data API wymagają podania identyfikatora usługi w Google Analytics w ścieżce adresu URL żądania w postaci 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 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 interfejsu API udostępnia parametr property, który oczekuje ciągu znaków w postaci 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 audience polu w formacie properties/{propertyId}/audiences/{audienceId}. Aby uzyskać tę wartość, możesz użyć audiences.list metody interfejsu Google Analytics Admin API w wersji 1. Nazwa listy odbiorców znajduje się w polu Audience.name odpowiedzi audiences.list.
• Prawidłowa lista wymiarów w polu dimensions. Listę wymiarów obsługiwanych przez tę metodę znajdziesz w dokumentacji schematu eksportu listy odbiorców. Eksport listy odbiorców zawiera tylko dane dotyczące wymiarów wymienionych w tym polu.

Oto przykładowe żądanie utworzenia eksportu listy 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 nazwę eksportu listy odbiorców w polu name, 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ą parametru name możesz wysyłać zapytania o użytkowników z eksportu listy odbiorców.

Sprawdzanie stanu gotowości eksportu listy odbiorców

Wygenerowanie eksportu listy odbiorców po wywołaniu metody 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ć eksport listy odbiorców w żądaniu, użyj nazwy eksportu listy odbiorców z odpowiedzi audienceExports.create.

Oto przykładowe żądanie:

Żądanie HTTP

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

Stan gotowości eksportu listy odbiorców jest zwracany w polu state field odpowiedzi. Gdy generowanie eksportu listy odbiorców się zakończy, jego stan zmieni 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 audienceExports.list metodę.

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

Gdy eksport listy odbiorców zostanie wygenerowany, wywołaj metodę audienceExports.query i w żądaniu podaj eksport listy odbiorców name.

Oto przykładowe żądanie:

Żądanie HTTP

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

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
}