Method: properties.getMetadata

Raporlama yöntemlerinde kullanılabilen boyutlar ve metriklere ilişkin meta verileri döndürür. Boyutları ve metrikleri keşfetmek için kullanılır. Bu yöntemde, istekte bir Google Analytics GA4 Mülk Tanımlayıcısı belirtilir ve meta veri yanıtı, özel boyutlar ve metriklerin yanı sıra Universal meta verilerini içerir.

Örneğin, parametre adı levels_unlocked olan bir özel metrik bir mülke kaydedilirse Meta veri yanıtı customEvent:levels_unlocked değerini içerir. Evrensel meta veriler, country ve totalUsers gibi mülkler için geçerli olan boyut ve metriklerdir.

HTTP isteği

GET https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/metadata}

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

Yol parametreleri

Parametreler
name

string

Zorunlu. Alınacak meta verilerin kaynak adı. Bu ad alanı, URL parametrelerinde değil URL yolunda belirtilir. Mülk, sayısal bir Google Analytics GA4 Mülkü tanımlayıcısıdır. Daha fazla bilgi için Mülk kimliğinizi nerede bulacağınızı öğrenin.

Örnek: özellikleri/1234/meta veri

Tüm mülklerde ortak olarak kullanılan boyutlar ve metrikler için Mülk Kimliği'ni 0 olarak ayarlayın. Bu özel modda, bu yöntem özel boyutları ve metrikleri döndürmez.

İstek içeriği

İstek metni boş olmalıdır.

Yanıt gövdesi

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

Raporlama yöntemlerinde şu anda kabul edilen boyut ve metriklerdir.

JSON gösterimi 
{
  "name": string,
  "dimensions": [
    {
      object (DimensionMetadata)
    }
  ],
  "metrics": [
    {
      object (MetricMetadata)
    }
  ]
}
Alanlar
name

string

Bu meta verilerin kaynak adı.
dimensions[]

object (DimensionMetadata)

Boyut açıklamaları.
metrics[]

object (MetricMetadata)

Metrik açıklamaları.

Yetkilendirme Kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

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

DimensionMetadata

Bir boyutu açıklar.

JSON gösterimi 
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "customDefinition": boolean
}
Alanlar
apiName

string

Bu boyutun adı. Boyut'un name öğesinde kullanılabilir. Örneğin, eventName.
uiName

string

Bu boyutun, Google Analytics kullanıcı arayüzündeki adı. Örneğin, Event name.
description

string

Bu boyutun nasıl kullanıldığı ve hesaplandığıyla ilgili açıklama.
deprecatedApiNames[]

string

Bu boyut için hâlâ kullanılabilir ancak kullanımdan kaldırılmış adlar. Doldurulduğunda bu boyut, belirli bir süre boyunca apiName veya deprecatedApiNames tarafından kullanılabilir. Kullanımdan kaldırma döneminden sonra bu boyut yalnızca apiName tarafından kullanılabilecektir.
customDefinition

boolean

Boyut bu mülk için özel bir boyutsa doğru değerini alır.

MetricMetadata

Bir metriği açıklar.

JSON gösterimi 
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "type": enum (MetricType),
  "expression": string,
  "customDefinition": boolean
}
Alanlar
apiName

string

Metrik adı. Metrik name öğesinde kullanılabilir. Örneğin, eventCount.
uiName

string

Bu metriğin Google Analytics kullanıcı arayüzündeki adı. Örneğin, Event count.
description

string

Bu metriğin nasıl kullanıldığı ve hesaplandığıyla ilgili açıklama.
deprecatedApiNames[]

string

Bu metrik için hâlâ kullanılabilir ancak kullanımdan kaldırılmış adlar. Doldurulduğunda bu metrik, belirli bir süre boyunca apiName veya deprecatedApiNames tarafından kullanılabilir. Kullanımdan kaldırma döneminden sonra, bu metrik yalnızca apiName itibarıyla kullanılabilecektir.
type

enum (MetricType)

Bu metriğin türü.
expression

string

Türetilen bu metriğin matematiksel ifadesi. Eşdeğer raporlar için Metrik'in expression alanında kullanılabilir. Çoğu metrik ifade değildir ve ifade olmayan öğeler için bu alan boştur.
customDefinition

boolean

Metrik bu mülk için özel bir metrikse doğru değerini döndürür.