Mengelola pengiriman aplikasi

  • Artikel

API pengiriman Microsoft Store menyediakan metode yang dapat Anda gunakan untuk mengelola pengiriman untuk aplikasi Anda, termasuk peluncuran paket bertahap. Untuk pengenalan API pengiriman Microsoft Store, termasuk prasyarat untuk menggunakan API, lihat Membuat dan mengelola pengiriman menggunakan layanan Microsoft Store.

Penting

Jika Anda menggunakan API pengiriman Microsoft Store untuk membuat pengiriman untuk aplikasi, pastikan untuk membuat perubahan lebih lanjut pada pengiriman hanya dengan menggunakan API, bukan Pusat Mitra. Jika Anda menggunakan Pusat Mitra untuk mengubah pengiriman yang awalnya Anda buat dengan menggunakan API, Anda tidak akan lagi dapat mengubah atau menerapkan pengiriman tersebut dengan menggunakan API. Dalam beberapa kasus, pengiriman dapat dibiarkan dalam status kesalahan di mana tidak dapat dilanjutkan dalam proses pengiriman. Jika ini terjadi, Anda harus menghapus pengiriman dan membuat pengiriman baru.

Penting

Anda tidak dapat menggunakan API ini untuk menerbitkan pengiriman untuk pembelian volume melalui Microsoft Store untuk Bisnis dan Microsoft Store untuk Pendidikan atau menerbitkan pengiriman untuk aplikasi LOB langsung ke perusahaan. Untuk kedua skenario ini, Anda harus menggunakan Pusat Mitra untuk menerbitkan pengiriman.

Metode untuk mengelola pengiriman aplikasi

Gunakan metode berikut untuk mendapatkan, membuat, memperbarui, menerapkan, atau menghapus pengiriman aplikasi. Sebelum dapat menggunakan metode ini, aplikasi harus sudah ada di akun Pusat Mitra dan Anda harus terlebih dahulu membuat satu pengiriman untuk aplikasi di Pusat Mitra. Untuk informasi selengkapnya, lihat prasyarat.

Metode URI Deskripsi
GET https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId} Mendapatkan pengiriman aplikasi yang sudah ada
GET https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/status Mendapatkan status pengiriman aplikasi yang sudah ada
POST https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions Membuat pengiriman aplikasi baru
PUT https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId} Memperbarui pengiriman aplikasi yang sudah ada
POST https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/commit Menerapkan pengiriman aplikasi baru atau yang diperbarui
DELETE https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId} Menghapus pengiriman aplikasi

Membuat pengiriman aplikasi

Untuk membuat pengiriman untuk aplikasi, ikuti proses ini.

  1. Jika Anda belum melakukannya, selesaikan semua prasyarat untuk API pengiriman Microsoft Store.

    Catatan

    Pastikan aplikasi sudah memiliki setidaknya satu pengiriman yang selesai dengan informasi peringkat usia selesai.

  2. Dapatkan token akses Azure AD. Anda harus meneruskan token akses ini ke metode di API pengiriman Microsoft Store. Setelah mendapatkan token akses, Anda memiliki waktu 60 menit untuk menggunakannya sebelum masa berlakunya habis. Setelah token kedaluwarsa, Anda dapat memperoleh yang baru.

  3. Buat pengiriman aplikasi dengan menjalankan metode berikut di API pengiriman Microsoft Store. Metode ini membuat pengiriman baru yang sedang berlangsung, yang merupakan salinan pengiriman terakhir Anda yang diterbitkan.

    POST https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions

    Isi respons berisi sumber daya pengiriman aplikasi yang menyertakan ID pengiriman baru, URI tanda tangan akses bersama (SAS) untuk mengunggah file terkait untuk pengiriman ke Azure Blob Storage (seperti paket aplikasi, mencantumkan gambar, dan file trailer), dan semua data untuk pengiriman baru (seperti daftar dan informasi harga).

    Catatan

    SAS URI menyediakan akses ke sumber daya yang aman di penyimpanan Azure tanpa memerlukan kunci akun. Untuk informasi latar belakang tentang URI SAS dan penggunaannya dengan Azure Blob Storage, lihat Tanda Tangan Akses Bersama, Bagian 1: Memahami model SAS dan Tanda Tangan Akses Bersama, Bagian 2: Membuat dan menggunakan SAS dengan penyimpanan Blob.

  4. Jika Anda menambahkan paket baru, mencantumkan gambar, atau file trailer untuk pengiriman, siapkan paket aplikasi dan siapkan cuplikan layar, gambar, dan trailer aplikasi. Tambahkan semua file ini ke arsip ZIP.

  5. Revisi data pengiriman aplikasi dengan perubahan yang diperlukan untuk pengiriman baru, dan jalankan metode berikut untuk memperbarui pengiriman aplikasi.

    PUT https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}

    Catatan

    Jika Anda menambahkan file baru untuk pengiriman, pastikan Anda memperbarui data pengiriman untuk merujuk ke nama dan jalur relatif file-file ini di arsip ZIP.

  6. Jika Anda menambahkan paket baru, mencantumkan gambar, atau file trailer untuk pengiriman, unggah arsip ZIP ke Azure Blob Storage menggunakan URI SAS yang disediakan dalam isi respons metode POST yang Anda panggil sebelumnya. Ada berbagai pustaka Azure yang dapat Anda gunakan untuk melakukan ini di berbagai platform, termasuk:

    Contoh kode C# berikut menunjukkan cara mengunggah arsip ZIP ke Azure Blob Storage menggunakan kelas CloudBlockBlob di Pustaka Klien Azure Storage untuk .NET. Contoh ini mengasumsikan bahwa arsip ZIP telah ditulis ke objek stream.

    string sasUrl = "https://productingestionbin1.blob.core.windows.net/ingestion/26920f66-b592-4439-9a9d-fb0f014902ec?sv=2014-02-14&sr=b&sig=usAN0kNFNnYE2tGQBI%2BARQWejX1Guiz7hdFtRhyK%2Bog%3D&se=2016-06-17T20:45:51Z&sp=rwl";
