Kueri untuk produk

  • Artikel

Gunakan metode ini di API pengumpulan Microsoft Store untuk mendapatkan semua produk yang dimiliki pelanggan untuk aplikasi yang terkait dengan ID klien Azure AD Anda. Anda dapat mencakup kueri Anda ke produk tertentu, atau menggunakan filter lain.

Metode ini dirancang untuk dipanggil oleh layanan Anda sebagai respons terhadap pesan dari aplikasi Anda. Layanan Anda tidak boleh melakukan polling secara teratur untuk semua pengguna sesuai jadwal.

Pustaka Microsoft.StoreServices menyediakan fungsionalitas metode ini melalui STOREServicesClient.CollectionsQueryAsync API.

Prasyarat

Untuk menggunakan metode ini, Anda memerlukan:

  • Token akses Azure AD yang memiliki nilai https://onestore.microsoft.comURI audiens .
  • Kunci ID Microsoft Store yang mewakili identitas pengguna yang produknya ingin Anda dapatkan.

Untuk informasi selengkapnya, lihat Mengelola pemberian izin produk dari layanan.

Minta

Minta sintaks

Metode URI Permintaan
KIRIM https://collections.mp.microsoft.com/v6.0/collections/query

Meminta header

Header Jenis Deskripsi
Authorization string Wajib diisi. Token akses Azure AD dalam bentuktoken>Pembawa<.
Host string Harus diatur ke nilai collections.mp.microsoft.com.
Panjang-Konten nomor Panjang isi permintaan.
Jenis-Konten string Menentukan jenis permintaan dan respons. Saat ini, satu-satunya nilai yang didukung adalah aplikasi/json.

Isi permintaan

Parameter Jenis Deskripsi Diperlukan
penerima manfaat daftar<UserIdentity> Daftar objek UserIdentity yang mewakili pengguna yang dikueri untuk produk. Untuk informasi selengkapnya, lihat tabel di bawah ini. Ya
continuationToken string Jika ada beberapa set produk, isi respons mengembalikan token kelanjutan saat batas halaman tercapai. Berikan token kelanjutan tersebut di sini dalam panggilan berikutnya untuk mengambil produk yang tersisa. Tidak
maxPageSize nomor Jumlah maksimum produk yang akan dikembalikan dalam satu respons. Nilai default dan maksimum adalah 100. Tidak
modifiedAfter tanggalwaktu Jika ditentukan, layanan hanya mengembalikan produk yang telah dimodifikasi setelah tanggal ini. Tidak
parentProductId string Jika ditentukan, layanan hanya mengembalikan add-on yang sesuai dengan aplikasi yang ditentukan. Tidak
productSkuIds daftar<ProductSkuId> Jika ditentukan, layanan hanya mengembalikan produk yang berlaku untuk pasangan produk/SKU yang disediakan. Untuk informasi selengkapnya, lihat tabel di bawah ini. Tidak
productTypes string daftar<> Menentukan jenis produk mana yang akan dikembalikan dalam hasil kueri. Jenis produk yang didukung adalah Application, Durable, Game, dan UnmanagedConsumable. Ya
validityType string Saat diatur ke Semua, semua produk untuk pengguna akan dikembalikan, termasuk item yang kedaluwarsa. Ketika diatur ke Valid, hanya produk yang valid pada saat ini yang dikembalikan (yaitu, mereka memiliki status aktif, tanggal < mulai sekarang, dan tanggal > akhir sekarang). Tidak

Objek UserIdentity berisi parameter berikut.

Parameter Jenis Deskripsi Diperlukan
identityType string Tentukan nilai string b2b. Ya
identityValue string Kunci ID Microsoft Store yang mewakili identitas pengguna yang ingin Anda kueri produknya. Ya
localTicketReference string Pengidentifikasi yang diminta untuk produk yang dikembalikan. Item yang dikembalikan dalam isi respons akan memiliki localTicketReference yang cocok. Kami menyarankan agar Anda menggunakan nilai yang sama dengan klaim userId di kunci ID Microsoft Store. Ya

Objek ProductSkuId berisi parameter berikut.

Parameter Jenis Deskripsi Diperlukan
productId string ID Toko untuk produk di katalog Microsoft Store. Contoh ID Penyimpanan untuk produk adalah 9NBLGGH42CFD. Ya
skuId string ID Toko untuk SKU produk di katalog Microsoft Store. Contoh ID Store untuk SKU adalah 0010. Ya

Contoh permintaan

POST https://collections.mp.microsoft.com/v6.0/collections/query HTTP/1.1
Authorization: Bearer eyJ0eXAiOiJKV1Q…….
Host: collections.mp.microsoft.com
Content-Length: 2531
Content-Type: application/json

{
  "maxPageSize": 100,
  "beneficiaries": [
    {
      "localTicketReference": "1055521810674918",
      "identityValue": "eyJ0eXAiOiJ……",
      "identityType": "b2b"
    }
  ],
  "modifiedAfter": "\/Date(-62135568000000)\/",
  "productSkuIds": [
    {
      "productId": "9NBLGGH5WVP6",
      "skuId": "0010"
    }
  ],
  "productTypes": [
    "UnmanagedConsumable"
  ],
  "validityType": "All"
}

