Method: accounts.searchChangeHistoryEvents

Procura todas as mudanças em uma conta ou em contas filhas com base no conjunto especificado de filtros.

Retorna apenas o subconjunto de mudanças com suporte da API. A interface pode retornar outras mudanças.

Solicitação HTTP

POST https://analyticsadmin.googleapis.com/v1beta/{account=accounts/*}:searchChangeHistoryEvents

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

Parâmetros de caminho

Parâmetros
account

string

Obrigatório. O recurso da conta para o qual os recursos do histórico de alterações serão retornados. Formato: accounts/{account}

Exemplo: accounts/100

Corpo da solicitação

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

Representação JSON 
{
  "property": string,
  "resourceType": [
    enum (ChangeHistoryResourceType)
  ],
  "action": [
    enum (ActionType)
  ],
  "actorEmail": [
    string
  ],
  "earliestChangeTime": string,
  "latestChangeTime": string,
  "pageSize": integer,
  "pageToken": string
}
Campos
property

string

Opcional. Nome do recurso de uma propriedade filha. Se definido, retorna apenas as mudanças feitas nesta propriedade ou nos recursos filhos dela. Formato: properties/{propertyId}

Exemplo: properties/100
resourceType[]

enum (ChangeHistoryResourceType)

Opcional. Se definido, só retorne mudanças se elas forem de um recurso que corresponda a pelo menos um desses tipos.
action[]

enum (ActionType)

Opcional. Se definido, retorna apenas as mudanças que correspondem a um ou mais desses tipos de ação.
actorEmail[]

string

Opcional. Se definido, só retorna mudanças feitas por um usuário desta lista.
earliestChangeTime

string (Timestamp format)

Opcional. Se definido, retorna apenas as mudanças feitas após esse horário (incluindo esse valor).

Usa o RFC 3339, em que a saída gerada é sempre normalizada em Z e usa dígitos fracionários 0, 3, 6 ou 9. Deslocamentos diferentes de "Z" também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
latestChangeTime

string (Timestamp format)

Opcional. Se definido, retorna apenas as mudanças feitas antes desse horário.

Usa o RFC 3339, em que a saída gerada é sempre normalizada em Z e usa dígitos fracionários 0, 3, 6 ou 9. Deslocamentos diferentes de "Z" também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
pageSize

integer

Opcional. O número máximo de itens do ChangeHistoryEvent a serem retornados. Se não for especificado, no máximo 50 itens serão retornados. O valor máximo é 200. Valores maiores serão convertidos para o máximo.

O serviço pode retornar uma página com menos itens do que o valor especificado (até mesmo zero) e ainda pode haver outras páginas. Se você quiser um número específico de itens, continue solicitando páginas adicionais usando pageToken até chegar ao número necessário.
pageToken

string

Opcional. Um token de página recebido de uma chamada accounts.searchChangeHistoryEvents anterior. Forneça isso para recuperar a página subsequente. Na paginação, todos os outros parâmetros enviados para accounts.searchChangeHistoryEvents precisam corresponder à chamada que informou o token da página.

Corpo da resposta

Mensagem de resposta para o RPC SearchAccounts.

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

Representação JSON 
{
  "changeHistoryEvents": [
    {
      object (ChangeHistoryEvent)
    }
  ],
  "nextPageToken": string
}
Campos
changeHistoryEvents[]

object (ChangeHistoryEvent)

Resultados acessíveis ao autor da chamada.
nextPageToken

string

Um token, que pode ser enviado como pageToken para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

ChangeHistoryResourceType

Tipos de recursos que podem retornar mudanças do histórico de alterações.

Enums
CHANGE_HISTORY_RESOURCE_TYPE_UNSPECIFIED O tipo de recurso é desconhecido ou não foi especificado.
ACCOUNT Recurso da conta
PROPERTY Recurso de propriedade
GOOGLE_SIGNALS_SETTINGS Recurso GoogleSignalsSettings
CONVERSION_EVENT Recurso ConversionEvent
MEASUREMENT_PROTOCOL_SECRET Recurso MeasurementProtocolSecret
CUSTOM_DIMENSION Recurso CustomDimension
CUSTOM_METRIC Recurso CustomMetric
DATA_RETENTION_SETTINGS Recurso DataRetentionSettings
DATA_STREAM Recurso DataStream
ATTRIBUTION_SETTINGS Recurso AttributionSettings

ActionType

Tipos de ações que podem alterar um recurso.