Microsoft.WindowsAzure.Storage.Blob.CloudBlockBlob blockBob =
    new Microsoft.WindowsAzure.Storage.Blob.CloudBlockBlob(new System.Uri(sasUrl));
await blockBob.UploadFromStreamAsync(stream);

  7. Terapkan pengiriman aplikasi dengan menjalankan metode berikut. Ini akan memperingatkan Pusat Mitra bahwa Anda selesai dengan pengiriman Anda dan bahwa pembaruan Anda sekarang harus diterapkan ke akun Anda.

    POST https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/commit

  8. Periksa status penerapan dengan menjalankan metode berikut untuk mendapatkan status pengiriman aplikasi.

    GET https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/status

    Untuk mengonfirmasi status pengiriman, tinjau nilai status di isi respons. Nilai ini harus berubah dari CommitStarted menjadi PraProses jika permintaan berhasil atau ke CommitFailed jika ada kesalahan dalam permintaan. Jika ada kesalahan, bidang statusDetails berisi detail lebih lanjut tentang kesalahan tersebut.

  9. Setelah penerapan berhasil diselesaikan, pengiriman dikirim ke Store untuk diserap. Anda dapat terus memantau kemajuan pengiriman dengan menggunakan metode sebelumnya, atau dengan mengunjungi Pusat Mitra.

Metode untuk mengelola peluncuran paket bertahap

Anda dapat meluncurkan paket yang diperbarui secara bertahap dalam pengiriman aplikasi ke persentase pelanggan aplikasi Anda di Windows 10 dan Windows 11. Ini memungkinkan Anda memantau umpan balik dan data analitik untuk paket tertentu untuk memastikan Anda yakin tentang pembaruan sebelum meluncurkannya secara lebih luas. Anda dapat mengubah persentase peluncuran (atau menghentikan pembaruan) untuk pengiriman yang diterbitkan tanpa harus membuat pengiriman baru. Untuk detail selengkapnya, termasuk instruksi tentang cara mengaktifkan dan mengelola peluncuran paket bertahap di Pusat Mitra, lihat artikel ini.

Untuk mengaktifkan peluncuran paket bertahap secara terprogram untuk pengiriman aplikasi, ikuti proses ini menggunakan metode di API pengiriman Microsoft Store:

  1. Buat pengiriman aplikasi atau dapatkan pengiriman aplikasi yang sudah ada.
  2. Dalam data respons, temukan sumber daya packageRollout , atur bidang isPackageRollout ke true, dan atur bidang packageRolloutPercentage ke persentase pelanggan aplikasi Anda yang harus mendapatkan paket yang diperbarui.
  3. Teruskan data pengiriman aplikasi yang diperbarui ke metode pengiriman aplikasi pembaruan .

Setelah peluncuran paket bertahap diaktifkan untuk pengiriman aplikasi, Anda dapat menggunakan metode berikut untuk mendapatkan, memperbarui, menghentikan, atau menyelesaikan peluncuran bertahap secara terprogram.

Metode URI Deskripsi
GET https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/packagerollout Mendapatkan info peluncuran bertahap untuk pengiriman aplikasi
POST https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/updatepackagerolloutpercentage Memperbarui persentase peluncuran bertahap untuk pengiriman aplikasi
POST https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/haltpackagerollout Menghentikan peluncuran bertahap untuk pengiriman aplikasi
POST https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/finalizepackagerollout Menyelesaikan peluncuran bertahap untuk pengiriman aplikasi

Contoh kode untuk mengelola pengiriman aplikasi

Artikel berikut ini menyediakan contoh kode terperinci yang menunjukkan cara membuat pengiriman aplikasi dalam beberapa bahasa pemrograman yang berbeda:

Modul StoreBroker PowerShell

Sebagai alternatif untuk memanggil API pengiriman Microsoft Store secara langsung, kami juga menyediakan modul PowerShell sumber terbuka yang mengimplementasikan antarmuka baris perintah di atas API. Modul ini disebut StoreBroker. Anda dapat menggunakan modul ini untuk mengelola pengiriman aplikasi, penerbangan, dan add-on dari baris perintah alih-alih memanggil API pengiriman Microsoft Store secara langsung, atau Anda cukup menelusuri sumber untuk melihat lebih banyak contoh tentang cara memanggil API ini. Modul StoreBroker secara aktif digunakan dalam Microsoft sebagai cara utama bahwa banyak aplikasi pihak pertama dikirimkan ke Store.

Untuk informasi selengkapnya, lihat halaman StoreBroker kami di GitHub.

Sumber daya data

Metode API pengiriman Microsoft Store untuk mengelola pengiriman aplikasi menggunakan sumber daya data JSON berikut.

Sumber daya pengiriman aplikasi

Sumber daya ini menjelaskan pengiriman aplikasi.

