Raporları yönetin

Apigee Edge belgelerini görüntülüyorsunuz.
. Git: Apigee X belgeleri.
bilgi

Giriş

Para kazanma raporları, odaklanmış kullanım bilgilerine ve işlem etkinliğine erişmenizi sağlar. Örneğin, hangi uygulamaların, geliştiricilerin, API ürün paketlerinin veya API ürünlerinin, belirli bir tarih aralığındaki işlem etkinliğidir. Para kazanma özelliğiyle, API kullanımını izleyen özet veya ayrıntılı raporlar oluşturabilirsiniz.

Para kazanma raporu türleri

Aşağıdaki türde para kazanma raporları oluşturabilirsiniz.

Bildir Açıklama
Faturalandırma Geliştiricilerin tek bir faturalandırma ayındaki etkinliğini görüntüleme ve ücreti doğrulama doğru şekilde uygulandığından emin olun.
Ön Ödeme Bakiyesi Ön ödemeli geliştiricinin bir fatura ayında veya belirli bir dönemde yaptığı bakiye yenilemelerini görüntüleyin bu ay açık olduğundan emin olun. Böylece, bu aracı kullanarak ödeme işleyici.
Gelir Geliştiricilerin belirli bir tarih aralığında oluşturduğu etkinliği ve geliri görüntüleyerek şunları yapabilirsiniz: API ürün paketlerinizin ve ürünlerinizin geliştiricileriniz (ve onların uygulamalar).
Varyans

İki tarih aralığında geliştiricilerin oluşturduğu etkinliği ve geliri karşılaştırın. Böylece, API paketlerinizin ve ürünlerinizin performansındaki yukarı veya aşağı eğilimleri analiz edebilir (ve uygulamalarını) kapsar.

Veri saklama hakkında

Apigee Edge herkese açık bulutunda, para kazanma verilerinin saklanabilmesi plan kapsamındaki bir özelliktir. Bkz. https://cloud.google.com/apigee/specsheets adresine giderek para kazanma haklarından yararlanabilirsiniz. Para kazanma verilerinizin geçerlidir. Genişletilmiş veri saklama, istek sırasında etkinleştirilir ve orijinal veri saklama aralığından önceki verileri içerecek şekilde geriye dönük olarak etkinleştirilemez.

Yinelenen işlemler hakkında

Para kazanma işlemi raporlarını Analytics verileriyle karşılaştırırsanız az sayıda yinelenen işlem olduğunu fark edebilirsiniz. Para kazanma sistemi, herhangi bir zamanda paralel olarak işlenen birçok işlemle birlikte günde birkaç milyon işlem işleyebildiğinden bu beklenen bir davranıştır. Ortalama olarak, işlemlerin yaklaşık% 0,1'i kopya olabilir.

Para Kazanma Raporları sayfasını keşfetme

Aşağıda açıklanan şekilde Para Kazanma Raporları sayfasına erişin.

Edge

Edge kullanıcı arayüzünü kullanarak Raporlar sayfasına erişmek için:

  1. apigee.com/edge adresinde oturum açın.
  2. Sol gezinme çubuğunda Yayınlama > Para kazanma > Raporlar'ı seçin.

Raporlar sayfası görüntülenir.

Şekilde de belirtildiği gibi, Raporlar sayfası sayesinde:

Klasik Edge (Private Cloud)

Klasik Edge kullanıcı arayüzünü kullanarak Raporlar sayfasına erişmek için:

  1. http://ms-ip:9000 adresinde oturum açın. ms-ip, Yönetim Sunucusu düğümünün IP adresi veya DNS adıdır.
  2. Üst gezinme çubuğunda Para kazanma > Para kazanma raporları'nı seçin.

Raporlar sayfası görüntülenir.

Raporu yapılandırma

Aşağıdaki bölümlerde açıklandığı gibi, kullanıcı arayüzünü kullanarak bir raporu yapılandırın.

Rapor yapılandırma adımları

Edge kullanıcı arayüzü veya Classice Edge kullanıcı arayüzünü kullanarak bir raporu yapılandırın.

Edge

Edge kullanıcı arayüzünü kullanarak bir raporu yapılandırmak için:

  1. Sol gezinme çubuğunda Yayınlama > Para kazanma > Raporlar'ı seçin.
  2. + Bildir'i tıklayın.
  3. Aşağıdaki tabloda tanımlanan rapor ayrıntılarını yapılandırın.
    Alan Açıklama
    Ad Raporun benzersiz adı.
    Açıklama Raporun açıklaması.
    Rapor türü Para kazanma raporu türleri başlıklı makaleyi inceleyin.
  4. Kalan rapor ayrıntılarını, seçilen rapor türüne göre aşağıdaki bölümlerde açıklandığı şekilde yapılandırın:
  5. Rapor penceresine bilgileri girdikten sonra şunları yapabilirsiniz:
    • Rapor yapılandırmasını kaydetmek için Raporu kaydet'i tıklayın.
    • Yalnızca ayrıntılı rapor için İşi gönder'i tıklayarak raporu eşzamansız olarak çalıştırın ve sonuçları daha sonra alın. Daha fazla bilgi için Rapor oluşturma ve indirme bölümünü inceleyin.

    • Oluşturulan raporu yerel makinenize virgülle ayrılmış değerler (CSV) veya CSV'yi içeren sıkıştırılmış bir zip dosyası olarak indirmek için CSV olarak kaydet ya da Zip olarak kaydet'i tıklayın. Büyük raporlar için zip indirmeleri önerilir ve bu indirme yöntemi daha etkilidir.

Klasik Edge (Private Cloud)

Klasik Edge kullanıcı arayüzünü kullanarak rapor oluşturmak için:

  1. Üst gezinme çubuğunda Para kazanma > Para kazanma raporları'nı seçin.
  2. Açılır menüden, oluşturmak istediğiniz rapor türünü seçin. Para kazanma raporlarının türleri bölümünü inceleyin.
  3. + Bildir'i tıklayın.
  4. Rapor ayrıntılarını, aşağıdaki bölümlerde açıklandığı gibi, seçilen faturalandırma türüne göre yapılandırın:
  5. Rapor penceresine bilgileri girdikten sonra şunları yapabilirsiniz:
    • Rapor yapılandırmasını kaydetmek ve raporu daha sonra indirmek için Farklı kaydet...'i tıklayın.
    • Yalnızca ayrıntılı rapor için İşi gönder'i tıklayarak raporu eşzamansız olarak çalıştırın ve sonuçları daha sonra alın. Daha fazla bilgi için Rapor oluşturma ve indirme bölümünü inceleyin.

    • Raporu oluşturmak ve görüntülemek için virgülle ayrılmış değerler (CSV) dosyası olarak yerel makinenize indirmek üzere CSV'yi indir'i tıklayın.

Faturalandırma raporunu yapılandırma

Rapor yapılandırmaya yönelik adımları uygulayın ve rapor sayfasına aşağıdaki bilgileri girin:

Alan Açıklama
Faturalandırma ayı

Raporun faturalandırıldığı ay.

Raporlama Düzeyi