Respons

Isi Respons

Parameter Jenis Deskripsi Diperlukan
continuationToken string Jika ada beberapa set produk, token ini dikembalikan ketika batas halaman tercapai. Anda dapat menentukan token kelanjutan ini dalam panggilan berikutnya untuk mengambil produk yang tersisa. Tidak
item CollectionItemContractV6 Array produk untuk pengguna yang ditentukan. Untuk informasi selengkapnya, lihat tabel di bawah ini. Tidak

Objek CollectionItemContractV6 berisi parameter berikut.

Parameter Jenis Deskripsi Diperlukan
acquiredDate tanggalwaktu Tanggal pengguna memperoleh item. Ya
campaignId string ID kampanye yang disediakan pada waktu pembelian untuk item ini. Tidak
devOfferId string ID penawaran dari pembelian dalam aplikasi. Tidak
endDate tanggalwaktu Tanggal akhir item. Ya
fulfillmentData string daftar<> T/A Tidak
inAppOfferToken string String ID produk yang ditentukan pengembang yang ditetapkan ke item di Pusat Mitra. Contoh ID produk adalah product123. Tidak
itemId string ID yang mengidentifikasi item koleksi ini dari item lain yang dimiliki pengguna. ID ini unik per produk. Ya
localTicketReference string ID localTicketReference yang disediakan sebelumnya dalam isi permintaan. Ya
modifiedDate tanggalwaktu Tanggal item ini terakhir diubah. Ya
orderId string Jika ada, ID pesanan tempat item ini diperoleh. Tidak
orderLineItemId string Jika ada, item baris dari urutan tertentu yang item ini diperoleh. Tidak
ownershipType string String OwnedByBeneficiary. Ya
productId string ID Toko untuk produk di katalog Microsoft Store. Contoh ID Penyimpanan untuk produk adalah 9NBLGGH42CFD. Ya
productType string Salah satu jenis produk berikut: Application, Durable, dan UnmanagedConsumable. Ya
purchasedCountry string T/A Tidak
Pembeli IdentityContractV6 Jika ada, ini mewakili identitas pembeli item. Lihat detail untuk objek ini di bawah ini. Tidak
quantity nomor Kuantitas item. Saat ini, ini akan selalu menjadi 1. Tidak
skuId string ID Toko untuk SKU produk di katalog Microsoft Store. Contoh ID Store untuk SKU adalah 0010. Ya
skuType string Jenis SKU. Nilai yang mungkin termasuk Uji Coba, Penuh, dan Sewa. Ya
startDate tanggalwaktu Tanggal item mulai valid. Ya
status string Status item. Nilai yang mungkin termasuk Aktif, Kedaluwarsa, Dicabut, dan Dilarang. Ya
tag string daftar<> T/A Ya
transactionId guid ID transaksi sebagai hasil dari pembelian item ini. Dapat digunakan untuk melaporkan item yang terpenuhi. Ya

Objek IdentityContractV6 berisi parameter berikut.

Parameter Jenis Deskripsi Diperlukan
identityType string Berisi nilai pub. Ya
identityValue string Nilai string publisherUserId dari kunci ID Microsoft Store yang ditentukan. Ya

Contoh respons

HTTP/1.1 200 OK
Content-Length: 7241
Content-Type: application/json
MS-CorrelationId: 699681ce-662c-4841-920a-f2269b2b4e6c
MS-RequestId: a9988cf9-652b-4791-beba-b0e732121a12
MS-CV: xu2HW6SrSkyfHyFh.0.1
MS-ServerId: 020022359
Date: Tue, 22 Sep 2015 20:28:18 GMT

{
  "items" : [
    {
      "acquiredDate" : "2015-09-22T19:22:51.2068724+00:00",
      "devOfferId" : "f9587c53-540a-498b-a281-8a349491ed47",
      "endDate" : "9999-12-31T23:59:59.9999999+00:00",
      "fulfillmentData" : [],
      "inAppOfferToken" : "consumable2",
      "itemId" : "4b8fbb13127a41f299270ea668681c1d",
      "localTicketReference" : "1055521810674918",
      "modifiedDate" : "2015-09-22T19:22:51.2513155+00:00",
      "orderId" : "4ba5960d-4ec6-4a81-ac20-aafce02ddf31",
      "ownershipType" : "OwnedByBeneficiary",
      "productId" : "9NBLGGH5WVP6",
      "productType" : "UnmanagedConsumable",
      "purchaser" : {
        "identityType" : "pub",
        "identityValue" : "user123"
      },
      "skuId" : "0010",
      "skuType" : "Full",
      "startDate" : "2015-09-22T19:22:51.2068724+00:00",
      "status" : "Active",
      "tags" : [],
      "transactionId" : "4ba5960d-4ec6-4a81-ac20-aafce02ddf31"
    }
  ]
}