{
  "id": "1152921504621243540",
  "applicationCategory": "BooksAndReference_EReader",
  "pricing": {
    "trialPeriod": "FifteenDays",
    "marketSpecificPricings": {},
    "sales": [],
    "priceId": "Tier2",
    "isAdvancedPricingModel": true
  },
  "visibility": "Public",
  "targetPublishMode": "Manual",
  "targetPublishDate": "1601-01-01T00:00:00Z",
  "listings": {
    "en-us": {
      "baseListing": {
        "copyrightAndTrademarkInfo": "",
        "keywords": [
          "epub"
        ],
        "licenseTerms": "",
        "privacyPolicy": "",
        "supportContact": "",
        "websiteUrl": "",
        "description": "Description",
        "features": [
          "Free ebook reader"
        ],
        "releaseNotes": "",
        "images": [
          {
            "fileName": "contoso.png",
            "fileStatus": "Uploaded",
            "id": "1152921504672272757",
            "description": "Main page",
            "imageType": "Screenshot"
          }
        ],
        "recommendedHardware": [],
        "title": "Contoso ebook reader"
      },
      "platformOverrides": {
        "Windows81": {
          "description": "Ebook reader for Windows 8.1"
        }
      }
    }
  },
  "hardwarePreferences": [
    "Touch"
  ],
  "automaticBackupEnabled": false,
  "canInstallOnRemovableMedia": true,
  "isGameDvrEnabled": false,
  "gamingOptions": [],
  "hasExternalInAppProducts": false,
  "meetAccessibilityGuidelines": true,
  "notesForCertification": "",
  "status": "PendingCommit",
  "statusDetails": {
    "errors": [],
    "warnings": [],
    "certificationReports": []
  },
  "fileUploadUrl": "https://productingestionbin1.blob.core.windows.net/ingestion/387a9ea8-a412-43a9-8fb3-a38d03eb483d?sv=2014-02-14&sr=b&sig=sdd12JmoaT6BhvC%2BZUrwRweA%2Fkvj%2BEBCY09C2SZZowg%3D&se=2016-06-17T18:32:26Z&sp=rwl",
  "applicationPackages": [
    {
      "fileName": "contoso_app.appx",
      "fileStatus": "Uploaded",
      "id": "1152921504620138797",
      "version": "1.0.0.0",
      "architecture": "ARM",
      "languages": [
        "en-US"
      ],
      "capabilities": [
        "ID_RESOLUTION_HD720P",
        "ID_RESOLUTION_WVGA",
        "ID_RESOLUTION_WXGA"
      ],
      "minimumDirectXVersion": "None",
      "minimumSystemRam": "None",
      "targetDeviceFamilies": [
        "Windows.Mobile min version 10.0.10240.0"
      ]
    }
  ],
  "packageDeliveryOptions": {
    "packageRollout": {
        "isPackageRollout": false,
        "packageRolloutPercentage": 0.0,
        "packageRolloutStatus": "PackageRolloutNotStarted",
        "fallbackSubmissionId": "0"
    },
    "isMandatoryUpdate": false,
    "mandatoryUpdateEffectiveDate": "1601-01-01T00:00:00.0000000Z"
  },
  "enterpriseLicensing": "Online",
  "allowMicrosoftDecideAppAvailabilityToFutureDeviceFamilies": true,
  "allowTargetFutureDeviceFamilies": {
    "Desktop": false,
    "Mobile": true,
    "Holographic": true,
    "Xbox": false,
    "Team": true
  },
  "friendlyName": "Submission 2",
  "trailers": []
}

Sumber daya ini memiliki nilai berikut.

Nilai Jenis Deskripsi
id string ID pengiriman. ID ini tersedia dalam data respons untuk permintaan untuk membuat pengiriman aplikasi, mendapatkan semua aplikasi, dan mendapatkan aplikasi. Untuk pengiriman yang dibuat di Pusat Mitra, ID ini juga tersedia di URL untuk halaman pengiriman di Pusat Mitra.
applicationCategory string String yang menentukan kategori dan/atau subkategori untuk aplikasi Anda. Kategori dan subkataan digabungkan ke dalam satu string dengan karakter garis bawah '_', seperti BooksAndReference_EReader.
Harga objek Sumber daya harga yang berisi info harga untuk aplikasi.
Visibilitas string Visibilitas aplikasi. Ini bisa menjadi salah satu nilai berikut:
  • Tersembunyi
  • Publik
  • Privat
  • NotSet
targetPublishMode string Mode penerbitan untuk pengiriman. Ini bisa menjadi salah satu nilai berikut:
  • Segera
  • Manual
  • SpecificDate
targetPublishDate string Tanggal penerbitan untuk pengiriman dalam format ISO 8601, jika targetPublishMode diatur ke SpecificDate.
Daftar objek Kamus pasangan kunci dan nilai, di mana setiap kunci adalah kode negara dan setiap nilai adalah sumber daya daftar yang berisi info daftar untuk aplikasi.
hardwarePreferences array Array string yang menentukan preferensi perangkat keras untuk aplikasi Anda. Ini bisa menjadi salah satu nilai berikut:
  • Sentuhan
  • Keyboard
  • Mouse
  • Kamera
  • NfcHce
  • Nfc
  • BluetoothLE
  • Telephony
automaticBackupEnabled boolean Menunjukkan apakah Windows dapat menyertakan data aplikasi Anda dalam pencadangan otomatis ke OneDrive. Untuk informasi selengkapnya, lihat Deklarasi aplikasi.
canInstallOnRemovableMedia boolean Menunjukkan apakah pelanggan dapat menginstal aplikasi Anda ke penyimpanan yang dapat dilepas. Untuk informasi selengkapnya, lihat Deklarasi aplikasi.
isGameDvrEnabled boolean Menunjukkan apakah DVR game diaktifkan untuk aplikasi.
gamingOptions array Array yang berisi satu sumber daya opsi game yang menentukan pengaturan terkait game untuk aplikasi.
hasExternalInAppProducts boolean Menunjukkan apakah aplikasi Anda memungkinkan pengguna untuk melakukan pembelian di luar sistem perdagangan Microsoft Store. Untuk informasi selengkapnya, lihat Deklarasi aplikasi.
meetAccessibilityGuidelines boolean Menunjukkan apakah aplikasi Anda telah diuji untuk memenuhi panduan aksesibilitas. Untuk informasi selengkapnya, lihat Deklarasi aplikasi.
notesForCertification string Berisi catatan untuk sertifikasi untuk aplikasi Anda.
status string Status pengiriman. Ini bisa menjadi salah satu nilai berikut:
  • Tidak ada
  • Batal
  • PendingCommit
  • CommitStarted
  • CommitFailed
  • PendingPublication
  • Menerbitkan
  • Diterbitkan
  • PublishFailed
  • Preprocessing
  • PreProcessingFailed
  • Sertifikasi
  • CertificationFailed
  • Rilis
  • ReleaseFailed
