Method: properties.getMetadata

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

Örneğin, levels_unlocked parametre adına sahip bir özel metrik bir mülke kaydedilirse Metadata yanıtı customEvent:levels_unlocked değerini içerir. Evrensel meta veriler, country ve totalUsers gibi herhangi bir mülk için geçerli olan boyutlar 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 mülk tanımlayıcısıdır. Daha fazla bilgi için Mülk kimliğinizi nerede bulabileceğinizi öğrenin.

Örnek: properties/1234/metadata

Tüm mülklerde ortak olan boyutlar ve metrikler için mülk kimliğini 0 olarak ayarlayın. Bu özel modda, bu yöntem özel boyutları ve metrikleri döndürmez.

İstek metni

İstek metni boş olmalıdır.

Yanıt metni

Raporlama yöntemlerinde şu anda kabul edilen boyutlar, metrikler ve karşılaştırmalar.

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

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

string

Bu meta verilerin kaynak adı.
dimensions[]

object (DimensionMetadata)

Boyut açıklamaları.
metrics[]

object (MetricMetadata)

Metrik açıklamaları.
comparisons[]

object (ComparisonMetadata)

Karşılaştırma açıklamaları.
conversions[]

object (ConversionMetadata)

Dönüşüm 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,
  "category": string,
  "sections": [
    enum (Section)
  ]
}
Alanlar
apiName

string

Bu boyutun adı. Boyut'un name bölümünde 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 desteği sonlandırılmış adlar. Doldurulursa bu boyut, bir süre boyunca apiName veya deprecatedApiNames'den biri tarafından kullanılabilir. Destek sonlandırma döneminden sonra boyut yalnızca apiName ile kullanılabilir.
customDefinition

boolean

Boyut bu mülke özelse doğru değerini döndürür. Buna kullanıcı, etkinlik ve öğe kapsamlı özel boyutlar dahildir. Özel boyutlar hakkında daha fazla bilgi edinmek için https://support.google.com/analytics/answer/14240153 adresini ziyaret edin. Özel kanal grupları da buna dahildir. Özel kanal grupları hakkında daha fazla bilgi edinmek için https://support.google.com/analytics/answer/13051316 adresini ziyaret edin.
category

string

Bu boyutun ait olduğu kategorinin görünen adı. Benzer boyutlar ve metrikler birlikte kategorize edilir.
sections[]

enum (Section)

Bu boyutun geçerli olduğu Google Analytics bölümlerini belirtir.

MetricMetadata

Bir metriği açıklar.

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

string

Metrik adı. Metrik'in name bölümünde 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ığına dair açıklama.
deprecatedApiNames[]

string

Bu metrik için hâlâ kullanılabilir ancak desteği sonlandırılmış adlar. Doldurulursa bu metrik, bir süre boyunca apiName veya deprecatedApiNames ile kullanılabilir. Kullanımdan kaldırma döneminden sonra metrik yalnızca apiName ile kullanılabilir.
type

enum (MetricType)

Bu metriğin türü.
expression

string

Bu türetilmiş metriğin matematiksel ifadesi. Eşdeğer raporlar için Metrik'in expression alanında kullanılabilir. Çoğu metrik ifade değildir ve ifadeler haricinde bu alan boştur.
customDefinition

boolean

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

enum (BlockedReason)

Nedenler belirtilmişse bu mülk için bu metriğe erişiminiz engellenir. Bu metrik için bu mülke yönelik API istekleriniz başarılı olur ancak raporda bu metrik için yalnızca sıfırlar yer alır. Engellenen metriklerde metrik filtreleri içeren API istekleri başarısız olur. Nedenler boşsa bu metriğe erişebilirsiniz.

Daha fazla bilgi edinmek için Erişim ve veri kısıtlama yönetimi başlıklı makaleyi inceleyin.
category

string

Bu metriğin ait olduğu kategorinin görünen adı. Benzer boyutlar ve metrikler birlikte kategorize edilir.
sections[]

enum (Section)

Bu metriğin geçerli olduğu Google Analytics bölümlerini belirtir.

BlockedReason

Bu metriğin neden engellendiğine dair gerekçeler.

Sıralamalar
BLOCKED_REASON_UNSPECIFIED API yanıtında hiçbir zaman belirtilmez.
NO_REVENUE_METRICS Bu mülk için gelirle ilgili metriklere erişiminiz engellenir ve bu metrik gelirle ilgilidir.
NO_COST_METRICS Bu mülk için maliyetle ilgili metriklere erişiminiz engellenmişse ve bu metrik maliyetle ilgiliyse.

ComparisonMetadata

Tek bir karşılaştırmanın meta verileri.

JSON gösterimi 
{
  "apiName": string,
  "uiName": string,
  "description": string
}
Alanlar
apiName

string

Bu karşılaştırmanın kaynak adı. Karşılaştırma'nın comparison alanında kullanılabilir. Örneğin, "comparisons/1234".
uiName

string

Bu karşılaştırmanın Google Analytics kullanıcı arayüzündeki adı.
description

string

Bu karşılaştırmanın açıklaması.

ConversionMetadata

Tek bir dönüşümün meta verileri.

JSON gösterimi 
{
  "conversionAction": string,
  "displayName": string
}
Alanlar
conversionAction

string

Dönüşüm işleminin benzersiz tanımlayıcısı. Bu kimlik, bir rapor isteğinin ConversionsSpec bölümündeki conversionActions alanı doldurularak bir rapora hangi dönüşümlerin dahil edileceğini belirtmek için kullanılır. Örneğin, "conversionActions/1234".
displayName

string

Bu dönüşümün Google Analytics kullanıcı arayüzündeki adı.