Raporları yönetin

Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin.
bilgi

Giriş

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

Para kazanma raporu türleri

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

Bildir Açıklama
Faturalandırma Geliştiricilerin bir fatura ayı için etkinliklerini görüntüleyin ve ücret planlarının doğru şekilde uygulandığını doğrulayın.
Ön Ödeme Bakiyesi Ödeme işleyicinizden alınan ödemelerle mutabakat sağlamak için ön ödemeli geliştiricinin faturalandırma ayında veya şu anda açık olan bir ayda yaptığı bakiye yenilemelerini görüntüleyin.
Gelir API ürün paketlerinizin ve ürünlerinizin geliştiricileriniz (ve uygulamaları) genelinde performansını analiz etmek için geliştiricilerin belirli bir tarih aralığında oluşturduğu etkinlik ve geliri görüntüleyin.
Varyans

Geliştiricilerin iki tarih aralığında oluşturduğu etkinlik ve geliri karşılaştırarak API paketlerinizin ve ürünlerinizin geliştiricileriniz (ve uygulamaları) performansındaki artış veya düşüş trendlerini analiz edebilirsiniz.

Veri saklama hakkında

Apigee Edge herkese açık bulutunda para kazanma verilerini saklama, plandan yararlanma hakkıdır. Para kazanma yetkilerini https://cloud.google.com/apigee/specsheets adresinde bulabilirsiniz. Para kazanma verilerinin, yararlanma hakkı süresinden sonra saklanmasını istiyorsanız Apigee Satış Ekibi ile iletişime geçin. Genişletilmiş veri saklama, istek sırasında etkinleştirilir ve orijinal veri saklama süresinden önceki verileri dahil etmek üzere geriye dönük olarak etkinleştirilemez.

Para Kazanma Raporları sayfasını keşfetme

Aşağıda açıklandığı ş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ınla > Para Kazanma > Raporlar'ı seçin.

Raporlar sayfası görüntülenir.

Şekilde vurgulandığı gibi, Raporlar sayfasında aşağıdakileri yapabilirsiniz:

Klasik Edge (Private Cloud)

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

  1. http://ms-ip:9000 üzerinde oturum açın. Burada 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.

Rapor yapılandırma

Kullanıcı arayüzünü kullanarak bir raporu aşağıdaki bölümlerde açıklandığı şekilde yapılandırın.

Rapor yapılandırma adımları

Edge kullanıcı arayüzünü veya Classice Edge kullanıcı arayüzünü kullanarak bir rapor 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ınla > 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 konusuna bakın.
  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 raporu eşzamansız olarak çalıştırmak ve sonuçları daha sonra almak üzere İşi gönder'i tıklayın. Daha fazla bilgi için Rapor oluşturma ve indirme bölümüne bakın.

    • Oluşturulan raporu, CSV olarak ayrılmış değerler (CSV) veya CSV dosyasını içeren sıkıştırılmış bir zip dosyası olarak yerel makinenize indirmek için CSV Olarak Kaydet veya Zip Olarak Kaydet'i tıklayın. Büyük raporlar için zip indirmeleri önerilir ve daha etkili bir şekilde indirilir.

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üde, oluşturmak istediğiniz rapor türünü seçin. Para kazanma raporu türleri konusuna bakın.
  3. + Bildir'i tıklayın.
  4. Rapor ayrıntılarını, seçilen faturalandırma 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 ve raporu daha sonra indirmek için Farklı kaydet ... seçeneğini tıklayın.
    • Yalnızca Ayrıntılı rapor için raporu rastgele çalıştırmak ve sonuçları daha sonra almak üzere İşi gönder'i tıklayın. Daha fazla bilgi için Rapor oluşturma ve indirme bölümüne bakın.

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

Faturalandırma raporunu yapılandırma

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

Alan Açıklama
Faturalandırma Ayı

Rapor için fatura ayı.

Raporlama Düzeyi

Raporlama düzeyi. Geçerli değerler şunları içerir:

  • Ayrıntılı: Her işlemi ayrı bir satırda görüntüler ve ücret planlarının doğru şekilde uygulandığını kontrol etmenize olanak tanır. Özet bölümü yok.
  • Özet: Her API ürünü ve geliştiricisi için toplam gelirleri özetler.