statusDetails objek Sumber daya detail status yang berisi detail tambahan tentang status pengiriman, termasuk informasi tentang kesalahan apa pun.
fileUploadUrl string URI tanda tangan akses bersama (SAS) untuk mengunggah paket apa pun untuk pengiriman. Jika Anda menambahkan paket baru, mencantumkan gambar, atau file trailer untuk pengiriman, unggah arsip ZIP yang berisi paket dan gambar ke URI ini. Untuk informasi selengkapnya, lihat Membuat pengiriman aplikasi.
applicationPackages array Array sumber daya paket aplikasi yang memberikan detail tentang setiap paket dalam pengiriman.
packageDeliveryOptions objek Sumber daya opsi pengiriman paket yang berisi peluncuran paket bertahap dan pengaturan pembaruan wajib untuk pengiriman.
EnterpriseLicensing string Salah satu nilai nilai lisensi perusahaan yang menunjukkan perilaku lisensi perusahaan untuk aplikasi.
allowMicrosoftDecideAppAvailabilityToFutureDeviceFamilies boolean Menunjukkan apakah Microsoft diizinkan untuk membuat aplikasi tersedia untuk keluarga perangkat Windows 10 dan Windows 11 di masa mendatang.
allowTargetFutureDeviceFamilies objek Kamus pasangan kunci dan nilai, di mana setiap kunci adalah keluarga perangkat Windows 10 dan Windows 11 dan setiap nilai adalah boolean yang menunjukkan apakah aplikasi Anda diizinkan untuk menargetkan keluarga perangkat yang ditentukan.
friendlyName string Nama pengiriman yang mudah diingat, seperti yang ditunjukkan di Pusat Mitra. Nilai ini dihasilkan untuk Anda saat Anda membuat pengiriman.
Trailer array Array yang berisi hingga 15 sumber daya trailer yang mewakili trailer video untuk daftar aplikasi.

Sumber daya harga

Sumber daya ini berisi info harga untuk aplikasi. Sumber daya ini memiliki nilai berikut.

Nilai Jenis Deskripsi
trialPeriod string String yang menentukan periode uji coba untuk aplikasi. Ini bisa menjadi salah satu nilai berikut:
  • NoFreeTrial
  • OneDay
  • TrialNeverExpires
  • Tujuh Hari
  • Lima belas hari
  • Tiga Puluh Hari
marketSpecificPricings objek Kamus pasangan kunci dan nilai, di mana setiap kunci adalah kode negara ISO 3166-1 alpha-2 dua huruf dan setiap nilai adalah tingkat harga. Item ini mewakili harga kustom untuk aplikasi Anda di pasar tertentu. Setiap item dalam kamus ini mengambil alih harga dasar yang ditentukan oleh nilai priceId untuk pasar yang ditentukan.
penjualan array Tidak digunakan lagi. Array sumber daya penjualan yang berisi informasi penjualan untuk aplikasi.
priceId string Tingkat harga yang menentukan harga dasar untuk aplikasi.
isAdvancedPricingModel boolean Jika true, akun pengembang Anda memiliki akses ke set tingkat harga yang diperluas dari .99 USD hingga 1999.99 USD. Jika false, akun pengembang Anda memiliki akses ke set tingkat harga asli dari .99 USD hingga 999,99 USD. Untuk informasi selengkapnya tentang berbagai tingkatan, lihat tingkat harga.

Catatan Bidang ini bersifat baca-saja.

Jual sumber daya

Sumber daya ini berisi info penjualan untuk aplikasi.

Penting

Sumber daya Penjualan tidak lagi didukung, dan saat ini Anda tidak dapat mendapatkan atau memodifikasi data penjualan untuk pengiriman aplikasi menggunakan API pengiriman Microsoft Store. Di masa mendatang, kami akan memperbarui API pengiriman Microsoft Store untuk memperkenalkan cara baru untuk mengakses informasi penjualan secara terprogram untuk pengiriman aplikasi.

Sumber daya ini memiliki nilai berikut.

Nilai Jenis Deskripsi
nama string Nama penjualan.
basePriceId string Tingkat harga yang digunakan untuk harga dasar penjualan.
startDate string Tanggal mulai untuk penjualan dalam format ISO 8601.
endDate string Tanggal akhir untuk penjualan dalam format ISO 8601.
marketSpecificPricings objek Kamus pasangan kunci dan nilai, di mana setiap kunci adalah kode negara ISO 3166-1 alpha-2 dua huruf dan setiap nilai adalah tingkat harga. Item ini mewakili harga kustom untuk aplikasi Anda di pasar tertentu. Setiap item dalam kamus ini mengambil alih harga dasar yang ditentukan oleh nilai basePriceId untuk pasar yang ditentukan.

Mencantumkan sumber daya

Sumber daya ini berisi info daftar untuk aplikasi. Sumber daya ini memiliki nilai berikut.

Nilai Jenis Deskripsi
baseListing objek Info daftar dasar untuk aplikasi, yang menentukan info daftar default untuk semua platform.
platformOverrides objek Kamus pasangan kunci dan nilai, di mana setiap kunci adalah string yang mengidentifikasi platform yang akan mengambil alih info daftar, dan setiap nilai adalah sumber daya daftar dasar (hanya berisi nilai dari deskripsi ke judul) yang menentukan info daftar yang akan diambil alih untuk platform yang ditentukan. Kunci dapat memiliki nilai berikut:
  • Tidak dikenal
  • Windows80
  • Windows81
  • WindowsPhone71
  • WindowsPhone80
  • WindowsPhone81

Sumber daya daftar dasar

Sumber daya ini berisi info daftar dasar untuk aplikasi. Sumber daya ini memiliki nilai berikut.

