Package google.analytics.admin.v1beta

Index

AnalyticsAdminService

Interface de service pour l'API Google Analytics Admin.

AcknowledgeUserDataCollection

rpc AcknowledgeUserDataCollection(AcknowledgeUserDataCollectionRequest) returns (AcknowledgeUserDataCollectionResponse)

Confirme les conditions de collecte des données utilisateur pour la propriété spécifiée.

Cette confirmation doit être effectuée (dans l'UI Google Analytics ou via cette API) avant que des ressources MeasurementProtocolSecret puissent être créées.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

rpc ArchiveCustomDimension(ArchiveCustomDimensionRequest) returns (Empty)

Archive une CustomDimension sur une propriété.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

rpc ArchiveCustomMetric(ArchiveCustomMetricRequest) returns (Empty)

Archive une métrique personnalisée sur une propriété.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

rpc CreateConversionEvent(CreateConversionEventRequest) returns (ConversionEvent)

Obsolète: utilisez CreateKeyEvent à la place. Crée un événement de conversion avec les attributs spécifiés.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

rpc CreateCustomDimension(CreateCustomDimensionRequest) returns (CustomDimension)

Crée une CustomDimension.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

rpc CreateCustomMetric(CreateCustomMetricRequest) returns (CustomMetric)

Crée une métrique personnalisée.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

rpc CreateDataStream(CreateDataStreamRequest) returns (DataStream)

Crée un DataStream.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

rpc CreateKeyEvent(CreateKeyEventRequest) returns (KeyEvent)

Crée un événement clé.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

rpc CreateMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest) returns (MeasurementProtocolSecret)

Crée un secret de protocole de mesure.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

rpc CreateProperty(CreatePropertyRequest) returns (Property)

Crée une propriété Google Analytics avec l'emplacement et les attributs spécifiés.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

rpc DeleteAccount(DeleteAccountRequest) returns (Empty)

Marque le compte cible comme supprimé de manière temporaire (c'est-à-dire "mis à la corbeille") et le renvoie.

Cette API ne dispose pas de méthode permettant de restaurer les comptes supprimés de manière temporaire. Toutefois, vous pouvez les restaurer à l'aide de l'interface utilisateur de la corbeille.

Si les comptes ne sont pas restaurés avant la date d'expiration, ils seront définitivement supprimés, ainsi que toutes les ressources enfants (par exemple, les propriétés, les liens Google Ads, les flux et les liaisons d'accès). https://support.google.com/analytics/answer/6154772

Renvoie une erreur si la cible n'est pas trouvée.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

rpc DeleteConversionEvent(DeleteConversionEventRequest) returns (Empty)

Obsolète: utilisez DeleteKeyEvent à la place. Supprime un événement de conversion dans une propriété.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

rpc DeleteDataStream(DeleteDataStreamRequest) returns (Empty)

Supprime un flux de données sur une propriété.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

rpc DeleteKeyEvent(DeleteKeyEventRequest) returns (Empty)

Supprime un événement clé.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

rpc DeleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest) returns (Empty)

Supprime le secret MeasurementProtocolSecret cible.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

rpc DeleteProperty(DeletePropertyRequest) returns (Property)

Marque la propriété cible comme supprimée de façon réversible (c'est-à-dire "mise à la corbeille") et la renvoie.

Cette API ne dispose pas de méthode permettant de restaurer les propriétés supprimées de façon réversible. Toutefois, vous pouvez les restaurer à l'aide de l'interface utilisateur de la corbeille.

Si les propriétés ne sont pas restaurées avant la date d'expiration, elles et toutes les ressources enfants (par exemple, GoogleAdsLinks, Streams et AccessBindings) seront définitivement supprimées. https://support.google.com/analytics/answer/6154772

Renvoie une erreur si la cible n'est pas trouvée.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

rpc GetAccount(GetAccountRequest) returns (Account)

Recherchez un seul compte.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

rpc GetConversionEvent(GetConversionEventRequest) returns (ConversionEvent)

Obsolète: utilisez GetKeyEvent à la place. Récupérer un seul événement de conversion

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

rpc GetCustomDimension(GetCustomDimensionRequest) returns (CustomDimension)

Recherchez une seule CustomDimension.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

rpc GetCustomMetric(GetCustomMetricRequest) returns (CustomMetric)

Recherchez une seule CustomMetric.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

rpc GetDataRetentionSettings(GetDataRetentionSettingsRequest) returns (DataRetentionSettings)

Renvoie les paramètres de conservation des données singleton pour cette propriété.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

rpc GetDataSharingSettings(GetDataSharingSettingsRequest) returns (DataSharingSettings)

Obtenir les paramètres de partage des données d'un compte Les paramètres de partage des données sont des singleton.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

rpc GetDataStream(GetDataStreamRequest) returns (DataStream)

Recherchez un seul DataStream.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

rpc GetKeyEvent(GetKeyEventRequest) returns (KeyEvent)

Récupérer un seul événement clé

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

rpc GetMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest) returns (MeasurementProtocolSecret)

Recherchez un seul secret MeasurementProtocol.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

rpc GetProperty(GetPropertyRequest) returns (Property)

Recherchez une seule propriété GA.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

rpc ListAccountSummaries(ListAccountSummariesRequest) returns (ListAccountSummariesResponse)

Renvoie des récapitulatifs de tous les comptes accessibles par l'appelant.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

rpc ListAccounts(ListAccountsRequest) returns (ListAccountsResponse)

Renvoie tous les comptes accessibles par l'appelant.

Notez que ces comptes ne disposent peut-être pas actuellement de propriétés GA. Les comptes supprimés de façon réversible (c'est-à-dire "mis à la corbeille") sont exclus par défaut. Renvoie une liste vide si aucun compte pertinent n'est trouvé.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

rpc ListConversionEvents(ListConversionEventsRequest) returns (ListConversionEventsResponse)

Obsolète: utilisez ListKeyEvents à la place. Renvoie la liste des événements de conversion dans la propriété parente spécifiée.

Renvoie une liste vide si aucun événement de conversion n'est trouvé.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

rpc ListCustomDimensions(ListCustomDimensionsRequest) returns (ListCustomDimensionsResponse)

Répertorie les CustomDimensions d'une propriété.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

rpc ListCustomMetrics(ListCustomMetricsRequest) returns (ListCustomMetricsResponse)

Répertorie les métriques personnalisées d'une propriété.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

rpc ListDataStreams(ListDataStreamsRequest) returns (ListDataStreamsResponse)

Répertorie les DataStreams d'une propriété.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

rpc ListKeyEvents(ListKeyEventsRequest) returns (ListKeyEventsResponse)

Renvoie une liste d'événements de touche dans la propriété parente spécifiée. Renvoie une liste vide si aucun événement de touche n'est détecté.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

rpc ListMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest) returns (ListMeasurementProtocolSecretsResponse)

Renvoie les MeasurementProtocolSecrets enfants sous la propriété parente spécifiée.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

rpc ListProperties(ListPropertiesRequest) returns (ListPropertiesResponse)

Renvoie les propriétés enfants du compte parent spécifié.

Les propriétés sont exclues si l'appelant n'y a pas accès. Les propriétés supprimées de façon réversible (c'est-à-dire "mises à la corbeille") sont exclues par défaut. Renvoie une liste vide si aucune propriété pertinente n'est trouvée.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

rpc ProvisionAccountTicket(ProvisionAccountTicketRequest) returns (ProvisionAccountTicketResponse)

Demande un ticket pour créer un compte.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

rpc RunAccessReport(RunAccessReportRequest) returns (RunAccessReportResponse)

Renvoie un rapport personnalisé sur les enregistrements d'accès aux données. Le rapport enregistre chaque fois qu'un utilisateur lit des données de rapport Google Analytics. Les enregistrements d'accès sont conservés pendant deux ans maximum.

Vous pouvez demander des rapports sur l'accès aux données pour une propriété. Vous pouvez demander des rapports pour n'importe quelle propriété, mais les dimensions qui ne sont pas liées au quota ne peuvent être demandées que pour les propriétés Google Analytics 360. Cette méthode n'est disponible que pour les administrateurs.

Ces enregistrements d'accès aux données incluent les rapports de l'interface utilisateur GA, les explorations de l'interface utilisateur GA, l'API GA Data et d'autres produits tels que Firebase et AdMob, qui peuvent récupérer des données à partir de Google Analytics via une association. Ces enregistrements n'incluent pas les modifications de configuration de la propriété, comme l'ajout d'un flux ou la modification du fuseau horaire de la propriété. Pour consulter l'historique des modifications de configuration, consultez searchChangeHistoryEvents.

Pour nous envoyer vos commentaires sur cette API, remplissez le formulaire de commentaires sur les rapports sur l'accès Google Analytics.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

rpc SearchChangeHistoryEvents(SearchChangeHistoryEventsRequest) returns (SearchChangeHistoryEventsResponse)

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.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

rpc UpdateAccount(UpdateAccountRequest) returns (Account)

Met à jour un compte.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

rpc UpdateConversionEvent(UpdateConversionEventRequest) returns (ConversionEvent)

Obsolète: utilisez UpdateKeyEvent à la place. Met à jour un événement de conversion avec les attributs spécifiés.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

rpc UpdateCustomDimension(UpdateCustomDimensionRequest) returns (CustomDimension)

Met à jour une CustomDimension sur une propriété.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

rpc UpdateCustomMetric(UpdateCustomMetricRequest) returns (CustomMetric)

Met à jour une CustomMetric sur une propriété.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

rpc UpdateDataRetentionSettings(UpdateDataRetentionSettingsRequest) returns (DataRetentionSettings)

Met à jour les paramètres de conservation des données singleton pour cette propriété.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

rpc UpdateDataStream(UpdateDataStreamRequest) returns (DataStream)

Met à jour un DataStream sur une propriété.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

rpc UpdateKeyEvent(UpdateKeyEventRequest) returns (KeyEvent)

Met à jour un événement clé.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

rpc UpdateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest) returns (MeasurementProtocolSecret)