Ü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çbir API 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 isterseniz Özet görüntüleme seçeneklerinde Görüntüleme seçeneğini işaretleyebilirsiniz. Bu durumda rapor tüm (veya seçili) API ürün paketlerindeki bilgileri toplar (ve her API ürün paketiyle ilgili bilgileri ayrı ayrı listelemez).

Ürünler

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

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

Özet raporu için isterseniz Özet görüntüleme seçeneklerinde Görüntüleme seçeneğini işaretleyebilirsiniz. Bu durumda rapor, tüm (veya seçili) geliştiricilerden gelen bilgileri toplar (ve seçilen her geliştiriciyle ilgili bilgileri ayrı ayrı listelemez).

Şirketler

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

Ücret Planı

Rapora dahil edilecek ücret planları. 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ı ekleyin.

Ön ödeme bakiyesi raporunu yapılandırma

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

Alan Açıklama
Faturalandırma Ayı

Rapor için fatura ayı.

Raporlama Düzeyi

Raporlama düzeyi. Geçerli değerler şunları içerir:

  • Ayrıntılı: Her bakiye yeniden doldurmasını ayrı olarak gösterir ve ödeme işleyicinizden alınan ödemelerle mutabakat sağlamanıza olanak tanır.
  • Özet: Her geliştirici için toplam bakiye yeniden doldurmalarını özetler.
Şirketler

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

Gelir raporu yapılandırma

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

Alan Açıklama
Tarih Aralığı

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

  • Hazır ayar: 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 şunları içerir:

  • Yerel para birimi: Raporun her satırı, geçerli ücret planı kullanılarak gösterilir. Yani, geliştiricilerin farklı para birimleri kullanan planları varsa, bir raporda birden fazla para birimi olabilir.
  • Avro: Rapordaki yerel para birimi işlemleri avroya dönüştürülür ve bu para birimi cinsinden gösterilir.
  • Birleşik Krallık poundu: Rapordaki yerel para birimi işlemleri, pound cinsinden dönüştürülür ve görüntülenir.
  • ABD Doları: Rapordaki yerel para birimi işlemleri, dolar cinsinden dönüştürülür ve görüntülenir.
Raporlama Düzeyi

Raporlama düzeyi. Geçerli değerler şunları içerir:

  • Ayrıntılı: Her işlemi ayrı bir satırda görüntüler. Özet bölümü yok.
  • Özet: Seçtiğiniz parametrelere bağlı olarak her bir API ürünü ve geliştiricisi için toplam gelirleri özetler.
Ü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çbir API 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 isterseniz Özet görüntüleme seçeneklerinde Görüntüleme seçeneğini işaretleyebilirsiniz. Bu durumda rapor tüm (veya seçili) API ürün paketlerindeki bilgileri toplar (ve her API ürün paketiyle ilgili bilgileri ayrı ayrı listelemez).

Ürünler

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

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

Özet raporu için isterseniz Özet görüntüleme seçeneklerinde Görüntüleme seçeneğini işaretleyebilirsiniz. Bu durumda rapor, tüm (veya seçili) geliştiricilerden gelen bilgileri toplar (ve seçilen her geliştiriciyle ilgili bilgileri ayrı ayrı listelemez).

Şirketler

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

Özet rapor için isterseniz Özet Görüntüleme Seçenekleri bölümünde Görüntüleme seçeneğini işaretleyebilirsiniz. Bu durumda rapor, tüm (veya seçilen) şirketlerdeki bilgileri toplar (ve seçilen her şirketin bilgilerini ayrı ayrı listelemez).

Uygulamalar

Rapora dahil edilecek uygulamaları seçin. Hiçbir uygulama seçilmezse tüm uygulamalar rapora dahil edilir.

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

Özet rapor için isterseniz Özet Görüntüleme Seçenekleri bölümünde Görüntüleme seçeneğini işaretleyebilirsiniz. Bu durumda, rapor tüm (veya seçili) uygulamalardaki bilgileri toplar (ve seçilen her uygulamanın bilgilerini ayrı olarak listelemez).

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

