Google Analytics

Visão geral

O Google Analytics rastreia e relata o tráfego do site, o comportamento dos usuários e os dados de conversão, permitindo que profissionais de marketing otimizem o desempenho online e as jornadas dos clientes. Com a integração no SquadOS, seus agentes podem executar relatórios personalizados, consultar audiências, verificar cotas e enviar eventos diretamente para propriedades GA4.

• Site oficial: https://analytics.google.com/
• Documentação na Composio: docs.composio.dev/toolkits/google_analytics

Autenticação

Esta ferramenta utiliza OAuth 2.0 (OAUTH2) para conectar.

Você vai precisar autorizar o acesso à sua conta Google Analytics via OAuth. Ao clicar em Conectar, você será redirecionado para a página de autorização do Google, onde poderá conceder permissão de acesso à conta desejada.

Como conectar no SquadOS

1. Acesse Ferramentas no menu lateral (/admin/tools).
2. Abra a aba Disponíveis e procure por Google Analytics.
3. Clique no card para abrir o modal de detalhes e em Conectar.
4. Você é levado para a página de conexão segura hospedada pela Composio, onde autoriza o acesso à sua conta Google Analytics via OAuth.
5. Ao concluir, você volta para o SquadOS com a conta conectada e a ferramenta disponível para os agentes. (Detalhes do fluxo em Ferramentas da Organização.)

Ações disponíveis

Arquivar dimensão personalizada

GOOGLE_ANALYTICS_ARCHIVE_CUSTOM_DIMENSION

Arquiva uma dimensão personalizada em uma propriedade. Use quando precisar remover uma dimensão personalizada do uso ativo sem excluí-la permanentemente. Dimensões arquivadas não podem ser usadas em novos relatórios.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	Nome do recurso da CustomDimension a arquivar. Deve estar no formato exato: properties/{property_id}/customDimensions/{dimension_id}. Exemplo válido: properties/489591273/customDimensions/13661259421.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Executar relatórios pivot em lote

GOOGLE_ANALYTICS_BATCH_RUN_PIVOT_REPORTS

Retorna múltiplos relatórios pivot em lote para uma propriedade GA4. Use quando precisar buscar vários relatórios de tabela dinâmica com análise multidimensional em uma única requisição.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
property	string	Sim	Nome do recurso da propriedade GA4. Formato: properties/{property_id}.
requests	array	Sim	Até 5 objetos RunPivotReportRequest individuais. Cada dimensão definida em dimensions DEVE ser usada em pelo menos um pivot, filtro ou orderBy.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Executar relatórios em lote

GOOGLE_ANALYTICS_BATCH_RUN_REPORTS

Retorna múltiplos relatórios de dados de análise em lote. Use quando precisar buscar vários relatórios para uma propriedade GA4 em uma única requisição.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
property	string	Sim	Nome do recurso da propriedade. Formato: properties/{property_id}.
requests	array	Sim	Até 5 objetos RunReportRequest individuais (mínimo 1, máximo 5). Requisições que não sejam de coorte DEVEM conter dateRanges.
unwrapped_filters	array	Não	Campo interno para rastrear filtros desempacotados durante a validação.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Verificar compatibilidade

GOOGLE_ANALYTICS_CHECK_COMPATIBILITY

Lista dimensões e métricas compatíveis com uma requisição de relatório GA4. Use quando precisar validar a compatibilidade de dimensões ou métricas antes de executar um relatório.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
metrics	array	Não	Lista de métricas para verificar a compatibilidade. Máximo de 10 métricas por requisição.
property	string	Sim	Nome do recurso da propriedade GA4. Formato: properties/{property_id}.
dimensions	array	Não	Lista de dimensões para verificar a compatibilidade.
metricFilter	object	Não	FilterExpression para métricas.
dimensionFilter	object	Não	FilterExpression para dimensões.
compatibilityFilter	string	Não	Status de compatibilidade. Valores válidos: COMPATIBILITY_UNSPECIFIED, COMPATIBLE, INCOMPATIBLE.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar exportação de audiência

GOOGLE_ANALYTICS_CREATE_AUDIENCE_EXPORT

Cria uma exportação de audiência para o Google Analytics. Use quando precisar exportar um instantâneo dos usuários em uma audiência em um momento específico. Esta ação inicia uma requisição assíncrona de longa duração que retorna imediatamente o nome do recurso de operação.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
parent	string	Sim	Nome do recurso da propriedade pai. Formato: properties/{property_id}.
audience	string	Sim	Nome do recurso da audiência a exportar. Formato: properties/{property_id}/audiences/{audience_id}.
dimensions	array	Não	Lista opcional de dimensões solicitadas exibidas na exportação.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar lista de audiência

GOOGLE_ANALYTICS_CREATE_AUDIENCE_LIST

Cria uma lista de audiência para recuperação posterior, iniciando uma requisição assíncrona de longa duração. Use quando precisar criar um instantâneo dos usuários atualmente em uma audiência.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
parent	string	Sim	Nome do recurso da propriedade pai. Formato: properties/{property_id}.
audience	string	Sim	Nome do recurso da audiência a listar. Formato: properties/{property_id}/audiences/{audience_id}.
dimensions	array	Sim	Dimensões solicitadas e exibidas na resposta. Pelo menos uma é obrigatória. Cada entrada deve ser um objeto com a chave dimensionName.
webhookNotification	object	Não	Configuração de notificação webhook para atualizações da operação de lista de audiência.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar dimensão personalizada

GOOGLE_ANALYTICS_CREATE_CUSTOM_DIMENSION