Raporlama düzeyi. Geçerli değerler şunlardır:

  • Ayrıntılı: Her işlemi ayrı bir satırda gösterir ve Ücret planlarının doğru şekilde uygulanıp uygulanmadığını kontrol etmenizi sağlar. Hayır, özet.
  • Özet: Her API ürününün toplam gelirini özetler ve geliştiriciyim.
Ürün Paketleri

Not: Klasik Edge kullanıcı arayüzünde API ürün paketleri API paketleri olarak adlandırılır.

Rapora dahil edilecek API ürün paketlerini seçin. Hiçbiri seçilmezse tüm API ürün paketleri rapora dahil edilir.

Rapor, seçilen her API ürün paketi için ayrı bir satır içerir.

Özet raporu için isteğe bağlı olarak Özet görüntüleme seçeneklerinde Gösterme'yi işaretleyebilirsiniz. Bu durumda rapor, tüm (veya seçili) API ürün paketlerindeki bilgileri toplar (ve bunları listelemez ürün paketleri için ayrı ayrı görüntüleyebilirsiniz).

Ürünler

Rapora dahil edilecek API ürünlerini seçin. Hiçbiri seçilmezse tüm API ürünleri rapora dahil edilir.

Rapor, seçilen her API ürünü için ayrı bir satır içerir.

Özet raporu için isteğe bağlı olarak Özet görüntüleme seçeneklerinde Gösterme'yi işaretleyebilirsiniz. Bu durumda rapor, tüm (veya seçili) geliştiricilerin bilgilerini toplar (ve seçilen her geliştiricinin bilgilerini ayrı ayrı listelemez).

Şirketler

Rapora dahil edilecek şirketleri seçin. Hiçbir şirket seçilmezse tüm şirketler rapordur.

Ücret Planı

Rapora dahil edilecek planları ücretlendirin. Aşağıdakilerden birini seçin:

  • Tüm ücret planları: Tüm ücret planlarını rapora dahil edin.
  • Standart ücret planları: Rapora yalnızca standart ücret planlarını dahil edin.
  • Geliştiriciye özel ücret planları: Rapora yalnızca geliştirici planlarını dahil edin.

Ön ödeme bakiyesi raporunu yapılandırma

Rapor yapılandırma adımlarını uygulayın ve rapor sayfasına aşağıdaki bilgileri girin:

Alan Açıklama
Faturalandırma ayı

Raporun faturalandırıldığı ay.

Raporlama Düzeyi

Raporlama düzeyi. Geçerli değerler şunlardır:

  • Ayrıntılı: Her bakiye doldurmayı ayrı olarak gösterir ve şunları yapmanıza olanak tanır: ödeme işleyicinizden alınan ödemelerle mutabakat sağlamanız gerekir.
  • Özet: Her geliştiricinin toplam bakiye ekleme işlemlerini özetler.
Şirketler

Rapora dahil edilecek şirketleri seçin. Hiçbir şirket seçilmezse tüm şirketler rapordur.

Gelir raporunu yapılandırma

Rapor yapılandırma adımlarını uygulayın ve rapor sayfasına aşağıdaki bilgileri girin:

Alan Açıklama
Tarih Aralığı

Raporun tarih aralığı. Aşağıdakilerden birini seçin:

  • Önceden ayarlanmış: Açılır menüden standart tarih aralıklarından birini (ör. son takvim ayı) seçin.
  • Özel: Takvim pop-up'ından aralık için bir başlangıç tarihi ve bitiş tarihi seçin.
Para birimi seç

Raporun para birimi. Geçerli değerler şunlardır:

  • Yerel para birimi: Raporun her satırı, geçerli ücret planı kullanılarak gösterilir. Bu, geliştiricilerin farklı para birimleri kullanan planları varsa tek bir raporda birden fazla para birimi olabileceği anlamına gelir.
  • Avrupa para birimi: Rapordaki yerel para birimi işlemleri dönüştürülüp avro cinsinden gösterilir.
  • Birleşik Krallık sterlini: Rapordaki yerel para birimi işlemleri dolar cinsinden dönüştürülür ve görüntülenir.
  • ABD doları: Rapordaki yerel para birimi işlemleri dönüştürülür ve dolar cinsinden gösterilir.
Raporlama düzeyi

Raporlama düzeyi. Geçerli değerler şunlardır:

  • Ayrıntılı: Her işlemi ayrı bir satırda gösterir. Özet yoktur.
  • Özet: Her API ürününün toplam gelirini özetler ve geliştirici olarak ayarlarsınız.
Ürün Paketleri

Not: Klasik Edge kullanıcı arayüzünde API ürün paketleri API paketleri olarak adlandırılır.

Rapora dahil edilecek API ürün paketlerini seçin. Hiçbiri seçilmezse tüm API ürün paketleri rapora dahil edilir.

Rapor, seçilen her API ürün paketi için ayrı bir satır içerir.

Özet raporu için isteğe bağlı olarak Özet görüntüleme seçeneklerinde Gösterme'yi işaretleyebilirsiniz. Bu durumda rapor, tüm (veya seçili) API ürün paketlerindeki bilgileri toplar (ve bunları listelemez ürün paketleri için ayrı ayrı görüntüleyebilirsiniz).

Ürünler

Rapora dahil edilecek API ürünlerini seçin. Hiçbiri seçilmezse tüm API ürünleri rapora dahil edilir.

Rapor, seçilen her API ürünü için ayrı bir satır içerir.

Özet raporu için isteğe bağlı olarak Özet görüntüleme seçeneklerinde Gösterme'yi işaretleyebilirsiniz. Bu durumda rapor, tüm (veya seçili) geliştiricilerin bilgilerini toplar (ve seçilen her geliştiricinin bilgilerini ayrı ayrı listelemez).

Şirketler

Rapora dahil edilecek şirketleri seçin. Hiçbiri seçilmezse tüm şirketler rapora dahil edilir.

Özet rapor için isterseniz, Özet Görüntüleme Seçenekleri bölümüne gidin. Bu durumda, rapor tüm (veya seçilen) şirketler genelindeki bilgileri toplar. (ve seçilen her şirket için bilgileri ayrı ayrı listelemez).

Uygulamalar

Yapılacak uygulamaları seçin dahil etmektir. Hiçbir uygulama seçilmezse tüm uygulamalar dikkat edin.

Raporda, seçilen her uygulama için ayrı bir satır bulunur.

Özet rapor için isteğe bağlı olarak Özet Görüntüleme Seçenekleri bölümünde Gösterme'yi işaretleyebilirsiniz. Bu durumda, rapor tüm (veya seçilen) uygulamalar (ve seçilen her uygulamaya ilişkin bilgileri listelemez) bakın).

Özet görüntüleme seçenekleri

Sütunların gruplandırıldığı ve raporda görüntülendiği sıra. Bir numara seçin gruplandırmadaki bölümün göreceli sırasını gösterir (1 ilk gruplandırma). Örneğin, aşağıdaki gruplandırmada rapor önce paketlere, ardından ürünlere, geliştiricilere ve uygulamalara göre gruplandırılır.

Bir bölümü göstermek istemiyorsanız Gösterme'yi, ardından kalan alanları sırayla seçin. Sırayı değiştirdiğinizde otomatik olarak göreceli sıralamayı kullanabilir veya raporda bölümleri görüntülememeyi seçebilirsiniz.

