MetricMetadata

Explique une métrique.

Représentation JSON
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "type": enum (MetricType),
  "expression": string,
  "customDefinition": boolean,
  "blockedReasons": [
    enum (BlockedReason)
  ],
  "category": string
}
Champs
apiName

string

Nom d'une métrique. Utilisable dans name de Metric. Par exemple, eventCount.

uiName

string

Nom de cette métrique dans l'interface utilisateur de Google Analytics. Par exemple, Event count.

description

string

Description de l'utilisation et du calcul de cette métrique.

deprecatedApiNames[]

string

Noms toujours utilisables, mais obsolètes, de cette métrique. Si elle est renseignée, cette métrique est disponible par apiName ou l'un des deprecatedApiNames pendant une période donnée. Passé ce délai, la métrique ne sera disponible que par apiName.

type

enum (MetricType)

Type de cette métrique.

expression

string

Expression mathématique de cette métrique dérivée. Peut être utilisé dans le champ expression de la métrique pour les rapports équivalents. La plupart des métriques ne sont pas des expressions. Pour les métriques qui ne sont pas des expressions, ce champ est vide.

customDefinition

boolean

"True" si la métrique est une métrique personnalisée pour cette propriété.

blockedReasons[]

enum (BlockedReason)

Si des raisons sont spécifiées, votre accès à cette métrique pour cette propriété est bloqué. Les requêtes API que vous envoyez à cette propriété pour cette métrique aboutiront, mais le rapport ne contiendra que des zéros pour cette métrique. Les requêtes API avec des filtres de métrique sur des métriques bloquées échoueront. Si ce champ est vide, vous avez accès à cette métrique.

Pour en savoir plus, consultez Gestion des accès et des restrictions de données.

category

string

Nom à afficher de la catégorie à laquelle cette métrique appartient. Les dimensions et les métriques similaires sont regroupées.

BlockedReason

Justifications du blocage de cette métrique.

Enums
BLOCKED_REASON_UNSPECIFIED Ne sera jamais spécifié dans la réponse de l'API.
NO_REVENUE_METRICS Si cette métrique est présente, votre accès aux métriques liées aux revenus de cette propriété est bloqué.
NO_COST_METRICS Si cette valeur est présente, votre accès aux métriques liées aux coûts de cette propriété est bloqué, et cette métrique est liée aux coûts.