Bagikan melalui

Referensi dokumen pengiriman item katalog

Anda harus menyertakan data dalam format JSON saat mengirimkan item ke katalog. Artikel ini menjelaskan properti yang valid untuk dokumen tersebut. JSON ini adalah contoh:

{
  "modelVersion": "1.0.0.0",
  "operation": "CreateOrUpdate",
  "sourcePortal": 526430005,
  "businessJustification": "Power Platform custom connector for Conference API",
  "publisherDetails": {
    "publisherId": "ContosoConferencesTeam",
    "publisherDisplayName": "Catalog Conferences Team"
  },
  "catalogItemDefinition": {
    "id": "ContosoConferencesCustomConnector",
    "displayName": "Contoso Conference Custom Connector",
    "description": "Demo Custom connector to query Conference Speakers & Sessions",
    "offer": {
      "type": "Component_Collection",
      "deploymentType": "Normal",
      "engineeringName": {
        "firstName": "Jennifer",
        "lastName": "Wilkins",
        "email": "jwilkins@contoso.com",
        "phoneNumber": "555-111-1234"
      },
      "supportName": {
        "firstName": "Aidan",
        "lastName": "Hunt",
        "email": "ahunt@contoso.com",
        "phoneNumber": "555-111-1234"
      }
    },
      "packageFile": {
         "name": "packageFileName.zip",
         "filesaslink": "https://Contoso.blob.core.windows.net/ContosoConferencesCustomConnector/packageFileName.zip"
      }
  }
}

Tabel ini menjelaskan properti untuk dokumen pengiriman:

Harta benda Tipe Diperlukan Description
modelVersion string Tidak. Nomor versi dokumen pengiriman. Defaultnya adalah 1.0.0.0.
sourcePortal int Tidak. Mengidentifikasi sumber permintaan ini. 526430005 Default yang merupakan PAC CLI. Untuk sumber lain, gunakan 526430000. Fungsi mengembalikan mspcat_GetPowerCatalogDetails daftar lengkap. Properti mspcat_GetPowerCatalogDetailsResponse.CatalogDetails.sourceOptions mencantumkan opsi yang tersedia.
submissionId panduan Tidak. Guid untuk mengidentifikasi pengiriman. Nilai ini adalah kunci asing untuk memungkinkan penautan permintaan ke sistem lain.
operation string Yes Untuk ekspansi di masa depan dan saat ini tidak dihormati. Jenis operasi yang akan digunakan. Nilai yang valid:
- CreateOrUpdate (Default)
- Create
- Update
- Disabled
businessJustification string Tidak. Menjelaskan nilai bisnis pengiriman ke pemberi izin. Nilai ini dapat berisi HTML atau Format Teks Kaya (RTF). Informasi ini muncul dalam pengalaman konsumsi yang direncanakan dalam pengalaman pengguna penemuan pembuat. Pengguna mungkin mengatakan pengiriman mereka membantu pengurangan biaya atau produktivitas, misalnya. Beberapa organisasi memerlukan kelas nilai tertentu dan nilai tersebut dapat dimasukkan di sini.
publisherDetails Penerbit Yes Penerbit yang terkait dengan pengiriman item ini.
catalogItemDefinition CatalogItemDefinition Yes Menentukan item katalog yang dikirimkan.

Publisher

Gunakan data ini untuk menentukan properti item publisherDetails pengiriman katalog.

Membuat catatan penerbit yang dapat dikaitkan dengan satu atau beberapa grup ID Microsoft Entra yang berisi pengguna yang berwenang yang dapat membuat pembaruan pada item katalog ke depannya.

Nota

Jangan bingung istilah ini dengan Penerbit Solusi. Penerbit item katalog tidak digunakan dengan solusi.

Anda harus menyediakan publisherDisplayName minimal. publisherId dapat berupa nilai string apa pun. Sistem memeriksa apakah penerbit tersebut ada, atau membuatnya dan menetapkan publisherId.

Misalnya, tim pengembang HR IT dapat membuat penerbit dan ID pengembang menggunakan grup ID Microsoft Entra.

Berikut adalah sampel catatan penerbit yang menyertakan operasi untuk menambahkan seseorang dan grup ID Entra

