- Solicitação HTTP
- Parâmetros de caminho
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- Faça um teste
Exporta uma lista de público-alvo de usuários para um arquivo das Planilhas Google. Depois de criar um público-alvo, os usuários não ficam imediatamente disponíveis para a página de detalhes. Primeiro, uma solicitação para audienceLists.create
é necessária para criar uma lista de público-alvo de usuários e, em seguida, esse método é usado para exportar esses usuários na lista de público-alvo para um arquivo do Planilhas Google.
Consulte Como criar uma lista de público-alvo para uma introdução a listas de público-alvo com exemplos.
Com os públicos-alvo do Google Analytics 4, você pode segmentar os usuários das maneiras mais relevantes para sua empresa. Para saber mais, consulte https://support.google.com/analytics/answer/9267572.
Esse método é introduzido na estabilidade Alfa com a intenção de coletar feedback sobre a sintaxe e os recursos antes de chegar à versão Beta. Para enviar feedback sobre essa API, preencha o formulário Feedback sobre a API Audience Export do Google Analytics.
Solicitação HTTP
POST https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/audienceLists/*}:exportSheet
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
Parâmetros | |
---|---|
name |
Obrigatório. O nome da lista de público-alvo da qual recuperar usuários. Formato: |
Corpo da solicitação
O corpo da solicitação contém dados com a seguinte estrutura:
Representação JSON |
---|
{ "offset": string, "limit": string } |
Campos | |
---|---|
offset |
Opcional. A contagem de linhas da linha inicial. A primeira linha é contada como 0. Durante a paginação, a primeira solicitação não especifica o deslocamento. ou equivalente, define o deslocamento para 0; a primeira solicitação retorna o primeiro Para saber mais sobre esse parâmetro de paginação, consulte Paginação. |
limit |
Opcional. O número de linhas a serem retornadas. Se não for especificado, 10.000 linhas serão retornadas. A API retorna no máximo 250.000 linhas por solicitação, independentemente de quantas linhas você pedir. A API também poderá retornar menos linhas do que o Para saber mais sobre esse parâmetro de paginação, consulte Paginação. |
Corpo da resposta
A planilha Google criada com a lista de usuários em uma lista de público-alvo.
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
Representação JSON |
---|
{
"spreadsheetUri": string,
"spreadsheetId": string,
"rowCount": integer,
"audienceList": {
object ( |
Campos | |
---|---|
spreadsheetUri |
Um URI para você acessar no navegador e ver a planilha Google. |
spreadsheetId |
Um ID que identifica o recurso do Planilhas Google criado. |
rowCount |
O número total de linhas no resultado da lista de públicos-alvo. Para saber mais sobre esse parâmetro de paginação, consulte Paginação. |
audienceList |
Dados de configuração sobre a lista de públicos-alvo que está sendo exportada. Retornado para ajudar a interpretar a lista de público-alvo no arquivo das Planilhas Google desta resposta. Por exemplo, a "AudienceList" pode ter mais linhas do que as presentes na planilha Google. Nesse caso, envie outra solicitação de exportação de planilha com um valor |
Escopos de autorização
Requer um dos seguintes escopos do 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