Sütunların gruplandırıldığı ve raporda görüntülendiği sıra. Gruplamada ilgili bölümün göreli sırasını gösteren bir sayı seçin (1, ilk gruplandırmadır). Örneğin, aşağıda, rapor önce paketlere, ardından ürünlere, ardından geliştiricilere ve daha sonra uygulamalara göre gruplandırılır.

Bir bölümü görüntülemek istemiyorsanız Görüntüleme'yi seçin ve ardından geri kalan alanları sırayla seçin. Bir bölümün göreli sırasını değiştirdiğinizde veya raporda bir bölümü görüntülememeyi seçtiğinizde sıra otomatik olarak güncellenir.

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

İşlem kaydetme politikaları, işlemlerden özel özellik verilerini yakalamanızı sağlar ve bu özel özellikleri, özet gelir raporlarına dahil edebilirsiniz. Kuruluşunuzun MINT.SUMMARY_CUSTOM_ATTRIBUTES özelliğini ayarlayarak para kazanma veritabanı tablolarına dahil edilen varsayılan özel özellik grubunu tanımlayın.

Bu özelliği kullanmak için biraz düşünmek ve planlama yapmak gerekir. Bu nedenle aşağıdaki noktaları inceleyin.

Bulut müşterisiyseniz özelliği ayarlamak için Apigee Edge Destek Ekibi ile iletişime geçin. Private Cloud için Apigee Edge müşterisiyseniz PUT isteği kullanarak işareti Sistem Yöneticisi kimlik bilgilerine sahip aşağıdaki API'ye 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ı özelliği etkinleştirir ve para kazanma veritabanına partner_id ve tax_source sütunlarını ekler. API çağrısındaki özel özellik dizisinin URL olarak kodlandığını unutmayın.

Raporlara özel işlem özellikleri eklerken dikkat edilmesi gereken noktalar

  • Kullanmak istediğiniz özellik adlarını API ile oluşturmadan önce emin olun. Bunlar, veritabanındaki sütun adlarıdır ve özel özellik verileri her zaman burada depolanır.
  • Aşağıdaki resimde gösterildiği gibi her işlem kayıt politikasında 10 kullanılabilir özel özellik yuvası vardır. Raporlara dahil edilecek ürünler genelinde aynı özellikler için tam olarak aynı özellik adlarını ve konumları kullanın. Örneğin, aşağıdaki işlem kaydetme politikasında partner_id ve tax_source özel özellikleri sırasıyla 4. ve 5. kutuları doldurur. Ürünlerin raporlamaya dahil edilmesi için bu adın tüm işlem kaydetme politikalarındaki adı ve konumu olmalıdır.

Özelliği etkinleştirdikten sonra bir özet gelir raporuna özel özellikler eklemek için MintCriteria öğesine transactionCustomAttributes öğesini ekleyerek rapor API'sini kullanın. Ölçüt yapılandırma seçenekleri bölümüne bakın.

Varyans raporunu yapılandırma (Kullanımdan kaldırıldı)

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

Alan Açıklama
Tarih Aralığı

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

  • Hazır ayar: 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çilen: Rapora dahil edilecek API paketlerini seçebileceğiniz bir liste görüntüler. Paket yok seçeneğini belirlerseniz tüm paketler rapora dahil edilir.

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

Özet rapor için isterseniz Özet Görüntüleme Seçenekleri bölümünde Gösterme (Paketler) seçeneğini işaretleyebilirsiniz. Bu durumda, rapor tüm (veya seçili) API paketlerindeki bilgileri toplar (ve her API paketine ait bilgileri ayrı ayrı listelemez).

Ü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çilenler: Rapora dahil edilecek ürünleri seçebileceğiniz bir liste görüntüler. Hiçbir ürün'ü seçerseniz tüm ürünler rapora dahil edilir.

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

Özet raporu için isterseniz Özet Görüntüleme Seçenekleri bölümünde Görüntüleme (Ürünler) seçeneğini işaretleyebilirsiniz. Bu durumda, rapor tüm (veya seçili) API ürünlerindeki bilgileri toplar (ve her API ürünüyle ilgili bilgileri ayrı ayrı listelemez).

Şirketler

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

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

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