Gelir özeti raporlarına özel işlem özelliklerini ekleme

İşlem kaydı politikaları, işlemlerden özel özellik verilerini yakalamanıza olanak tanır. Bu özel özellikleri özet gelir raporlarına ekleyebilirsiniz. Kuruluşunuzun MINT.SUMMARY_CUSTOM_ATTRIBUTES mülkünü ayarlayarak para kazanma veritabanı tablolarına dahil edilecek varsayılan özel özellik grubunu tanımlayın.

Bu özelliği kullanırken üzerinde biraz düşünüp planlama yapmanızı gerektirir. Bu nedenle, aşağıdaki hususları gözden geçirin.

Cloud müşterisiyseniz mülkü ayarlamak için Apigee Edge Destek Ekibi ile iletişime geçin. Private Cloud için Apigee Edge müşterisiyseniz aşağıdaki API'ye Sistem Yöneticisi kimlik bilgileriyle bir PUT isteği göndererek işareti ayarlayın.

curl -u email:password -X PUT -H "Content-type:application/xml" http://host:port/v1/o/{myorg} -d \
"<Organization type="trial" name="MyOrganization">
    <Properties>
        <Property name="features.isMonetizationEnabled">true</Property>
        <Property name="MINT.SUMMARY_CUSTOM_ATTRIBUTES">[&quot;partner_id&quot;,&quot;tax_source&quot;]</Property>
        <Property name="features.topLevelDevelopersAreCompanies">false</Property>
    </Properties>
</Organization>"

Bu örnekte API çağrısı, Şuna partner_id ve tax_source sütunları ekler: veritabanını kullanarak kontrol edebilirsiniz. API çağrısındaki özel özellik dizisinin URL olarak kodlandığını unutmayın.

Raporlara özel işlem özellikleri eklerken dikkate alınması gereken noktalar

  • API ile oluşturmadan önce kullanmak istediğiniz özellik adları konusunda emin olun. Bunlar veritabanındaki sütun adlarıdır ve özel özellik verileri her zaman burada depolanır.
  • Her işlem kaydetme politikasında 10 özel özellik yuvası bulunur. aşağıdaki resimde gösteriliyor. Raporlara dahil edilecek ürünlerde aynı özellikler için bire bir aynı özellik adlarını ve konumlarını kullanın. Örneğin, aşağıdaki işlem kaydetme politikası, partner_id ve tax_source özel özellikleri sırasıyla 4 ve 5 numaralı kutuları doldurur. Bu kişinin ismi ve raporlamaya dahil edilecek ürünlerle ilgili işlem kaydetme politikaları.

Özelliği etkinleştirdikten sonra özet gelir raporuna özel özellikler eklemek için MintCriteria alanına transactionCustomAttributes ekleyerek rapor API'sini kullanın. Ölçüt yapılandırma seçeneklerine bakın.

Varyans raporunu yapılandırma (Desteği sonlandırıldı)

Rapor yapılandırmaya yönelik adımları uygulayın ve rapor sayfasına aşağıdaki bilgileri girin:

Alan Açıklama
Tarih Aralığı

Raporun tarih aralığı. Aşağıdakilerden birini seçin:

  • Önceden ayarlanmış: Açılır menüden standart tarih aralıklarından birini (ör. son takvim ayı) seçin.
  • Özel: Takvim pop-up'ından aralık için bir başlangıç tarihi ve bitiş tarihi seçin.
Paketler

Rapora dahil edilecek API paketleri. Aşağıdakilerden birini seçin:

  • Tümü: Rapordaki tüm API paketlerini içerir.
  • Seçili: API paketlerini seçebileceğiniz bir liste görüntüler dahil etmektir. Hiçbir paketi seçmezseniz tüm paketler rapora dahil edilir.

Raporda, seçilen her API paketi için ayrı bir satır bulunur.

Özet raporu için isterseniz Özet bölümünde Gösterme (Paketler) seçeneğini işaretleyebilirsiniz. Görüntüleme Seçenekleri bölümüne gidin. Bu durumda, rapor tüm (veya seçili) API paketleri (ve her API paketi için bilgi listelemez) ayrı olarak) gönderebilirsiniz.

Ürünler

Rapora dahil edilecek API ürünleri. Aşağıdakilerden birini seçin:

  • Tümü: Rapordaki tüm API ürünlerini içerir.
  • Seçili: Listeye dahil edilecek ürünleri seçebileceğiniz bir liste görüntüler dikkat edin. Hiçbir ürün seçmezseniz tüm ürünler rapora dahil edilir.

Rapor, seçilen her API ürünü için ayrı bir satır içerir.

Özet rapor için isterseniz Özet bölümünde Gösterme (Ürünler) seçeneğini işaretleyebilirsiniz. Görüntüleme Seçenekleri bölümüne gidin. Bu durumda, rapor tüm (veya seçili) API ürünleri (ve her API ürünü için bilgi listelemez) ayrı olarak) gönderebilirsiniz.

Şirketler

Rapora dahil edilecek şirketler. Aşağıdakilerden birini seçin:

  • Tümü: Rapordaki tüm şirketleri içerir.
  • Seçili: Dahil edilecek şirketleri seçebileceğiniz bir liste görüntüler seçilebilir. Hiçbir şirket seçmezseniz tüm şirketler rapora dahil edilir.

Rapor, seçilen her şirket için ayrı bir satır içerir.

Özet rapor için isterseniz Özet Görüntüleme Seçenekleri bölümüne gidin. Bu durumda, rapor tüm (veya seçilen) şirketler (ve seçilen her şirkete ait bilgileri listelemez) ayrı olarak) gönderebilirsiniz.

Uygulamalar

Rapora dahil edilecek uygulamalar. Aşağıdakilerden birini seçin:

  • Tümü: Rapordaki tüm uygulamaları içerir.
  • Seçilenler: Rapora dahil edilecek uygulamaları seçebileceğiniz bir liste görüntülenir. Hiçbir uygulama seçmezseniz tüm uygulamalar dikkat edin.

Raporda, seçilen her uygulama için ayrı bir satır bulunur.

Bir özet rapor için isterseniz Özet Görüntüleme Seçenekleri bölümüne gidin. Bu durumda, rapor tüm (veya seçilen) uygulamalar (ve seçilen her uygulamaya ilişkin bilgileri listelemez) bakın).

Para Birimi

Raporun para birimi. Geçerli değerler şunlardır:

  • Yerel para birimi: Raporun her satırı, geçerli ücret planı kullanılarak gösterilir. Bu, geliştiricilerin farklı para birimleri kullanan planları varsa tek bir raporda birden fazla para birimi olabileceği anlamına gelir.
  • EUR: Rapordaki yerel para birimi işlemleri avroya dönüştürülür ve bu para birimiyle gösterilir.
  • GBP: Rapordaki yerel para birimi işlemleri dönüştürülür ve pound cinsinden gösterilir.
  • ABD doları: Rapordaki yerel para birimi işlemleri dolar cinsinden dönüştürülür ve görüntülenir.
Özet görüntüleme seçenekleri