Cria uma CustomDimension para uma propriedade do Google Analytics. Use quando precisar adicionar uma nova dimensão personalizada para rastrear propriedades de usuário, parâmetros de evento ou parâmetros de item de eCommerce específicos.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
scope	string	Sim	Escopo imutável desta dimensão. Deve ser: EVENT, USER ou ITEM.
parent	string	Sim	Propriedade na qual criar a CustomDimension. Formato: properties/{property_id}.
description	string	Não	Descrição opcional. Máximo de 150 caracteres.
displayName	string	Sim	Nome de exibição no painel do Analytics. Máximo de 82 caracteres, alfanumérico com espaço e sublinhado, começando com letra.
parameterName	string	Sim	Nome do parâmetro de rastreamento imutável. Máximo de 24 caracteres para dimensões de escopo de usuário, 40 para escopo de evento.
disallowAdsPersonalization	boolean	Não	Se verdadeiro, define esta dimensão como NPA e a exclui da personalização de anúncios (apenas dimensões de escopo de usuário).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar métrica personalizada

GOOGLE_ANALYTICS_CREATE_CUSTOM_METRIC

Cria uma métrica personalizada no Google Analytics. Use quando precisar definir uma nova métrica personalizada para rastrear parâmetros de evento específicos.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
scope	string	Sim	Escopo imutável desta métrica. Valores: METRIC_SCOPE_UNSPECIFIED ou EVENT.
parent	string	Sim	Propriedade onde a métrica personalizada será criada. Formato: properties/{property_id}.
description	string	Não	Descrição opcional. Máximo de 150 caracteres.
displayName	string	Sim	Nome de exibição no painel do Analytics. Máximo de 82 caracteres.
parameterName	string	Sim	Nome de rastreamento imutável. Máximo de 40 caracteres para métricas de escopo de evento.
measurementUnit	string	Sim	Tipo de valor da métrica. Valores: STANDARD, CURRENCY, FEET, METERS, KILOMETERS, MILES, MILLISECONDS, SECONDS, MINUTES, HOURS.
restrictedMetricType	array	Não	Tipos de dados restritos que esta métrica pode conter. Obrigatório para métricas com unidade de medida CURRENCY.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar conjunto de dados expandido

GOOGLE_ANALYTICS_CREATE_EXPANDED_DATA_SET

Cria um conjunto de dados expandido para uma propriedade. Use quando precisar combinar dimensões e métricas específicas em um conjunto de dados personalizado após a criação da propriedade.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
parent	string	Sim	Nome do recurso da propriedade pai. Formato: properties/{propertyId}.
expandedDataSet	object	Sim	Definição do ExpandedDataSet a criar.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar lista de audiência recorrente

GOOGLE_ANALYTICS_CREATE_RECURRING_AUDIENCE_LIST

Cria uma lista de audiência recorrente que gera automaticamente novas listas de audiência diariamente com base nos dados mais recentes. Use quando precisar automatizar a criação de listas de audiência e reduzir o consumo de tokens de cota.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
parent	string	Sim	Nome do recurso da propriedade pai. Formato: properties/{property_id}.
audience	string	Sim	Nome do recurso da audiência a listar. Formato: properties/{property_id}/audiences/{audience_id}.
dimensions	array	Sim	Lista de dimensões solicitadas e exibidas na resposta da lista de audiência.
activeDaysRemaining	integer	Não	Contador decrescente diário. Padrão: 180 dias para propriedades Analytics 360 (máx. 365) e 14 dias para propriedades padrão (máx. 30).
webhookNotification	object	Não	Configuração para receber notificações webhook sobre o status da lista de audiência recorrente.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar tarefa de relatório

GOOGLE_ANALYTICS_CREATE_REPORT_TASK

Cria uma tarefa de relatório como uma requisição assíncrona de longa duração para relatórios personalizados de dados de eventos do Google Analytics. Use quando precisar gerar relatórios grandes ou complexos que processam de forma assíncrona.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
parent	string	Sim	Identificador da propriedade no formato properties/{propertyId}.
reportDefinition	object	Não	Define como o relatório é executado.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar propriedade rollup

GOOGLE_ANALYTICS_CREATE_ROLLUP_PROPERTY

Cria uma propriedade roll-up. Use ao consolidar múltiplas propriedades GA4 em uma visão agregada.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
account	string	Sim	Recurso de conta pai. Formato: accounts/{account_id}.
timeZone	string	Sim	Fuso horário IANA para a propriedade roll-up.
displayName	string	Sim	Nome de exibição para a propriedade roll-up.
sourceProperties	array	Não	Lista opcional de nomes de recursos de propriedades de origem para vincular. Formato: properties/{property_id}.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter conta

GOOGLE_ANALYTICS_GET_ACCOUNT

Recupera uma única conta pelo nome do recurso. Use quando precisar de informações detalhadas da conta após confirmar o nome do recurso (ex.: accounts/100).

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	Nome do recurso da conta a recuperar. Formato exato: accounts/{account_id}. Exemplo válido: accounts/100.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter configurações de atribuição

GOOGLE_ANALYTICS_GET_ATTRIBUTION_SETTINGS

Recupera a configuração de atribuição de uma propriedade do Google Analytics. Use quando precisar verificar modelos de atribuição, janelas de lookback e configurações de exportação de conversão.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	Nome do recurso das configurações de atribuição. Formato: properties/{property_id}/attributionSettings.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter audiência

GOOGLE_ANALYTICS_GET_AUDIENCE

Recupera a configuração de uma única audiência de uma propriedade do Google Analytics. Use quando precisar de informações detalhadas da audiência, incluindo critérios de associação e cláusulas de filtro.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
audienceId	string	Sim	Identificador numérico da audiência (ex.: 11228260226).
propertyId	string	Sim	Identificador da propriedade GA4 (ex.: 123456789 ou properties/123456789).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter exportação de audiência

