Method: properties.audienceExports.query

Pobiera eksport list odbiorców z użytkownikami. Po utworzeniu listy odbiorców użytkownicy nie są od razu dostępni do eksportu. Najpierw żądanie wysłane do audienceExports.create jest konieczne do utworzenia eksportu list odbiorców z użytkownikami. Po drugie, ta metoda służy do pobierania użytkowników ujętych w eksporcie list odbiorców.

Wprowadzenie do eksportowania list odbiorców wraz z przykładami znajdziesz w artykule Tworzenie eksportu 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.

Interfejsy API eksportowania list odbiorców korzystają z pewnych metod w wersji alfa, a inne w stabilności beta. Celem jest rozwijanie metod stabilizacji wersji beta po uzyskaniu opinii i wprowadzeniu tych testów. 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/v1beta/{name=properties/*/audienceExports/*}:query

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
name

string

Wymagane. Nazwa eksportu list odbiorców, z którego mają zostać pobrane dane 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 w wierszu początkowym. 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 wartość limit pierwszego żądania. drugie żądanie zwróci drugi limit wierszy.

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

string (int64 format)

Opcjonalnie: Liczba wierszy do zwrócenia. Jeśli wartość nie jest określona, zwracanych jest 10 000 wierszy. Interfejs API zwraca maksymalnie 250 000 wierszy na żądanie bez względu na to, o ile prosisz. Wartość limit musi być liczbą dodatnią.

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

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

Treść odpowiedzi

Lista użytkowników objętych eksportem list 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 każdego użytkownika w eksporcie list odbiorców. Liczba wierszy w tej odpowiedzi będzie mniejsza od rozmiaru strony w żądaniu lub jej równa.
audienceExport

object (AudienceExport)

Dane konfiguracji dotyczące eksportowanych danych odbiorców AudienceExport. Powrót pomaga zinterpretować wiersze odbiorców w tej odpowiedzi. Na przykład wymiary w tym raporcie AudienceExport odpowiadają kolumnom w kolumnie AudienceRows.
rowCount

integer

Łączna liczba wierszy w wyniku AudienceExport. Wartość rowCount jest niezależna 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 limit z 50 wierszy w żądaniu do interfejsu API, odpowiedź będzie zawierać rowCount z 175 wierszy, ale tylko 50 wierszy.

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

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

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

AudienceRow

Atrybuty wartości wymiaru w wierszu użytkownika listy odbiorców.

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

object (AudienceDimensionValue)

Każdy atrybut wartości wymiaru u użytkownika na liście odbiorców. Jedna wartość wymiaru zostanie dodana do każdej żądanej kolumny 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 mieć tylko jedną z tych wartości:
value

string

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