Bagikan melalui

Mendapatkan add-on untuk aplikasi

  • Artikel

Gunakan metode ini di API pengiriman Microsoft Store untuk mencantumkan add-on untuk aplikasi yang didaftarkan ke akun Pusat Mitra Anda.

Prasyarat

Untuk menggunakan metode ini, Anda harus terlebih dahulu melakukan hal berikut:

  • Jika Anda belum melakukannya, selesaikan semua prasyarat untuk API pengiriman Microsoft Store.
  • Dapatkan token akses Azure ACTIVE Directory untuk digunakan di header permintaan untuk metode ini. Setelah mendapatkan token akses, Anda memiliki waktu 60 menit untuk menggunakan token akses sebelum masa berlakunya habis. Setelah token kedaluwarsa, Anda dapat memperoleh yang baru.

Minta

Metode ini memiliki sintaks berikut. Lihat bagian berikut untuk contoh penggunaan dan deskripsi header dan isi permintaan.

Metode URI Permintaan
GET https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/listinappproducts

Header permintaan

Header Tipe Deskripsi
Authorization string Harus diisi. Token akses Microsoft Azure ACTIVE Directory dalam bentuk token> Pembawa<.

Parameter permintaan

Nama Tipe Deskripsi Wajib diisi
applicationId string ID Toko aplikasi yang ingin Anda ambil add-onnya. Untuk informasi selengkapnya tentang ID Penyimpanan, lihat Menampilkan detail identitas aplikasi. Ya
atas int Jumlah item yang akan dikembalikan dalam permintaan (yaitu, jumlah add-on yang akan dikembalikan). Jika aplikasi memiliki lebih banyak add-on daripada nilai yang Anda tentukan dalam kueri, isi respons menyertakan jalur URI relatif yang dapat Anda tambahkan ke metode URI untuk meminta halaman data berikutnya. No
skip int Jumlah item yang akan dilewati dalam kueri sebelum mengembalikan item yang tersisa. Gunakan parameter ini untuk halaman melalui himpunan data. Misalnya, top=10 dan skip=0 mengambil item 1 sampai 10, top=10 dan skip=10 mengambil item 11 hingga 20, dan sebagainya. No

Isi permintaan

Jangan berikan isi permintaan untuk metode ini.

Contoh permintaan

Contoh berikut menunjukkan cara mencantumkan semua add-on untuk aplikasi.

GET https://manage.devcenter.microsoft.com/v1.0/my/applications/9NBLGGH4R315/listinappproducts HTTP/1.1
Authorization: Bearer <your access token>

Contoh berikut menunjukkan cara mencantumkan 10 add-on pertama untuk aplikasi.

GET https://manage.devcenter.microsoft.com/v1.0/my/applications/9NBLGGH4R315/listinappproducts?top=10 HTTP/1.1
Authorization: Bearer <your access token>

Respons

Contoh berikut menunjukkan isi respons JSON yang dikembalikan oleh permintaan yang berhasil untuk 10 add-on pertama untuk aplikasi dengan total 53 add-on. Untuk brevity, contoh ini hanya menunjukkan data untuk tiga add-on pertama yang dikembalikan oleh permintaan. Untuk detail selengkapnya tentang nilai dalam isi respons, lihat bagian berikut ini.

{
  "@nextLink": "applications/9NBLGGH4R315/listinappproducts/?skip=10&top=10",
  "value": [
    {
      "inAppProductId": "9NBLGGH4TNMP"
    },
    {
      "inAppProductId": "9NBLGGH4TNMN"
    },
    {
      "inAppProductId": "9NBLGGH4TNNR"
    },
    // Next 7 add-ons  are omitted for brevity ...
  ],
  "totalCount": 53
}

Isi respons

Nilai Tipe Deskripsi
@nextLink string Jika ada halaman data tambahan, string ini berisi jalur relatif yang dapat Anda tambahkan ke URI permintaan dasar https://manage.devcenter.microsoft.com/v1.0/my/ untuk meminta halaman data berikutnya. Misalnya, jika parameter atas isi permintaan awal diatur ke 10 tetapi ada 50 add-on untuk aplikasi, isi respons akan menyertakan @nextLink nilai applications/{applicationid}/listinappproducts/?skip=10&top=10, yang menunjukkan bahwa Anda dapat memanggil https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationid}/listinappproducts/?skip=10&top=10 untuk meminta 10 add-on berikutnya.
value array Array objek yang mencantumkan ID Toko dari setiap add-on untuk aplikasi yang ditentukan. Untuk informasi selengkapnya tentang data di setiap objek, lihat sumber daya add-on.
totalCount int Jumlah total baris dalam hasil data untuk kueri (yaitu, jumlah total add-on untuk aplikasi yang ditentukan).

Kode kesalahan

Jika permintaan tidak berhasil diselesaikan, respons akan berisi salah satu kode kesalahan HTTP berikut.

Kode kesalahan Deskripsi
404 Tidak ada add-on yang ditemukan.
409 Add-on menggunakan fitur Pusat Mitra yang saat ini tidak didukung oleh API pengiriman Microsoft Store.