GOOGLE_ANALYTICS_GET_AUDIENCE_EXPORT

Obtém metadados de configuração sobre uma exportação de audiência específica. Use quando precisar entender uma exportação de audiência após sua criação ou verificar o status dela.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	Nome do recurso da exportação de audiência. Formato: properties/{property}/audienceExports/{audience_export}.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter lista de audiência

GOOGLE_ANALYTICS_GET_AUDIENCE_LIST

Obtém metadados de configuração sobre uma lista de audiência específica. Use após confirmar o nome do recurso da lista de audiência.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	Nome do recurso da lista de audiência. Formato: properties/{property}/audienceLists/{audienceList}.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter dimensão personalizada

GOOGLE_ANALYTICS_GET_CUSTOM_DIMENSION

Recupera uma única CustomDimension pelo nome do recurso. Use quando precisar de informações detalhadas sobre uma dimensão personalizada específica, incluindo nome de exibição, escopo e nome do parâmetro.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	Nome do recurso da CustomDimension. Formato: properties/{property_id}/customDimensions/{customDimension_id}.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter configurações de retenção de dados

GOOGLE_ANALYTICS_GET_DATA_RETENTION_SETTINGS

Recupera a configuração de retenção de dados de uma propriedade do Google Analytics. Use quando precisar verificar as durações de retenção de dados a nível de evento e de usuário.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	Nome do recurso das configurações de retenção de dados. Formato: properties/{property_id}/dataRetentionSettings.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter configurações de compartilhamento de dados

GOOGLE_ANALYTICS_GET_DATA_SHARING_SETTINGS

Recupera a configuração de compartilhamento de dados de uma conta do Google Analytics. Use quando precisar verificar quais configurações de compartilhamento de dados estão habilitadas para uma conta.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	Nome do recurso das configurações de compartilhamento de dados. Formato: accounts/{account_id}/dataSharingSettings.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter configurações do Google Signals

GOOGLE_ANALYTICS_GET_GOOGLE_SIGNALS_SETTINGS

Recupera as configurações do Google Signals para uma propriedade GA4. Use quando precisar verificar se o Google Signals está habilitado e o status de consentimento para uma propriedade.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	Nome do recurso das configurações do Google Signals. Formato: properties/{property_id}/googleSignalsSettings.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter evento-chave

GOOGLE_ANALYTICS_GET_KEY_EVENT

Recupera um evento-chave pelo nome do recurso. Somente leitura; operações de criação, atualização ou exclusão requerem a interface do Google Analytics.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	Nome do recurso do evento-chave. Formato: properties/{property}/keyEvents/{keyEvent}.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter metadados

GOOGLE_ANALYTICS_GET_METADATA

Obtém metadados de dimensões, métricas e comparações para uma propriedade GA4. Use para descobrir campos disponíveis antes de construir um relatório — sempre derive os apiNames de dimensões/métricas a partir desta saída em vez de codificar rótulos da interface do GA4, que diferem. Os campos disponíveis variam por propriedade.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	Nome do recurso dos metadados. Formato: properties/{property_id}/metadata. Use property_id=0 para retornar apenas metadados universais.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter propriedade

GOOGLE_ANALYTICS_GET_PROPERTY

Recupera uma única propriedade GA4 pelo nome do recurso. Use quando precisar da configuração detalhada da propriedade, incluindo nome de exibição, fuso horário, moeda e outras configurações.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	Nome do recurso da propriedade. Formato: properties/{property_id}. Exemplo válido: properties/489591273.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter instantâneo de cotas da propriedade

GOOGLE_ANALYTICS_GET_PROPERTY_QUOTAS_SNAPSHOT

Recupera todas as cotas da propriedade organizadas por categoria para uma propriedade GA4. Use quando precisar verificar o uso atual de cotas. Os dados do instantâneo podem estar atrasados em relação ao consumo real em vários minutos.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
property	string	Sim	Recurso da propriedade. Formato: properties/{property_id}.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter lista de audiência recorrente

GOOGLE_ANALYTICS_GET_RECURRING_AUDIENCE_LIST

Obtém metadados de configuração sobre uma lista de audiência recorrente específica. Use quando precisar entender o estado de uma lista de audiência recorrente após sua criação.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	Nome do recurso da lista de audiência recorrente. Formato: properties/{property}/recurringAudienceLists/{recurring_audience_list}.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter tarefa de relatório

GOOGLE_ANALYTICS_GET_REPORT_TASK

Obtém metadados de um relatório sobre uma tarefa de relatório específica. Use após criar uma tarefa de relatório para verificar o estado de processamento ou inspecionar a definição do relatório.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	Nome do recurso da tarefa de relatório. Formato: properties/{property}/reportTasks/{reportTask}.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar contas (depreciado)

GOOGLE_ANALYTICS_LIST_ACCOUNTS

DEPRECIADO: Use GOOGLE_ANALYTICS_LIST_ACCOUNTS_V1_BETA. Lista todas as contas acessíveis pelo chamador. Resultados vazios ou parciais podem indicar problema de permissões.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
pageSize	integer	Não	Número máximo de contas a retornar. Deve ser maior ou igual a 1.
pageToken	string	Não	Token para recuperar a próxima página de resultados.
showDeleted	boolean	Não	Se deve incluir contas excluídas (na lixeira).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar resumos de contas

GOOGLE_ANALYTICS_LIST_ACCOUNT_SUMMARIES