Nilai Jenis Deskripsi
copyrightAndTrademarkInfo string Info hak cipta dan/atau merek dagang opsional.
kata kunci array Array kata kunci untuk membantu aplikasi Anda muncul di hasil pencarian.
licenseTerms string Ketentuan lisensi opsional untuk aplikasi Anda.
privacyPolicy string Nilai ini kedaluarsa. Untuk mengatur atau mengubah URL kebijakan privasi untuk aplikasi, Anda harus melakukan ini di halaman Properti di Pusat Mitra. Anda dapat menghilangkan nilai ini dari panggilan Anda ke API pengiriman. Jika Anda menetapkan nilai ini, nilai tersebut akan diabaikan.
supportContact string Nilai ini kedaluarsa. Untuk mengatur atau mengubah URL kontak dukungan atau alamat email untuk aplikasi, Anda harus melakukan ini di halaman Properti di Pusat Mitra. Anda dapat menghilangkan nilai ini dari panggilan Anda ke API pengiriman. Jika Anda menetapkan nilai ini, nilai tersebut akan diabaikan.
websiteUrl string Nilai ini kedaluarsa. Untuk mengatur atau mengubah URL halaman web untuk aplikasi, Anda harus melakukan ini di halaman Properti di Pusat Mitra. Anda dapat menghilangkan nilai ini dari panggilan Anda ke API pengiriman. Jika Anda menetapkan nilai ini, nilai tersebut akan diabaikan.
description string Deskripsi untuk daftar aplikasi.
features array Array hingga 20 string yang mencantumkan fitur untuk aplikasi Anda.
releaseNotes string Catatan rilis untuk aplikasi Anda.
images array Array sumber daya gambar dan ikon untuk daftar aplikasi.
recommendedHardware array Array hingga 11 string yang mencantumkan konfigurasi perangkat keras yang direkomendasikan untuk aplikasi Anda.
minimumHardware string Array hingga 11 string yang mencantumkan konfigurasi perangkat keras minimum untuk aplikasi Anda.
judul string Judul untuk daftar aplikasi.
shortDescription string Hanya digunakan untuk permainan. Deskripsi ini muncul di bagian Informasi dari Game Hub di Xbox One, dan membantu pelanggan memahami lebih lanjut tentang game Anda.
shortTitle string Versi yang lebih pendek dari nama produk Anda. Jika disediakan, nama yang lebih pendek ini mungkin muncul di berbagai tempat di Xbox One (selama penginstalan, di Prestasi, dll.) menggantikan judul lengkap produk Anda.
sortTitle string Jika produk Anda dapat dijadikan alfabet dengan cara yang berbeda, Anda dapat memasukkan versi lain di sini. Ini dapat membantu pelanggan menemukan produk dengan lebih cepat saat mencari.
voiceTitle string Nama alternatif untuk produk Anda yang, jika disediakan, dapat digunakan dalam pengalaman audio di Xbox One saat menggunakan Kinect atau headset.
devStudio string Tentukan nilai ini jika Anda ingin menyertakan bidang Dikembangkan menurut dalam daftar. (Bidang Diterbitkan oleh akan mencantumkan nama tampilan penerbit yang terkait dengan akun Anda, baik Anda memberikan nilai devStudio atau tidak.)

Sumber daya gambar

Sumber daya ini berisi data gambar dan ikon untuk daftar aplikasi. Untuk informasi selengkapnya tentang gambar dan ikon untuk daftar aplikasi, lihat Cuplikan layar dan gambar aplikasi. Sumber daya ini memiliki nilai berikut.

Nilai Jenis Deskripsi
fileName string Nama file gambar dalam arsip ZIP yang Anda unggah untuk pengiriman.
fileStatus string Status file gambar. Ini bisa menjadi salah satu nilai berikut:
  • Tidak ada
  • PendingUpload
  • Diunggah
  • PendingDelete
id string ID untuk gambar. Nilai ini disediakan oleh Pusat Mitra.
description string Deskripsi untuk gambar.
imageType string Menunjukkan jenis gambar. String berikut saat ini didukung.

Gambar cuplikan layar:

  • Cuplikan layar (gunakan nilai ini untuk cuplikan layar desktop)
  • MobileScreenshot
  • XboxScreenshot
  • SurfaceHubScreenshot
  • Cuplikan layar HoloLensS

Logo toko:

  • StoreLogo9x16
  • StoreLogoSquare
  • Ikon (gunakan nilai ini untuk logo 1:1 300 x 300 piksel)

Gambar promosi:

  • PromotionalArt16x9
  • PromotionalArtwork2400X1200

Gambar Xbox:

  • XboxBrandedKeyArt
  • XboxTitledHeroArt
  • XboxFeaturedPromotionalArt

Gambar promosi opsional:

  • SquareIcon358X358
  • BackgroundImage1000X800
  • PromotionalArtwork414X180

Sumber daya opsi game

Sumber daya ini berisi pengaturan terkait game untuk aplikasi. Nilai dalam sumber daya ini sesuai dengan pengaturan game untuk pengiriman di Pusat Mitra.

{
  "gamingOptions": [
    {
      "genres": [
        "Games_ActionAndAdventure",
        "Games_Casino"
      ],
      "isLocalMultiplayer": true,
      "isLocalCooperative": true,
      "isOnlineMultiplayer": false,
      "isOnlineCooperative": false,
      "localMultiplayerMinPlayers": 2,
      "localMultiplayerMaxPlayers": 12,
      "localCooperativeMinPlayers": 2,
      "localCooperativeMaxPlayers": 12,
      "isBroadcastingPrivilegeGranted": true,
      "isCrossPlayEnabled": false,
      "kinectDataForExternal": "Enabled"
    }
  ],
}

Sumber daya ini memiliki nilai berikut.

Nilai Jenis Deskripsi
Genre array Array dari satu atau beberapa string berikut yang menjelaskan genre permainan:
  • Games_ActionAndAdventure
  • Games_CardAndBoard
  • Games_Casino
  • Games_Educational
  • Games_FamilyAndKids
  • Games_Fighting
  • Games_Music
  • Games_Platformer
  • Games_PuzzleAndTrivia
  • Games_RacingAndFlying
  • Games_RolePlaying
  • Games_Shooter
  • Games_Simulation
  • Games_Sports
  • Games_Strategy
  • Games_Word
