Dapatkan semua add-on

  • Artikel

Gunakan metode ini di API pengiriman Microsoft Store untuk mengambil data untuk semua add-on untuk semua aplikasi yang terdaftar di 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 AD untuk digunakan di header permintaan untuk metode ini. Setelah mendapatkan token akses, Anda memiliki waktu 60 menit untuk menggunakannya 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/inappproducts

Meminta kop

Header Jenis Deskripsi
Authorization string Wajib diisi. Token akses Azure AD dalam bentukToken>pembawa<.

Parameter permintaan

Semua parameter permintaan bersifat opsional untuk metode ini. Jika Anda memanggil metode ini tanpa parameter, respons berisi data untuk semua add-on untuk semua aplikasi yang terdaftar di akun Anda.

Parameter Jenis Deskripsi Diperlukan
top int Jumlah item yang akan dikembalikan dalam permintaan (yaitu, jumlah add-on yang akan dikembalikan). Jika akun Anda 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. Tidak
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. Tidak

Isi permintaan

Jangan berikan isi permintaan untuk metode ini.

Contoh permintaan

Contoh berikut menunjukkan cara mengambil semua data add-on untuk semua aplikasi yang terdaftar di akun Anda.

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

Contoh berikut menunjukkan cara mengambil 10 add-on pertama saja.

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

Respons

Contoh berikut menunjukkan isi respons JSON yang dikembalikan oleh permintaan yang berhasil untuk 5 add-on pertama yang didaftarkan ke akun pengembang dengan total add-on 1072. Untuk keringkasan, contoh ini hanya menunjukkan data untuk dua add-on pertama yang dikembalikan oleh permintaan. Untuk detail selengkapnya tentang nilai dalam isi respons, lihat bagian berikut ini.

{
  "@nextLink": "inappproducts/?skip=5&top=5",
  "value": [
    {
      "applications": {
        "value": [
          {
            "id": "9NBLGGH4R315",
            "resourceLocation": "applications/9NBLGGH4R315"
          }
        ],
        "totalCount": 1
      },
      "id": "9NBLGGH4TNMP",
      "productId": "a8b8310b-fa8d-4da0-aca0-577ef6dce4dd",
      "productType": "Consumable",
      "pendingInAppProductSubmission": {
        "id": "1152921504621243619",
        "resourceLocation": "inappproducts/9NBLGGH4TNMP/submissions/1152921504621243619"
      },
      "lastPublishedInAppProductSubmission": {
        "id": "1152921504621243705",
        "resourceLocation": "inappproducts/9NBLGGH4TNMP/submissions/1152921504621243705"
      }
    },
    {
      "applications": {
        "value": [
          {
            "id": "9NBLGGH4R315",
            "resourceLocation": "applications/9NBLGGH4R315"
          }
        ],
        "totalCount": 1
      },
      "id": "9NBLGGH4TNMN",
      "productId": "6a3c9788-a350-448a-bd32-16160a13018a",
      "productType": "Consumable",
      "pendingInAppProductSubmission": {
        "id": "1152921504621243538",
        "resourceLocation": "inappproducts/9NBLGGH4TNMN/submissions/1152921504621243538"
      },
      "lastPublishedInAppProductSubmission": {
        "id": "1152921504621243106",
        "resourceLocation": "inappproducts/9NBLGGH4TNMN/submissions/1152921504621243106"
      }
    },

  // Other add-ons omitted for brevity...
  ],
  "totalCount": 1072
}

Isi Respons

Nilai Jenis 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 100 add-on yang terdaftar ke akun Anda, isi respons akan menyertakan @nextLink nilai inappproducts?skip=10&top=10, yang menunjukkan bahwa Anda dapat memanggil https://manage.devcenter.microsoft.com/v1.0/my/inappproducts?skip=10&top=10 untuk meminta 10 add-on berikutnya.
nilai array Array yang berisi objek yang menyediakan informasi tentang setiap add-on. Untuk informasi selengkapnya, lihat sumber daya add-on.
totalCount int Jumlah objek aplikasi dalam array nilai isi respons.

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 Aplikasi atau add-on menggunakan fitur Pusat Mitra yang saat ini tidak didukung oleh API pengiriman Microsoft Store.