Recupera resumos de todas as contas do Google Analytics acessíveis pelo chamador. Use quando precisar de uma visão geral das contas e suas propriedades sem buscar detalhes completos.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
pageSize	integer	Não	Número máximo de resumos de contas a retornar. Padrão: 50, máximo: 200.
pageToken	string	Não	Token de página de uma chamada anterior para recuperar a página seguinte.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar contas (v1beta)

GOOGLE_ANALYTICS_LIST_ACCOUNTS_V1_BETA

Lista todas as contas do Google Analytics acessíveis pelo chamador usando a API v1beta. Contas excluídas suavemente são excluídas por padrão.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
pageSize	integer	Não	Número máximo de recursos a retornar. Padrão: 50, máximo: 200.
pageToken	string	Não	Token de página de uma chamada anterior.
showDeleted	boolean	Não	Se deve incluir contas excluídas suavemente. Padrão: false.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar links do AdSense

GOOGLE_ANALYTICS_LIST_ADSENSE_LINKS

Lista todos os AdSenseLinks de uma propriedade. Use quando precisar buscar todos os links do AdSense para uma propriedade do Google Analytics.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
parent	string	Sim	Nome do recurso da propriedade. Formato: properties/{propertyId}.
pageSize	integer	Não	Número máximo de resultados a retornar (entre 1 e 200). Padrão: 50.
pageToken	string	Não	Token para recuperar a próxima página de resultados.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar exportações de audiência

GOOGLE_ANALYTICS_LIST_AUDIENCE_EXPORTS

Lista todas as exportações de audiência de uma propriedade. Use quando precisar encontrar e reutilizar exportações de audiência existentes em vez de criar novas.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
parent	string	Sim	Identificador da propriedade no formato properties/{propertyId}.
pageSize	integer	Não	Número máximo de exportações de audiência a retornar. Padrão: 200, máximo: 1000.
pageToken	string	Não	Token de uma resposta anterior para paginação.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar listas de audiência

GOOGLE_ANALYTICS_LIST_AUDIENCE_LISTS

Lista todas as listas de audiência de uma propriedade especificada. Use quando precisar recuperar as listas de audiência configuradas de uma propriedade após confirmar o ID da propriedade.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
parent	string	Sim	Nome do recurso da propriedade pai. Formato: properties/{property_id}.
pageSize	integer	Não	Número máximo de listas de audiência a retornar. Padrão: 200, máximo: 1000.
pageToken	string	Não	Token para recuperar a próxima página de resultados.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar audiências

GOOGLE_ANALYTICS_LIST_AUDIENCES

Lista audiências em uma propriedade. Use quando precisar recuperar configurações de audiência para uma propriedade do Google Analytics. Audiências criadas antes de 2020 podem não ser suportadas.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
parent	string	Sim	A propriedade para a qual listar audiências. Formato: properties/{propertyId}.
pageSize	integer	Não	Número máximo de recursos a retornar. Padrão: 50, máximo: 200.
pageToken	string	Não	Token de página de uma chamada anterior para recuperar a página seguinte.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar links do BigQuery

GOOGLE_ANALYTICS_LIST_BIGQUERY_LINKS

Lista links do BigQuery em uma propriedade. Use quando precisar recuperar recursos de link do BigQuery associados a uma propriedade do Google Analytics.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
parent	string	Sim	Nome da propriedade. Formato: properties/{property_id}.
pageSize	integer	Não	Número máximo de recursos a retornar. Padrão: 50, máximo: 200.
pageToken	string	Não	Token de uma chamada anterior para recuperar a página seguinte.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar métricas calculadas

GOOGLE_ANALYTICS_LIST_CALCULATED_METRICS

Lista métricas calculadas de uma propriedade.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
parent	string	Sim	Identificador da propriedade no formato properties/{propertyId}.
pageSize	integer	Não	Número máximo de resultados por requisição. Padrão: 50, máximo: 200.
pageToken	string	Não	Token de uma resposta anterior para paginação.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar grupos de canais

GOOGLE_ANALYTICS_LIST_CHANNEL_GROUPS

Lista ChannelGroups em uma propriedade. Use quando precisar recuperar grupos de canais que categorizam fontes de tráfego nos relatórios do Analytics.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
parent	string	Sim	A propriedade para a qual listar ChannelGroups. Formato: properties/{property_id}.
pageSize	integer	Não	Número máximo de recursos a retornar. Padrão: 50, máximo: 200.
pageToken	string	Não	Token de uma chamada anterior para recuperar a página seguinte.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar eventos de conversão

GOOGLE_ANALYTICS_LIST_CONVERSION_EVENTS

Lista eventos de conversão em uma propriedade. Use quando precisar recuperar os eventos de conversão configurados para uma propriedade.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
parent	string	Sim	Nome do recurso da propriedade pai. Formato: properties/{propertyId}.
pageSize	integer	Não	Número máximo de recursos a retornar. Padrão: 50, máximo: 200.
pageToken	string	Não	Token de uma chamada anterior para recuperar a página seguinte.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar dimensões personalizadas

GOOGLE_ANALYTICS_LIST_CUSTOM_DIMENSIONS

Lista dimensões personalizadas de uma propriedade.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
parent	string	Sim	A propriedade para a qual listar CustomDimensions. Formato: properties/{property_id}.
pageSize	integer	Não	Número máximo de recursos a retornar. Padrão: 50, máximo: 200.
pageToken	string	Não	Token de uma chamada anterior para recuperar a página seguinte.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar métricas personalizadas

GOOGLE_ANALYTICS_LIST_CUSTOM_METRICS

Lista CustomMetrics em uma propriedade. Use quando precisar recuperar todas as métricas personalizadas configuradas para uma propriedade.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
parent	string	Sim	Identificador da propriedade no formato properties/{propertyId}.
pageSize	integer	Não	Número máximo de recursos a retornar. Padrão: 50, máximo: 200.
pageToken	string	Não	Token de uma chamada anterior para paginação.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar fluxos de dados