Met à jour un secret de protocole de mesure.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

rpc UpdateProperty(UpdatePropertyRequest) returns (Property)

Met à jour une propriété.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

AccessBetweenFilter

Pour indiquer que le résultat doit être compris entre deux nombres (inclus).

Champs
from_value

NumericValue

Commence par ce nombre.

to_value

NumericValue

se termine par ce numéro ;

AccessDateRange

Plage de jours contigus: startDate, startDate + 1, etc., endDate.

Champs
start_date

string

Date de début inclusive de la requête, au format YYYY-MM-DD. Ne doit pas être postérieure au endDate. Le format NdaysAgo, yesterday ou today est également accepté. Dans ce cas, la date est déduite en fonction de l'heure actuelle du fuseau horaire de la requête.

end_date

string

Date de fin inclusive de la requête au format YYYY-MM-DD. Ne peut pas être antérieure au startDate. Le format NdaysAgo, yesterday ou today est également accepté. Dans ce cas, la date est déduite en fonction de l'heure actuelle du fuseau horaire de la requête.

AccessDimension

Les dimensions correspondent aux attributs de vos données. Par exemple, la dimension userEmail indique l'adresse e-mail de l'utilisateur qui a accédé aux données de reporting. Les valeurs des dimensions dans les réponses des rapports sont des chaînes.

Champs
dimension_name

string

Nom de l'API de la dimension. Consultez le schéma d'accès aux données pour obtenir la liste des dimensions compatibles avec cette API.

Les dimensions sont référencées par nom dans dimensionFilter et orderBys.

AccessDimensionHeader

Décrit une colonne de dimension dans le rapport. Les dimensions demandées dans un rapport génèrent des entrées de colonnes dans les lignes et les en-têtes de dimension. Toutefois, les dimensions utilisées exclusivement dans des filtres ou des expressions ne génèrent pas de colonnes dans un rapport. Par conséquent, elles ne génèrent pas d'en-têtes.

Champs
dimension_name

string

Nom de la dimension (par exemple, "userEmail").

AccessDimensionValue

Valeur d'une dimension.

Champs
value

string

Valeur de la dimension. Par exemple, cette valeur peut être "France" pour la dimension "Pays".

AccessFilter

Expression permettant de filtrer les valeurs de dimension ou de métrique.

Champs
field_name

string

Nom de la dimension ou de la métrique.

Champ d'union one_filter. Spécifiez un type de filtre pour Filter. La one_filter ne peut être qu'un des éléments suivants :
string_filter

AccessStringFilter

Filtre lié aux chaînes.

in_list_filter

AccessInListFilter

Filtre pour les valeurs de la liste.

numeric_filter

AccessNumericFilter

Filtre pour les valeurs numériques ou de date.

between_filter

AccessBetweenFilter

Filtre pour deux valeurs.

AccessFilterExpression

Exprime les filtres de dimension ou de métrique. Les champs d'une même expression doivent correspondre à toutes les dimensions ou à toutes les métriques.

Champs
Champ d'union one_expression. Spécifiez un type d'expression de filtre pour FilterExpression. La one_expression ne peut être qu'un des éléments suivants :
and_group

AccessFilterExpressionList

Chacune des expressions de filtre du groupe and_group a une relation AND.

or_group

AccessFilterExpressionList

Chacune des expressions de filtre du groupe "or_group" a une relation OU.

not_expression

AccessFilterExpression

L'expression de filtre n'est PAS de type not_expression.

access_filter

AccessFilter

Filtre primitif. Dans la même expression de filtre, tous les noms de champ du filtre doivent correspondre à des dimensions ou à des métriques.

AccessFilterExpressionList

Liste des expressions de filtre.

Champs
expressions[]

AccessFilterExpression

Liste des expressions de filtre.

AccessInListFilter

Le résultat doit se trouver dans une liste de valeurs de chaîne.

Champs
values[]

string

Liste des valeurs de chaîne. Ne doit pas être vide.

case_sensitive

bool

Si la valeur est définie sur "true", la valeur de la chaîne est sensible à la casse.

AccessMetric

Mesures quantitatives d'un rapport. Par exemple, la métrique accessCount correspond au nombre total d'enregistrements d'accès aux données.

Champs
metric_name

string

Nom de l'API de la métrique. Pour obtenir la liste des métriques compatibles avec cette API, consultez le schéma d'accès aux données.

Les métriques sont référencées par nom dans metricFilter et orderBys.

AccessMetricHeader

Décrit une colonne de métriques dans le rapport. Les métriques visibles demandées dans un rapport génèrent des entrées de colonne dans les lignes et les en-têtes de métrique. Toutefois, les métriques utilisées exclusivement dans des filtres ou des expressions ne génèrent pas de colonnes dans un rapport. Par conséquent, elles ne génèrent pas d'en-têtes.

Champs
metric_name

string

Nom de la métrique (par exemple, "accessCount").

AccessMetricValue

Valeur d'une métrique.

Champs
value

string

Valeur de la mesure. Par exemple, cette valeur peut être "13".

AccessNumericFilter

Filtres pour les valeurs numériques ou les dates

Champs
operation

Operation

Type d'opération pour ce filtre.

value

NumericValue

Une valeur numérique ou une valeur de date.

Opération

Opération appliquée à un filtre numérique.

Enums
OPERATION_UNSPECIFIED Non spécifié.
EQUAL Égal
LESS_THAN Inférieur à
LESS_THAN_OR_EQUAL Inférieur(e) ou égal(e) à
GREATER_THAN Supérieur(e) à
GREATER_THAN_OR_EQUAL Supérieur(e) ou égal(e) à

AccessOrderBy

Les ordres de tri définissent le mode de tri des lignes dans la réponse. Par exemple, vous pouvez trier les lignes par nombre d'accès décroissant ou par chaîne de pays.

Champs
desc

bool

Si défini sur "true", trie par ordre décroissant. Si la valeur est "false" ou non spécifiée, le tri est effectué dans l'ordre croissant.

Champ d'union one_order_by. Spécifiez un type de tri pour OrderBy. La one_order_by ne peut être qu'un des éléments suivants :
metric

MetricOrderBy

Trie les résultats en fonction des valeurs d'une métrique.

dimension

DimensionOrderBy

Trie les résultats par valeurs d'une dimension.

DimensionOrderBy

Trie les données par valeurs de dimension.

Champs
dimension_name

string

Nom de la dimension à trier dans la requête.

order_type

OrderType

Contrôle la règle de tri des valeurs de dimension.

OrderType

Règle permettant d'organiser les valeurs de la dimension de chaîne.

Enums
ORDER_TYPE_UNSPECIFIED Non spécifié.
ALPHANUMERIC Tri alphanumérique par point de code Unicode. Par exemple, "2" < "A" < "X" < "b" < "z".
CASE_INSENSITIVE_ALPHANUMERIC Tri alphanumérique insensible à la casse par point de code Unicode minuscule. Par exemple, "2" < "A" < "b" < "X" < "z".
NUMERIC Les valeurs des dimensions sont converties en nombres avant le tri. Par exemple, dans le tri NUMERIC, "25" < "100", et dans le tri ALPHANUMERIC, "100" < "25". Les valeurs de dimension non numériques ont toutes une valeur d'ordre égale sous toutes les valeurs numériques.

MetricOrderBy

Trie les données en fonction des valeurs de métrique.

Champs
metric_name

string

Nom d'une métrique dans la requête à trier.

AccessQuota

État actuel de tous les quotas de cette propriété Analytics. Si un quota d'une propriété est épuisé, toutes les requêtes envoyées à cette propriété renvoient des erreurs "Ressource épuisée".

Champs
tokens_per_day

AccessQuotaStatus

Les établissements peuvent utiliser 250 000 jetons par jour. La plupart des requêtes consomment moins de 10 jetons.

tokens_per_hour

AccessQuotaStatus

Les propriétés peuvent utiliser 50 000 jetons par heure. Une requête API consomme un seul nombre de jetons, qui est déduit de tous les quotas horaires, quotidiens et par projet.

concurrent_requests

AccessQuotaStatus

Les propriétés peuvent utiliser jusqu'à 50 requêtes simultanées.

server_errors_per_project_per_hour

AccessQuotaStatus

Les paires de propriétés et de projets Cloud peuvent générer jusqu'à 50 erreurs de serveur par heure.

tokens_per_project_per_hour

AccessQuotaStatus

Les propriétés peuvent utiliser jusqu'à 25% de leurs jetons par projet et par heure. Cela signifie que les propriétés Analytics 360 peuvent utiliser 12 500 jetons par projet et par heure. Une requête API consomme un seul nombre de jetons, qui est déduit de tous les quotas horaires, quotidiens et par projet.

AccessQuotaStatus

État actuel d'un groupe de quotas particulier.

Champs
consumed

int32

Quota consommé par cette requête.