isLocalMultiplayer boolean Menunjukkan apakah game mendukung multipemain lokal.
isLocalCooperative boolean Menunjukkan apakah game mendukung co-op lokal.
isOnlineMultiplayer boolean Menunjukkan apakah game mendukung multipemain online.
isOnlineCooperative boolean Menunjukkan apakah game mendukung co-op online.
localMultiplayerMinPlayers int Menentukan jumlah minimum pemain yang didukung game untuk multipemain lokal.
localMultiplayerMaxPlayers int Menentukan jumlah maksimum pemain yang didukung game untuk multiplayer lokal.
localCooperativeMinPlayers int Menentukan jumlah minimum pemain yang didukung permainan untuk co-op lokal.
localCooperativeMaxPlayers int Menentukan jumlah maksimum pemain yang didukung permainan untuk co-op lokal.
isBroadcastingPrivilegeGranted boolean Menunjukkan apakah game mendukung siaran.
isCrossPlayEnabled boolean Menunjukkan apakah game mendukung sesi multipemain antara pemain di WINDOWS 10 dan PC Windows 11 dan Xbox.
kinectDataForExternal string Salah satu nilai string berikut yang menunjukkan apakah game dapat mengumpulkan data Kinect dan mengirimkannya ke layanan eksternal:
  • NotSet
  • Tidak dikenal
  • Aktif
  • Nonaktif

Catatan

Sumber daya gamingOptions ditambahkan pada Mei 2017, setelah API pengiriman Microsoft Store pertama kali dirilis kepada pengembang. Jika Anda membuat pengiriman untuk aplikasi melalui API pengiriman sebelum sumber daya ini diperkenalkan dan pengiriman ini masih berlangsung, sumber daya ini akan null untuk pengiriman untuk aplikasi sampai Anda berhasil melakukan pengiriman atau Anda menghapusnya. Jika sumber daya gamingOptions tidak tersedia untuk pengiriman untuk aplikasi, bidang hasAdvancedListingPermission dari sumber daya Aplikasi yang dikembalikan oleh metode dapatkan aplikasi adalah false.

Sumber daya detail status

Sumber daya ini berisi detail tambahan tentang status pengiriman. Sumber daya ini memiliki nilai berikut.

Nilai Jenis Deskripsi
errors objek Array sumber daya detail status yang berisi detail kesalahan untuk pengiriman.
Peringatan objek Array sumber daya detail status yang berisi detail peringatan untuk pengiriman.
certificationReports objek Array sumber daya laporan sertifikasi yang menyediakan akses ke data laporan sertifikasi untuk pengiriman. Anda dapat memeriksa laporan ini untuk informasi lebih lanjut jika sertifikasi gagal.

Sumber daya detail status

Sumber daya ini berisi informasi tambahan tentang kesalahan atau peringatan terkait untuk pengiriman. Sumber daya ini memiliki nilai berikut.

Nilai Jenis Deskripsi
kode string Kode status pengiriman yang menjelaskan jenis kesalahan atau peringatan.
detail string Pesan dengan detail selengkapnya tentang masalah ini.

Sumber daya paket aplikasi

Sumber daya ini berisi detail tentang paket aplikasi untuk pengiriman.

{
  "applicationPackages": [
    {
      "fileName": "contoso_app.appx",
      "fileStatus": "Uploaded",
      "id": "1152921504620138797",
      "version": "1.0.0.0",
      "architecture": "ARM",
      "languages": [
        "en-US"
      ],
      "capabilities": [
        "ID_RESOLUTION_HD720P",
        "ID_RESOLUTION_WVGA",
        "ID_RESOLUTION_WXGA"
      ],
      "minimumDirectXVersion": "None",
      "minimumSystemRam": "None",
      "targetDeviceFamilies": [
        "Windows.Mobile min version 10.0.10240.0"
      ]
    }
  ],
}

Sumber daya ini memiliki nilai berikut.

Catatan

Saat memanggil pembaruan metode pengiriman aplikasi , hanya nilai fileName, fileStatus, minimumDirectXVersion, dan minimumSystemRam objek ini yang diperlukan dalam isi permintaan. Nilai lainnya diisi oleh Pusat Mitra.

Nilai Jenis Deskripsi
fileName string Nama paket.
fileStatus string Status paket. Ini bisa menjadi salah satu nilai berikut:
  • Tidak ada
  • PendingUpload
  • Diunggah
  • PendingDelete
id string ID yang secara unik mengidentifikasi paket. Nilai ini disediakan oleh Pusat Mitra.
versi string Versi paket aplikasi. Untuk informasi selengkapnya, lihat Penomoran versi paket.
Arsitektur string Arsitektur paket (misalnya, ARM).
languages array Array kode bahasa untuk bahasa yang didukung aplikasi. Untuk informasi selengkapnya, lihat Bahasa yang didukung.
capabilities array Array kemampuan yang diperlukan oleh paket. Untuk informasi selengkapnya tentang kemampuan, lihat Deklarasi kemampuan aplikasi.
minimumDirectXVersion string Versi DirectX minimum yang didukung oleh paket aplikasi. Ini hanya dapat diatur untuk aplikasi yang menargetkan Windows 8.x. Untuk aplikasi yang menargetkan versi OS lainnya, nilai ini harus ada saat memanggil metode pengiriman aplikasi pembaruan tetapi nilai yang Anda tentukan diabaikan. Ini bisa menjadi salah satu nilai berikut:
  • Tidak ada
  • DirectX93
  • DirectX100