GOOGLE_ANALYTICS_LIST_DATA_STREAMS

Lista DataStreams em uma propriedade. Use quando precisar recuperar configurações de fluxo de dados para uma propriedade do Google Analytics.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
parent	string	Sim	Identificador da propriedade GA4. Formato: properties/{NUMERIC_ID}.
pageSize	integer	Não	Número máximo de recursos a retornar. Padrão: 50, máximo: 200.
pageToken	string	Não	Token de uma chamada anterior para recuperar a página seguinte.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar links de anunciantes Display e Video 360

GOOGLE_ANALYTICS_LIST_DV360_AD_LINKS

Lista links de anunciantes Display & Video 360 em uma propriedade. Use quando precisar recuperar recursos DisplayVideo360AdvertiserLink associados a uma propriedade do Google Analytics.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
parent	string	Sim	Nome da propriedade. Formato: properties/{property_id}.
pageSize	integer	Não	Número máximo de recursos a retornar. Padrão: 50, máximo: 200.
pageToken	string	Não	Token de uma chamada anterior para recuperar a página seguinte.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar propostas de links DisplayVideo360

GOOGLE_ANALYTICS_LIST_DV360_LINK_PROPOSALS

Lista propostas de links de anunciantes DisplayVideo360 em uma propriedade. Use quando precisar recuperar propostas de link de anunciante Display & Video 360 associadas a uma propriedade do Google Analytics.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
parent	string	Sim	Nome da propriedade. Formato: properties/{property_id}.
pageSize	integer	Não	Número máximo de recursos a retornar. Padrão: 50, máximo: 200.
pageToken	string	Não	Token de uma chamada anterior para recuperar a página seguinte.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar regras de criação de eventos

GOOGLE_ANALYTICS_LIST_EVENT_CREATE_RULES

Lista EventCreateRules configuradas em um fluxo de dados web. Use quando precisar recuperar regras de criação de eventos para um fluxo de dados de propriedade GA4 específico.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
parent	string	Sim	Nome do recurso do fluxo de dados pai. Formato: properties/{propertyId}/dataStreams/{dataStreamId}.
pageSize	integer	Não	Número máximo de regras de criação de eventos a retornar. Padrão: 50, máximo: 200.
pageToken	string	Não	Token de uma chamada anterior para recuperar a próxima página.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar conjuntos de dados expandidos

GOOGLE_ANALYTICS_LIST_EXPANDED_DATA_SETS

Lista ExpandedDataSets em uma propriedade. Use quando precisar recuperar configurações de conjuntos de dados expandidos para uma propriedade do Google Analytics 360.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
parent	string	Sim	Nome da propriedade. Formato: properties/{property_id}.
pageSize	integer	Não	Número máximo de recursos a retornar. Padrão: 50, máximo: 200.
pageToken	string	Não	Token de uma chamada anterior para recuperar a página seguinte.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar links do Firebase

GOOGLE_ANALYTICS_LIST_FIREBASE_LINKS

Lista FirebaseLinks em uma propriedade. Use quando precisar recuperar conexões Firebase associadas a uma propriedade do Google Analytics. Cada propriedade pode ter no máximo um FirebaseLink.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
parent	string	Sim	A propriedade para a qual listar FirebaseLinks. Formato: properties/{property_id}.
pageSize	integer	Não	Número máximo de recursos a retornar. Padrão: 50, máximo: 200.
pageToken	string	Não	Token de uma chamada anterior para recuperar a página seguinte.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar links do Google Ads

GOOGLE_ANALYTICS_LIST_GOOGLE_ADS_LINKS

Lista GoogleAdsLinks em uma propriedade. Use quando precisar recuperar links de conta do Google Ads configurados para uma propriedade do Google Analytics.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
parent	string	Sim	Nome do recurso da propriedade. Formato: properties/{propertyId}.
pageSize	integer	Não	Número máximo de recursos a retornar. Padrão: 50, máximo: 200.
pageToken	string	Não	Token de uma chamada anterior para recuperar a página seguinte.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar eventos-chave

GOOGLE_ANALYTICS_LIST_KEY_EVENTS

Lista eventos-chave de uma propriedade. Somente leitura via API; criação, atualização e exclusão requerem a interface do Google Analytics. Uma lista de resultados vazia significa que nenhum evento-chave está configurado, não uma falha.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
parent	string	Sim	Nome do recurso da propriedade pai. Formato: properties/{property_id}.
pageSize	integer	Não	Número máximo de resultados a retornar (entre 1 e 200).
pageToken	string	Não	Token para recuperar a próxima página de resultados.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar segredos do Measurement Protocol

GOOGLE_ANALYTICS_LIST_MEASUREMENT_PROTOCOL_SECRETS

Lista MeasurementProtocolSecrets em um fluxo de dados. Use quando precisar recuperar segredos do protocolo de medição para rastreamento de eventos no lado do servidor.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
parent	string	Sim	Nome do recurso do fluxo de dados pai. Formato: properties/{property}/dataStreams/{dataStream}.
pageSize	integer	Não	Número máximo de recursos a retornar. Padrão: 10, máximo: 10.
pageToken	string	Não	Token de uma chamada anterior para recuperar a página seguinte.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar propriedades (depreciado)

GOOGLE_ANALYTICS_LIST_PROPERTIES

