Method: properties.audienceLists.query

Pobiera listę odbiorców. Po utworzeniu listy odbiorców użytkownicy nie są od razu dostępni na liście. Najpierw musisz wysłać żądanie do audienceLists.create, aby utworzyć listę odbiorców, a potem użyć tej metody do pobrania użytkowników z tej listy.

Więcej informacji o listach odbiorców wraz z przykładami znajdziesz w artykule Tworzenie listy odbiorców.

Listy odbiorców w Google Analytics 4 umożliwiają dzielenie użytkowników na segmenty w sposób odpowiadający potrzebom Twojej firmy. Więcej informacji znajdziesz na stronie https://support.google.com/analytics/answer/9267572.

Ta metoda jest dostępna na poziomie stabilności beta w przypadku funkcji audienceExports.query. Aby przesłać opinię o tym interfejsie API, wypełnij formularz opinii o interfejsie Google Analytics Audience Export API.

Żądanie HTTP

POST https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/audienceLists/*}:query

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
name

string

Wymagane. Nazwa listy odbiorców, z której mają być pobierani użytkownicy. Format: properties/{property}/audienceLists/{audienceList}

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "offset": string,
  "limit": string
}
Pola
offset

string (int64 format)

Opcjonalnie. Liczba wierszy w wierszu początkowym. Pierwszy wiersz jest liczony jako wiersz 0.

Podczas stronicowania pierwsze żądanie nie określa przesunięcia lub ustawia przesunięcie na 0. Pierwsze żądanie zwraca pierwsze limit wierszy. Drugie żądanie ustawia przesunięcie na limit pierwszego żądania, a drugie żądanie zwraca drugi limit wierszy.

Więcej informacji o tym parametrze paginacji znajdziesz w sekcji Paginacja.
limit

string (int64 format)

Opcjonalnie. Liczba wierszy do zwrócenia. Jeśli nie określono inaczej, zwracanych jest 10 tys. wierszy. Interfejs API zwraca maksymalnie 250 tys. wierszy na żądanie,niezależnie od tego, ile wierszy zażądasz. Wartość limit musi być dodatnia.

Interfejs API może też zwrócić mniej wierszy niż żądana wartość limit, jeśli liczba wartości wymiarów jest mniejsza niż limit.

Więcej informacji o tym parametrze paginacji znajdziesz w sekcji Paginacja.

Treść odpowiedzi

Lista użytkowników na liście odbiorców.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "audienceRows": [
    {
      object (AudienceRow)
    }
  ],
  "audienceList": {
    object (AudienceList)
  },
  "rowCount": integer
}
Pola
audienceRows[]

object (AudienceRow)

Wiersze dla każdego użytkownika na liście odbiorców. Liczba wierszy w tej odpowiedzi będzie mniejsza lub równa rozmiarowi strony żądania.
audienceList

object (AudienceList)

Dane konfiguracyjne dotyczące listy odbiorców, o którą wysyłane jest zapytanie. Zwrócone, aby pomóc w interpretacji wierszy odbiorców w tej odpowiedzi. Na przykład wymiary w tym obiekcie AudienceList odpowiadają kolumnom w obiekcie AudienceRows.
rowCount

integer

Łączna liczba wierszy w wyniku AudienceList. rowCount jest niezależny od liczby wierszy zwróconych w odpowiedzi, parametru żądania limit i parametru żądania offset. Jeśli na przykład zapytanie zwraca 175 wierszy i zawiera w żądaniu do interfejsu API wartość limit = 50, odpowiedź będzie zawierać wartość rowCount = 175, ale tylko 50 wierszy.

Więcej informacji o tym parametrze paginacji znajdziesz w sekcji Paginacja.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics

AudienceRow

Atrybuty wartości wymiaru w wierszu użytkownika na liście odbiorców.

Zapis JSON 
{
  "dimensionValues": [
    {
      object (AudienceDimensionValue)
    }
  ]
}
Pola
dimensionValues[]

object (AudienceDimensionValue)

Każdy atrybut wartości wymiaru użytkownika na liście odbiorców. Dla każdej kolumny wymiaru zostanie dodana jedna wartość wymiaru.

AudienceDimensionValue

Wartość wymiaru.

Zapis JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "value": string
  // End of mutually exclusive fields.
}
Pola
Jeden rodzaj wartości wymiaru. Poniżej znajduje się lista pól, które wykluczają się nawzajem. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
value

string

Wartość jako ciąg znaków, jeśli typ wymiaru to ciąg znaków.
Koniec pól wykluczających się nawzajem.