Sütunların gruplandırıldığı ve raporda görüntülendiği sıra. Bir numara seçin gruplandırmadaki bölümün göreceli sırasını gösterir (1 ilk gruplandırma). Örneğin, aşağıdaki gruplandırmada rapor önce paketlere, ardından ürünlere, geliştiricilere ve uygulamalara göre gruplandırılır.

Bir bölümü göstermek istemiyorsanız Gösterme'yi, ardından kalan alanları sırayla seçin. Sırayı değiştirdiğinizde otomatik olarak göreceli sıralamayı kullanabilir veya raporda bölümleri görüntülememeyi seçebilirsiniz.

Rapor oluşturma ve indirme

Bir rapor oluşturduktan sonra, raporun sonuçlarını CSV veya zip dosyası biçiminde indirebilirsiniz. CSV veya ZIP dosyasını eşzamanlı ya da eşzamansız olarak oluşturabilirsiniz.

  • Eşzamanlı rapor için rapor isteğini çalıştırırsınız ve istek engellenir yanıt verene kadar bekleyin. Ancak bir raporun hazırlanması ve büyük miktarda veri içeriyorsa (örneğin, 100 GB'lık) bir eşzamanlı rapor, zaman aşımı nedeniyle başarısız olabilir.

    Özet rapor düzeyi yalnızca eşzamanlı oluşturmayı destekler.

  • Asenkron rapor için rapor isteğini çalıştırır ve sonuçları daha sonra alırsınız. Eşzamansız sorgu işlemenin iyi sonuç verebileceği bazı durumlar alternatifi şunlardır:

    • Uzun zaman aralıkları kapsayan raporları analiz etme ve oluşturma
    • Sorguya karmaşıklık katan çeşitli gruplandırma boyutları ve diğer kısıtlamalarla verileri analiz etme.
    • Bazı kullanıcılar veya kuruluşlar için veri hacimlerinin önemli ölçüde arttığını tespit ettiğinizde sorguları yönetme

    Ayrıntılı rapor düzeyi, eşzamansız oluşturmayı destekler.

CSV veya zip dosyası biçiminde bir rapor oluşturmak ve indirmek için aşağıdaki görevlerden birini gerçekleştirin:

  1. Raporlar sayfasına gidin.
  2. İmleci, indirmek istediğiniz raporun üzerine getirin.
  3. Değiştirildi sütununda aşağıdakilerden birini tıklayın:

    1. CSV dosyası simgesi simgesi veya zip dosyası simgesi simgesi (Özet raporu için). Rapor, senkronize olarak bir CSV veya zip dosyasına kaydedilir.
    2. İşi gönder (ayrıntılı rapor için). Eşzamansız iş başlar.
      1. Değiştirilme tarihi sütununda işin durumunu izleyin.

        Rapor indirilmeye hazır olduğunda disk simgesi gösterilir:

        Rapor indirilmeye hazır olduğunda disk görüntüsü gösterilir.
      2. İş tamamlandıktan sonra, raporu indirmek için disk simgesini tıklayın.

Aşağıda, özet faturalandırma raporu için bir CSV dosyası örneği verilmiştir.

Raporları düzenleme

Bir raporu düzenlemek için:

  1. Raporlar sayfasına erişin.
  2. İmleci düzenlemek istediğiniz raporun üzerine getirin ve işlemler menüsünde simgesini tıklayın.
  3. Gerekirse rapor yapılandırmasını güncelleyin.
  4. Güncellenen rapor yapılandırmasını kaydetmek için Raporu güncelle'yi tıklayın.

Rapor silme

Bir raporu silmek için:

  1. Raporlar sayfasına gidin.
  2. İmleci, silmek istediğiniz raporun üzerine getirin.
  3. İşlemler menüsünde simgesini tıklayın.

API kullanarak para kazanma raporlarını yönetme

Aşağıdaki bölümlerde, API'yi kullanarak para kazanma raporlarının nasıl yönetileceği açıklanmaktadır.

API'yi kullanarak rapor yapılandırma

Bir kuruluşun tamamı için rapor yapılandırmak üzere şu adrese bir POST isteği gönderin: /organizations/{org_name}/report-definitions

Belirli bir geliştirici için rapor yapılandırmak üzere /organizations/{org_name}/developers/{dev_id}/report-definitions, burada: {dev_id}, geliştiricinin kimliğidir.

İsteği gönderirken raporun adını ve türünü belirtmeniz gerekir. Tür şulardan biri olmalıdır: BILLING, REVENUE, VARIANCE (desteği sonlandırıldı) veya PREPAID_BALANCE. Ayrıca, mintCriteria mülkünde raporu daha da yapılandıran ölçütler belirtebilirsiniz. Belirleyebileceğiniz çok çeşitli ölçütler vardır. Bu, raporu yapılandırma konusunda size büyük ölçüde esneklik sağlar. Ölçüt olarak belirtebileceğiniz şeylerden bazıları şunlardır:

  • Faturalandırma veya ön ödemeli bakiye raporu için raporun faturalandırma ayı
  • Bir gelir raporu için raporda yer alan işlemlerin türü (ör. satın alma) işlemler, ödeme alma işlemleri ve geri ödemeler
  • Ön ödemeli bakiye raporu için raporun geçerli olduğu geliştirici
  • Bir gelir raporu için, rapor geçerlidir
  • Gelir veya varyans raporu için raporun geçerli para birimi
  • Faturalandırma, ön ödemeli bakiye veya gelir raporları için raporun özet rapor mu yoksa ayrıntılı rapor mu olduğu
  • Gelir özeti raporu için rapora özel işlem özellikleri ekleyin

Rapor ölçütlerinin tam listesi için Rapor yapılandırma seçenekleri başlıklı makaleyi inceleyin.

Örneğin, aşağıdaki ifade Temmuz 2015 ayına ait işlem etkinliğini özetleyen bir gelir raporu oluşturur. Bu rapor, transactionTypes mülküdür ve özellikle Payment API ürün paketi ve Ödeme API'si ürünü. Raporda belirli bir geliştirici veya uygulama belirtilmediği için bu rapor tüm geliştiriciler ve uygulamalar için geçerlidir. Ayrıca currencyOption özelliği LOCAL olarak ayarlanırsa raporun her satırında Geçerli ücret planının para birimi kullanılarak görüntülenmelidir. Ayrıca, groupBy mülkü, rapordaki sütunların aşağıdaki sırayla gruplandırılacağını belirtir: PACKAGE, PRODUCT, DEVELOPER, APPLICATION ve RATEPLAN (raporda ücret planı adını ve kimliğini içerir).

$ curl -H "Content-Type: application/json" -X POST -d \
'{
      "name": "July 2015 revenue report",
      "description": " July 2015 revenue report for Payment product",
      "type": "REVENUE",     
      "mintCriteria":{
         "fromDate":"2015-07-01 00:00:00",
         "toDate":"2015-08-01 13:35:00",
         "showTxDetail":true,
         "showSummary":true,
         "transactionTypes":[
            "PURCHASE",
            "CHARGE",
            "REFUND",
            "CREDIT",
            "SETUPFEES",
            "TERMINATIONFEES",
            "RECURRINGFEES"
         ],
         "monetizationPackageIds":[
            "payment"
         ],
         "productIds":[
            "payment"
         ],
         "currencyOption":"LOCAL",
         "groupBy":[
            "PACKAGE",
            "PRODUCT",
            "DEVELOPER",
            "APPLICATION",
            "RATEPLAN"
         ]
      }
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions" \
-u email:password

Aşağıdaki komut, DEV FIVE adlı geliştiricinin Haziran 2015'teki etkinliğini gösteren ayrıntılı bir faturalandırma raporu oluşturur.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
      "name": "June billing report, DEV FIVE",
      "description": "June billing report, DEV FIVE",
      "type": "BILLING",      
      "mintCriteria":{
         "billingMonth": "JUNE",
         "billingYear": 2015,
         "showTxDetail":true,
         "showSummary":false,         
         "currencyOption":"LOCAL"         
      },
      "devCriteria":[{
         "id":"RtHAeZ6LtkSbEH56",
         "orgId":"myorg"}]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/5cTWgdUvdr6JW3xU/report-definitions" \
-u email:password

API'yi kullanarak rapor yapılandırmalarını görüntüleme

Bir kuruluşa ait belirli bir rapor yapılandırmasını veya tüm rapor yapılandırmalarını görüntüleyebilirsiniz. Ayrıca, tek bir geliştiricinin rapor yapılandırmalarını da görüntüleyebilirsiniz.

Bir kuruluşa yönelik belirli bir rapor yapılandırmasını görüntülemek için şuna bir GET isteği gönderin: /organizations/{org_name}/report-definitions/{report_definition_id}, burada: {report_definition_id}, özel rapor yapılandırmasının ( Rapor yapılandırmasını oluşturduğunuzda yanıtta kimlik döndürülür). Örneğin:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions/1f7fa53b-de5a-431d-9438-62131e1396c5" \
-u email:password

Kuruluşun tüm rapor yapılandırmalarını görüntülemek için /organizations/{org_name}/report-definitions adresine bir GET isteği gönderin.

Sonuçları filtrelemek ve sıralamak için aşağıdaki sorgu parametrelerini iletebilirsiniz:

Sorgu Parametresi Açıklama
all Tüm API ürün paketlerinin döndürülüp döndürülmeyeceğini belirten işaret. false olarak ayarlanırsa sayfa başına döndürülen API ürün paketi sayısı size sorgu parametresiyle tanımlanır. Varsayılan olarak false (yanlış) değerine ayarlanır.
size Sayfa başına döndürülen API ürün paketi sayısı. Varsayılan değer 20'dir. all sorgusu parametresi true olarak ayarlanırsa bu parametre yoksayılır.
page Döndürmek istediğiniz sayfanın numarası (içerik sayfalara ayrılmışsa). all sorgu parametresi true olarak ayarlanırsa bu parametre yoksayılır.
sort Bilgilerin sıralanacağı alan. all sorgu parametresi true değerine ayarlanmışsa bu parametre yoksayılır. Varsayılan değer: UPDATED:DESC

Örneğin, aşağıdaki ifade kuruluşun rapor yapılandırmalarını döndürür ve getirme işlemini en fazla beş rapor yapılandırmasıyla sınırlandırır:

$ curl -H "Accept:application/json" -X GET \ 
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions?size=5" \ 
-u email:password

Yanıtın görünümü aşağıdaki gibi olacaktır (yanıtın yalnızca bir kısmı gösterilmiştir):

{
  "reportDefinition" : [ {
    "description" : "Test revenue report",
    "developer" : null,
    "id" : "1f7fa53b-de5a-431d-9438-62131e1396c5",
    "lastModified" : "2015-08-27 15:44:03",
    "mintCriteria" : {
      "asXorg" : false,
      "currencyOption" : "LOCAL",
      "fromDate" : "2015-07-01 00:00:00",
      "groupBy" : [ "PACKAGE", "PRODUCT", "DEVELOPER", "APPLICATION", "RATEPLAN" ],
      "monetizationPackageIds" : [ "payment" ],
      "productIds" : [ "payment" ],
      "showRevSharePct" : false,
      "showSummary" : true,
      "showTxDetail" : true,
      "showTxType" : false,
      "toDate" : "2015-08-01 00:05:00",
      "transactionTypes" : [ "PURCHASE", "CHARGE", "REFUND", "CREDIT", "SETUPFEES", "TERMINATIONFEES", "RECURRINGFEES" ]
    },
    "name" : "Test revenue report",
    "organization" : {
      ...
    },
    "type" : "REVENUE"
  }, {
    "description" : "June billing report, DEV FIVE",
    "developer" : null,
    "id" : "fedac696-ce57-469b-b62c-a77b535fd0eb",
    "lastModified" : "2015-08-27 17:13:20",
    "mintCriteria" : {
      "asXorg" : false,
      "billingMonth" : "JUNE",
      "billingYear" : 2015,
      "currencyOption" : "LOCAL",
      "showRevSharePct" : false,
      "showSummary" : false,
      "showTxDetail" : true,
      "showTxType" : false
    },
    "name" : "June billing report, DEV FIVE",
    "organization" : {
      ...
    },
    "type" : "BILLING"
  } ],
  "totalRecords" : 2
}

Belirli bir geliştiricinin rapor yapılandırmalarını görüntülemek için /organizations/{org_name}/developers/{dev_id}/report-definitions adresine bir GET isteği gönderin. Burada {dev_id}, geliştiricinin kimliğidir. Bu isteği gönderirken verileri filtrelemek ve sıralamak için yukarıda açıklanan sorgu parametrelerini belirtin.

Örneğin, aşağıdaki örnek, belirli bir geliştiriciye ait rapor yapılandırmalarını döndürür ve rapor adına göre yanıt:

$ curl -H "Accept:application/json" -X GET \ 
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/5cTWgdUvdr6JW3xUreport-definitions?sort=name" \ 
-u email:password

API'yi kullanarak rapor yapılandırmasını güncelleme

Rapor yapılandırmasını güncellemek için bir PUT isteği gönderin: /organizations/{org_name}/report-definitions/{report_definition_id}, burada: {report_definition_id}, özel rapor yapılandırmasının tanımıdır. Güncellemeyi yaparken istek gövdesinde güncellenmiş yapılandırma değerlerini ve rapor yapılandırmasının kimliğini belirtmeniz gerekir. Örneğin, aşağıdaki istek, raporu özet rapor olarak günceller (güncellenen özellikler vurgulanmıştır):

$ curl -H "Content-Type: application/json" -X PUT -d \
 '{
       "id": "fedac696-ce57-469b-b62c-a77b535fd0eb",
       "name": "June billing report, DEV FIVE",
       "description": "June billing report, DEV FIVE",
       "type": "BILLING",      
       "mintCriteria":{      
         "billingMonth": "JUNE",
         "billingYear": 2015,
         "showTxDetail":false,
         "showSummary":true    
        }     
 }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions/fedac696-ce57-469b-b62c-a77b535fd0eb" \
-u email:password