DEPRECIADO: Use GOOGLE_ANALYTICS_LIST_PROPERTIES_FILTERED. Lista propriedades GA4 em uma conta específica. Suporta paginação e inclusão de propriedades excluídas suavemente.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
account	string	Sim	Nome do recurso da conta do Google Analytics. Formato: accounts/{account_id}.
pageSize	integer	Não	Número máximo de propriedades a retornar (entre 1 e 200).
pageToken	string	Não	Token de uma chamada anterior para recuperar a próxima página.
showDeleted	boolean	Não	Se deve incluir propriedades excluídas suavemente (na lixeira).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar propriedades filtradas

GOOGLE_ANALYTICS_LIST_PROPERTIES_FILTERED

Lista propriedades GA4 com base em critérios de filtro. Use quando precisar encontrar propriedades em uma conta pai específica ou com projetos Firebase específicos.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
filter	string	Sim	Expressão para filtrar os resultados. Campos elegíveis: parent:, ancestor:, firebase_project:. Exemplos: parent:accounts/123, firebase_project:project-id.
pageSize	integer	Não	Número máximo de propriedades a retornar (1–200). Padrão: 50.
pageToken	string	Não	Token de uma chamada anterior para recuperar a próxima página.
showDeleted	boolean	Não	Se deve incluir propriedades excluídas suavemente. Padrão: false.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar listas de audiência recorrentes

GOOGLE_ANALYTICS_LIST_RECURRING_AUDIENCE_LISTS

Lista todas as listas de audiência recorrentes para uma propriedade GA4. Use quando precisar encontrar e reutilizar listas de audiência recorrentes existentes.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
parent	string	Sim	Nome do recurso da propriedade pai. Formato: properties/{property_id}.
pageSize	integer	Não	Número máximo de listas de audiência recorrentes a retornar. Padrão: 200, máximo: 1000.
pageToken	string	Não	Token para recuperar a próxima página de resultados.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar anotações de dados de relatório

GOOGLE_ANALYTICS_LIST_REPORTING_DATA_ANNOTATIONS

Lista todas as anotações de dados de relatório para uma propriedade específica. Use quando precisar recuperar anotações que documentam eventos ou períodos importantes nos dados de relatório do GA4.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
filter	string	Não	Expressão para refinar os resultados. Campos suportados: name, title, description, annotationDate, annotationDateRange, color.
parent	string	Sim	Nome do recurso da propriedade. Formato: properties/{property_id}.
pageSize	integer	Não	Número máximo de recursos por resposta. Padrão: 50, máximo: 200.
pageToken	string	Não	Token de paginação de uma resposta anterior.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar tarefas de relatório

GOOGLE_ANALYTICS_LIST_REPORT_TASKS

Lista todas as tarefas de relatório para uma propriedade do Google Analytics. Use quando precisar recuperar definições de tarefas de relatório e seu status de execução.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
parent	string	Sim	Identificador da propriedade no formato properties/{propertyId}.
pageSize	integer	Não	Número máximo de tarefas de relatório a retornar por página.
pageToken	string	Não	Token de paginação de uma resposta anterior.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar links do Search Ads 360

GOOGLE_ANALYTICS_LIST_SEARCH_ADS360_LINKS

Lista todos os SearchAds360Links em uma propriedade. Use quando precisar recuperar todos os links do Search Ads 360 para uma propriedade do Google Analytics.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
parent	string	Sim	Nome do recurso da propriedade. Formato: properties/{propertyId}.
pageSize	integer	Não	Número máximo de recursos a retornar. Padrão: 50, máximo: 200.
pageToken	string	Não	Token de uma chamada anterior para recuperar a próxima página.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar esquemas de valor de conversão SKAdNetwork

GOOGLE_ANALYTICS_LIST_SK_AD_NETWORK_CONVERSION_VALUE_SCHEMAS

Lista configurações de SKAdNetworkConversionValueSchema para um fluxo de dados iOS. Use quando precisar recuperar esquemas de valor de conversão para rastreamento de aplicativos iOS.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
parent	string	Sim	Recurso DataStream para o qual listar esquemas. Formato: properties/{property_id}/dataStreams/{dataStream}.
pageSize	integer	Não	Número máximo de recursos por resposta. Padrão: 50, máximo: 200.
pageToken	string	Não	Token de uma chamada anterior para paginação.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar filtros de eventos de subpropriedade

GOOGLE_ANALYTICS_LIST_SUBPROPERTY_EVENT_FILTERS

Lista todos os filtros de eventos de subpropriedade em uma propriedade. Use quando precisar recuperar filtros de eventos que roteiam eventos para subpropriedades.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
parent	string	Sim	Nome do recurso da propriedade comum. Formato: properties/{property_id}.
pageSize	integer	Não	Número máximo de recursos a retornar. Padrão: 50, máximo: 200.
pageToken	string	Não	Token de uma chamada anterior para recuperar a próxima página.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar configurações de sincronização de subpropriedade

GOOGLE_ANALYTICS_LIST_SUBPROPERTY_SYNC_CONFIGS

Lista recursos SubpropertySyncConfig para gerenciar configurações de sincronização de subpropriedades. Use quando precisar buscar configurações de sincronização de subpropriedades para uma propriedade GA4.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
parent	string	Sim	Nome do recurso da propriedade. Formato: properties/{property_id}.
pageSize	integer	Não	Número máximo de recursos a retornar. Padrão: 50, máximo: 200.
pageToken	string	Não	Token de uma chamada anterior para recuperar a página seguinte.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Provisionar ticket de conta

GOOGLE_ANALYTICS_PROVISION_ACCOUNT_TICKET

Solicita um ticket para criar uma conta do Google Analytics. Use quando precisar iniciar o fluxo de criação de conta que requer a aceitação dos Termos de Serviço pelo usuário.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
account	object	Sim	Detalhes da conta incluindo nome de exibição e código de região.
redirectUri	string	Sim	URI de redirecionamento para onde o usuário será enviado após aceitar os Termos de Serviço. Deve estar configurado no Cloud Console como URI de redirecionamento.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Consultar exportação de audiência

