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 na liście. Po pierwsze, żądanie do audienceLists.create jest potrzebne do utworzenia listy odbiorców zawierającej użytkowników, a po drugie, ta metoda służy do eksportowania tych użytkowników z listy odbiorców do Arkuszy Google.

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.

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 Opinie 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

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

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

Adres URI, który możesz otworzyć w przeglądarce, aby wyświetlić Arkusz Google.
spreadsheetId

string

Identyfikator identyfikujący utworzony zasób Arkuszy Google.
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.
audienceList

object (AudienceList)

Dane konfiguracji dotyczące eksportowanej listy odbiorców AudienceList. Zwracana wartość pomaga interpretować listę odbiorców w arkuszu Google, który zawiera tę odpowiedź.

Na przykład lista AudienceList może zawierać więcej wierszy niż arkusz Google. W takim przypadku możesz wysłać dodatkowe żądanie wyeksportowania 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