Method: properties.audienceLists.query

Pobiera listę odbiorców zawierającą użytkowników. Po utworzeniu listy odbiorców użytkownicy nie są od razu dostępni na liście. Po pierwsze, żądanie audienceLists.create jest potrzebne do utworzenia listy odbiorców zawierającej użytkowników. Po drugie, ta metoda służy do pobierania użytkowników z listy odbiorców.

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 wymaganiom Twojej firmy. Więcej informacji znajdziesz na stronie https://support.google.com/analytics/answer/9267572.

Ta metoda jest dostępna w wersji beta w funkcji audienceExports.query. Aby przesłać opinię na temat tego interfejsu API, wypełnij formularz Opinie 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.

W przypadku pobierania stron pierwsze żądanie nie określa przesunięcia, czyli jest ustawione na 0. Pierwsze żądanie zwraca pierwsze limit wierszy. Drugie żądanie ustawia offset na limit pierwszego żądania; zwraca drugi limit wierszy.

Więcej informacji o tym parametrze podziału znajdziesz w sekcji Podział na strony.
limit

string (int64 format)

Opcjonalnie: Liczba wierszy do zwrócenia. Jeśli nie podasz tej wartości, zwróci się 10 tys. wierszy. Interfejs API zwraca maksymalnie 250 tys. wierszy na żądanie,niezależnie od tego, o ile prosisz. Wartość limit musi być dodatnia.

Interfejs API może też zwrócić mniej wierszy niż żądana liczba limit, jeśli nie ma tylu wartości wymiarów, ile wynosi parametr limit.

Więcej informacji o tym parametrze podziału znajdziesz w sekcji Podział na strony.

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 konfiguracji dotyczące listy odbiorców, której dotyczy zapytanie. Zwracane, aby ułatwić interpretację wierszy dotyczących odbiorców w tej odpowiedzi. Na przykład wymiary w tym obiekcie AudienceList odpowiadają kolumnom w obiektach 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 np. zapytanie zwraca 175 wierszy i zawiera limit o długości 50 w żądaniu do interfejsu API, odpowiedź będzie zawierać rowCount o długości 175, ale tylko 50 wierszy.

Więcej informacji o tym parametrze podziału znajdziesz w sekcji Podział na strony.

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żytkownik w liście odbiorców.

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

object (AudienceDimensionValue)

Każdy atrybut wartości wymiaru dla użytkownika na liście odbiorców. Do każdej żądanej kolumny wymiaru zostanie dodana 1 wartość wymiaru.

AudienceDimensionValue

Wartość wymiaru.

Zapis JSON 
{

  // Union field one_value can be only one of the following:
  "value": string
  // End of list of possible types for union field one_value.
}
Pola
Pole unii one_value. Jeden z rodzajów wartości wymiaru. one_value może być tylko jednym z tych elementów:
value

string

Wartość jako ciąg znaków, jeśli typ wymiaru to ciąg znaków.