Yanıtın görünümü aşağıdaki gibi olacaktır (yanıtın yalnızca bir kısmı gösterilmiştir):

{
 "description" : "June billing report, DEV FIVE",
  "developer" : null,
  "id" : "fedac696-ce57-469b-b62c-a77b535fd0eb",
  "lastModified" : "2015-08-27 17:47:29",
  "mintCriteria" : {
    "asXorg" : false,
    "billingMonth" : "JUNE",
    "billingYear" : 2015,
    "showRevSharePct" : false,
    "showSummary" : true,
    "showTxDetail" : false,
    "showTxType" : false
  },
  "name" : "June billing report, DEV FIVE",
  "organization" : {
    ... 
  },
  "type" : "BILLING"
}

API'yi kullanarak rapor yapılandırmasını silme

Bir rapor yapılandırmasını silmek için /organizations/{org_namer}/report-definitions/{report_definition_id} adresine DELETE isteği gönderin. Bu adreste {report_definition_id}, silinecek rapor yapılandırmasının kimliğidir. Örneğin:

$ curl -H "Accept:application/json" -X DELETE \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions/fedac696-ce57-469b-b62c-a77b535fd0eb" \
-u email:password

API kullanarak rapor oluşturma

Yapılandırdığınız raporları görüntülemek için virgülle ayrılmış değerler (CSV) dosya biçiminde oluşturabilirsiniz.

