Method: userActivity.search

Retorna dados de atividade do usuário.

Solicitação HTTP

POST https://analyticsreporting.googleapis.com/v4/userActivity:search

O URL usa a sintaxe de transcodificação gRPC.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "dateRange": {
    object(DateRange)
  },
  "viewId": string,
  "user": {
    object(User)
  },
  "activityTypes": [
    enum(ActivityType)
  ],
  "pageSize": number,
  "pageToken": string
}
Campos
dateRange

object(DateRange)

Período para o qual a atividade do usuário será recuperada. Se um período não for fornecido, o período padrão será: "startDate: data atual - 7 dias" e "endDate: data atual - 1 dia".

viewId

string

Obrigatório. O código da vista do Google Analytics da qual os dados serão recuperados. Todo SearchUserActivityRequest precisa conter o viewId.

user

object(User)

Obrigatório. ID do usuário único a ser consultado. Cada SearchUserActivityRequest precisa conter esse campo.

activityTypes[]

enum(ActivityType)

Conjunto de todos os tipos de atividade solicitados. Somente atividades correspondentes a esses tipos serão retornadas na resposta. Se estiver vazio, todas as atividades serão retornadas.

pageSize

number

O tamanho da página é referente à paginação e especifica o número máximo de linhas retornadas. O tamanho da página precisa ser maior que 0. Se o valor for 0 ou se o campo não for especificado, a solicitação retornará o padrão de 1.000 linhas por página.

pageToken

string

Um token de continuação para ter acesso à próxima página de resultados. Se você adicioná-lo à solicitação, as linha depois do pageToken serão retornadas. O pageToken precisa ser o valor retornado no parâmetro nextPageToken na resposta à solicitação SearchUserActivityRequest.

Corpo da resposta

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

A resposta da chamada de userActivity:get.

Representação JSON 
{
  "sessions": [
    {
      object(UserActivitySession)
    }
  ],
  "totalRows": number,
  "nextPageToken": string,
  "sampleRate": number
}
Campos
sessions[]

object(UserActivitySession)

Cada registro representa uma sessão (detalhes do dispositivo, duração etc.).

totalRows

number

Total de linhas retornadas por essa consulta (em diferentes páginas).

nextPageToken

string

Esse token precisa ser transmitido para SearchUserActivityRequest para recuperar a próxima página.

sampleRate

number

Esse campo representa a taxa de amostragem da solicitação especificada e é um número entre 0,0 e 1,0. Consulte o guia do desenvolvedor para ver detalhes.

Escopos de autorização

Requer um dos seguintes escopos de OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics

Usuário

Contém informações para identificar um determinado usuário de forma exclusiva.

Representação JSON 
{
  "type": enum(UserIdType),
  "userId": string
}
Campos
type

enum(UserIdType)

Tipo de usuário na solicitação. O campo userId está associado a esse tipo.

userId

string

ID exclusivo do usuário para o qual os dados estão sendo solicitados.

UserIdType

Representa vários tipos de identificação do usuário disponíveis.

Enums
USER_ID_TYPE_UNSPECIFIED Quando o tipo de ID do usuário não é especificado, o tipo padrão usado é CLIENT_ID.
USER_ID Um usuário único, como uma conta de usuário conectada, que pode interagir com o conteúdo em mais de uma instância do dispositivo e/ou navegador.
CLIENT_ID O clientId foi atribuído pelo Google Analytics.

ActivityType

Enums
ACTIVITY_TYPE_UNSPECIFIED ActivityType nunca terá esse valor na resposta. O uso desse tipo na solicitação resultará em um erro.
PAGEVIEW Usado quando a atividade resulta da visualização de uma página por um visitante.
SCREENVIEW Usado quando a atividade resulta do uso de um aplicativo em um dispositivo móvel por um visitante.
GOAL Usado para indicar que um tipo de atividade de meta.
ECOMMERCE Uma transação de comércio eletrônico foi realizada pelo visitante na página.
EVENT Usado quando a atividade é um evento.

UserActivitySession

Isso representa uma sessão de usuário realizada em um dispositivo específico em um determinado período.

Representação JSON 
{
  "sessionId": string,
  "deviceCategory": string,
  "platform": string,
  "dataSource": string,
  "activities": [
    {
      object(Activity)
    }
  ],
  "sessionDate": string
}
Campos
sessionId

string

ID exclusivo da sessão.

deviceCategory

string

O tipo de dispositivo usado: "smartphone", "tablet" etc.

platform

string

Plataforma em que a atividade aconteceu: "android", "ios" etc.

dataSource

string

A fonte de dados de um hit. Por padrão, os hits enviados pelo analytics.js são contabilizados como "Web" e os hits enviados pelos SDKs para dispositivos móveis são contabilizados como "app". Esses valores podem ser substituídos no Measurement Protocol.

activities[]

object(Activity)

Representa uma visualização detalhada de cada atividade na sessão.

sessionDate

string

Data desta sessão no formato ISO-8601.

Atividade

