Udostępnij przez


Dokumentacja dokumentu przesyłania elementów wykazu

Podczas przesyłania elementu do wykazu należy uwzględnić dane w formacie JSON. W tym artykule opisano prawidłowe właściwości tego dokumentu. Ten kod JSON jest przykładem:

{
  "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"
      }
  }
}

W tej tabeli opisano właściwości dokumentu przesyłania:

Majątek Typ Wymagane Description
modelVersion ciąg Nie. Numer wersji dokumentu przesyłania. Wartość domyślna to 1.0.0.0.
sourcePortal int Nie. Identyfikuje źródło tego żądania. Wartości domyślne, do 526430005 których służy interfejs wiersza polecenia PAC. W przypadku innych źródeł użyj polecenia 526430000. Funkcja mspcat_GetPowerCatalogDetails zwraca pełną listę. Właściwość mspcat_GetPowerCatalogDetailsResponse.CatalogDetails.sourceOptions zawiera listę dostępnych opcji.
submissionId przewodnik Nie. Identyfikator GUID umożliwiający zidentyfikowanie przesyłania. Ta wartość jest kluczem obcym umożliwiającym łączenie żądania z innymi systemami.
operation ciąg Tak Dla przyszłej ekspansji i nie jest obecnie szanowany. Typ operacji, która ma być używana. Prawidłowe wartości:
- CreateOrUpdate (Ustawienie domyślne)
- Create
- Update
- Disabled
businessJustification ciąg Nie. Opisuje wartość biznesową przesyłania do osoby zatwierdzającej. Ta wartość może zawierać format HTML lub sformatowany tekst sformatowany (RTF). Te informacje są wyświetlane w środowisku planowanego użycia w środowisku użytkownika odnajdywania twórcy. Użytkownicy mogą powiedzieć, że ich przesyłanie pomaga na przykład w obniżeniu kosztów lub produktywności. Niektóre organizacje wymagają pewnych klas wartości, a te wartości można wprowadzić tutaj.
publisherDetails Publisher Tak Wydawca skojarzony z tym przesłaniem elementu.
catalogItemDefinition CatalogItemDefinition Tak Definiuje przesyłany element wykazu.

Publisher

Użyj tych danych, aby określić właściwość elementu publisherDetails przesyłania wykazu.

Tworzy rekord wydawcy, który może być skojarzony z co najmniej jedną grupą identyfikatorów Entra firmy Microsoft zawierającą autoryzowanych użytkowników, którzy mogą wprowadzać aktualizacje do elementu wykazu w przyszłości.

Uwaga / Notatka

Nie należy mylić tego terminu z wydawcą rozwiązań. Wydawca elementów wykazu nie jest używany z rozwiązaniami.

Musisz podać publisherDisplayName wartość minimalną. publisherId może być dowolną wartością ciągu. System sprawdza, czy ten wydawca istnieje, a następnie tworzy go i przypisuje element publisherId.

Na przykład zespół IT działu kadr deweloperów może utworzyć wydawcę i identyfikator deweloperów przy użyciu grupy Identyfikator entra firmy Microsoft.

Oto przykład rekordu wydawcy zawierającego operacje dodawania osoby i grupy Identyfikator 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"
      }
   ]
}
Majątek Typ Wymagane Description
publisherId ciąg Tak Unikatowy identyfikator tego wydawcy. Użyj tego identyfikatora, aby zidentyfikować tego wydawcę w dowolnym momencie tworzenia lub aktualizowania elementu wykazu dla tego wydawcy. Elementy wykazu mogą być skojarzone tylko z jednym wydawcą jednocześnie. Wartość może być identyfikatorem GUID lub ciągiem. Po ustawieniu należy go zachować.
publisherDisplayName ciąg Tak Konsumenci widzą te dane w galerii katalogów.
publisherUpnList CatalogUPNOperation[] Nie. Osoby, które mogą przesyłać nowe lub aktualizowane elementy wykazu jako ten wydawca. Zawsze dołącza przesyłającego użytkownika przy pierwszym utworzeniu programu Publisher.
publisherAADGroupOIDS CatalogGroupOperation[] Nie. Entra ID Grupy, których członkowie mogą uzyskiwać dostęp do tego wydawcy.