{
   "publisherId": "MyPublisherId",
   "publisherDisplayName": "Contoso Publishing",
   "publisherUpnList": [
      {
         "action": "Add",
         "upn": "john.doe@contoso.com"
      }
   ],
   "publisherAADGroupOIDS": [
      {
         "action": "Add",
         "groupName": "PowerCatalogSubmitters",
         "groupOID": "2ded6de9-ab44-4478-9bd4-e609947daa2e",
         "groupType": "Security"
      }
   ]
}
Harta benda Tipe Diperlukan Description
publisherId string Yes ID unik untuk penerbit ini. Gunakan ID ini untuk mengidentifikasi penerbit ini kapan saja Anda membuat atau memperbarui item katalog untuk penerbit ini. Item Katalog hanya dapat dikaitkan dengan satu penerbit pada satu waktu. Nilainya bisa berupa GUID atau string. Setelah diatur, itu harus dipertahankan.
publisherDisplayName string Yes Konsumen melihat data ini di galeri katalog.
publisherUpnList CatalogUPNOperation[] Tidak. Orang yang bisa mengirimkan item katalog baru atau memperbarui sebagai penerbit ini. Selalu menyertakan pengguna yang mengirimkan saat pertama kali Publisher dibuat.
publisherAADGroupOIDS CatalogGroupOperation[] Tidak. Grup ID Entra yang anggotanya diizinkan untuk mengakses penerbit ini.

CatalogUPNOperation

Gunakan data ini untuk menentukan properti PublisherpublisherUpnList .

Menentukan operasi untuk menambahkan atau menghapus orang yang bisa mengirimkan item katalog baru atau memperbarui item katalog sebagai penerbit ini.

Harta benda Tipe Diperlukan Description
action string Yes Tindakan yang harus diambil dengan UPN ini. Nilai yang valid: Add atau Remove.
upn string Yes Nama Prinsipal Pengguna (UPN) pengguna.
userOid panduan Yes Pengidentifikasi Objek untuk pengguna.

CatalogGroupOperation

Gunakan data ini untuk menentukan properti PublisherpublisherAADGroupOIDS .

Menentukan operasi untuk menambahkan atau menghapus Grup ID Entra yang dapat mengakses penerbit ini.

Harta benda Tipe Diperlukan Description
action string Yes Tindakan yang harus diambil dengan UPN ini. Nilai yang valid: Add atau Remove.
groupName string Yes Nama grup.
groupOid panduan Yes Pengidentifikasi objek untuk grup.
groupType string Yes Jenis Grup yang sedang ditangani. Nilai yang valid adalah Security dan Modern.

CatalogItemDefinition

Gunakan data ini untuk menentukan properti item catalogItemDefinition pengiriman katalog.

Properti ini menentukan item katalog yang dikirimkan. Ini adalah solusi Power Platform yang sebenarnya. Paket adalah apa yang disimpan dalam katalog.

Berikut adalah contoh item katalog termasuk engineeringNamesupportName dan kontaknya yang wajib.

"catalogItemDefinition": {
   "id": "ContosoTravelsApp",
   "displayName": "Contoso Travel Expense App",
   "description": "Submit expenses on the go!",
   "offer": {
   "businessCategories": [526430000, 526430001, 526430002],
   "type": "Component_Collection",
   "deploymentType": "Normal",
   "small48x48Image": {
      "name": "Small48Image",
      "fileSasLink": "https://www.contoso.com/icon48.jpg"      
   },
   "large216x216Image": {
      "name": "Large216image2",
      "fileSasLink": "https://www.contoso.com/icon216.jpg"
   },
   "documents": [
      {
         "name": "ImaNewfile",
         "fileSasLink": "https://www.contoso.com/screenshot1.jpg"
      },
      {
         "name": "ImaNewfile2",
         "fileSasLink": "https://www.contoso.com/screenshot2.jpg"
      }
   ],
   "helpLink": "https://www.contoso.com/help.html",
   "privacyPolicyLink": "https://www.contoso.com/privacy.html",
   "legalTerms": "https://www.contoso.com/legal.html",
   "engineeringName": {
      "firstName": "John",
      "lastName": "Roon",
      "email": "john@contoso.com",
      "phoneNumber": "999-111-1234"
   },
   "supportName": {
      "firstName": "Jane",
      "lastName": "Drill",
      "email": "jane@contoso.com",
      "phoneNumber": "999-111-1234"
   }
   }
}
Harta benda Tipe Diperlukan Description
id panduan Yes ID unik item katalog. Gunakan ID ini saat memperbarui atau menginstal item katalog.
displayName string Yes Nama yang ditunjukkan kepada konsumen di galeri katalog.
description string Tidak. Deskripsi yang ditunjukkan kepada konsumen di galeri katalog.
offer OfferDetails Yes Detail pengiriman item katalog.
packageFile CatalogFileAsset Yes Menjelaskan tempat mendapatkan file paket katalog untuk pengiriman.

Rincian Penawaran

Gunakan data ini untuk menentukan properti CatalogItemDefinitionoffer .

Properti ini menentukan detail pengiriman item katalog.