Uma atividade representa os dados de uma atividade de um usuário. Uma atividade é diferente de um hit. Um hit pode resultar em várias atividades. Por exemplo, se um hit incluir uma transação e uma conclusão de meta, haverá dois protótipos de atividade para esse hit, um para ECOMMERCE e outro para GOAL. Por outro lado, vários hits também podem construir uma atividade. No comércio eletrônico clássico, os dados de uma transação podem ser enviados por meio de vários hits. Esses hits serão mesclados em uma atividade de E-COMMERCE.

Representação JSON 
{
  "activityTime": string,
  "source": string,
  "medium": string,
  "channelGrouping": string,
  "campaign": string,
  "keyword": string,
  "hostname": string,
  "landingPagePath": string,
  "activityType": enum(ActivityType),
  "customDimension": [
    {
      object(CustomDimension)
    }
  ],

  // Union field activity_details can be only one of the following:
  "pageview": {
    object(PageviewData)
  },
  "appview": {
    object(ScreenviewData)
  },
  "ecommerce": {
    object(EcommerceData)
  },
  "goals": {
    object(GoalSetData)
  },
  "event": {
    object(EventData)
  }
  // End of list of possible types for union field activity_details.
}
Campos
activityTime

string (Timestamp format)

Carimbo de data/hora da atividade.

É um carimbo de data/hora no formato UTC "Zulu" RFC3339, medido com precisão de nanossegundos. Exemplo: "2014-10-02T15:01:23.045123456Z".
source

string

Origem de referências. Para o acompanhamento de campanhas manual, é o valor do parâmetro de acompanhamento de campanhas utm_source. Para a codificação automática do Google AdWords, é "google". Se você não usar nenhuma das opções, será o domínio da origem (por exemplo, document.referrer) que vai se referir aos usuários. Ele também pode conter um endereço de porta. Se os usuários chegaram sem um referenciador, o valor é "direto".

medium

string

Tipo de referência. Para o acompanhamento de campanhas manual, é o valor do parâmetro de acompanhamento de campanhas utm_medium. Para a codificação automática do Google AdWords, é CPC. Se os usuários vieram de um mecanismo de pesquisa detectado pelo Google Analytics, ele é orgânico. Se o referenciador não for um mecanismo de pesquisa, será uma referência. Se os usuários vierem diretamente à propriedade e document.referrer estiver vazio, o valor será (nenhum).

channelGrouping

string

O grupo de canais associado à sessão de um usuário final para essa vista (definido pelos agrupamentos de canais dela).

campaign

string

Para o acompanhamento de campanhas manual, é o valor do parâmetro de acompanhamento de campanhas utm_campaign. Para a codificação automática do Google AdWords, é o(s) nome(s) da(s) campanha(s) de publicidade on-line que você usa para a propriedade. Se você não usar nenhum deles, o valor será "(not set)".

keyword

string

Para o acompanhamento de campanhas manual, é o valor do parâmetro de acompanhamento de campanhas utm_term. Para o tráfego do Google AdWords, ele contém os critérios de segmentação que melhor correspondem. Para a Rede de Display, onde vários critérios de segmentação poderiam ter causado a exibição do anúncio, ela retorna os critérios de segmentação com melhor correspondência, conforme selecionado pelo Google Ads. Pode ser display_keyword, siteplacement, boomuserlist, user_interest, idade ou gênero. Caso contrário, o valor será "(not set)".

hostname

string

O nome do host a partir do qual a solicitação de acompanhamento foi feita.

landingPagePath

string

A primeira página nas sessões dos usuários ou a página de destino.

activityType

enum(ActivityType)

Tipo dessa atividade.

customDimension[]

object(CustomDimension)

Uma lista de todas as dimensões personalizadas associadas a esta atividade.

Campo de união activity_details. Dependendo de activity_type, exatamente um dos campos a seguir será definido. activity_details pode ser apenas de um dos tipos a seguir:
pageview

object(PageviewData)

Ele será definido se activityType for igual a PAGEVIEW. Esse campo contém todos os detalhes sobre o visitante e a página que foi visitada.

appview

object(ScreenviewData)

Ele será definido se activityType for igual a SCREEN_VIEW.

ecommerce

object(EcommerceData)

Ele será definido se activityType for igual a ECOMMERCE.

goals

object(GoalSetData)

Esse campo contém uma lista de todas as metas que foram alcançadas nessa atividade quando activityType for igual a GOAL.

event

object(EventData)

Esse campo contém todos os detalhes relacionados a um evento e será definido se activityType for igual a EVENT.

CustomDimension

Dimensão personalizada.

Representação JSON 
{
  "index": number,
  "value": string
}
Campos
index

number

Número do slot da dimensão personalizada.

value

string

Valor da dimensão personalizada. O valor padrão (ou seja, string vazia) indica a limpeza do valor da dimensão personalizada da sessão/escopo do visitante.

PageviewData

Representa os detalhes coletados quando o visitante visualiza uma página.

Representação JSON 
{
  "pagePath": string,
  "pageTitle": string
}
Campos
pagePath

string

O URL da página que o visitante visualizou.

pageTitle

