Method: properties.audienceLists.exportSheet

Eksportuje listę odbiorców zawierającą użytkowników do Arkuszy Google. 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ć prośbę do usługi audienceLists.create. Następnie ta metoda służy do eksportowania użytkowników z listy do Arkusza Google.

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.

Wprowadzamy tę metodę na poziomie stabilności alfa, aby zebrać opinie na temat jej składni i możliwości, zanim udostępnimy wersję beta. 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/*}:exportSheet

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
name

string

To pole jest wymagane. Nazwa listy odbiorców, z której chcesz pobrać użytkowników. 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 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

Utworzony arkusz Google z listą użytkowników na liście odbiorców.

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

Zapis JSON
{
  "spreadsheetUri": string,
  "spreadsheetId": string,
  "rowCount": integer,
  "audienceList": {
    object (AudienceList)
  }
}
Pola
spreadsheetUri

string

Identyfikator URI, który musisz otworzyć w przeglądarce, aby wyświetlić Arkusz Google.

spreadsheetId

string

Identyfikator, który identyfikuje utworzony zasób Arkuszy Google.

rowCount

integer

Łączna liczba wierszy w wyniku listy odbiorców. 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.

audienceList

object (AudienceList)

Dane konfiguracji dotyczące eksportowania listy odbiorców. Zwracany w celu ułatwienia interpretacji listy odbiorców w arkuszu Google tej odpowiedzi.

Na przykład lista odbiorców może zawierać więcej wierszy niż jest w Arkuszu Google. W takim przypadku możesz wysłać dodatkowe żądanie eksportu arkusza z inną wartością offset, aby pobrać następną stronę wierszy w dodatkowym arkuszu Google.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/spreadsheets