GOOGLE_ANALYTICS_QUERY_AUDIENCE_EXPORT

Consulta uma exportação de audiência concluída. Use quando precisar buscar linhas de usuário com paginação.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	Nome do recurso da exportação de audiência. Formato: properties/{property}/audienceExports/{audienceExport}.
limit	integer	Não	Número de linhas a retornar (entre 1 e 250.000). Padrão: 10.000.
offset	integer	Não	Índice de linha inicial baseado em zero para paginação. Padrão: 0.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Consultar lista de audiência

GOOGLE_ANALYTICS_QUERY_AUDIENCE_LIST

Consulta uma lista de audiência. Use quando precisar recuperar linhas de usuário de uma lista de audiência GA4 com paginação.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	Recurso de lista de audiência a consultar. Formato: properties/{property}/audienceLists/{audienceList}.
limit	integer	Não	Número de linhas a retornar. Padrão: 10.000, máximo: 250.000.
offset	integer	Não	Deslocamento de linha baseado em zero para paginação.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Consultar tarefa de relatório

GOOGLE_ANALYTICS_QUERY_REPORT_TASK

Recupera o conteúdo de uma tarefa de relatório. Use após criar uma tarefa com GOOGLE_ANALYTICS_CREATE_REPORT_TASK e confirmar que está no estado ACTIVE. Este método retorna erro se a tarefa não estiver no estado ACTIVE.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	Nome da tarefa de relatório no formato properties/{propertyId}/reportTasks/{reportTaskId}.
limit	integer	Não	Número de linhas a retornar (máx. 250.000). Padrão: 10.000.
offset	integer	Não	Deslocamento de linha para paginação (índice 0).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Executar relatório de funil

GOOGLE_ANALYTICS_RUN_FUNNEL_REPORT

Executa um relatório de funil GA4. Use quando precisar de uma análise de funil personalizada para uma propriedade. A sequência de etapas do funil é determinada pelos atributos de etapa na resposta, não pela ordem das linhas.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
limit	integer	Não	Número de linhas a retornar. Padrão: 10.000, máximo: 250.000.
funnel	object	Sim	Objeto de configuração do funil. Deve incluir uma chave steps com pelo menos uma etapa. Cada etapa requer name e opcionalmente filterExpression.
property	string	Sim	Nome do recurso da propriedade GA4. Formato: properties/{property_id}.
segments	array	Não	Até 4 segmentos; cada um gera sua própria linha no relatório.
dateRanges	array	Não	Lista de intervalos de datas a ler.
dimensionFilter	object	Não	Expressão de filtro somente para dimensões.
funnelBreakdown	object	Não	Configuração da dimensão de detalhamento para o sub-relatório de tabela de funil.
funnelNextAction	object	Não	Configuração de dimensão de próxima ação para o sub-relatório de visualização de funil.
returnPropertyQuota	boolean	Não	Se verdadeiro, inclui o estado atual de cotas da propriedade.
funnelVisualizationType	string	Não	Tipo de visualização: STANDARD_FUNNEL (padrão) ou TRENDED_FUNNEL.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Executar relatório pivot

GOOGLE_ANALYTICS_RUN_PIVOT_REPORT

Executa um relatório pivot personalizado de dados de eventos do Google Analytics. Use quando precisar de uma visão de tabela dinâmica com segmentação avançada e análise multidimensional de dados GA4.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
pivots	array	Não	Configuração do formato visual para dimensões.
metrics	array	Sim	Pelo menos uma métrica é obrigatória. Cada métrica tem um campo name.
property	string	Sim	Nome do recurso da propriedade GA4. Formato: properties/{property_id}.
cohortSpec	object	Não	Configuração de coorte.
dateRanges	array	Não	Intervalos de datas para recuperação de dados de eventos.
dimensions	array	Não	Dimensões a solicitar. As dimensões devem ser usadas em pivots, filtros ou orderBys.
comparisons	array	Não	Configurações de comparação.
currencyCode	string	Não	Código de moeda ISO4217 (ex.: USD, EUR).
metricFilter	object	Não	Filtro pós-agregação.
keepEmptyRows	boolean	Não	Se verdadeiro, inclui linhas onde todas as métricas são zero.
dimensionFilter	object	Não	Cláusula de filtro somente para dimensões.
returnPropertyQuota	boolean	Não	Se verdadeiro, retorna o estado atual de cotas.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Executar relatório em tempo real

GOOGLE_ANALYTICS_RUN_REALTIME_REPORT

Executa um relatório personalizado em tempo real de dados de eventos do Google Analytics. Use quando precisar de dados em tempo real (últimos 30–60 minutos) com dimensões e métricas para uma propriedade GA4.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
limit	integer	Não	Máximo de linhas a retornar (padrão: 10.000, máximo: 250.000).
metrics	array	Não	Métricas a medir (máx. 10). Nomes válidos: activeUsers, eventCount, keyEvents, screenPageViews.
orderBys	array	Não	Especificação de ordenação.
property	string	Sim	Nome do recurso da propriedade GA4. Formato: properties/{property_id}.
dimensions	array	Não	Dimensões para agrupar (máx. 9). Nomes válidos: appVersion, audienceId, city, country, deviceCategory, eventName, minutesAgo, platform etc.
metricFilter	object	Não	Filtro pós-agregação nos valores de métricas.
minuteRanges	array	Não	Intervalos de tempo para o relatório. Padrão: últimos 30 minutos.
dimensionFilter	object	Não	Filtro para restringir dados por valores de dimensão.
metricAggregations	array	Não	Tipos de agregação: TOTAL, MINIMUM, MAXIMUM, COUNT.
returnPropertyQuota	boolean	Não	Se verdadeiro, inclui informações de uso de cotas da API.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Executar relatório