Rapor oluşturmak için bir POST isteği gönderin organizations/{org_id}/{report_type}; burada {report_type}, türünü seçin. Türler şunlardır:

  • billing-reports
  • revenue-reports
  • prepaid-balance-reports
  • variance-reports
Ayrıca, aşağıda açıklandığı gibi belirli bir geliştirici için bir gelir raporu oluşturabilirsiniz: Geliştiriciler için gelir raporu oluşturun.

Örneğin, faturalandırma raporu oluşturmak için organizations/{org_name}/billing-reports adresine POST isteği gönderin.

İstek gövdesinde (tüm rapor türleri için) rapora ilişkin arama ölçütlerini belirtin. Tekliflerinizi otomatikleştirmek ve optimize etmek için Arama ölçütlerini belirtmek için mintCriteria özelliklerini kullanın. Daha fazla ayrıntı için Ölçüt yapılandırma seçenekleri bölümüne bakın.

Örneğin, aşağıdaki istek çeşitli ölçütlere dayalı olarak bir gelir raporu arar. (ör. rapor başlangıç ve bitiş tarihleri ile işlem türleri)

$ curl -H "Content-Type:application/json" -H "Accept: application/octet-stream" -X POST -d \
'{
      "fromDate":"2015-07-01 00:00:00",
      "toDate":"2015-08-01 13:35:00",
      "showTxDetail":true,
      "showSummary":true,                
      "transactionTypes":[
        "PURCHASE",
        "CHARGE",
        "REFUND",
        "CREDIT",
        "SETUPFEES",
        "TERMINATIONFEES",
        "RECURRINGFEES"
      ],
      "currencyOption":"LOCAL",
      "groupBy":[
        "PACKAGE",
        "PRODUCT",
        "DEVELOPER",
        "APPLICATION",
        "RATEPLAN"]
 }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/revenue-reports" \
-u email:password

Gelir raporu bulunursa CSV dosyası biçiminde oluşturulur. Aşağıda, rapor çıkışına dair bir örnek verilmiştir:

Reporting Period:,From:,2015-07-01,  To:,2015-07-31
API Product:,All
Developer:,All
Application:,All
Currency:,Local
Type of Report:,Summary Revenue Report

Monetization Package,Package ID,API Product,Product ID,Developer Name,Developer ID,Application Name,Application ID,Rate Plan,Plan ID,Currency,Transaction Type,Provider Status,Total Volume,Charged Rate,
Location,location,foo_product,foo_product,Apigee,QQ7uxeMGf3w9W08B,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,
Location,location,foo_product,foo_product,BarCompany,barcompany,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,
Location,location,foo_product,foo_product,fremont,fremont,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,
Location,location,foo_product,foo_product,Juan's Taco Shack,juan-s-taco-sha,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,

Gelir raporlarına geliştirici özel özelliklerini eklemek için API

Yalnızca gelir raporları için rapora özel özellikler ekleyebilirsiniz. özelliği tarafından tanımlanmıştır. Geliştiricilere geliştirici eklerken özel Uygulama geliştiricilerini yönetme bölümünde açıklandığı şekilde kuruluşunuzda.

Bir gelir raporuna özel özellikler eklemek için organizations/{org_name}/revenue-reports adresine bir POST isteği gönderin ve istek gövdesine devCustomAttributes dizisini ekleyin:

"devCustomAttributes": [
    "custom_attribute1",
    "custom_attribute2",
    ...
]

Not: Önceden tanımlanmış MINT_* ve devCustomAttributes dizisindeki ADMIN_* özellikleri.

Örneğin, aşağıdaki örnekte raporda BILLING_TYPE, SFID ve ORG_EXT olmak üzere üç özel özellik (geliştirici için tanımlanmışsa) yer alır:

$ curl -H "Content-Type:application/json" -H "Accept: application/octet-stream" -X POST -d \
'{
      "fromDate":"2015-07-01 00:00:00",
      "toDate":"2015-08-01 13:35:00",
      "showTxDetail":true,
      "showSummary":true,                
      "transactionTypes":[
        "PURCHASE",
        "CHARGE",
        "REFUND",
        "CREDIT",
        "SETUPFEES",
        "TERMINATIONFEES",
        "RECURRINGFEES"
      ],
      "currencyOption":"LOCAL",
      "groupBy":[
        "PACKAGE",
        "PRODUCT",
        "DEVELOPER",
        "APPLICATION",
        "RATEPLAN"
      ],
      "devCustomAttributes": [
         "BILLING_TYPE",
         "SFID",
         "ORG_EXT"
      ]
 }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/revenue-reports" \
-u email:password

Aşağıda, iki özel rapora ait değerleri içeren bir rapor çıkışı örneği gösterilmektedir özellikler:

Reporting Period:,From:,2015-07-01,  To:,2015-07-31
API Product:,All
Developer:,All
Application:,All
Currency:,Local
Type of Report:,Summary Revenue Report

Monetization Package,Package ID,API Product,Product ID,Developer Name,Developer ID,Application Name,Application ID,Rate Plan,Plan ID,Currency,Transaction Type,Provider Status,Total Volume,Charged Rate,BILLING_TYPE,SFID,ORG_EXT 
Location,location,foo_product,foo_product,Apigee,QQ7uxeMGf3w9W08B,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA,
Location,location,foo_product,foo_product,BarCompany,barcompany,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA,
Location,location,foo_product,foo_product,fremont,fremont,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA,
Location,location,foo_product,foo_product,Juan's Taco Shack,juan-s-taco-sha,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA,

API'yi kullanarak işlem etkinliğini raporlama

/organizations/{org_name}/transaction-search adresine POST isteği göndererek bir kuruluşun işlem etkinliğini görüntüleyebilirsiniz. Talebinizi iletirken şunları yapmanız gerekir: alınması için ölçütleri belirtir. Ölçüt olarak belirtebileceğiniz bazı şeyler:

  • İşlemlerin yapıldığı bir veya daha fazla API ürününün kimliği.
  • İşlemlerin fatura ayı ve yılı.
  • İşlemi gerçekleştiren geliştiriciler.
  • İşlemin türü (ör. satın alma ve kurulum ücretleri).
  • İşlemin başarılı ve başarısız gibi durumudur.