remaining

int32

Quota restant après cette requête.

AccessRow

Accéder aux données du rapport pour chaque ligne

Champs
dimension_values[]

AccessDimensionValue

Liste des valeurs de dimension. Ces valeurs sont dans le même ordre que celui spécifié dans la requête.

metric_values[]

AccessMetricValue

Liste des valeurs de métrique. Ces valeurs sont dans le même ordre que celui spécifié dans la requête.

AccessStringFilter

Filtre pour les chaînes.

Champs
match_type

MatchType

Type de correspondance de ce filtre.

value

string

Valeur de chaîne utilisée pour la mise en correspondance.

case_sensitive

bool

Si la valeur est définie sur "true", la valeur de la chaîne est sensible à la casse.

MatchType

Type de correspondance d'un filtre de chaîne.

Enums
MATCH_TYPE_UNSPECIFIED Non spécifié
EXACT Correspondance exacte de la valeur de la chaîne.
BEGINS_WITH Commence par la valeur de la chaîne.
ENDS_WITH Se termine par la valeur de la chaîne.
CONTAINS Contient la valeur de la chaîne.
FULL_REGEXP Correspondance exacte de l'expression régulière avec la valeur de chaîne.
PARTIAL_REGEXP Correspondance partielle de l'expression régulière avec la valeur de chaîne.

Compte

Message de ressource représentant un compte Google Analytics.

Champs
name

string

Uniquement en sortie. Nom de ressource de ce compte. Format: accounts/{compte} Exemple: "accounts/100"

create_time

Timestamp

Uniquement en sortie. Heure à laquelle ce compte a été créé à l'origine.

update_time

Timestamp

Uniquement en sortie. Heure à laquelle les champs de la charge utile du compte ont été mis à jour pour la dernière fois.

display_name

string

Obligatoire. Nom à afficher lisible par l'humain pour ce compte.

region_code

string

Pays de l'établissement. Doit correspondre à un code de région CLDR au format Unicode.

deleted

bool

Uniquement en sortie. Indique si ce compte est supprimé de manière temporaire ou non. Les comptes supprimés sont exclus des résultats de la liste, sauf si vous le demandez spécifiquement.

gmp_organization

string

Uniquement en sortie. URI d'une ressource d'organisation Google Marketing Platform. Ce paramètre n'est défini que lorsque ce compte est associé à une entreprise GMP. Format: marketingplatformadmin.googleapis.com/organizations/{org_id}

AccountSummary

Ressource virtuelle représentant une vue d'ensemble d'un compte et de toutes ses propriétés Google Analytics enfants.

Champs
name

string

Nom de la ressource pour ce récapitulatif de compte. Format: accountSummaries/{account_id} Exemple: "accountSummaries/1000"

account

string

Nom de la ressource du compte auquel fait référence ce récapitulatif de compte Format: accounts/{account_id} Exemple: "accounts/1000"

display_name

string

Nom à afficher du compte auquel fait référence ce récapitulatif.

property_summaries[]

PropertySummary

Liste des récapitulatifs des comptes enfants de ce compte.

AcknowledgeUserDataCollectionRequest

Message de requête pour l'appel RPC AcknowledgeUserDataCollection.

Champs
property

string

Obligatoire. Propriété pour laquelle confirmer la collecte des données utilisateur.

acknowledgement

string

Obligatoire. Confirmation que l'appelant de cette méthode comprend les conditions de collecte des données utilisateur.

Ce champ doit contenir la valeur exacte suivante: "Je confirme avoir informé mes utilisateurs finaux sur la confidentialité et obtenu leur autorisation pour collecter et traiter leurs données, y compris pour associer ces données aux informations sur les visites qui sont collectées par Google Analytics à partir de mon site et/ou application."

AcknowledgeUserDataCollectionResponse

Ce type ne comporte aucun champ.

Message de réponse pour l'appel RPC AcknowledgeUserDataCollection.

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 ce changement.

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 actor_email.
SYSTEM Modifications apportées par le système Google Analytics.
SUPPORT Modifications apportées par l'équipe d'assistance Google Analytics.

ArchiveCustomDimensionRequest

Message de requête pour l'appel RPC ArchiveCustomDimension.

Champs
name

string

Obligatoire. Nom de la CustomDimension à archiver. Exemple de format: properties/1234/customDimensions/5678

ArchiveCustomMetricRequest

Message de requête pour l'appel RPC ArchiveCustomMetric.

Champs
name

string

Obligatoire. Nom de la CustomMetric à archiver. Exemple de format: properties/1234/customMetrics/5678

ChangeHistoryChange

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

Champs
resource

string

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

action

ActionType

Type d'action ayant modifié cette ressource.

resource_before_change

ChangeHistoryResource

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

resource_after_change

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.

Champs

Champ d'union resource.

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

account

Account

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

property

Property

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

conversion_event

ConversionEvent

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

measurement_protocol_secret

MeasurementProtocolSecret

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

data_retention_settings

DataRetentionSettings

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

data_stream

DataStream

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

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.

Champs
id

string

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

change_time

Timestamp

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

actor_type

ActorType

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

user_actor_email

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.

changes_filtered

bool

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[]

ChangeHistoryChange

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

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 de propriété
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

ConversionEvent

Événement de conversion dans une propriété Google Analytics.

Champs
name

string

Uniquement en sortie. Nom de la ressource de cet événement de conversion. Format: properties/{property}/conversionEvents/{conversion_event}

event_name

string

Immuable. Nom de l'événement de conversion. Exemples: "clic", "achat"

create_time

Timestamp

Uniquement en sortie. Heure à laquelle cet événement de conversion a été créé dans la propriété.

deletable

bool

Uniquement en sortie. Si elle est définie, cet événement peut actuellement être supprimé avec DeleteConversionEvent.

custom

bool

Uniquement en sortie. Si elle est définie sur "True", cet événement de conversion fait référence à un événement personnalisé. Si la valeur est définie sur "false", cet événement de conversion fait référence à un événement par défaut dans GA. Les événements par défaut ont généralement une signification particulière dans GA. Ils sont généralement créés par le système GA, mais peuvent parfois être créés par les administrateurs de la propriété. Les événements personnalisés sont comptabilisés dans le nombre maximal d'événements de conversion personnalisés pouvant être créés par propriété.

counting_method

ConversionCountingMethod

Facultatif. Méthode de comptabilisation des conversions pour plusieurs événements au cours d'une session. Si cette valeur n'est pas fournie, elle est définie sur ONCE_PER_EVENT.

default_conversion_value

DefaultConversionValue

Facultatif. Définit une valeur/une devise par défaut pour un événement de conversion.

ConversionCountingMethod

Méthode de comptabilisation des conversions pour plusieurs événements au cours d'une session.

Enums
CONVERSION_COUNTING_METHOD_UNSPECIFIED La méthode de comptabilisation n'est pas spécifiée.
ONCE_PER_EVENT Chaque instance d'événement est considérée comme une conversion.
ONCE_PER_SESSION Une instance d'événement est considérée comme une conversion au maximum une fois par session et par utilisateur.

DefaultConversionValue

Définit une valeur/une devise par défaut pour un événement de conversion. Vous devez indiquer la valeur et la devise.

Champs
value

double

Cette valeur sera utilisée pour renseigner la valeur de toutes les conversions de l'événement "event_name" spécifié pour lequel le paramètre "value" de l'événement n'est pas défini.

currency_code

string

Lorsqu'aucun code de devise n'est défini pour un événement de conversion associé à ce nom d'événement, cette devise est appliquée par défaut. Doit être au format de code de devise ISO 4217. Pour en savoir plus, consultez https://en.wikipedia.org/wiki/ISO_4217.

CreateConversionEventRequest

Message de requête pour le RPC CreateConversionEvent

Champs
conversion_event

ConversionEvent

Obligatoire. Événement de conversion à créer.

parent

string

Obligatoire. Nom de la ressource de la propriété parente dans laquelle cet événement de conversion sera créé. Format: properties/123

CreateCustomDimensionRequest

Message de requête pour l'appel RPC CreateCustomDimension.

Champs
parent

string

Obligatoire. Exemple de format: properties/1234

custom_dimension

CustomDimension

Obligatoire. CustomDimension à créer.

CreateCustomMetricRequest

Message de requête pour l'appel RPC CreateCustomMetric.

Champs
parent

string

Obligatoire. Exemple de format: properties/1234

custom_metric

CustomMetric

Obligatoire. CustomMetric à créer.

CreateDataStreamRequest

Message de requête pour l'appel RPC CreateDataStream.

Champs
parent

string

Obligatoire. Exemple de format: properties/1234

data_stream

DataStream

Obligatoire. DataStream à créer.

CreateFirebaseLinkRequest

Message de requête pour le RPC CreateFirebaseLink

Champs
parent

string

Obligatoire. Format: properties/{property_id}

Exemple : properties/1234

CreateGoogleAdsLinkRequest

Message de requête pour l'appel RPC CreateGoogleAdsLink

Champs
parent

string

Obligatoire. Exemple de format: properties/1234

CreateKeyEventRequest

Message de requête pour l'appel RPC CreateKeyEvent

Champs
key_event

KeyEvent

Obligatoire. Événement clé à créer.

parent

string

Obligatoire. Nom de la ressource de la propriété parente dans laquelle cet événement clé sera créé. Format: properties/123

CreateMeasurementProtocolSecretRequest