Özet rapor için isterseniz Özet Görüntüleme Seçenekleri bölümünde Görüntülememe (Şirketler) seçeneğini işaretleyebilirsiniz. Bu durumda rapor, tüm (veya seçilen) şirketlerdeki bilgileri toplar (ve seçilen her şirketin bilgilerini ayrı olarak listelemez).

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üler. Hiçbir uygulama'yı seçmezseniz tüm uygulamalar rapora dahil edilir.

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

Özet rapor için isterseniz Özet Görüntüleme Seçenekleri bölümünde Görüntüleme (Uygulamalar) seçeneğini işaretleyebilirsiniz. Bu durumda, rapor tüm (veya seçili) uygulamalardaki bilgileri toplar (ve seçilen her uygulamanın bilgilerini ayrı olarak listelemez).

Currency

Raporun para birimi. Geçerli değerler şunları içerir:

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

Sütunların gruplandırıldığı ve raporda görüntülendiği sıra. Gruplamada ilgili bölümün göreli sırasını gösteren bir sayı seçin (1, ilk gruplandırmadır). Örneğin, aşağıda, rapor önce paketlere, ardından ürünlere, ardından geliştiricilere ve daha sonra uygulamalara göre gruplandırılır.

Bir bölümü görüntülemek istemiyorsanız Görüntüleme'yi seçin ve ardından geri kalan alanları sırayla seçin. Bir bölümün göreli sırasını değiştirdiğinizde veya raporda bir bölümü görüntülememeyi seçtiğinizde sıra otomatik olarak güncellenir.

Rapor oluşturma ve indirme

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

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

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

  • Eşzamansız 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 bir alternatif olabileceği bazı durumlar şunlardır:

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

    Ayrıntılı rapor düzeyi ise 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 yapın:

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

    1. CSV dosya simgesi simgesi veya zip dosya simgesi simgesi (Özet rapor için). Rapor eşzamanlı olarak CSV veya zip dosyasına kaydedilir.
    2. İşi gönder (Ayrıntılı rapor için). Eşzamansız iş başlatılır.
      1. Değiştirildi sütununda işin durumunu izleyin.

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

        Rapor indirilmeye hazır olduğunda disk görüntüsü görünür.
      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.

Raporu 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. Rapor yapılandırmasını gerektiği şekilde 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 erişin.
  2. İmleci, silmek istediğiniz raporun üzerine getirin.
  3. İşlemler menüsünde simgesini tıklayın.

API'yi kullanarak para kazanma raporlarını yönetme

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

API'yi kullanarak rapor yapılandırma

Raporu kuruluşun tamamı için yapılandırmak üzere /organizations/{org_name}/report-definitions sitesine POST isteği gönderin.

Raporu belirli bir geliştirici için yapılandırmak üzere /organizations/{org_name}/developers/{dev_id}/report-definitions adresine POST isteği gönderin. Burada {dev_id}, geliştiricinin kimliğidir.

İstekte bulunduğunuzda raporun adını ve türünü belirtmeniz gerekir. Tür şunlardan biridir: BILLING, REVENUE, VARIANCE (desteği sonlandırıldı) veya PREPAID_BALANCE. Ayrıca mintCriteria özelliğinde raporu daha fazla yapılandıran ölçütler de belirtebilirsiniz. Belirtebileceğiniz çok çeşitli ölçütler vardır. Bu, raporu yapılandırırken büyük bir esneklik sağlar. Ölçüt olarak belirtebileceğiniz öğelerden bazıları şunlardır:

  • Faturalandırma veya ön ödeme bakiyesi raporu için raporun fatura ayı
  • Gelir raporu için satın alma işlemleri, ücret işlemleri ve geri ödemeler gibi raporda yer alan işlemlerin türü
  • Ön ödeme bakiyesi raporu için raporun geçerli olduğu geliştirici
  • Gelir raporu için raporun geçerli olduğu API ürün paketleri (veya API paketleri), ürünler, ücret planları ve uygulamalar
  • Gelir veya sapma raporu için raporda geçerli para birimi
  • Faturalandırma, ön ödeme bakiyesi veya gelir raporları için rapor ister özet rapor ister ayrıntılı rapor olsun
  • Gelir özeti raporu için rapora özel işlem özelliklerini ekleyin