CatalogUPNOperation

Użyj tych danych, aby określić właściwość wydawcypublisherUpnList .

Definiuje operację dodawania lub usuwania osób, które mogą przesyłać nowe lub aktualizowane elementy wykazu jako ten wydawca.

Majątek Typ Wymagane Description
action ciąg Tak Akcja do wykonania przy użyciu tej nazwy UPN. Prawidłowe wartości: Add lub Remove.
upn ciąg Tak Główna nazwa użytkownika (UPN) użytkownika.
userOid przewodnik Tak Identyfikator obiektu użytkownika.

CatalogGroupOperation

Użyj tych danych, aby określić właściwość wydawcypublisherAADGroupOIDS .

Definiuje operację dodawania lub usuwania grupy identyfikatorów entra, która może uzyskiwać dostęp do tego wydawcy.

Majątek Typ Wymagane Description
action ciąg Tak Akcja do wykonania przy użyciu tej nazwy UPN. Prawidłowe wartości: Add lub Remove.
groupName ciąg Tak Nazwa grupy.
groupOid przewodnik Tak Identyfikator obiektu dla grupy.
groupType ciąg Tak Typ adresowanej grupy. Prawidłowe wartości to Security i Modern.

CatalogItemDefinition

Użyj tych danych, aby określić właściwość elementu catalogItemDefinition przesyłania wykazu.

Te właściwości definiują przesyłany element wykazu. Jest to rzeczywiste rozwiązanie platformy Power Platform. Pakiet jest przechowywany w wykazie.

Oto przykład elementu wykazu, w tym jego engineeringName i supportName kontakty, które są obowiązkowe.

"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"
   }
   }
}
Majątek Typ Wymagane Description
id przewodnik Tak Unikatowy identyfikator elementu wykazu. Użyj tego identyfikatora podczas aktualizowania lub instalowania elementu wykazu.
displayName ciąg Tak Nazwa wyświetlana konsumentom w galeriach wykazu.
description ciąg Nie. Opis wyświetlany konsumentom w galeriach wykazu.
offer OfferDetails Tak Szczegóły przesyłania elementu wykazu.
packageFile CatalogFileAsset Tak W tym artykule opisano, gdzie pobrać plik pakietu wykazu na potrzeby przesyłania.

Szczegóły oferty

Użyj tych danych, aby określić właściwość CatalogItemDefinitionoffer .

Te właściwości definiują szczegóły przesyłania elementu wykazu.