Message de requête pour le RPC CreateMeasurementProtocolSecret

Champs
parent

string

Obligatoire. Ressource parente dans laquelle ce secret sera créé. Format: properties/{property}/dataStreams/{dataStream}

measurement_protocol_secret

MeasurementProtocolSecret

Obligatoire. Secret du protocole de mesure à créer.

CreatePropertyRequest

Message de requête pour l'appel RPC CreateProperty.

Champs
property

Property

Obligatoire. Propriété à créer. Remarque: La propriété fournie doit spécifier son parent.

CustomDimension

Définition d'une CustomDimension.

Champs
name

string

Uniquement en sortie. Nom de la ressource CustomDimension. Format: properties/{property}/customDimensions/{customDimension}

parameter_name

string

Obligatoire. Immuable. Nom du paramètre de taggage pour cette dimension personnalisée.

S'il s'agit d'une dimension de portée utilisateur, il s'agit du nom de la propriété utilisateur. S'il s'agit d'une dimension de portée événement, il s'agit du nom du paramètre d'événement.

S'il s'agit d'une dimension de portée article, il s'agit du nom du paramètre trouvé dans le tableau des articles d'e-commerce.

Ne peut contenir que des caractères alphanumériques et des traits de soulignement, et doit commencer par une lettre. Longueur maximale de 24 caractères pour les dimensions de portée utilisateur et de 40 caractères pour les dimensions de portée événement.

display_name

string

Obligatoire. Nom à afficher pour cette dimension personnalisée, tel qu'il apparaît dans l'interface utilisateur d'Analytics. 82 caractères maximum, caractères alphanumériques, espaces et traits de soulignement, commençant par une lettre. Les anciens noms à afficher générés par le système peuvent contenir des crochets, mais les mises à jour de ce champ n'en autoriseront jamais.

description

string

Facultatif. Description de cette dimension personnalisée. 150 caractères maximum.

scope

DimensionScope

Obligatoire. Immuable. Champ d'application de cette dimension.

disallow_ads_personalization

bool

Facultatif. Si cette valeur est définie sur "true", cette dimension est définie comme ANP et est exclue de la personnalisation des annonces.

Cette fonctionnalité n'est actuellement compatible qu'avec les dimensions personnalisées basées sur les utilisateurs.

DimensionScope

Valeurs valides pour le champ d'application de cette dimension.

Enums
DIMENSION_SCOPE_UNSPECIFIED Champ d'application inconnu ou non spécifié.
EVENT Dimension de portée événement
USER Dimension de portée utilisateur
ITEM Dimension de portée article

CustomMetric

Définition d'une métrique personnalisée.

Champs
name

string

Uniquement en sortie. Nom de ressource de cette ressource CustomMetric. Format: properties/{property}/customMetrics/{customMetric}

parameter_name

string

Obligatoire. Immuable. Nom du taggage pour cette métrique personnalisée.

S'il s'agit d'une métrique de portée événement, il s'agit du nom du paramètre d'événement.

Ne peut contenir que des caractères alphanumériques et des traits de soulignement, et doit commencer par une lettre. La longueur maximale des métriques de portée événement est de 40 caractères.

display_name

string

Obligatoire. Nom à afficher de cette métrique personnalisée, tel qu'il apparaît dans l'interface utilisateur d'Analytics. 82 caractères maximum, caractères alphanumériques, espaces et traits de soulignement, commençant par une lettre. Les anciens noms à afficher générés par le système peuvent contenir des crochets, mais les mises à jour de ce champ n'en autoriseront jamais.

description

string

Facultatif. Description de cette dimension personnalisée. 150 caractères maximum.

measurement_unit

MeasurementUnit

Obligatoire. Type de la valeur de la métrique personnalisée.

scope

MetricScope

Obligatoire. Immuable. Portée de cette métrique personnalisée.

restricted_metric_type[]

RestrictedMetricType

Facultatif. Types de données soumises à des restrictions que cette métrique peut contenir. Obligatoire pour les métriques avec l'unité de mesure "MONNAIE". Doit être vide pour les métriques dont l'unité de mesure n'est pas CURRENCY.

MeasurementUnit

Types de représentation possibles de la valeur de la métrique personnalisée.

La représentation des devises peut changer à l'avenir, ce qui nécessitera une modification destructive de l'API.

Enums
MEASUREMENT_UNIT_UNSPECIFIED MeasurementUnit non spécifié ou manquant.
STANDARD Cette métrique utilise les unités par défaut.
CURRENCY Cette métrique mesure une devise.
FEET Cette métrique mesure les pieds.
METERS Cette métrique mesure les mètres.
KILOMETERS Cette métrique mesure les kilomètres.
MILES Cette métrique mesure les kilomètres.
MILLISECONDS Cette métrique mesure les millisecondes.
SECONDS Cette métrique mesure les secondes.
MINUTES Cette métrique mesure les minutes.
HOURS Cette métrique mesure les heures.

MetricScope

Champ d'application de cette métrique.

Enums
METRIC_SCOPE_UNSPECIFIED Champ d'application inconnu ou non spécifié.
EVENT Métrique de portée événement.

RestrictedMetricType

Libellés qui indiquent que les données de cette métrique personnalisée doivent être limitées à des utilisateurs spécifiques.

Enums
RESTRICTED_METRIC_TYPE_UNSPECIFIED Type inconnu ou non spécifié.
COST_DATA Les métriques fournissent des données sur les coûts.
REVENUE_DATA La métrique enregistre les données sur les revenus.

DataRetentionSettings

Valeurs des paramètres de conservation des données. Il s'agit d'une ressource singleton.

Champs
name

string

Uniquement en sortie. Nom de la ressource DataRetentionSetting. Format: properties/{property}/dataRetentionSettings

event_data_retention

RetentionDuration

Obligatoire. Durée pendant laquelle les données au niveau des événements sont conservées.

user_data_retention

RetentionDuration

Obligatoire. Durée pendant laquelle les données au niveau de l'utilisateur sont conservées.

reset_user_data_on_new_activity

bool

Si cette valeur est définie sur "true", la durée de conservation de l'identifiant de l'utilisateur est réinitialisée à chaque événement de cet utilisateur.

RetentionDuration

Valeurs valides pour la durée de conservation des données.

Enums
RETENTION_DURATION_UNSPECIFIED La durée de conservation des données n'est pas spécifiée.
TWO_MONTHS La durée de conservation des données est de deux mois.
FOURTEEN_MONTHS La durée de conservation des données est de 14 mois.
TWENTY_SIX_MONTHS La durée de conservation des données est de 26 mois. Disponible uniquement pour les propriétés 360. Disponible uniquement pour les données d'événement.
THIRTY_EIGHT_MONTHS La durée de conservation des données est de 38 mois. Disponible uniquement pour les propriétés 360. Disponible uniquement pour les données d'événement.
FIFTY_MONTHS La durée de conservation des données est de 50 mois. Disponible uniquement pour les propriétés 360. Disponible uniquement pour les données d'événement.

DataSharingSettings

Message de ressource représentant les paramètres de partage des données d'un compte Google Analytics.

Champs
name

string

Uniquement en sortie. Nom de la ressource. Format: accounts/{account}/dataSharingSettings Exemple: "accounts/1000/dataSharingSettings"

sharing_with_google_support_enabled

bool

Autorisez les représentants de l'assistance technique Google à accéder à vos données et à votre compte Google Analytics si nécessaire afin de résoudre les problèmes techniques.

Ce champ correspond au champ "Assistance technique" dans l'interface utilisateur Google Analytics "Administration".

sharing_with_google_assigned_sales_enabled

bool

Autorisez Google à accéder aux données de votre compte Google Analytics, y compris aux données d'utilisation et de configuration du compte, aux dépenses liées aux produits et aux utilisateurs associés à votre compte Google Analytics. Google pourra ainsi vous aider à exploiter tout le potentiel de ses produits en vous fournissant des insights, des offres, des recommandations et des conseils d'optimisation dans Google Analytics et d'autres produits Google pour les entreprises.

Ce champ correspond au champ "Recommandations pour votre entreprise" dans l'interface utilisateur de l'administrateur Google Analytics.

sharing_with_google_any_sales_enabled
(deprecated)

bool

Obsolète. Ce champ n'est plus utilisé et renvoie toujours la valeur "false".

sharing_with_google_products_enabled

bool

Autorisez Google à utiliser les données pour améliorer d'autres produits ou services Google.

Ce champ correspond au champ "Produits et services Google" dans l'UI d'administration de Google Analytics.

sharing_with_others_enabled

bool

Activez des fonctionnalités telles que les prédictions, la modélisation et les analyses comparatives qui fournissent des insights métier plus détaillés lorsque vous partagez des données de mesure agrégées. Les données que vous partagez (y compris les informations sur la propriété à partir de laquelle elles sont partagées) sont agrégées et anonymisées avant d'être utilisées pour générer des insights métier.

Ce champ correspond au champ "Contributions à la modélisation et insights métier" dans l'interface utilisateur Google Analytics "Administration".

DataStream

Message de ressource représentant un flux de données.

Champs
name

string

Uniquement en sortie. Nom de ressource de ce flux de données. Format: properties/{property_id}/dataStreams/{stream_id} Exemple: "properties/1000/dataStreams/2000"

type

DataStreamType

Obligatoire. Immuable. Type de cette ressource DataStream.

display_name

string

Nom à afficher lisible pour le flux de données.