Ölçütlerin tam listesi için Ölçüt yapılandırma seçenekleri başlıklı makaleyi inceleyin.

Örneğin, aşağıdaki işlemler, faturalandırma için belirli bir geliştirici tarafından gerçekleştirilen işlemleri döndürür. ay Haziran 2015:

$ curl -H "Content-Type:application/json" -X POST -d \
 '{        
    "billingMonth": "JUNE",
    "billingYear": 2015,
    "devCriteria": [{
      "id": "RtHAeZ6LtkSbEH56",
      "orgId":"myorg"}],
    "transactionTypes": ["PURCHASE", "CHARGE", "SETUPFEES"],
    "transactionStatus": ["SUCCESS", "FAILED"]
    }'
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/transaction-search \
-u email:password

Ayrıca, hangi uygulamaların, geliştiricilerin, API ürün paketlerinin veya API ürünlerinin, belirli bir tarih aralığındaki işlem etkinliğidir. Bu bilgileri her biri için olacaktır. Örneğin, belirli bir başlangıç ve bitiş tarihi aralığında, para kazanılan API ürün paketlerinizdeki API'lere erişen uygulamalarla ilgili bilgileri görüntüleyebilirsiniz.

İşlem etkinliğiyle ilgili bilgileri görüntülemek için aşağıdakilerden birine GET isteği gönderin kaynaklar:

Kaynak İadeler
/organizations/{org_name}/applications-with-transactions

İşlem yapılan uygulamalar

/organizations/{org_name}/developers-with-transactions

İşlem yapan geliştiriciler

/organizations/{org_name}/products-with-transactions

İşlem yapılan ürünler

/organizations/{org_name}/packages-with-transactions

İşlem içeren API ürün paketleri (veya API paketleri)

İsteği gönderirken sorgu parametreleri olarak başlangıç ve bitiş tarihi belirtmeniz gerekir seçin. Örneğin, aşağıdaki istek, elde etti.

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers-with-transactions?START_DATE=2015-08-01&END_DATE=2015-08-31" \
-u email:password

Yanıtın görünümü aşağıdaki gibi olacaktır (yanıtın yalnızca bir kısmı gösterilmiştir):

{
  "developer" : [ {
    "address" : [ {
      "address1" : "Dev Five Address",
      "city" : "Pleasanton",
      "country" : "US",
      "id" : "0917f15f-9521-4e69-9376-07aa7b7b32ca",
      "isPrimary" : true,
      "state" : "CA",
      "zip" : "94588"
    } ],
    "approxTaxRate" : 0.0900,
    "billingType" : "POSTPAID",
    "broker" : false,
    "developerRole" : [ ],
    "email" : "dev5@myorg.com",
    "hasSelfBilling" : false,
    "id" : "tJZG6broTpGGGeLV",
    "legalName" : "DEV FIVE",
    "name" : "Dev Five",
    "organization" : {
      ...
    },
    "registrationId" : "dev5",
    "status" : "ACTIVE",
    "type" : "UNTRUSTED"
  }, {
    "address" : [ {
      "address1" : "Dev Seven Address",
      "city" : "Pleasanton",
      "country" : "US",
      "id" : "f86d8c9f-6ed1-4323-b050-6adf494096c9",
      "isPrimary" : true,
      "state" : "CA",
      "zip" : "94588"
    } ],
    "approxTaxRate" : 0.0900,
    "billingType" : "POSTPAID",
    "broker" : false,
    "developerRole" : [ ],
    "email" : "dev7@myorg.com",
    "hasSelfBilling" : false,
    "id" : "VI3l8m8IPAvJTvjS",
    "legalName" : "DEV SEVEN",
    "name" : "Dev Seven",
    "organization" : {
      ...
    },
    "registrationId" : "dev7",
    "status" : "ACTIVE",
    "type" : "UNTRUSTED"
  }, ...
  ]
}

API için rapor yapılandırma seçenekleri

API'de aşağıdaki rapor yapılandırma seçenekleri kullanılabilir:

Ad Açıklama Varsayılan Zorunlu mu?
name

Raporun adı.

Yok Evet
description

Raporun açıklaması.

Yok Hayır
mintCriteria

Raporu yapılandırma ölçütleri. Ölçütlere bakın yapılandırma seçeneklerini inceleyin.

Yok Hayır
type

Raporun türü. Değer aşağıdakilerden biri olabilir:

  • BILLING
  • REVENUE
  • VARIANCE
  • PREPAID_BALANCE
Yok Evet

Ölçüt yapılandırma seçenekleri

mintCriteria mülkü aracılığıyla raporlar için aşağıdaki yapılandırma seçenekleri kullanılabilir:

Ad Açıklama Varsayılan Zorunlu mu?
appCriteria

Rapora dahil edilecek belirli bir uygulamanın kimliği ve kuruluşu. Bu özellik belirtilmezse tüm uygulamalar rapora dahil edilir.

Yok Hayır
billingMonth

Not: Bu mülk, gelir raporları için geçerli değildir.

Raporun faturalandırma ayı (ör. TEMMUZ).

Yok Evet
billingYear

Not: Bu mülk, gelir raporları için geçerli değildir.

Raporun faturalandırma yılı (ör. 2015).

Yok Evet
currCriteria

Rapora dahil edilecek belirli bir para biriminin kimliği ve kuruluşu. Bu mülk belirtilmezse desteklenen tüm para birimleri rapora dahil edilir.

Yok Hayır
currencyOption

Raporun para birimi. Geçerli değerler şunlardır:

  • LOCAL Raporun her satırı, geçerli oran kullanılarak gösterilir. hakkında bilgi edindiniz. Bu, geliştiricilerin farklı para birimleri kullanan planları varsa tek bir raporda birden fazla para birimi olabileceği anlamına gelir.
  • EUR Yerel para birimi işlemleri, para birimine dönüştürülerek gösterilir. Avro.
  • GPB. Yerel para birimi işlemleri dönüştürülür ve Birleşik Krallık sterlini cinsinden gösterilir.
  • USD. Yerel para birimi işlemleri dönüştürülür ve ABD doları cinsinden gösterilir.
Yok Hayır
devCriteria

Rapora dahil edilecek belirli bir geliştiricinin geliştirici kimliği (e-posta adresi) ve kuruluş adı. Bu özellik belirtilmezse tüm geliştiriciler dikkat edin. Örneğin:

"devCriteria":[{
    "id":"RtHAeZ6LtkSbEH56",
    "orgId":"my_org"}
]
                
Yok Hayır
devCustomAttributes

Not: Bu özellik yalnızca gelir raporları için geçerlidir.

Geliştirici için tanımlanmışsa rapora dahil edilecek özel özellikler. Örneğin:

"devCustomAttributes": [
    "custom_attribute1",
    "custom_attribute2",
    ...
]

Not: devCustomAttributes dizisinde önceden tanımlanmış MINT_* ve ADMIN_* özelliklerini belirtmeyin.

Yok Hayır
fromDate

Not: Bu özellik yalnızca gelir, varyans ve işlem etkinliği raporlarıdır.