Majątek Typ Wymagane Description
businessCategories int[] Nie. Lista wartości opcji wyboru szanowanych przez wykaz docelowy. Identyfikuje kategorie biznesowe do skojarzenia z tym elementem wykazu. Zobacz Kategorie biznesowe , aby uzyskać prawidłowe wartości do użycia.
type ciąg Tak Typ elementu wykazu. Prawidłowe wartości:
- Application
- Component_Collection
supportsApplicationTypes string[] Nie. Lista obsługiwanych typów aplikacji. Prawidłowe wartości:
- CanvasApps
- ModelApps
- PowerPortals
- PowerAutomate
deploymentType ciąg Tak Wskazuje typ wdrożenia, aby wdrożyć ten element wykazu. Prawidłowe wartości:
- Normal reprezentuje element zarządzany.
- Template Kopia rozwiązania niezarządzanego, którą inni twórcy mogą edytować, jednak wybierają.
Dowiedz się więcej o typach elementów wykazu
searchKeywords string[] Nie. Wyrazy, których użytkownicy mogą użyć do znalezienia tego elementu wykazu.
small48x48Image CatalogFileAsset Nie. Obraz przedstawiający widok galerii. Jeśli nie podasz tego obrazu, zostanie użyta ikona domyślna systemu.
large216x216Image CatalogFileAsset Nie. Obraz przedstawiający widok szczegółów. Podaj ikonę, która ma być wyświetlana w interfejsie użytkownika twórcy lub innego odnajdywania. Niektóre środowiska użytkownika używają większych ikon do renderowania kart na potrzeby odnajdywania.
useCaseDocument CatalogFileAsset Nie. Opis przypadku użycia i wyjaśnienie osób zatwierdzających.
videos CatalogFileAsset[] Nie. Widok szczegółów wyświetla łącza do tych plików wideo/gif.
documents CatalogFileAsset[] Nie. Widok szczegółów wyświetla łącza do tych plików.
screenshots CatalogFileAsset[] Nie. Widok szczegółów wyświetla te obrazy. W tym miejscu możesz przekazać zrzuty ekranu aplikacji, aby ułatwić twórcom określenie, czy ta aplikacja zapewnia funkcje lub możliwości, których szukają. Najczęstszą czynnością, jaką użytkownicy wykonują przed pobraniem aplikacji lub szablonu, jest zapoznanie się z jego obrazami i zrzutami ekranu, aby zrozumieć możliwości zamiast odczytywać opis.
helpLink URI Nie. Link do dokumentacji. Te adresy URL mogą być linkami do wewnętrznych dokumentów lub zasobów programu SharePoint.
privacyPolicyLink URI Nie. Link do dokumentu dotyczącego prywatności. Zasady dotyczące dokładnego użycia przesyłanego składnika lub aplikacji.
legalTermsLink URI Nie. Link do dokumentu Warunki i postanowienia. Wszelkie postanowienia prawne lub wewnętrzne wskazówki dotyczące oceny konsumenta elementu wykazu.
legalTerms ciąg Nie. Wersja znaczników Markdown, HTML lub tekstowa dokumentu Warunki i postanowienia. Wszelkie postanowienia prawne lub wewnętrzne wskazówki dotyczące oceny konsumenta elementu wykazu.
sourceCodeRepositoryLink URI Nie. Łącze do repozytorium kodu źródłowego
engineeringName PersonContactInformation Tak Informacje kontaktowe inżyniera lub grupy, które opracowały ten element wykazu.
supportName PersonContactInformation Nie. Informacje kontaktowe dotyczące pomocy technicznej lub grupy obsługującej ten element wykazu. Może być taki sam jak kontakt inżynieryjny, z którym użytkownik elementu wykazu może skontaktować się, jeśli wystąpią problemy z aplikacją.

Kategorie biznesowe

Ustaw właściwość OfferDetailsbusinessCategories na co najmniej jedną z następujących kategorii biznesowych:

Code Description
526430000 Obsługa Klienta
526430001 Zarządzanie projektem
526430002 Zarządzanie kalendarzami i planowanie
526430003 Zarządzanie pocztą e-mail
526430004 Pliki i dokumentacja
526430005 Powiadomienia i przypomnienia
526430006 Analiza danych
526430007 Kolaboracja
526430008 Commerce
526430009 Finance
526430010 Zgodność i sprawy prawne
526430011 Sales
526430012 Narzędzia IT
526430013 Marketing
526430014 Operacje i łańcuch dostaw
526430015 Internet rzeczy
526430016 Uczenie maszynowe sztucznej inteligencji
526430017 Geolokalizacja
526430018 Zasoby ludzkie

Obecnie nie można skonfigurować nowych kategorii biznesowych, ale można je pobrać z kategorii biznesowej wykazu (mspcat_catalogbusinesscategory) wyboru globalnego.

CatalogFileAsset

Te właściwości definiują plik, do których odwołuje się katalogItemDefinitionpackageFile i właściwości OfferDetailssmall48x48Image, , large216x216ImageuseCaseDocumentvideos, documents, i screenshots .

Majątek Typ Wymagane Description
name ciąg Tak Nazwa pliku.
filesaslink URI Tak Połącz, aby pobrać plik. Jeśli link wymaga uwierzytelniania, podaj adres URL sygnatury dostępu współdzielonego (SAS).

PersonContactInformation

Te właściwości definiują osoby w elemencie katalogu OfferDetailsengineeringName i supportName właściwości.

Majątek Typ Wymagane Description
firstName ciąg Nie. Imię i nazwisko osoby.
lastName ciąg Tak Nazwisko osoby.
email ciąg Tak Adres e-mail osoby.
phoneNumber ciąg Nie. Numer telefonu osoby.