Obligatoire pour les flux de données Web.

La longueur maximale autorisée du nom à afficher est de 255 unités de code UTF-16.

create_time

Timestamp

Uniquement en sortie. Heure à laquelle ce flux a été créé à l'origine.

update_time

Timestamp

Uniquement en sortie. Heure de la dernière mise à jour des champs de la charge utile du flux.

Champ d'union stream_data. Données pour des types de flux de données spécifiques. Le message qui sera défini correspond au type de ce flux. stream_data ne peut être qu'un des éléments suivants :
web_stream_data

WebStreamData

Données spécifiques aux flux Web. Doit être renseigné si le type est WEB_DATA_STREAM.

android_app_stream_data

AndroidAppStreamData

Données spécifiques aux flux d'applications Android. Doit être renseigné si le type est ANDROID_APP_DATA_STREAM.

ios_app_stream_data

IosAppStreamData

Données spécifiques aux flux d'application iOS. Doit être renseigné si le type est IOS_APP_DATA_STREAM.

AndroidAppStreamData

Données spécifiques aux flux d'applications Android.

Champs
firebase_app_id

string

Uniquement en sortie. ID de l'application Android correspondante dans Firebase, le cas échéant. Cet ID peut changer si l'application Android est supprimée et recréée.

package_name

string

Immuable. Nom du package de l'application mesurée. Exemple: "com.example.myandroidapp"

DataStreamType

Type du flux de données.

Enums
DATA_STREAM_TYPE_UNSPECIFIED Type inconnu ou non spécifié.
WEB_DATA_STREAM Flux de données Web
ANDROID_APP_DATA_STREAM Flux de données d'application Android.
IOS_APP_DATA_STREAM Flux de données d'application iOS

IosAppStreamData

Données spécifiques aux flux d'application iOS.

Champs
firebase_app_id

string

Uniquement en sortie. ID de l'application iOS correspondante dans Firebase, le cas échéant. Cet ID peut changer si l'application iOS est supprimée et recréée.

bundle_id

string

Obligatoire. Immuable. ID de bundle de l'App Store d'Apple pour l'application (exemple: "com.example.myiosapp")

WebStreamData

Données spécifiques aux flux Web.

Champs
measurement_id

string

Uniquement en sortie. ID de mesure Analytics.

Exemple: "G-1A2BCD345E"

firebase_app_id

string

Uniquement en sortie. ID de l'application Web correspondante dans Firebase (le cas échéant). Cet ID peut changer si l'application Web est supprimée et recréée.

default_uri

string

Nom de domaine de l'application Web mesurée, ou vide. Exemple: "http://www.google.com", "https://www.google.com"

DeleteAccountRequest

Message de requête pour l'appel RPC DeleteAccount.

Champs
name

string

Obligatoire. Nom du compte à supprimer de manière temporaire. Format: accounts/{compte} Exemple: "accounts/100"

DeleteConversionEventRequest

Message de requête pour l'appel RPC DeleteConversionEvent

Champs
name

string

Obligatoire. Nom de ressource de l'événement de conversion à supprimer. Format: properties/{property}/conversionEvents/{conversion_event} Exemple: "properties/123/conversionEvents/456"

DeleteDataStreamRequest

Message de requête pour l'appel RPC DeleteDataStream.

Champs
name

string

Obligatoire. Nom du DataStream à supprimer. Exemple de format: properties/1234/dataStreams/5678

DeleteFirebaseLinkRequest

Message de requête pour l'appel RPC DeleteFirebaseLink

Champs
name

string

Obligatoire. Format: properties/{property_id}/firebaseLinks/{firebase_link_id}

Exemple : properties/1234/firebaseLinks/5678

DeleteGoogleAdsLinkRequest

Message de requête pour la requête RPC DeleteGoogleAdsLink.

Champs
name

string

Obligatoire. Exemple de format: properties/1234/googleAdsLinks/5678

DeleteKeyEventRequest

Message de requête pour l'appel RPC DeleteKeyEvent

Champs
name

string

Obligatoire. Nom de ressource de l'événement de touche à supprimer. Format: properties/{property}/keyEvents/{key_event} Exemple: "properties/123/keyEvents/456"

DeleteMeasurementProtocolSecretRequest

Message de requête pour l'appel RPC DeleteMeasurementProtocolSecret

Champs
name

string

Obligatoire. Nom du secret MeasurementProtocol à supprimer. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}

DeletePropertyRequest

Message de requête pour l'appel RPC DeleteProperty.

Champs
name

string

Obligatoire. Nom de l'établissement à supprimer de manière temporaire. Format: properties/{property_id} Exemple: "properties/1000"

GetAccountRequest

Message de requête pour l'appel RPC GetAccount.

Champs
name

string

Obligatoire. Nom du compte à rechercher. Format: accounts/{compte} Exemple: "accounts/100"

GetConversionEventRequest

Message de requête pour l'appel RPC GetConversionEvent

Champs
name

string

Obligatoire. Nom de la ressource de l'événement de conversion à récupérer. Format: properties/{property}/conversionEvents/{conversion_event} Exemple: "properties/123/conversionEvents/456"

GetCustomDimensionRequest

Message de requête pour l'appel RPC GetCustomDimension.

Champs
name

string

Obligatoire. Nom de la CustomDimension à obtenir. Exemple de format: properties/1234/customDimensions/5678

GetCustomMetricRequest

Message de requête pour l'appel RPC GetCustomMetric.

Champs
name

string

Obligatoire. Nom de la métrique personnalisée à obtenir. Exemple de format: properties/1234/customMetrics/5678

GetDataRetentionSettingsRequest

Message de requête pour l'appel RPC GetDataRetentionSettings.

Champs
name

string

Obligatoire. Nom des paramètres à rechercher. Format: properties/{property}/dataRetentionSettings Exemple: "properties/1000/dataRetentionSettings"

GetDataSharingSettingsRequest

Message de requête pour l'appel RPC GetDataSharingSettings.

Champs
name

string

Obligatoire. Nom des paramètres à rechercher. Format: accounts/{account}/dataSharingSettings

Exemple : accounts/1000/dataSharingSettings

GetDataStreamRequest

Message de requête pour l'appel RPC GetDataStream.

Champs
name

string

Obligatoire. Nom du DataStream à obtenir. Exemple de format: properties/1234/dataStreams/5678

GetKeyEventRequest

Message de requête pour l'appel RPC GetKeyEvent

Champs
name

string

Obligatoire. Nom de la ressource de l'événement clé à récupérer. Format: properties/{property}/keyEvents/{key_event} Exemple: "properties/123/keyEvents/456"

GetMeasurementProtocolSecretRequest

Message de requête pour l'appel RPC GetMeasurementProtocolSecret.

Champs
name

string

Obligatoire. Nom du secret du protocole de mesure à rechercher. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}

GetPropertyRequest

Message de requête pour l'appel RPC GetProperty.

Champs
name

string

Obligatoire. Nom de l'établissement à rechercher. Format: properties/{property_id} Exemple: "properties/1000"

IndustryCategory

Catégorie sélectionnée pour cette propriété, utilisée pour l'analyse comparative du secteur.

Enums
INDUSTRY_CATEGORY_UNSPECIFIED Catégorie sectorielle non spécifiée
AUTOMOTIVE Automobile
BUSINESS_AND_INDUSTRIAL_MARKETS Commerce et industrie
FINANCE Finance
HEALTHCARE Santé
TECHNOLOGY Technologie
TRAVEL Voyages
OTHER Autre
ARTS_AND_ENTERTAINMENT Arts et divertissements
BEAUTY_AND_FITNESS Soins du corps et remise en forme
BOOKS_AND_LITERATURE Livres et littérature
FOOD_AND_DRINK Alimentation et boissons
GAMES Jeux
HOBBIES_AND_LEISURE Hobbies et loisirs
HOME_AND_GARDEN Maison et jardinage
INTERNET_AND_TELECOM Internet et télécoms
LAW_AND_GOVERNMENT Justice et administrations
NEWS Actualités
ONLINE_COMMUNITIES Communautés en ligne
PEOPLE_AND_SOCIETY Individus et société
PETS_AND_ANIMALS Animaux
REAL_ESTATE Immobilier
REFERENCE Référence
SCIENCE Science
SPORTS Sport
JOBS_AND_EDUCATION Emploi et enseignement
SHOPPING Shopping

KeyEvent

Événement clé dans une propriété Google Analytics.

Champs
name

string

Uniquement en sortie. Nom de la ressource de cet événement clé. Format: properties/{property}/keyEvents/{key_event}

event_name

string

Immuable. Nom de l'événement pour cet événement clé. Exemples: "clic", "achat"

create_time

Timestamp

Uniquement en sortie. Heure à laquelle cet événement clé a été créé dans la propriété.

deletable

bool

Uniquement en sortie. Si cette valeur est définie sur "true", cet événement peut être supprimé.

custom

bool

Uniquement en sortie. Si elle est définie sur "True", cet événement clé fait référence à un événement personnalisé. Si la valeur est définie sur "false", cet événement clé fait référence à un événement par défaut dans GA. Les événements par défaut ont généralement une signification particulière dans GA. Ils sont généralement créés par le système GA, mais peuvent parfois être créés par les administrateurs de la propriété. Les événements personnalisés sont comptabilisés dans le nombre maximal d'événements clés personnalisés pouvant être créés par propriété.

counting_method

CountingMethod

