Method: accounts.searchChangeHistoryEvents

Pesquisa em todas as alterações em uma conta ou nas contas secundárias com base no conjunto especificado de filtros.

Solicitação HTTP

POST https://analyticsadmin.googleapis.com/v1alpha/{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 retornar recursos do histórico de alterações. 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 alterações feitas nessa propriedade ou nos recursos filhos dela. Formato: propriedades/{propertyId}

Exemplo: properties/100

resourceType[]

enum (ChangeHistoryResourceType)

Opcional. Se definido, retornará alterações somente se forem para 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ções.

actorEmail[]

string

Opcional. Se definido, retorna alterações somente se elas forem feitas por um usuário dessa lista.

earliestChangeTime

string (Timestamp format)

Opcional. Se definido, retorna somente as alterações feitas depois desse período (inclusive).

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

latestChangeTime

string (Timestamp format)

Opcional. Se definido, retorna apenas as alterações feitas antes desse período (inclusive).

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

pageSize

integer

Opcional. O número máximo de itens ChangeHistoryEvent a ser retornado. O serviço pode retornar menos do que esse valor, mesmo que haja páginas adicionais. Se não for especificado, no máximo 50 itens serão retornados. O valor máximo é 200 (valores mais altos serão convertidos para o máximo).

pageToken

string

Opcional. Um token de página recebido de uma chamada accounts.searchChangeHistoryEvents anterior. Forneça isso para recuperar a página subsequente. Ao paginar, todos os outros parâmetros fornecidos para accounts.searchChangeHistoryEvents precisam corresponder à chamada que forneceu o token da página.

Corpo da resposta

Mensagem de resposta para a 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 que estavam 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 com alterações que podem ser retornadas do histórico de alterações.

Enums
CHANGE_HISTORY_RESOURCE_TYPE_UNSPECIFIED Tipo de recurso desconhecido ou não especificado.
ACCOUNT Recurso da conta
PROPERTY Recurso de propriedade
GOOGLE_SIGNALS_SETTINGS Recurso GoogleSignalsSettings
CONVERSION_EVENT Recurso ConversionEvent
MEASUREMENT_PROTOCOL_SECRET Recurso Measurement ProtocolSecret
CUSTOM_DIMENSION Recurso CustomDimension
CUSTOM_METRIC Recurso CustomMetric
DATA_RETENTION_SETTINGS Recurso DataRetençãoSettings
DATA_STREAM Recurso do DataStream
ATTRIBUTION_SETTINGS Recurso AttributionSettings
EXPANDED_DATA_SET Recurso ExtendedDataSet
CHANNEL_GROUP Recurso ChannelGroup
ENHANCED_MEASUREMENT_SETTINGS Recurso EnhancedMeasurementSettings
DATA_REDACTION_SETTINGS Recurso DataRedactionSettings
SKADNETWORK_CONVERSION_VALUE_SCHEMA Recurso SKAdNetworkConversionValueSchema
AUDIENCE Recurso de público-alvo
EVENT_CREATE_RULE Recurso EventCreateRule
CALCULATED_METRIC Recurso CalculatedMetric

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 com base nessa mudança.
UPDATED O recurso foi atualizado com base nessa mudança.
DELETED O recurso foi excluído nesta mudança.

ChangeHistoryEvent

Um conjunto de alterações em uma conta do Google Analytics ou nas propriedades filhas que resultaram da mesma causa. As causas comuns seriam atualizações feitas na interface do Google Analytics, alterações do suporte ao cliente ou alterações automáticas do 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 do histórico de alterações. Ele é exclusivo no Google Analytics.

changeTime

string (Timestamp format)

Hora em que a alteração foi feita.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

actorType

enum (ActorType)

O tipo de agente que fez a alteração.

userActorEmail

string

Endereço de e-mail da Conta do Google que fez a alteração Este será um endereço de e-mail válido se o campo "ator" estiver definido como USER. Caso contrário, estará vazio. As contas do Google que foram excluídas causarão um erro.

changesFiltered

boolean

Se verdadeiro, a lista de alterações retornadas foi filtrada e não representa todas as alterações que ocorreram nesse evento.

changes[]

object (ChangeHistoryChange)

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

ActorType

Diferentes tipos de agentes que podem fazer alterações nos recursos do Google Analytics.

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

ChangeHistoryChange

Uma descrição de uma alteração 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 alterações são descritas por esta entrada.

action

enum (ActionType)

O tipo de ação que alterou este recurso.

resourceBeforeChange

object (ChangeHistoryResource)

Conteúdos do recurso anteriores à mudança. Se o recurso tiver sido criado com a mudança, este campo vai estar ausente.

resourceAfterChange

object (ChangeHistoryResource)

Conteúdo do recurso posterior à alteração. Se o recurso tiver sido excluído após a mudança, este campo vai estar ausente.

ChangeHistoryResource

Um snapshot de um recurso como 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)
  },
  "googleSignalsSettings": {
    object (GoogleSignalsSettings)
  },
  "displayVideo360AdvertiserLink": {
    object (DisplayVideo360AdvertiserLink)
  },
  "displayVideo360AdvertiserLinkProposal": {
    object (DisplayVideo360AdvertiserLinkProposal)
  },
  "conversionEvent": {
    object (ConversionEvent)
  },
  "measurementProtocolSecret": {
    object (MeasurementProtocolSecret)
  },
  "customDimension": {
    object (CustomDimension)
  },
  "customMetric": {
    object (CustomMetric)
  },
  "dataRetentionSettings": {
    object (DataRetentionSettings)
  },
  "searchAds360Link": {
    object (SearchAds360Link)
  },
  "dataStream": {
    object (DataStream)
  },
  "attributionSettings": {
    object (AttributionSettings)
  },
  "expandedDataSet": {
    object (ExpandedDataSet)
  },
  "channelGroup": {
    object (ChannelGroup)
  },
  "bigqueryLink": {
    object (BigQueryLink)
  },
  "enhancedMeasurementSettings": {
    object (EnhancedMeasurementSettings)
  },
  "dataRedactionSettings": {
    object (DataRedactionSettings)
  },
  "skadnetworkConversionValueSchema": {
    object (SKAdNetworkConversionValueSchema)
  },
  "adsenseLink": {
    object (AdSenseLink)
  },
  "audience": {
    object (Audience)
  },
  "eventCreateRule": {
    object (EventCreateRule)
  },
  "calculatedMetric": {
    object (CalculatedMetric)
  }
  // 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.

googleSignalsSettings

object (GoogleSignalsSettings)

Um resumo de um recurso GoogleSignalsSettings 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 Measurement ProtocolSecret no histórico de alterações.

customDimension

object (CustomDimension)

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

customMetric

object (CustomMetric)

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

dataRetentionSettings

object (DataRetentionSettings)

Um resumo 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.

attributionSettings

object (AttributionSettings)

Um resumo do recurso AttributionSettings no histórico de alterações.

expandedDataSet

object (ExpandedDataSet)

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

channelGroup

object (ChannelGroup)

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

enhancedMeasurementSettings

object (EnhancedMeasurementSettings)

Um resumo do recurso EnhancedMeasurementSettings no histórico de alterações.

dataRedactionSettings

object (DataRedactionSettings)

Um resumo do recurso DataRedactionSettings no histórico de alterações.

skadnetworkConversionValueSchema

object (SKAdNetworkConversionValueSchema)

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

audience

object (Audience)

Um resumo de um recurso de público-alvo no histórico de alterações.

eventCreateRule

object (EventCreateRule)

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

calculatedMetric

object (CalculatedMetric)

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