minimumSystemRam string RAM minimum yang diperlukan oleh paket aplikasi. Ini hanya dapat diatur untuk aplikasi yang menargetkan Windows 8.x. Untuk aplikasi yang menargetkan versi OS lainnya, nilai ini harus ada saat memanggil metode pengiriman aplikasi pembaruan tetapi nilai yang Anda tentukan diabaikan. Ini bisa menjadi salah satu nilai berikut:
  • Tidak ada
  • Memory2GB
targetDeviceFamilies array Array string yang mewakili keluarga perangkat yang ditargetkan paket. Nilai ini hanya digunakan untuk paket yang menargetkan Windows 10; untuk paket yang menargetkan rilis sebelumnya, nilai ini memiliki nilai Tidak Ada. String keluarga perangkat berikut saat ini didukung untuk paket Windows 10 dan Windows 11, di mana {0} adalah string versi Windows 10 atau Windows 11 seperti 10.0.10240.0, 10.0.10586.0 atau 10.0.14393.0:
  • Versi min Windows.Universal {0}
  • Versi min Windows.Desktop {0}
  • Versi min Windows.Mobile {0}
  • Versi min Windows.Xbox {0}
  • Versi min Windows.Holographic {0}

id="certification-report-resource"

Sumber daya laporan sertifikasi

Sumber daya ini menyediakan akses ke data laporan sertifikasi untuk pengiriman. Sumber daya ini memiliki nilai berikut.

Nilai Jenis Deskripsi
tanggal string Tanggal dan waktu laporan dibuat, dalam format ISO 8601.
reportUrl string URL tempat Anda dapat mengakses laporan.

Sumber daya opsi pengiriman paket

Sumber daya ini berisi peluncuran paket bertahap dan pengaturan pembaruan wajib untuk pengiriman.

{
  "packageDeliveryOptions": {
    "packageRollout": {
        "isPackageRollout": false,
        "packageRolloutPercentage": 0,
        "packageRolloutStatus": "PackageRolloutNotStarted",
        "fallbackSubmissionId": "0"
    },
    "isMandatoryUpdate": false,
    "mandatoryUpdateEffectiveDate": "1601-01-01T00:00:00.0000000Z"
  },
}

Sumber daya ini memiliki nilai berikut.

Nilai Jenis Deskripsi
packageRollout objek Sumber daya peluncuran paket yang berisi pengaturan peluncuran paket bertahap untuk pengiriman.
isMandatoryUpdate boolean Menunjukkan apakah Anda ingin memperlakukan paket dalam pengiriman ini sebagai wajib untuk menginstal pembaruan aplikasi sendiri. Untuk informasi selengkapnya tentang paket wajib untuk menginstal pembaruan aplikasi sendiri, lihat Mengunduh dan menginstal pembaruan paket untuk aplikasi Anda.
mandatoryUpdateEffectiveDate tanggal Tanggal dan waktu ketika paket dalam pengiriman ini menjadi wajib, dalam format ISO 8601 dan zona waktu UTC.

Sumber daya peluncuran paket

Sumber daya ini berisi pengaturan peluncuran paket bertahap untuk pengiriman. Sumber daya ini memiliki nilai berikut.

Nilai Jenis Deskripsi
isPackageRollout boolean Menunjukkan apakah peluncuran paket bertahap diaktifkan untuk pengiriman.
packageRolloutPercentage float Persentase pengguna yang akan menerima paket dalam peluncuran bertahap.
packageRolloutStatus string Salah satu string berikut yang menunjukkan status peluncuran paket bertahap:
  • PackageRolloutNotStarted
  • PackageRolloutInProgress
  • PackageRolloutComplete
  • PackageRolloutStopped
fallbackSubmissionId string ID pengiriman yang akan diterima oleh pelanggan yang tidak mendapatkan paket peluncuran bertahap.

Catatan

Nilai packageRolloutStatus dan fallbackSubmissionId ditetapkan oleh Pusat Mitra, dan tidak dimaksudkan untuk ditetapkan oleh pengembang. Jika Anda menyertakan nilai-nilai ini dalam isi permintaan, nilai-nilai ini akan diabaikan.

Sumber daya trailer

Sumber daya ini mewakili trailer video untuk daftar aplikasi. Nilai dalam sumber daya ini sesuai dengan opsi trailer untuk pengiriman di Pusat Mitra.

Anda dapat menambahkan hingga 15 sumber daya trailer ke array trailer dalam sumber daya pengiriman aplikasi. Untuk mengunggah file video trailer dan gambar mini untuk pengiriman, tambahkan file-file ini ke arsip ZIP yang sama yang berisi paket dan mencantumkan gambar untuk pengiriman, lalu unggah arsip ZIP ini ke URI tanda tangan akses bersama (SAS) untuk pengiriman. Untuk informasi selengkapnya tentang mengunggah arsip ZIP ke SAS URI, lihat Membuat pengiriman aplikasi.

{
  "trailers": [
    {
      "id": "1158943556954955699",
      "videoFileName": "Trailers\\ContosoGameTrailer.mp4",
      "videoFileId": "1159761554639123258",
      "trailerAssets": {
        "en-us": {
          "title": "Contoso Game",
          "imageList": [
            {
              "fileName": "Images\\ContosoGame-Thumbnail.png",
              "id": "1155546904097346923",
              "description": "This is a still image from the video."
            }
          ]
        }
      }
    }
  ]
}

Sumber daya ini memiliki nilai berikut.

Nilai Jenis Deskripsi
id string ID untuk trailer. Nilai ini disediakan oleh Pusat Mitra.
videoFileName string Nama file video trailer dalam arsip ZIP yang berisi file untuk pengiriman.
videoFileId string ID untuk file video trailer. Nilai ini disediakan oleh Pusat Mitra.
trailerAssets objek Kamus pasangan kunci dan nilai, di mana setiap kunci adalah kode bahasa dan setiap nilai adalah sumber daya aset trailer yang berisi aset khusus lokal tambahan untuk trailer. Untuk informasi selengkapnya tentang kode bahasa yang didukung, lihat Bahasa yang didukung.