Rapor ölçütlerinin tam listesi için Rapor yapılandırma seçenekleri bölümüne bakın.

Örneğin, aşağıda Temmuz 2015 ayına ait işlem etkinliğini özetleyen bir gelir raporu oluşturulur. transactionTypes özelliğinde belirtilen çeşitli işlem türlerini içeren rapor, özellikle Payment API ürün paketi ve Payment API ürünü için geçerlidir. Rapor tanımında belirli bir geliştirici veya uygulama belirtilmedikçe rapor, tüm geliştiriciler ve uygulamalar için geçerlidir. Ayrıca currencyOption özelliği LOCAL olarak ayarlandığından rapordaki her satır, geçerli ücret planının para birimi kullanılarak gösterilir. Ayrıca groupBy özelliği, rapordaki sütunların şu sırayla gruplandırılacağını belirtir: PACKAGE, PRODUCT, DEVELOPER, APPLICATION ve RATEPLAN (rapora ücret planı adı ve kimliği dahil).

$ 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ğıda, bir geliştiricinin Haziran 2015 için DEV FIVE etkinliğini gösteren ayrıntılı bir faturalandırma raporu oluşturulmuştur.

$ 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. Belirli bir geliştiricinin rapor yapılandırmalarını da görüntüleyebilirsiniz.