Enums
ACTION_TYPE_UNSPECIFIED Tipo de ação desconhecido ou não especificado.
CREATED O recurso foi criado nessa mudança.
UPDATED O recurso foi atualizado nesta mudança.
DELETED O recurso foi excluído nesta mudança.

ChangeHistoryEvent

Um conjunto de mudanças em uma conta do Google Analytics ou nas propriedades filhas dela que resultaram da mesma causa. As causas comuns são atualizações feitas na interface do Google Analytics, mudanças feitas pelo suporte ao cliente ou alterações automáticas no sistema do Google Analytics.

Representação JSON 
{
  "id": string,
  "changeTime": string,
  "actorType": enum (ActorType),
  "userActorEmail": string,
  "changesFiltered": boolean,
  "changes": [
    {
      object (ChangeHistoryChange)
    }
  ]
}
Campos
id

string

ID desse evento de histórico de alterações. Esse ID é exclusivo no Google Analytics.
changeTime

string (Timestamp format)

Horário em que a mudança foi feita.

Usa o RFC 3339, em que a saída gerada é sempre normalizada em Z e usa dígitos fracionários 0, 3, 6 ou 9. Deslocamentos diferentes de "Z" também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
actorType

enum (ActorType)

O tipo de ator que fez essa mudança.
userActorEmail

string

Endereço de e-mail da Conta do Google que fez a alteração. Será um endereço de e-mail válido se o campo "Ator" estiver definido como "USER", e vazio caso contrário. Contas do Google excluídas vão causar um erro.
changesFiltered

boolean

Se for verdadeiro, a lista de mudanças retornadas foi filtrada e não representa todas as mudanças que ocorreram nesse evento.
changes[]

object (ChangeHistoryChange)

Uma lista de mudanças feitas neste evento do histórico de alterações que se encaixam nos filtros especificados em SearchChangeHistoryEventsRequest.

ActorType

Diferentes tipos de atores que podem fazer mudanças nos recursos do Google Analytics.

Enums
ACTOR_TYPE_UNSPECIFIED Tipo de ator desconhecido ou não especificado.
USER Mudanças feitas pelo usuário especificado em actorEmail.
SYSTEM Mudanças feitas pelo sistema do Google Analytics.
SUPPORT Mudanças feitas pela equipe de suporte do Google Analytics.

ChangeHistoryChange

Uma descrição de uma mudança em um único recurso do Google Analytics.

Representação JSON 
{
  "resource": string,
  "action": enum (ActionType),
  "resourceBeforeChange": {
    object (ChangeHistoryResource)
  },
  "resourceAfterChange": {
    object (ChangeHistoryResource)
  }
}
Campos
resource

string

Nome do recurso cujas mudanças são descritas por essa entrada.
action

enum (ActionType)

O tipo de ação que mudou esse recurso.
resourceBeforeChange

object (ChangeHistoryResource)

Conteúdo do recurso antes da mudança. Se esse recurso foi criado nessa mudança, esse campo não vai estar presente.
resourceAfterChange

object (ChangeHistoryResource)

Conteúdo do recurso após a mudança. Se esse recurso foi excluído nessa mudança, esse campo não vai estar presente.

ChangeHistoryResource

Um snapshot de um recurso antes ou depois do resultado de uma alteração no histórico de alterações.

Representação JSON 
{

  // Union field resource can be only one of the following:
  "account": {
    object (Account)
  },
  "property": {
    object (Property)
  },
  "firebaseLink": {
    object (FirebaseLink)
  },
  "googleAdsLink": {
    object (GoogleAdsLink)
  },
  "conversionEvent": {
    object (ConversionEvent)
  },
  "measurementProtocolSecret": {
    object (MeasurementProtocolSecret)
  },
  "dataRetentionSettings": {
    object (DataRetentionSettings)
  },
  "dataStream": {
    object (DataStream)
  }
  // End of list of possible types for union field resource.
}
Campos

Campo de união resource.

resource pode ser apenas de um dos tipos a seguir:
account

object (Account)

Um resumo de um recurso da conta no histórico de alterações.
property

object (Property)

Um snapshot de um recurso de propriedade no histórico de alterações.
conversionEvent

object (ConversionEvent)

Um resumo de um recurso ConversionEvent no histórico de alterações.
measurementProtocolSecret

object (MeasurementProtocolSecret)

Um snapshot de um recurso MeasurementProtocolSecret no histórico de alterações.
dataRetentionSettings

object (DataRetentionSettings)

Um snapshot de um recurso de configurações de retenção de dados no histórico de alterações.
dataStream

object (DataStream)

Um snapshot de um recurso do DataStream no histórico de alterações.