Method: properties.audienceLists.exportSheet

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, é necessário enviar uma solicitação para audienceLists.create para criar uma lista de público-alvo de usuários. Depois, esse método é usado para exportar os usuários incluídos na lista de público-alvo para uma planilha Google.

Consulte Criar uma lista de público-alvo para uma introdução a listas de público-alvo com exemplos.

Com os públicos-alvo no Google Analytics 4, é possível segmentar os usuários 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 seu feedback sobre a 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

string

Obrigatório. O nome da lista de público-alvo da qual os usuários serão recuperados. Formato: properties/{property}/audienceLists/{audienceList}

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

string (int64 format)

Opcional. A contagem de linhas da primeira linha. A primeira linha é contada como a linha 0.

Na paginação, a primeira solicitação não especifica o deslocamento ou, de maneira equivalente, define o deslocamento como 0. A primeira solicitação retorna a primeira limit das linhas. A segunda solicitação define o deslocamento para o limit da primeira solicitação. A segunda solicitação retorna a segunda limit de linhas.

Consulte Paginação para saber mais sobre esse parâmetro.
limit

string (int64 format)

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ê solicitar. limit precisa ser positivo.

A API também pode retornar menos linhas do que o limit solicitado, se não houver tantos valores de dimensão quanto o limit.

Consulte Paginação para saber mais sobre esse parâmetro.

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 (AudienceList)
  }
}
Campos
spreadsheetUri

string

Um URI para você acessar no navegador para ver a planilha Google.
spreadsheetId

string

Um ID que identifica o recurso criado nas Planilhas Google.
rowCount

integer

O número total de linhas no resultado da AudienceList. rowCount é independente do número de linhas retornadas na resposta, no parâmetro de solicitação limit e no parâmetro de solicitação offset. Por exemplo, se uma consulta retornar 175 linhas e incluir limit de 50 na solicitação de API, a resposta conterá rowCount de 175, mas apenas 50 linhas.

Consulte Paginação para saber mais sobre esse parâmetro.
audienceList

object (AudienceList)

Dados de configuração da lista de público-alvo sendo exportada. Retornado para ajudar a interpretar a AudienceList na Planilha 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 com um valor offset diferente para recuperar a próxima página de linhas em uma planilha adicional.

Escopos de autorização

Requer um dos seguintes escopos de 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