Catatan

Sumber daya trailer ditambahkan pada Mei 2017, setelah API pengiriman Microsoft Store pertama kali dirilis kepada pengembang. Jika Anda membuat pengiriman untuk aplikasi melalui API pengiriman sebelum sumber daya ini diperkenalkan dan pengiriman ini masih berlangsung, sumber daya ini akan null untuk pengiriman untuk aplikasi sampai Anda berhasil melakukan pengiriman atau Anda menghapusnya. Jika sumber daya trailer tidak tersedia untuk pengiriman untuk aplikasi, bidang hasAdvancedListingPermission dari sumber daya Aplikasi yang dikembalikan oleh metode dapatkan aplikasi adalah false.

Sumber daya aset trailer

Sumber daya ini berisi aset khusus lokal tambahan untuk trailer yang ditentukan dalam sumber daya trailer. Sumber daya ini memiliki nilai berikut.

Nilai Jenis Deskripsi
judul string Judul trailer yang dilokalkan. Judul ditampilkan saat pengguna memutar trailer dalam mode layar penuh.
imageList array Array yang berisi satu sumber daya gambar yang menyediakan gambar mini untuk trailer. Anda hanya dapat menyertakan satu sumber daya gambar dalam array ini.

Sumber daya gambar (untuk trailer)

Sumber daya ini menjelaskan gambar mini untuk trailer. Sumber daya ini memiliki nilai berikut.

Nilai Jenis Deskripsi
fileName string Nama file gambar mini dalam arsip ZIP yang Anda unggah untuk pengiriman.
id string ID untuk gambar mini. Nilai ini disediakan oleh Pusat Mitra.
description string Deskripsi untuk gambar mini. Nilai ini hanya metadata, dan tidak ditampilkan kepada pengguna.

Enum

Metode ini menggunakan enum berikut.

Tingkat harga

Nilai berikut mewakili tingkat harga yang tersedia di sumber daya sumber daya harga untuk pengiriman aplikasi.

Nilai Deskripsi
Base Tingkat harga tidak ditetapkan; gunakan harga dasar untuk aplikasi.
Tidak Tersedia Aplikasi tidak tersedia di wilayah yang ditentukan.
Gratis Aplikasi ini gratis.
Tingkatxxx String yang menentukan tingkat harga untuk aplikasi, dalam format Tierxxxx. Saat ini, rentang tingkat harga berikut didukung:

  • Jika nilai isAdvancedPricingModel dari sumber daya hargabenar, nilai tingkat harga yang tersedia untuk akun Anda adalah Tier1012 - Tier1424.
  • Jika nilai isAdvancedPricingModel dari sumber daya hargasalah, nilai tingkat harga yang tersedia untuk akun Anda adalah Tier2 - Tier96.
Untuk melihat tabel lengkap tingkat harga yang tersedia untuk akun pengembang Anda, termasuk harga khusus pasar yang terkait dengan setiap tingkatan, buka halaman Harga dan ketersediaan untuk salah satu pengiriman aplikasi Anda di Pusat Mitra dan klik tautan tabel tampilan di bagian Pasar dan harga kustom (untuk beberapa akun pengembang, tautan ini ada di bagian Harga ).

Nilai lisensi perusahaan

Nilai berikut mewakili perilaku lisensi organisasi untuk aplikasi. Untuk informasi selengkapnya tentang opsi ini, lihat Opsi lisensi organisasi.

Catatan

Meskipun Anda dapat mengonfigurasi opsi lisensi organisasi untuk pengiriman aplikasi melalui API pengiriman, Anda tidak dapat menggunakan API ini untuk menerbitkan pengiriman untuk pembelian volume melalui Microsoft Store untuk Bisnis dan Microsoft Store untuk Pendidikan. Untuk menerbitkan pengiriman ke Microsoft Store untuk Bisnis dan Microsoft Store untuk Pendidikan, Anda harus menggunakan Pusat Mitra.

Nilai Deskripsi
Tidak ada Jangan membuat aplikasi Anda tersedia untuk perusahaan dengan lisensi volume yang dikelola Store (online).
Online Sediakan aplikasi Anda untuk perusahaan dengan lisensi volume yang dikelola toko (online).
OnlineAndOffline Sediakan aplikasi Anda untuk perusahaan dengan lisensi volume yang dikelola Store (online), dan buat aplikasi Anda tersedia untuk perusahaan melalui lisensi yang terputus (offline).

Kode status pengiriman

Nilai berikut mewakili kode status pengiriman.

Nilai Deskripsi
Tidak ada Tidak ada kode yang ditentukan.
InvalidArchive Arsip ZIP yang berisi paket tidak valid atau memiliki format arsip yang tidak dikenal.
MissingFiles Arsip ZIP tidak memiliki semua file yang tercantum dalam data pengiriman Anda, atau file tersebut berada di lokasi yang salah dalam arsip.
PackageValidationFailed Satu atau beberapa paket dalam pengiriman Anda gagal divalidasi.
InvalidParameterValue Salah satu parameter dalam isi permintaan tidak valid.
InvalidOperation Operasi yang Anda coba tidak valid.
InvalidState Operasi yang Anda coba tidak valid untuk status penerbangan paket saat ini.
ResourceNotFound Penerbangan paket yang ditentukan tidak dapat ditemukan.
ServiceError Kesalahan layanan internal mencegah permintaan berhasil. Coba permintaan lagi.
ListingOptOutWarning Pengembang menghapus daftar dari pengiriman sebelumnya, atau tidak menyertakan informasi daftar yang didukung oleh paket.
ListingOptInWarning Pengembang menambahkan daftar.
UpdateOnlyWarning Pengembang mencoba menyisipkan sesuatu yang hanya memiliki dukungan pembaruan.
Lainnya Pengiriman dalam keadaan tidak dikenal atau tidak dikategorikan.
PackageValidationWarning Proses validasi paket menghasilkan peringatan.