Method: accounts.searchChangeHistoryEvents

Recherche toutes les modifications apportées à un compte ou à ses enfants en fonction de l'ensemble de filtres spécifié.

Ne renvoie que le sous-ensemble des modifications compatibles avec l'API. L'interface utilisateur peut renvoyer des modifications supplémentaires.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
account

string

Obligatoire. Ressource de compte pour laquelle renvoyer des ressources d'historique des modifications. Format: accounts/{account}

Exemple : accounts/100

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON
{
  "property": string,
  "resourceType": [
    enum (ChangeHistoryResourceType)
  ],
  "action": [
    enum (ActionType)
  ],
  "actorEmail": [
    string
  ],
  "earliestChangeTime": string,
  "latestChangeTime": string,
  "pageSize": integer,
  "pageToken": string
}
Champs
property

string

Facultatif. Nom de la ressource pour une propriété enfant. Si défini, ne renvoie que les modifications apportées à cette propriété ou à ses ressources enfants. Format: properties/{propertyId}

Exemple : properties/100

resourceType[]

enum (ChangeHistoryResourceType)

Facultatif. Si cette valeur est définie, ne renvoyez les modifications que si elles concernent une ressource correspondant à au moins l'un de ces types.

action[]

enum (ActionType)

Facultatif. Si cette valeur est définie, seules les modifications correspondant à un ou plusieurs de ces types d'actions sont renvoyées.

actorEmail[]

string

Facultatif. Si cette valeur est définie, seules les modifications apportées par un utilisateur de cette liste sont renvoyées.

earliestChangeTime

string (Timestamp format)

Facultatif. Si cette valeur est définie, seules les modifications effectuées après cette heure (inclusive) sont renvoyées.

Utilise la norme RFC 3339, où la sortie générée est toujours normalisée avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés.Exemples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

latestChangeTime

string (Timestamp format)

Facultatif. Si cette valeur est définie, seules les modifications effectuées avant cette heure (inclusive) sont renvoyées.

Utilise la norme RFC 3339, où la sortie générée est toujours normalisée avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés.Exemples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

pageSize

integer

Facultatif. Nombre maximal d'éléments ChangeHistoryEvent à renvoyer. Si aucune valeur n'est spécifiée, 50 éléments maximum sont renvoyés. La valeur maximale est de 200 (les valeurs supérieures sont réduites à la valeur maximale).

Notez que le service peut renvoyer une page contenant moins d'éléments que cette valeur (et même zéro) et qu'il peut y avoir d'autres pages. Si vous souhaitez un nombre d'éléments particulier, vous devrez continuer à demander des pages supplémentaires à l'aide de pageToken jusqu'à ce que vous obteniez le nombre souhaité.

pageToken

string

Facultatif. Jeton de page reçu d'un appel accounts.searchChangeHistoryEvents précédent. Fournissez-le pour récupérer la page suivante. Lors de la pagination, tous les autres paramètres fournis à accounts.searchChangeHistoryEvents doivent correspondre à l'appel ayant fourni le jeton de page.

Corps de la réponse

Message de réponse pour le RPC SearchAccounts.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON
{
  "changeHistoryEvents": [
    {
      object (ChangeHistoryEvent)
    }
  ],
  "nextPageToken": string
}
Champs
changeHistoryEvents[]

object (ChangeHistoryEvent)

Résultats accessibles à l'appelant.

nextPageToken

string

Jeton pouvant être envoyé en tant que pageToken pour récupérer la page suivante. Si ce champ est omis, il n'y a pas d'autres pages.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

ChangeHistoryResourceType

Types de ressources dont les modifications peuvent être renvoyées à partir de l'historique des modifications.

Enums
CHANGE_HISTORY_RESOURCE_TYPE_UNSPECIFIED Type de ressource inconnu ou non spécifié.
ACCOUNT Ressource de compte
PROPERTY Ressource d'établissement
GOOGLE_SIGNALS_SETTINGS Ressource GoogleSignalsSettings
CONVERSION_EVENT Ressource ConversionEvent
MEASUREMENT_PROTOCOL_SECRET Ressource MeasurementProtocolSecret
CUSTOM_DIMENSION Ressource CustomDimension
CUSTOM_METRIC Ressource CustomMetric
DATA_RETENTION_SETTINGS Ressource DataRetentionSettings
DATA_STREAM Ressource DataStream
ATTRIBUTION_SETTINGS Ressource AttributionSettings

