- Żądanie HTTP
- Parametry ścieżki
- Treść żądania
- Treść odpowiedzi
- Zakresy autoryzacji
- AudienceRow (Wiersz odbiorców)
- AudienceDimensionValue
- Wypróbuj
Pobiera listę odbiorców użytkowników. Po utworzeniu listy odbiorców użytkownicy nie są od razu dostępni do strony aplikacji. Aby utworzyć listę odbiorców zawierającą użytkowników, należy najpierw wysłać żądanie audienceLists.create
. Po drugie, ta metoda służy do pobrania użytkowników z tej listy.
Wprowadzenie do list odbiorców z przykładami znajdziesz w artykule Tworzenie listy 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.
Ta metoda jest dostępna w przypadku stabilności beta w pliku audienceExports.query. 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/v1alpha/{name=properties/*/audienceLists/*}:query
Adres URL używa składni transkodowania gRPC.
Parametry ścieżki
Parametry | |
---|---|
name |
Wymagane. Nazwa listy odbiorców, z której chcesz pobrać użytkowników. Format: |
Treść żądania
Treść żądania zawiera dane o następującej strukturze:
Zapis JSON |
---|
{ "offset": string, "limit": string } |
Pola | |
---|---|
offset |
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 Więcej informacji o tym parametrze podziału na strony znajdziesz w artykule Podział na strony. |
limit |
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. Interfejs API może też zwrócić mniej wierszy niż w żądaniu Więcej informacji o tym parametrze podziału na strony znajdziesz w artykule Podział na strony. |
Treść odpowiedzi
Lista użytkowników z listy odbiorców.
W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:
Zapis JSON |
---|
{ "audienceRows": [ { object ( |
Pola | |
---|---|
audienceRows[] |
Wiersze odpowiadające poszczególnym użytkownikom na liście odbiorców. Liczba wierszy w tej odpowiedzi będzie mniejsza od rozmiaru strony w żądaniu lub jej równa. |
audienceList |
Dane konfiguracji dotyczące zapytania dotyczącego listy odbiorców. Zwracany, aby pomóc zinterpretować wiersze odbiorców w tej odpowiedzi. Na przykład wymiary na tej liście odbiorców odpowiadają kolumnom w wierszu AudienceRows. |
rowCount |
Łączna liczba wierszy w wyniku listy odbiorców. 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 ( |
Pola | |
---|---|
dimensionValues[] |
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 |
Pola | |
---|---|
Pole sumy one_value . Jeden rodzaj wartości wymiaru. one_value może być tylko jedną z tych wartości: |
|
value |
Wartość jako ciąg znaków, jeśli typem wymiaru jest ciąg znaków. |