Raporun UTC'de başlangıç tarihi.

Yok Gelir raporları için gereklidir; diğer rapor türleri için gerekli değildir.
groupBy

Sütunların raporda gruplandırılma sırası. Geçerli değerler şunlardır:

  • APPLICATION
  • BALANCE
  • DEVELOPER
  • ORG
  • PACKAGE
  • PRODUCT
  • RATEPLAN
Yok Hayır
monetizationPackageId

Rapora dahil edilecek bir veya daha fazla API ürün paketinin kimliği. Bu özellik belirtilmezse tüm API ürün paketleri rapora dahil edilir.

Not: İşlem etkinliğini (/transaction-search) görüntülerken bu özellik geçerli değildir.

Yok Hayır
pkgCriteria

Rapora dahil edilecek belirli bir API ürün paketinin kimliği ve kuruluşu. Bu özelliği belirtilmemişse tüm API ürün paketleri rapora dahil edilir. Bu özellik, monetizationpackageIds özelliği yerine belirtilebilir.

Not: Bu özellik, işlem etkinliği (/transaction-search) görüntülenirken geçerli değildir.

Yok Hayır
prevFromDate

Not: Bu özellik yalnızca varyans raporları için geçerlidir.

Önceki bir dönemin UTC saat diliminde başlangıç tarihi. Mevcut bir raporla karşılaştırmak için önceki bir döneme ait rapor oluşturmak için kullanılır.

Yok Hayır
prevToDate

Not: Bu özellik yalnızca varyans raporları için geçerlidir.

Önceki bir dönemin UTC saat diliminde bitiş tarihi. Önceki bir döneme ait rapor oluşturmak için kullanılır güncel bir raporla karşılaştırabilirsiniz.

Yok Hayır
prodCriteria

Rapora dahil edilecek belirli bir API ürününün kimliği ve kuruluşu. Bu özellik belirtilmezse tüm API ürünleri rapora dahil edilir. Bu mülk productIds özelliği yerine belirtilmelidir.

Not: İşlem etkinliğini (/transaction-search) görüntülerken bu özellik geçerli değildir.

Yok Hayır
productIds

Rapora dahil edilecek bir veya daha fazla API ürününün kimliği. Bu özellik belirtilmezse tüm API ürünleri rapora dahil edilir.

API ürün kimlikleri org-name@@@product-name olarak belirtilmelidir. Örnek: "productIds": ["myorg@@@myproduct", "myorg@@@myproduct2"]

Yok Hayır
pricingTypes

Rapora dahil edilecek ücret planının fiyatlandırma türü. Geçerli değerler şunlardır:

  • REVSHARE. Gelir paylaşımı planı.
  • REVSHARE_RATECARD Gelir paylaşımı ve ücret listesi ücret planı.
  • RATECARD Ücret listesi planı.

Bu tesis belirtilmezse tüm fiyatlandırma türlerinin ücret planları rapordur.

Yok Hayır
ratePlanLevels

Rapora dahil edilecek ücret planının türü. Geçerli değerler şunlardır:

  • DEVELOPER Geliştirici ücret planı.
  • STANDARD. Standart ücret planı.

Bu özellik belirtilmezse rapora hem geliştiriciye özel hem de standart ücret planları dahil edilir.

Yok Hayır
showRevSharePct

Raporun gelir paylaşımı yüzdelerini gösterip göstermediğini belirten işaret. Geçerli değerler şunlardır:

  • true. Gelir paylaşımı yüzdelerini gösterin.
  • false Gelir paylaşımı yüzdelerini gösterme.
Yok Hayır
showSummary

Raporun özet olup olmadığını belirten işaret. Geçerli değerler şunlardır:

  • true. Rapor bir özettir.
  • false Rapor özet değil.
Yok Hayır
showTxDetail

Not: Bu özellik yalnızca gelir raporları için geçerlidir.

Raporun işlem düzeyindeki ayrıntıları gösterip göstermediğini belirten işaret. Geçerli değerler şunlardır:

  • true. İşlem düzeyindeki ayrıntıları gösterin.
  • false İşlem düzeyindeki ayrıntıları gösterme.
Yok Hayır
showTxType

Raporda her bir işlemin türünü gösterip göstermeyeceğini belirten işaret. Geçerli değerler şunlardır:

  • true. Her bir işlemin türünü gösterin.
  • false. Her bir işlemin türünü göstermeyin.
Yok Hayır
toDate

Not: Bu özellik yalnızca gelir, varyans ve işlem etkinliği raporlarıdır.

Raporun bitiş tarihi (UTC).

Rapor, belirtilen tarihten önce gün sonuna kadar toplanan verileri içerir. Belirtilen bitiş tarihinde toplanan rapor verileri rapordan hariç tutulur. Örneğin, bir ücret planının süresini 31 Aralık 2016'da sona erdirmek istiyorsanız toDate değerini 2017-01-01 olarak ayarlamanız gerekir. Bu durumda rapor, 31 Aralık 2016'nın sonuna kadarki rapor verilerini içerir; 1 Ocak 2017'deki rapor verileri hariç tutulur.

Yok Gelir raporları için gereklidir; diğer rapor türleri için gerekli değildir.
transactionStatus

Rapora eklenecek işlemlerin durumu. Geçerli değerler şunlardır:

  • SUCCESS. İşlem başarılı.
  • DUPLICATE. Yinelenen işlem. Bu işlemleri yoksayabilirsiniz. Apigee çalışma zamanından puanlama sunucusuna giden veri ardışık düzeni, bazen hatalara karşı dayanıklı olmak için yinelenen işlemler oluşturabilir ve para kazanma, bunları yinelenen olarak tanır ve işaretler.
  • FAILED. İşlem başarısız oldu. Bu durum, bir ön koşulun doğrulaması başarısız olduğunda tetiklenir. Örnek:
    • Geliştirici ücret planını satın almamış olsa bile puanlama denemesi. Bu durum, Para Kazanma Sınırı Kontrolü politikası yapılandırılmamışsa ortaya çıkabilir.
    • Kota aşıldı ancak aramalar devam ediyor. Bu durum, Para Kazanma Sınırları Kontrolü politikası yapılandırılmamışsa gerçekleşebilir.
    • Özel özelliğe dayalı plan için negatif özel özellik değeri gönderildi.
  • INVALID_TSC İşlem geçersiz. txProviderStatus çalışma zamanı ölçütleri, API ürün paketi düzeyinde belirtilen başarı kriterleriyle eşleşmediğinde bu durum tetiklenir.
  • REVIEW. İncelenmesi gereken işlemler. Değer, yapılandırılmamış bir gelir aralığında yer alıyorsa esnek gelir paylaşımı ücret planları için bu durum tetiklenir.
Yok Hayır
transactionCustomAttributes

Özet gelir raporlarına eklenecek özel işlem özellikleri. Bu özelliği kuruluşunuzda etkinleştirmeniz gerekir. Gelir özeti raporlarına özel işlem özelliklerini dahil etme başlıklı makaleyi inceleyin.

Yok Hayır
transactionTypes

Rapora dahil edilecek işlem türü. Geçerli değerler şunlardır:

Bu özellik belirtilmezse tüm işlem türleri rapordur.

Yok Hayır