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 stronie z informacjami o niej. Najpierw żądanie wysłane do audienceLists.create jest konieczne do utworzenia listy odbiorców, a potem za pomocą tej metody można wyeksportować tych użytkowników z listy odbiorców do Arkuszy Google.

Wprowadzenie do list odbiorców wraz z przykładami znajdziesz w części 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ę o tym interfejsie 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

Wymagane. Nazwa listy odbiorców, z której mają być pobierane 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 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

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 możesz otworzyć w przeglądarce, aby wyświetlić Arkusz Google.
spreadsheetId

string

Identyfikator, który określa utworzony zasób Arkusza Google.
rowCount

integer

Łączna liczba wierszy w wyniku AudienceList. 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.
audienceList

object (AudienceList)

Dane konfiguracji eksportu listy odbiorców. Powrócono, aby pomóc zinterpretować listę odbiorców w arkuszu Google tej odpowiedzi.

Na przykład lista odbiorców może mieć więcej wierszy niż jest dostępnych w pliku Arkuszy 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 protokołu 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