ActionType

Types d'actions pouvant modifier une ressource.

Enums
ACTION_TYPE_UNSPECIFIED Type d'action inconnu ou non spécifié.
CREATED La ressource a été créée lors de ce changement.
UPDATED La ressource a été mise à jour lors de ce changement.
DELETED La ressource a été supprimée lors de cette modification.

ChangeHistoryEvent

Ensemble de modifications apportées à un compte Google Analytics ou à ses propriétés enfants pour une même raison. Les causes courantes sont les mises à jour apportées à l'interface utilisateur de Google Analytics, les modifications apportées par le service client ou les modifications automatiques du système Google Analytics.

Représentation JSON
{
  "id": string,
  "changeTime": string,
  "actorType": enum (ActorType),
  "userActorEmail": string,
  "changesFiltered": boolean,
  "changes": [
    {
      object (ChangeHistoryChange)
    }
  ]
}
Champs
id

string

ID de cet événement de l'historique des modifications. Cet ID est unique dans Google Analytics.

changeTime

string (Timestamp format)

Heure à laquelle la modification a été apportée.

Utilise la norme RFC 3339, où la sortie générée est toujours normalisée avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés.Exemples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

actorType

enum (ActorType)

Type d'acteur à l'origine de cette modification.

userActorEmail

string

Adresse e-mail du compte Google à l'origine de la modification. Il s'agit d'une adresse e-mail valide si le champ "acteur" est défini sur "UTILISATEUR", et d'une adresse vide dans le cas contraire. Les comptes Google supprimés génèrent une erreur.

changesFiltered

boolean

Si la valeur est "true", la liste des modifications renvoyées a été filtrée et ne représente pas toutes les modifications apportées à cet événement.

changes[]

object (ChangeHistoryChange)

Liste des modifications apportées dans cet événement de l'historique des modifications qui correspondent aux filtres spécifiés dans SearchChangeHistoryEventsRequest.

ActorType

Différents types d'acteurs pouvant modifier les ressources Google Analytics.

Enums
ACTOR_TYPE_UNSPECIFIED Type d'acteur inconnu ou non spécifié.
USER Modifications apportées par l'utilisateur spécifié dans actorEmail.
SYSTEM Modifications apportées par le système Google Analytics.
SUPPORT Modifications apportées par l'équipe d'assistance Google Analytics.

ChangeHistoryChange

Description d'une modification apportée à une seule ressource Google Analytics.

Représentation JSON
{
  "resource": string,
  "action": enum (ActionType),
  "resourceBeforeChange": {
    object (ChangeHistoryResource)
  },
  "resourceAfterChange": {
    object (ChangeHistoryResource)
  }
}
Champs
resource

string

Nom de la ressource dont les modifications sont décrites par cette entrée.

action

enum (ActionType)

Type d'action ayant modifié cette ressource.

resourceBeforeChange

object (ChangeHistoryResource)

Contenu de la ressource avant le changement. Si cette ressource a été créée lors de cette modification, ce champ sera manquant.

resourceAfterChange

object (ChangeHistoryResource)

Contenu de la ressource après la modification. Si cette ressource a été supprimée lors de cette modification, ce champ sera manquant.

ChangeHistoryResource

Instantané d'une ressource avant ou après le résultat d'une modification dans l'historique des modifications.

Représentation 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.
}
Champs

Champ d'union resource.

resource ne peut être qu'un des éléments suivants :

account

object (Account)

Snapshot d'une ressource de compte dans l'historique des modifications.

property

object (Property)

Instantané d'une ressource de propriété dans l'historique des modifications.

conversionEvent

object (ConversionEvent)

Snapshot d'une ressource ConversionEvent dans l'historique des modifications.

measurementProtocolSecret

object (MeasurementProtocolSecret)

Instantané d'une ressource MeasurementProtocolSecret dans l'historique des modifications.

dataRetentionSettings

object (DataRetentionSettings)

Instantané d'une ressource de paramètres de conservation des données dans l'historique des modifications.

dataStream

object (DataStream)

Instantané d'une ressource DataStream dans l'historique des modifications.