Harta benda Tipe Diperlukan Description
businessCategories int[] Tidak. Daftar nilai opsi pilihan yang dihormati oleh katalog target. Mengidentifikasi kategori bisnis untuk dikaitkan dengan item katalog ini. Lihat Kategori bisnis untuk nilai yang valid untuk digunakan.
type string Yes Jenis item katalog. Nilai yang valid:
- Application
- Component_Collection
supportsApplicationTypes string[] Tidak. Daftar jenis aplikasi yang didukung. Nilai yang valid:
- CanvasApps
- ModelApps
- PowerPortals
- PowerAutomate
deploymentType string Yes Menunjukkan jenis penyebaran untuk menyebarkan item katalog ini. Nilai yang valid:
- Normal mewakili item terkelola.
- Template Salinan solusi anda yang tidak terkelola yang dapat diedit oleh pembuat lain.
Pelajari selengkapnya tentang jenis item katalog
searchKeywords string[] Tidak. Kata-kata yang mungkin digunakan orang untuk menemukan item katalog ini.
small48x48Image CatalogFileAsset Tidak. Gambar untuk tampilan galeri. Jika Anda tidak menyediakan gambar ini, ikon default sistem akan digunakan.
large216x216Image CatalogFileAsset Tidak. Gambar untuk tampilan detail. Berikan ikon untuk ditampilkan di pembuat atau UI penemuan lainnya. Beberapa pengalaman pengguna menggunakan ikon yang lebih besar untuk merender kartu untuk penemuan.
useCaseDocument CatalogFileAsset Tidak. Gunakan deskripsi dan penjelasan kasus untuk pemberi persetujuan.
videos CatalogFileAsset[] Tidak. Tampilan detail menampilkan tautan ke file video/gif ini.
documents CatalogFileAsset[] Tidak. Tampilan detail menampilkan tautan ke file-file ini.
screenshots CatalogFileAsset[] Tidak. Tampilan detail menampilkan gambar-gambar ini. Anda dapat meneruskan cuplikan layar di sini dari aplikasi Anda untuk membantu pembuat mengidentifikasi apakah aplikasi ini menyediakan fungsionalitas atau kemampuan yang mereka cari. Hal paling umum yang dilakukan orang sebelum mengunduh aplikasi atau templat adalah melihat gambar dan cuplikan layarnya untuk memahami kemampuan alih-alih membaca deskripsi.
helpLink URI Tidak. Tautkan ke dokumentasi. URL ini dapat berupa tautan ke dokumen internal atau sumber daya sharepoint.
privacyPolicyLink URI Tidak. Tautkan ke dokumen privasi. Kebijakan mengenai penggunaan komponen atau aplikasi yang cermat dikirimkan.
legalTermsLink URI Tidak. Tautan ke dokumen Syarat dan Ketentuan. Setiap persyaratan hukum atau panduan internal untuk evaluasi konsumen item katalog.
legalTerms string Tidak. Markdown, HTML, atau versi teks dokumen Syarat dan Ketentuan. Setiap persyaratan hukum atau panduan internal untuk evaluasi konsumen item katalog.
sourceCodeRepositoryLink URI Tidak. Menautkan ke repositori kode sumber
engineeringName PersonContactInformation Yes Informasi kontak untuk teknisi atau grup yang mengembangkan item katalog ini.
supportName PersonContactInformation Tidak. Informasi kontak untuk dukungan atau grup yang mendukung item katalog ini. Dapat sama dengan kontak rekayasa yang dapat dijangkau konsumen item katalog jika mengalami masalah dengan aplikasi.

Kategori bisnis

Atur properti OfferDetailsbusinessCategories ke satu atau beberapa kategori bisnis ini:

Kode Description
526430000 Layanan Pelanggan
526430001 Manajemen proyek
526430002 Manajemen Kalender & Penjadwalan
526430003 Manajemen Email
526430004 File & Dokumentasi
526430005 Pemberitahuan & Pengingat
526430006 Analitik
526430007 Kolaborasi
526430008 Commerce
526430009 Keuangan
526430010 Kepatuhan & Hukum
526430011 Sales
526430012 Alat TI
526430013 Marketing
526430014 Operasi & Rantai Pasokan
526430015 Internet of Things
526430016 Pembelajaran Mesin AI
526430017 Geolokasi
526430018 Sumber Daya Manusia

Saat ini, kategori bisnis baru tidak dapat dikonfigurasi, tetapi dapat diambil dari pilihan global Kategori Bisnis Katalog (mspcat_catalogbusinesscategory).

CatalogFileAsset

Properti ini menentukan file yang dirujuk di properti CatalogItemDefinitionpackageFile dan OfferDetailssmall48x48Image, , large216x216Image, useCaseDocumentvideos, documents, dan screenshots .

Harta benda Tipe Diperlukan Description
name string Yes Nama file.
filesaslink URI Yes Tautan untuk mengunduh file. Jika tautan memerlukan autentikasi, berikan URL tanda tangan akses bersama (SAS).

PersonContactInformation

Properti ini menentukan orang-orang dalam item katalog OfferDetailsengineeringName dan supportName properti.

Harta benda Tipe Diperlukan Description
firstName string Tidak. Nama depan orang.
lastName string Yes Nama keluarga orang.
email string Yes Alamat email orang.
phoneNumber string Tidak. Nomor telepon orang.
  • Last updated on