GOOGLE_ANALYTICS_RUN_REPORT

Executa um relatório de dados GA4 personalizado. Use quando precisar de dados de eventos especificando dimensões, métricas e intervalos de datas. Se receber um erro 400 sobre incompatibilidade de dimensões/métricas, use GOOGLE_ANALYTICS_CHECK_COMPATIBILITY primeiro para validar as combinações.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
limit	integer	Não	Número de linhas a retornar (entre 1 e 250.000).
offset	integer	Não	Linha inicial baseada em zero para paginação.
metrics	array	Não	As métricas a solicitar. Máximo de 10 por requisição. Nomes válidos: activeUsers, totalUsers, newUsers, sessions, engagedSessions, screenPageViews, eventCount, conversions etc.
orderBys	array	Não	Especificação de como as linhas são ordenadas.
property	string	Sim	Nome do recurso da propriedade. Formato: properties/{property_id}.
cohortSpec	object	Não	Especificação de coorte. Requer a dimensão de coorte.
dateRanges	array	Não	Intervalos de datas a ler. Obrigatório para relatórios padrão.
dimensions	array	Não	As dimensões a solicitar. Máximo de 9 por requisição. Nomes válidos: date, city, country, deviceCategory, sessionSource, pagePath, eventName etc.
comparisons	array	Não	Configuração de comparação.
currencyCode	string	Não	Código de moeda no formato ISO 4217.
metricFilter	object	Não	Filtro por valores de métricas. Use apenas nomes de métricas aqui.
keepEmptyRows	boolean	Não	Se verdadeiro, inclui linhas com todas as métricas zeradas.
dimensionFilter	object	Não	Filtro por valores de dimensões. Use apenas nomes de dimensões aqui.
metricAggregations	array	Não	Tipos de agregação: TOTAL, MINIMUM, MAXIMUM.
returnPropertyQuota	boolean	Não	Se verdadeiro, inclui o estado atual de cotas na resposta.
removed_dimensions_internal	array	Não	Campo interno para armazenar nomes de dimensões filtrados. Não é enviado à API.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Enviar eventos

GOOGLE_ANALYTICS_SEND_EVENTS

Envia dados de eventos para o Google Analytics 4 usando o Measurement Protocol. Use quando precisar rastrear eventos no lado do servidor que complementam o rastreamento do lado do cliente via gtag.js ou Firebase. Os eventos são processados de forma assíncrona e geralmente aparecem nos relatórios em 24–48 horas.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
events	array	Sim	Array de objetos de evento a enviar. Máximo de 25 eventos por requisição. Cada evento deve ter name e opcionalmente params.
consent	object	Não	Configurações de consentimento para o Google Analytics 4.
user_id	string	Não	Identificador único para um usuário logado. Máximo de 256 caracteres.
client_id	string	Sim	Identificador único para um usuário/cliente. Máximo de 256 caracteres.
api_secret	string	Sim	Segredo de API gerado na interface do Google Analytics em Admin > Fluxos de dados > Segredos de API do Measurement Protocol.
measurement_id	string	Sim	ID de medição do fluxo web no formato G-XXXXXXX.
user_properties	object	Não	Propriedades do usuário a definir. Persistem entre eventos.
timestamp_micros	integer	Não	Timestamp Unix em microssegundos. Pode ser até 72 horas no passado.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar propriedade

GOOGLE_ANALYTICS_UPDATE_PROPERTY

Atualiza uma propriedade GA4 existente. Use quando precisar modificar configurações como nome de exibição, fuso horário, código de moeda ou categoria de setor.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	Nome do recurso da propriedade a atualizar. Formato: properties/{property_id}.
parent	string	Não	Nome do recurso do pai lógico desta propriedade. Formato: accounts/{account} ou properties/{property}.
timeZone	string	Não	Fuso horário de relatório. Formato: IANA. Exemplo: America/Los_Angeles.
updateMask	string	Sim	Lista de campos a atualizar em snake_case. Exemplo: display_name,time_zone,currency_code.
displayName	string	Não	Nome de exibição legível. Máximo de 100 unidades de código UTF-16.
currencyCode	string	Não	Tipo de moeda no formato ISO 4217. Exemplos: USD, EUR, JPY.
propertyType	string	Não	Tipo de propriedade: PROPERTY_TYPE_ORDINARY, PROPERTY_TYPE_SUBPROPERTY ou PROPERTY_TYPE_ROLLUP.
industryCategory	string	Não	Categoria do setor da propriedade. Ex.: TECHNOLOGY, FINANCE, HEALTHCARE.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Validar eventos

GOOGLE_ANALYTICS_VALIDATE_EVENTS

Valida eventos do Measurement Protocol antes de enviá-los para produção. Use quando precisar verificar se a estrutura e os parâmetros dos eventos estão corretos antes de enviar dados reais.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
events	array	Sim	Array de eventos a validar. Cada evento deve ter um campo name e opcionalmente params.
consent	object	Não	Estado de consentimento do usuário.
user_id	string	Não	Identificador único para um usuário.
client_id	string	Sim	Identificador único do cliente.
api_secret	string	Sim	Segredo de API do Google Analytics para o Measurement Protocol.
measurement_id	string	Sim	ID de medição para fluxos web. Formato: G-XXXXXXXXXX.
user_properties	object	Não	Propriedades do usuário para a medição.
timestamp_micros	string	Não	Timestamp Unix em microssegundos para associar ao evento.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.