Obligatoire. Méthode de comptabilisation des événements clés pour plusieurs événements au cours d'une session.

default_value

DefaultValue

Facultatif. Définit une valeur/une devise par défaut pour un événement clé.

CountingMethod

Méthode de comptabilisation des événements clés pour plusieurs événements au cours d'une session.

Enums
COUNTING_METHOD_UNSPECIFIED La méthode de comptabilisation n'est pas spécifiée.
ONCE_PER_EVENT Chaque instance d'événement est considérée comme un événement clé.
ONCE_PER_SESSION Une instance d'événement est considérée comme un événement clé au maximum une fois par session et par utilisateur.

DefaultValue

Définit une valeur/une devise par défaut pour un événement clé.

Champs
numeric_value

double

Obligatoire. Il sera utilisé pour renseigner le paramètre "value" pour toutes les occurrences de cet événement clé (spécifié par event_name) pour lequel ce paramètre n'est pas défini.

currency_code

string

Obligatoire. Lorsqu'une occurrence de cet événement clé (spécifié par event_name) n'a pas de devise définie, cette devise est appliquée par défaut. Doit être au format de code de devise ISO 4217.

Pour en savoir plus, consultez https://en.wikipedia.org/wiki/ISO_4217.

ListAccountSummariesRequest

Message de requête pour l'appel RPC ListAccountSummaries.

Champs
page_size

int32

Nombre maximal de ressources AccountSummary à renvoyer. Le service peut renvoyer un nombre inférieur à cette valeur, même si des pages supplémentaires sont disponibles. Si aucune valeur n'est spécifiée, 50 ressources au maximum sont renvoyées. La valeur maximale est 200 (les valeurs supérieures sont réduites à la valeur maximale).

page_token

string

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

ListAccountSummariesResponse

Message de réponse pour l'appel RPC ListAccountSummaries.

Champs
account_summaries[]

AccountSummary

Résumés des comptes pour lesquels l'appelant dispose d'un accès.

next_page_token

string

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

ListAccountsRequest

Message de requête pour l'appel RPC ListAccounts.

Champs
page_size

int32

Nombre maximal de ressources à renvoyer. Le service peut renvoyer un nombre inférieur à cette valeur, même si des pages supplémentaires sont disponibles. Si aucune valeur n'est spécifiée, 50 ressources au maximum sont renvoyées. La valeur maximale est 200 (les valeurs supérieures sont réduites à la valeur maximale).

page_token

string

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

show_deleted

bool