string

O título da página que o visitante visualizou.

ScreenviewData

Representação JSON 
{
  "screenName": string,
  "mobileDeviceBranding": string,
  "mobileDeviceModel": string,
  "appName": string
}
Campos
screenName

string

Nome da tela.

mobileDeviceBranding

string

Fabricante ou nome da marca do dispositivo móvel Por exemplo: "Google", "Apple" etc.

mobileDeviceModel

string

Modelo do dispositivo móvel. Por exemplo: "Pixel", "iPhone" etc.

appName

string

O nome do aplicativo.

EcommerceData

Detalhes de e-commerce associados à atividade do usuário.

Representação JSON 
{
  "actionType": enum(ECommerceAction),
  "transaction": {
    object(TransactionData)
  },
  "products": [
    {
      object(ProductData)
    }
  ],
  "ecommerceType": enum(EcommerceType)
}
Campos
actionType

enum(ECommerceAction)

Ação associada a esta ação de e-commerce.

transaction

object(TransactionData)

Detalhes da transação dessa ação de e-commerce.

products[]

object(ProductData)

Detalhes dos produtos nesta transação.

ecommerceType

enum(EcommerceType)

O tipo dessa atividade de e-commerce.

ECommerceAction

Conjunto de todas as ações associadas a uma ação de comércio eletrônico.

Enums
UNKNOWN O tipo de ação é desconhecido.
CLICK Clique nas listas de produtos.
DETAILS_VIEW Visualizações dos detalhes do produto.
ADD_TO_CART Adicione produtos ao carrinho.
REMOVE_FROM_CART Remover produto(s) do carrinho.
CHECKOUT Finalize a compra.
PAYMENT Compra concluída.
REFUND Reembolso da compra.
CHECKOUT_OPTION Opções de finalização de compra.

TransactionData

Representa os detalhes coletados quando o visitante realiza uma transação na página.

Representação JSON 
{
  "transactionId": string,
  "transactionRevenue": number,
  "transactionTax": number,
  "transactionShipping": number
}
Campos
transactionId

string

O ID da transação, fornecido pelo método de acompanhamento de comércio eletrônico, para a compra no carrinho.

transactionRevenue

number

A receita total de vendas (excluindo frete e tributos) da transação.

transactionTax

number

O tributo total da transação.

transactionShipping

number

Custo total de frete.

ProductData

Detalhes dos produtos em uma transação de e-commerce.

Representação JSON 
{
  "productSku": string,
  "productName": string,
  "itemRevenue": number,
  "productQuantity": string
}
Campos
productSku

string

Código exclusivo que representa o produto.

productName

string

O nome do produto, fornecido pelo aplicativo de acompanhamento de comércio eletrônico, para os itens comprados.

itemRevenue

number

A receita total dos itens de produto comprados.

productQuantity

string (int64 format)

Número total dessas unidades de produto na transação.

EcommerceType

Representa o tipo de dados de comércio eletrônico que está sendo retornado.

Enums
ECOMMERCE_TYPE_UNSPECIFIED Usado quando o tipo de atividade de e-commerce não é especificado.
CLASSIC Usado quando a atividade tem informações de comércio eletrônico clássicas (não aprimoradas).
ENHANCED Usado quando a atividade tem informações de e-commerce avançado.

GoalSetData

Representa um conjunto de metas que foram alcançadas em uma atividade.

Representação JSON 
{
  "goals": [
    {
      object(GoalData)
    }
  ]
}
Campos
goals[]

object(GoalData)

Todas as metas que foram alcançadas na atividade atual.

GoalData

Representa todos os detalhes relacionados a uma meta.

Representação JSON 
{
  "goalIndex": number,
  "goalCompletions": string,
  "goalValue": number,
  "goalCompletionLocation": string,
  "goalPreviousStep1": string,
  "goalPreviousStep2": string,
  "goalPreviousStep3": string,
  "goalName": string
}
Campos
goalIndex

number

Isso identifica a meta como configurada para o perfil.

goalCompletions

string (int64 format)

Número total de conclusões de meta nesta atividade.

goalValue

number

Valor nesta meta.

goalCompletionLocation

string

URL da página em que essa meta foi concluída.

goalPreviousStep1

string

URL da página uma etapa antes da conclusão da meta.

goalPreviousStep2

string

URL da página duas etapas antes da conclusão da meta.

goalPreviousStep3

string

URL da página três etapas antes da conclusão da meta.

goalName

string

Nome da meta.

EventData

Representa todos os detalhes relacionados a um evento.

Representação JSON 
{
  "eventCategory": string,
  "eventAction": string,
  "eventLabel": string,
  "eventValue": string,
  "eventCount": string
}
Campos
eventCategory

string

O objeto na página que recebeu a interação. Por exemplo: "Vídeo".

eventAction

string

Tipo de interação com o objeto. Por exemplo: "play".

eventLabel

string

Marcador anexado ao evento.

eventValue

string (int64 format)

Valor numérico associado ao evento.

eventCount

string (int64 format)

Número desses eventos nesta atividade.

Confira!