Method: accounts.searchChangeHistoryEvents

Pesquisa todas as mudanças em uma conta ou nos filhos dela com base no conjunto de filtros especificado.

Retorna apenas o subconjunto de mudanças compatíveis com a API. A interface pode retornar outras mudanças.

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 secundária. Se definido, retorna apenas as mudanças feitas nessa propriedade ou nos recursos filhos dela. Formato: properties/{propertyId}

Exemplo: properties/100

resourceType[]

enum (ChangeHistoryResourceType)

Opcional. Se definido, retorna apenas as mudanças 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ções.

actorEmail[]

string

Opcional. Se definido, retorna apenas as mudanças feitas por um usuário nesta lista.

earliestChangeTime

string (Timestamp format)

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

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes 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 (incluindo esse valor).

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes 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 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 esse valor especifica (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é receber a quantidade necessária.

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 cujas mudanças 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 MeasurementProtocolSecret
CUSTOM_DIMENSION Recurso CustomDimension
CUSTOM_METRIC Recurso CustomMetric
DATA_RETENTION_SETTINGS Recurso DataRetentionSettings
DATA_STREAM Recurso DataStream
ATTRIBUTION_SETTINGS Recurso AttributionSettings
EXPANDED_DATA_SET Recurso ExpandedDataSet
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
KEY_EVENT Recurso KeyEvent
CALCULATED_METRIC Recurso CalculatedMetric
REPORTING_DATA_ANNOTATION Recurso ReportingDataAnnotation
SUBPROPERTY_SYNC_CONFIG Recurso SubpropertySyncConfig
REPORTING_IDENTITY_SETTINGS Recurso ReportingIdentitySettings

ActionType

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

Enums
ACTION_TYPE_UNSPECIFIED Tipo de ação desconhecido ou não especificado.
CREATED O recurso foi criado nesta 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 usuário do Google Analytics, mudanças 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 deste evento do histórico de mudanças. Esse ID é exclusivo no Google Analytics.

changeTime

string (Timestamp format)

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

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes 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 mudança. 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 causam um erro.

changesFiltered

boolean

Se for "true", a lista de mudanças retornada 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 esta 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 o recurso foi criado nessa mudança, esse campo não vai aparecer.

resourceAfterChange

object (ChangeHistoryResource)

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

ChangeHistoryResource

Um snapshot de um recurso antes ou depois do resultado de uma mudança 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)
  },
  "keyEvent": {
    object (KeyEvent)
  },
  "calculatedMetric": {
    object (CalculatedMetric)
  },
  "reportingDataAnnotation": {
    object (ReportingDataAnnotation)
  },
  "subpropertySyncConfig": {
    object (SubpropertySyncConfig)
  },
  "reportingIdentitySettings": {
    object (ReportingIdentitySettings)
  }
  // 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 snapshot de um recurso "Account" 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 instantâneo de um recurso "GoogleSignalsSettings" no histórico de alterações.

conversionEvent

object (ConversionEvent)

Um snapshot de um recurso "ConversionEvent" no histórico de mudanças.

measurementProtocolSecret

object (MeasurementProtocolSecret)

Um snapshot de um recurso MeasurementProtocolSecret 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 mudanças.

dataRetentionSettings

object (DataRetentionSettings)

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

dataStream

object (DataStream)

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

attributionSettings

object (AttributionSettings)

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

expandedDataSet

object (ExpandedDataSet)

Um instantâneo de um recurso ExpandedDataSet no histórico de alterações.

channelGroup

object (ChannelGroup)

Um snapshot de um recurso ChannelGroup no histórico de mudanças.

enhancedMeasurementSettings

object (EnhancedMeasurementSettings)

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

dataRedactionSettings

object (DataRedactionSettings)

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

keyEvent

object (KeyEvent)

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

calculatedMetric

object (CalculatedMetric)

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

reportingDataAnnotation

object (ReportingDataAnnotation)

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

subpropertySyncConfig

object (SubpropertySyncConfig)

Um instantâneo de um recurso "SubpropertySyncConfig" no histórico de alterações.

reportingIdentitySettings

object (ReportingIdentitySettings)

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