Indique si les comptes supprimés de façon réversible (c'est-à-dire "mis à la corbeille") doivent être inclus dans les résultats. Vous pouvez inspecter les comptes pour déterminer s'ils ont été supprimés ou non.

ListAccountsResponse

Message de requête pour l'appel RPC ListAccounts.

Champs
accounts[]

Account

Résultats accessibles à l'appelant.

next_page_token

string

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

ListConversionEventsRequest

Message de requête pour l'appel RPC ListConversionEvents

Champs
parent

string

Obligatoire. Nom de la ressource de la propriété parente. Exemple: "properties/123"

page_size

int32

Nombre maximal de ressources à renvoyer. Si aucune valeur n'est spécifiée, 50 ressources au maximum sont renvoyées. La valeur maximale est 200 (les valeurs supérieures sont réduites à la valeur maximale).

page_token

string

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

ListConversionEventsResponse

Message de réponse pour l'appel RPC ListConversionEvents.

Champs
conversion_events[]

ConversionEvent

Les événements de conversion demandés

next_page_token

string

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

ListCustomDimensionsRequest

Message de requête pour l'appel RPC ListCustomDimensions.

Champs
parent

string

Obligatoire. Exemple de format: properties/1234

page_size

int32

Nombre maximal de ressources à renvoyer. Si aucune valeur n'est spécifiée, 50 ressources au maximum sont renvoyées. La valeur maximale est 200 (les valeurs supérieures sont réduites à la valeur maximale).

page_token

string

Jeton de page reçu d'un appel ListCustomDimensions précédent. Fournissez-le pour récupérer la page suivante.

Lors de la pagination, tous les autres paramètres fournis à ListCustomDimensions doivent correspondre à l'appel ayant fourni le jeton de page.

ListCustomDimensionsResponse

Message de réponse pour l'appel RPC ListCustomDimensions.

Champs
custom_dimensions[]

CustomDimension

Liste des CustomDimensions.

next_page_token

string

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

ListCustomMetricsRequest

Message de requête pour l'appel RPC ListCustomMetrics.

Champs
parent

string

Obligatoire. Exemple de format: properties/1234

page_size

int32

Nombre maximal de ressources à renvoyer. Si aucune valeur n'est spécifiée, 50 ressources au maximum sont renvoyées. La valeur maximale est 200 (les valeurs supérieures sont réduites à la valeur maximale).

page_token

string

Jeton de page reçu d'un appel ListCustomMetrics précédent. Fournissez-le pour récupérer la page suivante.

Lors de la pagination, tous les autres paramètres fournis à ListCustomMetrics doivent correspondre à l'appel ayant fourni le jeton de page.

ListCustomMetricsResponse

Message de réponse pour l'appel RPC ListCustomMetrics.

Champs
custom_metrics[]

CustomMetric

Liste des CustomMetrics.

next_page_token

string

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

ListDataStreamsRequest

Message de requête pour l'appel RPC ListDataStreams.

Champs
parent

string

Obligatoire. Exemple de format: properties/1234

page_size

int32

Nombre maximal de ressources à renvoyer. Si aucune valeur n'est spécifiée, 50 ressources au maximum sont renvoyées. La valeur maximale est 200 (les valeurs supérieures sont réduites à la valeur maximale).

page_token

string

Jeton de page reçu d'un appel ListDataStreams précédent. Fournissez-le pour récupérer la page suivante.

Lors de la pagination, tous les autres paramètres fournis à ListDataStreams doivent correspondre à l'appel ayant fourni le jeton de page.

ListDataStreamsResponse

Message de réponse pour l'appel RPC ListDataStreams.

Champs
data_streams[]

DataStream

Liste des flux de données.

next_page_token

string

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

ListFirebaseLinksRequest

Message de requête pour l'appel RPC ListFirebaseLinks

Champs
parent

string

Obligatoire. Format: properties/{property_id}

Exemple : properties/1234

page_size

int32

Nombre maximal de ressources à renvoyer. Le service peut renvoyer un nombre inférieur à cette valeur, même si des pages supplémentaires sont disponibles. Si aucune valeur n'est spécifiée, 50 ressources au maximum sont renvoyées. La valeur maximale est 200 (les valeurs supérieures sont réduites à la valeur maximale).

page_token

string

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

ListFirebaseLinksResponse

Message de réponse pour l'appel RPC ListFirebaseLinks

Champs
next_page_token

string

Jeton pouvant être envoyé en tant que page_token pour récupérer la page suivante. Si ce champ est omis, il n'y a pas d'autres pages. Actuellement, Google Analytics n'accepte qu'un seul FirebaseLink par propriété. Ce champ ne sera donc jamais renseigné.

ListGoogleAdsLinksRequest

Message de requête pour l'appel RPC ListGoogleAdsLinks.

Champs
parent

string

Obligatoire. Exemple de format: properties/1234

page_size

int32

Nombre maximal de ressources à renvoyer. Si aucune valeur n'est spécifiée, 50 ressources au maximum sont renvoyées. La valeur maximale est 200 (les valeurs supérieures sont réduites à la valeur maximale).

page_token

string

Jeton de page reçu d'un appel ListGoogleAdsLinks précédent. Fournissez-le pour récupérer la page suivante.

Lors de la pagination, tous les autres paramètres fournis à ListGoogleAdsLinks doivent correspondre à l'appel ayant fourni le jeton de page.

ListGoogleAdsLinksResponse

Message de réponse pour l'appel RPC ListGoogleAdsLinks.

Champs
next_page_token

string

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

ListKeyEventsRequest

Message de requête pour l'appel RPC ListKeyEvents

Champs
parent

string

Obligatoire. Nom de la ressource de la propriété parente. Exemple: "properties/123"

page_size

int32

Nombre maximal de ressources à renvoyer. Si aucune valeur n'est spécifiée, 50 ressources au maximum sont renvoyées. La valeur maximale est 200 (les valeurs supérieures sont réduites à la valeur maximale).

page_token

string

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

ListKeyEventsResponse

Message de réponse pour l'appel RPC ListKeyEvents.

Champs
key_events[]

KeyEvent

Événements clés demandés

next_page_token

string

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

ListMeasurementProtocolSecretsRequest

Message de requête pour l'appel RPC ListMeasurementProtocolSecret

Champs
parent

string

Obligatoire. Nom de la ressource du flux parent. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets

page_size

int32

Nombre maximal de ressources à renvoyer. Si aucune valeur n'est spécifiée, 10 ressources au maximum sont renvoyées. La valeur maximale est 10. Les valeurs supérieures sont réduites à la valeur maximale.

page_token

string

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

ListMeasurementProtocolSecretsResponse

Message de réponse pour l'appel RPC ListMeasurementProtocolSecret

Champs
measurement_protocol_secrets[]

MeasurementProtocolSecret

Liste des secrets pour le flux parent spécifié dans la requête.

next_page_token

string

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

ListPropertiesRequest

Message de requête pour l'appel RPC ListProperties.

Champs
filter

string

Obligatoire. Expression pour filtrer les résultats de la requête. Les champs pouvant être filtrés sont les suivants: parent:(nom de la ressource du compte/propriété parent) ou ancestor:(nom de la ressource du compte parent) ou firebase_project:(ID ou numéro du projet Firebase associé). Voici quelques exemples de filtres:

| Filter                      | Description                               |
|-----------------------------|-------------------------------------------|
| parent:accounts/123         | The account with account id: 123.       |
| parent:properties/123       | The property with property id: 123.       |
| ancestor:accounts/123       | The account with account id: 123.         |
| firebase_project:project-id | The firebase project with id: project-id. |
| firebase_project:123        | The firebase project with number: 123.    |
page_size

int32

Nombre maximal de ressources à renvoyer. Le service peut renvoyer un nombre inférieur à cette valeur, même si des pages supplémentaires sont disponibles. Si aucune valeur n'est spécifiée, 50 ressources au maximum sont renvoyées. La valeur maximale est 200 (les valeurs supérieures sont réduites à la valeur maximale).

page_token

string

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

show_deleted

bool

Indique si les propriétés supprimées de façon réversible (c'est-à-dire "mises à la corbeille") doivent être incluses dans les résultats. Vous pouvez inspecter les propriétés pour déterminer si elles ont été supprimées ou non.

ListPropertiesResponse

Message de réponse pour l'appel RPC ListProperties.

Champs
properties[]

Property

Résultats correspondant aux critères de filtrage et accessibles à l'appelant.

next_page_token

string

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

MeasurementProtocolSecret

Valeur secrète utilisée pour envoyer des appels au protocole de mesure.

Champs
name

string

Uniquement en sortie. Nom de la ressource de ce secret. Ce secret peut être un enfant de n'importe quel type de flux. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}

display_name

string

Obligatoire. Nom à afficher lisible par l'humain pour ce secret.

secret_value

string

Uniquement en sortie. Valeur secrète du protocole de mesure. Transmettez cette valeur au champ "api_secret" de l'API Measurement Protocol lorsque vous envoyez des appels à la propriété parente de ce secret.

NumericValue

Représenter un nombre

Champs
Champ d'union one_value. Une valeur numérique one_value ne peut être qu'une des valeurs suivantes:
int64_value

int64

Valeur entière

double_value

double

Valeur double

Propriété

Message de ressource représentant une propriété Google Analytics.

Champs
name

string

Uniquement en sortie. Nom de la ressource de cette propriété. Format: properties/{property_id} Exemple: "properties/1000"

property_type

PropertyType

Immuable. Type de propriété de cette ressource Property. Lorsque vous créez un établissement, si le type est "PROPERTY_TYPE_UNSPECIFIED", "ORDINARY_PROPERTY" est implicite.

create_time

Timestamp

Uniquement en sortie. Heure à laquelle l'entité a été créée à l'origine.

update_time

Timestamp

Uniquement en sortie. Heure à laquelle les champs de la charge utile de l'entité ont été mis à jour pour la dernière fois.

parent

string

Immuable. Nom de la ressource du parent logique de cette propriété.

Remarque: Vous pouvez modifier le parent à l'aide de l'UI de déplacement de propriété. Format: accounts/{account}, properties/{property} Exemple: "accounts/100", "properties/101"

display_name

string

Obligatoire. Nom à afficher lisible par l'humain pour cet établissement.

La longueur maximale autorisée du nom à afficher est de 100 unités de code UTF-16.

industry_category

IndustryCategory

Secteur associé à cette propriété (exemple: AUTOMOTIVE, FOOD_AND_DRINK)

time_zone

string

Obligatoire. Fuseau horaire utilisé pour les rapports, qui sert de repère temporel pour les rapports, quelle que soit l'origine des données. Si le fuseau horaire respecte l'heure d'été, Analytics ajuste automatiquement l'heure en conséquence.

REMARQUE: Le changement de fuseau horaire n'affecte que les données à venir. Il n'est pas rétroactif.

Format: https://www.iana.org/time-zones Exemple: "America/Los_Angeles"

currency_code

string

Type de devise utilisé dans les rapports comportant des valeurs monétaires.

Format: https://en.wikipedia.org/wiki/ISO_4217 Exemples: "USD", "EUR", "JPY"

service_level

ServiceLevel

Uniquement en sortie. Niveau de service Google Analytics qui s'applique à cette propriété.

delete_time

Timestamp

Uniquement en sortie. Si défini, heure à laquelle cette propriété a été placée dans la corbeille. Si cette valeur n'est pas définie, cette propriété ne se trouve pas actuellement dans la corbeille.

expire_time

Timestamp

Uniquement en sortie. Si défini, heure à laquelle cette propriété supprimée sera définitivement supprimée. Si cet attribut n'est pas défini, cette propriété ne se trouve pas actuellement dans la corbeille et n'est pas prévue pour être supprimée.

account

string

Immuable. Nom de la ressource du compte parent. Format: accounts/{account_id}. Exemple: "accounts/123"

PropertySummary

Ressource virtuelle représentant les métadonnées d'une propriété Google Analytics.

Champs
property

string

Nom de la ressource de la propriété référencée par ce récapitulatif de propriété Format: properties/{property_id} Exemple: "properties/1000"

display_name

string

Nom à afficher de la propriété mentionnée dans ce récapitulatif.

property_type

PropertyType

Type de propriété

parent

string

Nom de la ressource du parent logique de cette propriété.

Remarque: Vous pouvez modifier le parent à l'aide de l'UI de déplacement de propriété. Format: accounts/{account}, properties/{property} Exemple: "accounts/100", "properties/200"

PropertyType

Types de ressources Property.

Enums
PROPERTY_TYPE_UNSPECIFIED Type de propriété inconnu ou non spécifié
PROPERTY_TYPE_ORDINARY Propriété Google Analytics standard
PROPERTY_TYPE_SUBPROPERTY Sous-propriété Google Analytics
PROPERTY_TYPE_ROLLUP Propriété de consolidation Google Analytics

ProvisionAccountTicketRequest

Message de requête pour l'appel RPC ProvisionAccountTicket.

Champs
account

Account

Compte à créer.

redirect_uri

string

URI de redirection vers lequel l'utilisateur sera redirigé après avoir accepté les conditions d'utilisation. Doit être configuré dans la console Cloud en tant qu'URI de redirection.

ProvisionAccountTicketResponse

Message de réponse pour l'appel RPC ProvisionAccountTicket.

Champs
account_ticket_id

string

Paramètre à transmettre dans le lien vers les conditions d'utilisation.

RunAccessReportRequest

Demande d'un rapport sur les enregistrements d'accès aux données.

Champs
entity

string

Le rapport sur l'accès aux données permet de demander l'accès au niveau de la propriété ou du compte. Si vous les demandez au niveau du compte, les rapports sur l'accès aux données incluent tous les accès pour toutes les propriétés de ce compte.

Pour effectuer une demande au niveau de la propriété, l'entité doit être, par exemple, "properties/123" si "123" est l'ID de votre propriété Google Analytics. Pour effectuer une demande au niveau du compte, l'entité doit être, par exemple, "accounts/1234" si "1234" est l'ID de votre compte Google Analytics.

dimensions[]

AccessDimension

Dimensions demandées et affichées dans la réponse. Les requêtes sont autorisées jusqu'à neuf dimensions.

metrics[]

AccessMetric

Métriques demandées et affichées dans la réponse. Les requêtes peuvent contenir jusqu'à 10 métriques.

date_ranges[]

AccessDateRange

Plage de dates des enregistrements d'accès à lire. Si plusieurs périodes sont demandées, chaque ligne de réponse contient un indice de période basé sur zéro. Si deux périodes se chevauchent, les enregistrements d'accès pour les jours qui se chevauchent sont inclus dans les lignes de réponse pour les deux périodes. Vous pouvez demander jusqu'à deux plages de dates.

dimension_filter

AccessFilterExpression

Les filtres de dimension vous permettent de limiter la réponse du rapport à des valeurs de dimension spécifiques qui correspondent au filtre. Par exemple, filtrer les enregistrements d'accès d'un seul utilisateur. Pour en savoir plus, consultez Principes de base des filtres de dimension pour obtenir des exemples. Vous ne pouvez pas utiliser de métriques dans ce filtre.

metric_filter

AccessFilterExpression

Les filtres de métriques vous permettent de limiter la réponse du rapport aux valeurs de métriques spécifiques qui correspondent au filtre. Les filtres de métriques sont appliqués après l'agrégation des lignes du rapport, comme la clause HAVING en SQL. Vous ne pouvez pas utiliser de dimensions dans ce filtre.

offset

int64

Nombre de lignes de la ligne de début. La première ligne est comptée comme la ligne 0. Si le décalage n'est pas spécifié, il est traité comme 0. Si le décalage est nul, cette méthode renvoie la première page de résultats avec des entrées limit.

Pour en savoir plus sur ce paramètre de pagination, consultez Pagination.

limit

int64

Nombre de lignes à renvoyer. Si ce paramètre n'est pas spécifié, 10 000 lignes sont renvoyées. L'API renvoie un maximum de 100 000 lignes par requête, quel que soit le nombre de lignes que vous demandez. limit doit être positif.

L'API peut renvoyer moins de lignes que l'limit demandée, si le nombre de lignes restantes est inférieur à celui de l'limit. Par exemple, il existe moins de 300 valeurs possibles pour la dimension country. Par conséquent, si vous n'utilisez que country dans vos rapports, vous ne pouvez pas obtenir plus de 300 lignes, même si vous définissez limit sur une valeur plus élevée.

Pour en savoir plus sur ce paramètre de pagination, consultez Pagination.

time_zone

string

Fuseau horaire de cette requête, le cas échéant. Si aucune valeur n'est spécifiée, le fuseau horaire de la propriété est utilisé. Le fuseau horaire de la requête est utilisé pour interpréter les dates de début et de fin du rapport.

Formaté sous forme de chaînes issues de la base de données des fuseaux horaires IANA (https://www.iana.org/time-zones), par exemple "Amérique/New_York" ou "Asie/Tokyo".

order_bys[]

AccessOrderBy

Spécifie l'ordre des lignes dans la réponse.

return_entity_quota

bool

Indique si l'état actuel du quota de cette propriété Analytics doit être renvoyé. Le quota est renvoyé dans AccessQuota. Pour les requêtes au niveau du compte, ce champ doit être défini sur "false".

include_all_users

bool

Facultatif. Indique si les utilisateurs qui n'ont jamais effectué d'appel d'API doivent être inclus dans la réponse. Si la valeur est "true", tous les utilisateurs ayant accès à la propriété ou au compte spécifiés sont inclus dans la réponse, qu'ils aient effectué un appel d'API ou non. Si la valeur est "false", seuls les utilisateurs ayant effectué un appel d'API seront inclus.

expand_groups

bool

Facultatif. Indique si les utilisateurs doivent être renvoyés dans des groupes d'utilisateurs. Ce champ ne fonctionne que lorsque "include_all_users" est défini sur "true". Si la valeur est "True", tous les utilisateurs ayant accès à la propriété ou au compte spécifiés sont renvoyés. Si la valeur est "false", seuls les utilisateurs disposant d'un accès direct sont renvoyés.

RunAccessReportResponse

Réponse personnalisée du rapport sur les enregistrements d'accès aux données.

Champs
dimension_headers[]

AccessDimensionHeader

En-tête d'une colonne du rapport qui correspond à une dimension spécifique. Le nombre et l'ordre des éléments DimensionHeaders correspondent aux dimensions présentes dans les lignes.

metric_headers[]

AccessMetricHeader

En-tête d'une colonne du rapport qui correspond à une métrique spécifique. Le nombre et l'ordre des MetricHeaders correspondent aux métriques présentes dans les lignes.

rows[]

AccessRow

Lignes de combinaisons de valeurs de dimension et de valeurs de métrique dans le rapport.

row_count

int32

Nombre total de lignes dans le résultat de la requête. rowCount est indépendant du nombre de lignes renvoyées dans la réponse, du paramètre de requête limit et du paramètre de requête offset. Par exemple, si une requête renvoie 175 lignes et inclut limit de 50 dans la requête API, la réponse contiendra rowCount de 175, mais seulement 50 lignes.

Pour en savoir plus sur ce paramètre de pagination, consultez Pagination.

quota

AccessQuota

État du quota pour cette propriété Analytics, y compris pour cette requête. Ce champ ne fonctionne pas avec les requêtes au niveau du compte.

SearchChangeHistoryEventsRequest

Message de requête pour le RPC SearchChangeHistoryEvents.

Champs
account

string

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

Exemple : accounts/100

property

string

Facultatif. Nom de la ressource d'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

resource_type[]

ChangeHistoryResourceType

Facultatif. Si cette valeur est définie, seules les modifications concernant une ressource correspondant à au moins l'un de ces types sont renvoyées.

action[]

ActionType

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

actor_email[]

string

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

earliest_change_time

Timestamp

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

latest_change_time

Timestamp

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

page_size

int32

Facultatif. Nombre maximal d'éléments ChangeHistoryEvent à renvoyer. Si aucune valeur n'est spécifiée, 50 articles au maximum sont renvoyés. La valeur maximale est 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 devez continuer à demander des pages supplémentaires à l'aide de page_token jusqu'à ce que vous obteniez le nombre souhaité.

page_token

string

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

SearchChangeHistoryEventsResponse

Message de réponse pour la requête RPC SearchAccounts.

Champs
change_history_events[]

ChangeHistoryEvent

Résultats accessibles à l'appelant.

next_page_token

string

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

ServiceLevel

Différents niveaux de service pour Google Analytics.

Enums
SERVICE_LEVEL_UNSPECIFIED Niveau de service non spécifié ou non valide.
GOOGLE_ANALYTICS_STANDARD Version standard de Google Analytics.
GOOGLE_ANALYTICS_360 Version payante de Google Analytics.

UpdateAccountRequest

Message de requête pour le RPC UpdateAccount.

Champs
account

Account

Obligatoire. Compte à mettre à jour. Le champ name du compte permet de l'identifier.

update_mask

FieldMask

Obligatoire. Liste des champs à mettre à jour. Les noms de champs doivent être au format snake case (par exemple, "field_to_update"). Les champs omis ne seront pas mis à jour. Pour remplacer l'entité entière, utilisez un chemin d'accès avec la chaîne "*" pour faire correspondre tous les champs.

UpdateConversionEventRequest

Message de requête pour le RPC UpdateConversionEvent

Champs
conversion_event

ConversionEvent

Obligatoire. Événement de conversion à mettre à jour. Le champ name permet d'identifier les paramètres à mettre à jour.

update_mask

FieldMask

Obligatoire. Liste des champs à mettre à jour. Les noms de champs doivent être en snake case (par exemple, "field_to_update"). Les champs omis ne seront pas mis à jour. Pour remplacer l'entité entière, utilisez un chemin d'accès avec la chaîne "*" pour faire correspondre tous les champs.

UpdateCustomDimensionRequest

Message de requête pour le RPC UpdateCustomDimension.

Champs
custom_dimension

CustomDimension

La CustomDimension à mettre à jour

update_mask

FieldMask

Obligatoire. Liste des champs à mettre à jour. Les champs omis ne seront pas mis à jour. Pour remplacer l'entité entière, utilisez un chemin d'accès avec la chaîne "*" pour faire correspondre tous les champs.

UpdateCustomMetricRequest

Message de requête pour le RPC UpdateCustomMetric.

Champs
custom_metric

CustomMetric

La métrique personnalisée à mettre à jour

update_mask

FieldMask

Obligatoire. Liste des champs à mettre à jour. Les champs omis ne seront pas mis à jour. Pour remplacer l'entité entière, utilisez un chemin d'accès avec la chaîne "*" pour faire correspondre tous les champs.

UpdateDataRetentionSettingsRequest

Message de requête pour l'appel RPC UpdateDataRetentionSettings.

Champs
data_retention_settings

DataRetentionSettings

Obligatoire. Paramètres à mettre à jour. Le champ name permet d'identifier les paramètres à mettre à jour.

update_mask

FieldMask

Obligatoire. Liste des champs à mettre à jour. Les noms de champs doivent être en snake case (par exemple, "field_to_update"). Les champs omis ne seront pas mis à jour. Pour remplacer l'entité entière, utilisez un chemin d'accès avec la chaîne "*" pour faire correspondre tous les champs.

UpdateDataStreamRequest

Message de requête pour l'appel RPC UpdateDataStream.

Champs
data_stream

DataStream

DataStream à mettre à jour

update_mask

FieldMask

Obligatoire. Liste des champs à mettre à jour. Les champs omis ne seront pas mis à jour. Pour remplacer l'entité entière, utilisez un chemin d'accès avec la chaîne "*" pour faire correspondre tous les champs.

UpdateGoogleAdsLinkRequest

Message de requête pour le RPC UpdateGoogleAdsLink

Champs
update_mask

FieldMask

Obligatoire. Liste des champs à mettre à jour. Les noms de champs doivent être en snake case (par exemple, "field_to_update"). Les champs omis ne seront pas mis à jour. Pour remplacer l'entité entière, utilisez un chemin d'accès avec la chaîne "*" pour faire correspondre tous les champs.

UpdateKeyEventRequest

Message de requête pour l'appel RPC UpdateKeyEvent

Champs
key_event

KeyEvent

Obligatoire. Événement clé à mettre à jour. Le champ name permet d'identifier les paramètres à mettre à jour.

update_mask

FieldMask

Obligatoire. Liste des champs à mettre à jour. Les noms de champs doivent être en snake case (par exemple, "field_to_update"). Les champs omis ne seront pas mis à jour. Pour remplacer l'entité entière, utilisez un chemin d'accès avec la chaîne "*" pour faire correspondre tous les champs.

UpdateMeasurementProtocolSecretRequest

Message de requête pour l'appel RPC UpdateMeasurementProtocolSecret

Champs
measurement_protocol_secret

MeasurementProtocolSecret

Obligatoire. Secret du protocole de mesure à mettre à jour.

update_mask

FieldMask

Obligatoire. Liste des champs à mettre à jour. Les champs omis ne seront pas mis à jour.

UpdatePropertyRequest

Message de requête pour l'appel RPC UpdateProperty.

Champs
property

Property

Obligatoire. Propriété à mettre à jour. Le champ name de la propriété permet d'identifier la propriété à mettre à jour.

update_mask

FieldMask

Obligatoire. Liste des champs à mettre à jour. Les noms de champs doivent être en snake case (par exemple, "field_to_update"). Les champs omis ne seront pas mis à jour. Pour remplacer l'entité entière, utilisez un chemin d'accès avec la chaîne "*" pour faire correspondre tous les champs.