Bir kuruluşun belirli bir rapor yapılandırmasını görüntülemek amacıyla /organizations/{org_name}/report-definitions/{report_definition_id} için GET isteği gönderin. Burada {report_definition_id}, belirli rapor yapılandırmasının kimliğidir (kimlik, rapor yapılandırmasını oluşturduğunuzda yanıtta 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 GET isteği gönderin.

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

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 paketlerinin sayısı, size sorgu parametresi tarafından tanımlanır. Varsayılan olarak false (yanlış) değerine ayarlanır.
size Sayfa başına döndürülen API ürün paketlerinin sayısı. Varsayılan değer 20'dir. all sorgu parametresi true olarak ayarlanırsa bu parametre yok sayılır.
page Döndürmek istediğiniz sayfanın sayısı (içerik sayfalara ayrılmışsa). all sorgu parametresi true olarak ayarlanırsa bu parametre yok sayılır.
sort Bilgilerin sıralanacağı alan. all sorgu parametresi true olarak ayarlanırsa bu parametre yok sayılır. Varsayılan olarak UPDATED:DESC değerine ayarlanır.

Örneğin, aşağıdaki komut, kuruluş için rapor yapılandırmalarını döndürür ve alma 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 aşağıdaki gibi görünmelidir (yanıtın yalnızca bir kısmı gösterilir):

{
  "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. İstekte bulunduğunuzda verileri filtrelemek ve sıralamak için yukarıda açıklanan sorgu parametrelerini belirtebilirsiniz.

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

$ 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

Bir rapor yapılandırmasını güncellemek için /organizations/{org_name}/report-definitions/{report_definition_id} adresine PUT isteği gönderin. Burada {report_definition_id}, belirli rapor yapılandırmasının tanımlamasıdır. Güncellemeyi yaparken, istek gövdesinde güncellenen yapılandırma değerlerini ve rapor yapılandırmasının kimliğini belirtmeniz gerekir. Örneğin, aşağıdaki istek, raporu özet raporuyla 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 aşağıdaki gibi görünmelidir (yanıtın yalnızca bir kısmı gösterilir):

{
 "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. Burada {report_definition_id}, silinecek rapor yapılandırmasının tanımlamasıdır. Ö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'yi kullanarak rapor oluşturma

Bir raporu yapılandırdıktan sonra, görüntülemek üzere virgülle ayrılmış değerler (CSV) dosyası biçiminde oluşturabilirsiniz.

organizations/{org_id}/{report_type} adresine POST isteği göndererek rapor sorunu oluşturmak için burada {report_type}, oluşturmak istediğiniz rapor türünü belirtir. Türler şunlardır:

  • billing-reports
  • revenue-reports
  • prepaid-balance-reports
  • variance-reports
Ayrıca, Geliştirici için gelir raporu oluşturma bölümünde açıklandığı gibi belirli bir geliştirici için gelir raporu oluşturabilirsiniz.

Ö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. 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, raporun başlangıç ve bitiş tarihleri ile işlem türleri gibi çeşitli ölçütlere göre bir gelir raporu arar.

$ 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

Bu seçeneği görürseniz gelir raporu CSV dosyası biçiminde oluşturulur. Aşağıda, rapor çıkışının bir örneği 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,

API'yi kullanarak gelir raporlarına geliştirici özel özelliklerini ekleme

Yalnızca gelir raporlarında, geliştirici için tanımlanmış olan özel özellikler varsa rapora özel özellikler ekleyebilirsiniz. Özel özellikleri, kuruluşunuza geliştirici eklerken Uygulama geliştiricileri yönetme bölümünde açıklandığı gibi tanımlarsınız.

Gelir raporuna özel özellikler eklemek isterseniz organizations/{org_name}/revenue-reports için bir POST isteği gönderin ve devCustomAttributes dizisini istek gövdesine dahil edin:

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

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

Örneğin, aşağıdaki örnek, raporda BILLING_TYPE, SFID ve ORG_EXT adlı üç özel özellik içerir (geliştirici için tanımlanmışsa):

$ 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 özelliğe ait değerleri içeren bir rapor çıktısı örneği 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,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 sitesine POST isteği göndererek bir kuruluşun işlem etkinliğini görüntüleyebilirsiniz. İstekte bulunduğunuzda alma ölçütleri belirtmeniz gerekir. Ölçüt olarak belirtebileceğiniz öğelerden bazıları şunlardır:

  • İşlem yapılan bir veya daha fazla API ürününün kimliği.
  • İşlemlerin fatura ayı ve yılı.
  • İşlemi yapan geliştiriciler.
  • İşlemin türü (satın alma ve kurulum ücretleri gibi).
  • İşlemin başarılı ve başarısız gibi durumu.

Ölçütlerin tam listesi için Ölçüt yapılandırma seçenekleri bölümüne bakın.

Örneğin, aşağıda Haziran 2015 faturalandırma ayı için belirli bir geliştirici tarafından yapılan işlemler iade edilmiştir:

$ 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, belirli bir tarih aralığında hangi uygulamaların, geliştiricilerin, API ürün paketlerinin veya API ürünlerinin işlem etkinliği olduğunu da belirleyebilirsiniz. Bu bilgileri her bir nesne türü için ayrı ayrı görüntüleyebilirsiniz. Örneğin, özellikle belirli bir başlangıç ve bitiş tarihi için para kazandıran 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ğıdaki kaynaklardan birine GET isteği gönderin:

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

İşlem içeren uygulamalar

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

İşlemleri olan 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önderdiğinizde, sorgu parametreleri olarak tarih aralığı için bir başlangıç tarihi ve bitiş tarihi belirtmeniz gerekir. Örneğin, aşağıdaki istek Ağustos 2015 ayında işlemleri olan geliştiricileri döndürür.

$ 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 aşağıdaki gibi görünmelidir (yanıtın yalnızca bir kısmı gösterilir):

{
  "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

Rapor yapılandırma ölçütleri. Daha fazla ayrıntı için Ölçüt yapılandırma seçenekleri bölümüne bakın.

Yok Hayır
type

Raporun türü. Değer şunlardan 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 özellik, gelir raporları için geçerli değildir.

Rapor için faturalandırma ayı (ör. TEMMUZ).

Yok Evet
billingYear

Not: Bu özellik, gelir raporları için geçerli değildir.

Rapor için faturalandırma yılı (ör. 2015).

Yok Evet
currCriteria

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

Yok Hayır
currencyOption

Raporun para birimi. Geçerli değerler şunları içerir:

  • LOCAL. Rapordaki her satır, geçerli ücret planı kullanılarak gösterilir. Yani, geliştiricilerin farklı para birimleri kullanan planları varsa bir raporda birden fazla para birimi olabilir.
  • EUR. Yerel para birimi işlemleri avro cinsinden dönüştürülür ve bu para birimi cinsinden gösterilir.
  • GPB. Yerel para birimi işlemleri İngiliz sterlinine dönüştürülür ve bu para birimiyle gösterilir.
  • USD. Yerel para birimi işlemleri ABD doları cinsinden dönüştürülür ve bu para biriminde görüntülenir.
Yok Hayır
devCriteria

Rapora eklenecek belirli bir geliştiriciye ait geliştirici kimliği (e-posta adresi) ve kuruluş adı. Bu özellik belirtilmezse tüm geliştiriciler rapora dahil edilir. Örneğin:

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

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

Bir 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, sapma ve işlem etkinliği raporları için geçerlidir.

Raporun başlangıç tarihi (UTC).

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

Raporda sütunların hangi sırayla gruplandırıldığı. Geçerli değerler şunları içerir:

  • 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: Bu özellik, işlem etkinliği (/transaction-search) görüntülenirken geçerli değildir.

Yok Hayır
pkgCriteria

Rapora dahil edilecek belirli bir API ürün paketinin kimliği ve kuruluşu. Bu özellik belirtilmezse tüm API ürün paketleri rapora dahil edilir. Bu özellik, monetizationpackageIds özelliğinin 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 varyasyon raporları için geçerlidir.

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

Yok Hayır
prevToDate

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

Önceki bir dönemin UTC olarak bitiş tarihi. Mevcut raporla karşılaştırmak amacıyla önceki bir döneme ait rapor oluşturmak için kullanılır.

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 özellik, productIds özelliğinin yerine belirtilebilir.

Not: Bu özellik, işlem etkinliği (/transaction-search) görüntülenirken 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. Örneğin: "productIds": ["myorg@@@myproduct", "myorg@@@myproduct2"]

Yok Hayır
pricingTypes

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

  • 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ı rapora dahil edilir.

Yok Hayır
ratePlanLevels

Rapora dahil edilecek ücret planı türü. Geçerli değerler şunları içerir:

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

Bu özellik belirtilmezse hem geliştiriciye özel hem de standart ücret planları rapora 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 şunları içerir:

  • true. Rapor özet niteliğindedir.
  • false. Rapor özet değildir.
Yok Hayır
showTxDetail

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

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

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

Raporun her işlemin türünü gösterip göstermediğini belirten işaret. Geçerli değerler şunları içerir:

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

Not: Bu özellik yalnızca gelir, sapma ve işlem etkinliği raporları için geçerlidir.

Raporun bitiş tarihi (UTC).

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

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

Rapora dahil edilecek işlemlerin durumu. Geçerli değerler şunları içerir:

  • SUCCESS. Başarılı işlem.
  • DUPLICATE. Yinelenen işlem. Bu işlemler yoksayılabilir. Apigee çalışma zamanından derecelendirme sunucusuna giden veri ardışık düzeni, bazen hatadan etkilenmeyecek şekilde yinelenen işlemler oluşturabilir. Ayrıca, para kazanma bunları yineleniyor olarak kabul edip işaretler.
  • FAILED. İşlem başarısız oldu. Bu durum, bir ön koşulun doğrulaması başarısız olduğunda tetiklenir. Örneğin:
    • Geliştirici, ücret planı satın almamasına rağmen derecelendirme yapılmaya çalışıldı. Bu durum, Para Kazanma Sınırları Kontrolü politikası yapılandırılmadığında meydana gelebilir.
    • Kota aşıldı ancak çağrılar devam ediyor. Bu durum, Para Kazanma Sınırları Kontrolü politikası yapılandırılmadığında meydana gelebilir.
    • Özel özelliğe dayalı plan için negatif özel özellik değeri gönderildi.
  • INVALID_TSC. İşlem geçersiz. Bu durum, txProviderStatus çalışma zamanı ölçütleri, API ürün paketi düzeyinde belirtilen başarı ölçütleriyle eşleşmediğinde tetiklenir.
  • REVIEW. İnceleme gerektiren 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. Kuruluşunuzda bu özelliği etkinleştirmeniz gerekir. Gelir özeti raporlarına özel işlem özelliklerini ekleme konusuna bakın.

Yok Hayır
transactionTypes

Rapora dahil edilecek işlem türleri. Geçerli değerler şunları içerir:

Bu özellik belirtilmezse tüm işlem türleri rapora dahil edilir.

Yok Hayır