Method: properties.audienceExports.query

Pobiera eksport listy odbiorców z listą użytkowników. Po utworzeniu listy odbiorców użytkownicy nie są od razu dostępni do eksportu. Żądanie do usługi audienceExports.create jest niezbędne do utworzenia eksportu list odbiorców obejmującego użytkowników. Następnie ta metoda służy do pobierania listy użytkowników z tego eksportu.

Wprowadzenie do eksportowania list odbiorców z przykładami znajdziesz w artykule Tworzenie eksportu list odbiorców.

Listy odbiorców w Google Analytics 4 umożliwiają podział użytkowników na segmenty odpowiadające wymaganiom Twojej firmy. Więcej informacji znajdziesz na stronie https://support.google.com/analytics/answer/9267572.

Interfejsy API eksportowania list odbiorców mają pewne metody w wersji alfa i inne metody zapewniające stabilność w wersji beta. W ramach naszych działań zamierzamy rozwijać metody zwiększania stabilności w wersji beta po zebraniu opinii i wdrożeniu tych metod. Aby przesłać opinię na temat tego interfejsu API, wypełnij formularz opinii o interfejsie Google Analytics Audience Export API.

Żądanie HTTP

POST https://analyticsdata.googleapis.com/v1beta/{name=properties/*/audienceExports/*}:query

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
name

string

To pole jest wymagane. Nazwa eksportu listy odbiorców, z której chcesz pobrać użytkowników. Format: properties/{property}/audienceExports/{audienceExport}

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 wiersza początkowego. Pierwszy wiersz jest liczony jako wiersz 0.

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

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

limit

string (int64 format)

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

Interfejs API może też zwrócić mniej wierszy niż w żądaniu limit, jeśli nie ma tylu wartości wymiarów co limit.

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

Treść odpowiedzi

Lista użytkowników uwzględnionych w eksporcie odbiorców.

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

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

object (AudienceRow)

Wiersze odpowiadające poszczególnym użytkownikom w eksporcie odbiorców. Liczba wierszy w tej odpowiedzi będzie mniejsza od rozmiaru strony w żądaniu lub jej równa.

audienceExport

object (AudienceExport)

Dane konfiguracji związane z wysyłaniem zapytań dotyczących AudienceExport. Zwracany, aby pomóc zinterpretować wiersze odbiorców w tej odpowiedzi. Na przykład wymiary w tym standardzie AudienceExport odpowiadają kolumnom w wierszu AudienceRows.

rowCount

integer

Łączna liczba wierszy w wyniku AudienceExport. rowCount zależy od liczby wierszy zwróconych w odpowiedzi, parametru żądania limit i parametru żądania offset. Jeśli na przykład zapytanie zwróci 175 wierszy i zawiera w żądaniu do interfejsu API limit z 50, odpowiedź będzie zawierała rowCount ze 175, ale tylko 50 wierszy.

Więcej informacji o tym parametrze podziału na strony znajdziesz w artykule 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 listy odbiorców.

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

object (AudienceDimensionValue)

Każdy atrybut wartości wymiaru w przypadku użytkownika z listą odbiorców. Dla każdej żądanej kolumny wymiaru zostanie dodana jedna 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 sumy one_value. Jeden rodzaj wartości wymiaru. one_value może być tylko jedną z tych wartości:
value

string

Wartość jako ciąg znaków, jeśli typem wymiaru jest ciąg znaków.