Tworzenie eksportu list odbiorców

Listy odbiorców w Google Analytics pozwalają dzielić użytkowników na segmenty odpowiadające wymaganiom 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 ich użytkowników.

Ważne informacje o danych, które widzisz w eksportach list odbiorców, znajdziesz w poradnikach Wymagania dotyczące danych z eksportu list odbiorców.

Omówienie

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

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

Aby uzyskać więcej informacji, możesz wywołać funkcję audienceExports.get, aby pobrać metadane konfiguracji dotyczące konkretnego eksportu list odbiorców, oraz funkcję audienceExports.list, aby wyświetlić listę wszystkich eksportów list odbiorców dla konkretnej usługi.

Wybierz podmiot raportowania

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

Tworzenie pliku eksportu listy odbiorców

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

• W polu audience wpisz prawidłową nazwę listy odbiorców 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 audiences.list odpowiedzi audiences.list zawiera nazwę listy odbiorców.Audience.name
• Prawidłowa lista wymiarów w polu dimensions. Listę wymiarów obsługiwanych przez tę metodę znajdziesz w dokumentacji Schemat eksportu danych o odbiorcach. W eksporcie listy odbiorców uwzględniane są tylko dane dotyczące wymiarów wymienionych w tym polu.

Oto przykładowa prośba o utworzenie 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ę pliku 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"
  }
}

Możesz użyć zapytania name, aby uzyskać informacje o użytkownikach z wyeksportowanej listy odbiorców.

Sprawdzanie stanu gotowości eksportu listy odbiorców

Wygenerowanie pliku 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 listy odbiorców z odpowiedzi audienceExports.create, aby określić w żądaniu eksport listy odbiorców.

Oto przykładowa prośba:

Żądanie HTTP

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 pliku eksportu listy odbiorców stan tego pliku 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 metodę audienceExports.list.

Pobieranie użytkowników z pliku wyeksportowanej listy odbiorców

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

Oto przykładowa prośba:

Żądanie HTTP

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

Jeśli eksport listy odbiorców jest gotowy, wywołanie zwraca 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
}