GalleryRestClient class

リファレンス

パッケージ:: azure-devops-extension-api

VSS REST API への要求を行うために (から派生) 使用する必要がある基底クラス

Extends: RestClientBase

コンストラクター

GalleryRestClient(IVssRestClientOptions)

プロパティ

RESOURCE_AREA_ID

メソッド

addAssetForEditExtensionDraft(string, string, string, string, string)
addAssetForNewExtensionDraft(string, string, string, string)
associateAzurePublisher(string, string)
createCategory(ExtensionCategory)
createDraftForEditExtension(string, string)
createDraftForNewExtension(any, string, String, String)
createExtension(any, string, string)
createExtensionWithPublisher(any, string, string, string)
createPublisher(Publisher)
createQuestion(Question, string, string)	拡張機能の新しい質問を作成します。
createResponse(Response, string, string, number)	拡張機能の特定の質問に対する新しい応答を作成します。
createReview(Review, string, string)	拡張機能の新しいレビューを作成します
createSupportRequest(CustomerSupportRequest)
deleteExtension(string, string, string)
deleteExtensionById(string, string)
deletePublisher(string)
deletePublisherAsset(string, string)	ロゴなどの発行元アセットを削除する
deleteQuestion(string, string, number)	既存の質問とそれに関連付けられているすべての回答を拡張機能に対して削除します。 (論理的な削除)
deleteResponse(string, string, number, number)	拡張機能の応答を削除します。 (論理的な削除)
deleteReview(string, string, number)	レビューを削除します
extensionValidator(AzureRestApiRequestModel)	Azure パブリッシャーがサードパーティのコマースシナリオの拡張機能を所有しているかどうかを検証するための残りのエンドポイント。 Azure では POST 操作のみがサポートされており、上記の署名は REST 操作の一般的なものではありません。 http://sharepoint/sites/AzureUX/_layouts/15/WopiFrame2.aspx?sourcedoc={A793D31E-6DC6-4174-8FA3-DE3F82B51642}&file=Data%20Market%20Partner%20integration%20with%20Marketplace%20service.docx&action=default
fetchDomainToken(string)
generateKey(string, number)
getAcquisitionOptions(string, string, boolean, boolean)
getAsset(string, string, string, string, boolean, String)
getAssetAuthenticated(string, string, string, string, string, String)
getAssetByName(string, string, string, string, string, boolean, String)
getAssetFromEditExtensionDraft(string, string, string, string)
getAssetFromNewExtensionDraft(string, string, string)
getAssetWithToken(string, string, string, string, string, string, boolean, String)
getCategories(string)
getCategoryDetails(string, string, string)
getCategoryTree(string, string, number, string, string, string, string, string)
getCertificate(string, string, string)
getContentVerificationLog(string, string)
getExtension(string, string, string, ExtensionQueryFlags, string, String)
getExtensionById(string, string, ExtensionQueryFlags)
getExtensionDailyStats(string, string, number, Daily, Date)
getExtensionDailyStatsAnonymous(string, string, string)	このルート/場所 ID は、ページビューの毎日の統計を Marketplace クライアントからインクリメントできるように、匿名で HTTP POST のみをサポートします。このルートで GET を呼び出そうとすると、例外が発生します。この明示的な実装がない場合、このパブリックルートで GET を呼び出すと、上記の GET 実装 GetExtensionDailyStats が呼び出されます。
getExtensionEvents(string, string, number, Date, string, string)	拡張機能のインストール/アンインストールイベントを取得します。 count パラメーターと afterDate パラメーターの両方が指定されている場合は、count が優先されます。
getExtensionReports(string, string, number, number, Date)	拡張機能レポートを返します
getGalleryUserSettings(string, string)	特定のユーザー/すべてのユーザースコープのすべての設定エントリを取得する
getPackage(string, string, string, string, boolean, String)	このエンドポイントは、Web UI から VSTS 拡張機能をダウンロードするとヒットします
getPublisher(string, number)
getPublisherAsset(string, string)	ロゴなどのパブリッシャーアセットをストリームとして取得する
getPublisherWithoutToken(string)
getQuestions(string, string, number, number, Date)	回答が拡張機能に関連付けられている質問の一覧を返します。
getReviews(string, string, number, ReviewFilterOptions, Date, Date)	拡張機能に関連付けられているレビューの一覧を返します
getReviewsSummary(string, string, Date, Date)	レビューの概要を返します
getRootCategories(string, number, string, string, string, string)
getSigningKey(string)
getVerificationLog(string, string, string, string)
incrementExtensionDailyStat(string, string, string, string, string)	拡張機能に関連付けられている日次統計をインクリメントします
performEditExtensionDraftOperation(ExtensionDraftPatch, string, string, string)
performNewExtensionDraftOperation(ExtensionDraftPatch, string, string)
publishExtensionEvents(ExtensionEvents[])	拡張機能のインストール/アンインストールイベントを発行する API エンドポイント。これは、拡張機能のインストール/アンインストールに関連するデータを送信するためにのみ EMS によって呼び出されることを目的としています。
publishExtensionWithPublisherSignature(any, string, string, string, string, boolean)
queryAssociatedAzurePublisher(string)
queryExtensions(ExtensionQuery, string, String)
queryPublishers(PublisherQuery)
reportQuestion(Concern, string, string, number)	拡張機能に関する既存の質問に関する懸念事項にフラグを設定します。
requestAcquisition(ExtensionAcquisitionRequest)
sendNotifications(NotificationsData)	通知の送信
setGalleryUserSettings({[key: string]: any}, string)	特定のユーザー/すべてのユーザースコープのすべての設定エントリを設定する
shareExtension(string, string, string)
shareExtensionById(string, string)
shareExtensionWithHost(string, string, string, string)
unshareExtension(string, string, string)
unshareExtensionById(string, string)
unshareExtensionWithHost(string, string, string, string)
updateExtension(any, string, string, string, string, boolean)	拡張機能を更新するための REST エンドポイント。
updateExtensionById(string, string)
updateExtensionProperties(string, string, PublishedExtensionFlags)
updateExtensionStatistics(ExtensionStatisticUpdate, string, string)
updatePayloadInDraftForEditExtension(any, string, string, string, String)
updatePayloadInDraftForNewExtension(any, string, string, String)
updatePublisher(Publisher, string)
updatePublisherAsset(any, string, string, String)	ロゴなどの発行元アセットを更新します。アセットファイルはオクテットストリームとして受け入れ、ファイル名はヘッダー値で渡されます。
updatePublisherMembers(PublisherUserRoleAssignmentRef[], string, boolean)	パブリッシャーメンバーシップを追加/変更するエンドポイント。現在、一度に 1 人のユーザーの追加/変更のみをサポートしています。同じテナントのメンバーを追加する場合にのみ機能します。
updateQuestion(Question, string, string, number)	拡張機能に関する既存の質問をUpdatesします。
updateResponse(Response, string, string, number, number)	拡張機能に関する特定の質問に対する既存の回答をUpdatesします。
updateReview(ReviewPatch, string, string, number)	レビューをUpdatesまたはフラグを設定する
updateVSCodeWebExtensionStatistics(string, string, VSCodeWebExtensionStatisicsType)
verifyDomainToken(string)

コンストラクターの詳細

GalleryRestClient(IVssRestClientOptions)

new GalleryRestClient(options: IVssRestClientOptions)

パラメーター

options: IVssRestClientOptions

プロパティの詳細

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

プロパティ値

string

メソッドの詳細

addAssetForEditExtensionDraft(string, string, string, string, string)

function addAssetForEditExtensionDraft(content: string, publisherName: string, extensionName: string, draftId: string, assetType: string): Promise<ExtensionDraftAsset>

パラメーター

content: string

アップロードするコンテンツ

publisherName: string

extensionName: string

draftId: string

assetType: string

戻り値

Promise<ExtensionDraftAsset>

addAssetForNewExtensionDraft(string, string, string, string)

function addAssetForNewExtensionDraft(content: string, publisherName: string, draftId: string, assetType: string): Promise<ExtensionDraftAsset>

パラメーター

content: string

アップロードするコンテンツ

publisherName: string

draftId: string

assetType: string

戻り値

Promise<ExtensionDraftAsset>

associateAzurePublisher(string, string)

function associateAzurePublisher(publisherName: string, azurePublisherId: string): Promise<AzurePublisher>

パラメーター

publisherName: string

azurePublisherId: string

戻り値

Promise<AzurePublisher>

createCategory(ExtensionCategory)

function createCategory(category: ExtensionCategory): Promise<ExtensionCategory>

パラメーター

category: ExtensionCategory

戻り値

Promise<ExtensionCategory>

createDraftForEditExtension(string, string)

function createDraftForEditExtension(publisherName: string, extensionName: string): Promise<ExtensionDraft>

パラメーター

publisherName: string

extensionName: string

戻り値

Promise<ExtensionDraft>

createDraftForNewExtension(any, string, String, String)

function createDraftForNewExtension(content: any, publisherName: string, product: String, fileName?: String): Promise<ExtensionDraft>

パラメーター

content: any

アップロードするコンテンツ

publisherName: string

product: String

ペイロードファイルの製品の種類を渡すヘッダー

fileName: String

アップロードされたデータのファイル名を渡すヘッダー

戻り値

Promise<ExtensionDraft>

createExtension(any, string, string)

function createExtension(content: any, extensionType?: string, reCaptchaToken?: string): Promise<PublishedExtension>

パラメーター

content: any

アップロードするコンテンツ

extensionType: string

reCaptchaToken: string

戻り値

Promise<PublishedExtension>

createExtensionWithPublisher(any, string, string, string)

function createExtensionWithPublisher(content: any, publisherName: string, extensionType?: string, reCaptchaToken?: string): Promise<PublishedExtension>

パラメーター

content: any

アップロードするコンテンツ

publisherName: string

extensionType: string

reCaptchaToken: string

戻り値

Promise<PublishedExtension>

createPublisher(Publisher)

function createPublisher(publisher: Publisher): Promise<Publisher>

パラメーター

publisher: Publisher

戻り値

Promise<Publisher>

createQuestion(Question, string, string)

拡張機能の新しい質問を作成します。

function createQuestion(question: Question, publisherName: string, extensionName: string): Promise<Question>

パラメーター

question: Question

拡張機能に対して作成する質問。

publisherName: string

拡張機能を発行した発行元の名前。

extensionName: string

拡張機能の名前。

戻り値

Promise<Question>

createResponse(Response, string, string, number)

拡張機能の特定の質問に対する新しい応答を作成します。

function createResponse(response: Response, publisherName: string, extensionName: string, questionId: number): Promise<Response>

パラメーター

response: Response

拡張機能に対して作成される応答。

publisherName: string

拡張機能を発行した発行元の名前。

extensionName: string

拡張機能の名前。

questionId: number

拡張機能に対してどの応答を作成するかを示す質問の識別子。

戻り値

Promise<Response>

createReview(Review, string, string)

拡張機能の新しいレビューを作成します

function createReview(review: Review, pubName: string, extName: string): Promise<Review>

パラメーター

review: Review

拡張機能の作成を確認する

pubName: string

拡張機能を公開した発行元の名前

extName: string

拡張機能の名前

戻り値

Promise<Review>

createSupportRequest(CustomerSupportRequest)

function createSupportRequest(customerSupportRequest: CustomerSupportRequest): Promise<void>

パラメーター

customerSupportRequest: CustomerSupportRequest

戻り値

Promise<void>

deleteExtension(string, string, string)

function deleteExtension(publisherName: string, extensionName: string, version?: string): Promise<void>

パラメーター

publisherName: string

extensionName: string

version: string

戻り値

Promise<void>

deleteExtensionById(string, string)

function deleteExtensionById(extensionId: string, version?: string): Promise<void>

パラメーター

extensionId: string

version: string

戻り値

Promise<void>

deletePublisher(string)

function deletePublisher(publisherName: string): Promise<void>

パラメーター

publisherName: string

戻り値

Promise<void>

deletePublisherAsset(string, string)

ロゴなどの発行元アセットを削除する

function deletePublisherAsset(publisherName: string, assetType?: string): Promise<void>

パラメーター

publisherName: string

発行元の内部名

assetType: string

資産の種類。既定値は 'logo' です。

戻り値

Promise<void>

deleteQuestion(string, string, number)

既存の質問とそれに関連付けられているすべての回答を拡張機能に対して削除します。 (論理的な削除)

function deleteQuestion(publisherName: string, extensionName: string, questionId: number): Promise<void>

パラメーター

publisherName: string

拡張機能を発行した発行元の名前。

extensionName: string

拡張機能の名前。

questionId: number

拡張機能に対して削除する質問の識別子。

戻り値

Promise<void>

deleteResponse(string, string, number, number)

拡張機能の応答を削除します。 (論理的な削除)

function deleteResponse(publisherName: string, extensionName: string, questionId: number, responseId: number): Promise<void>

パラメーター

publisherName: string

拡張機能を発行した発行元の名前。

extensionName: string

拡張機能の名前。

questionId: number

回答を削除する質問を識別します。

responseId: number

削除する応答を識別します。

戻り値

Promise<void>

deleteReview(string, string, number)

レビューを削除します

function deleteReview(pubName: string, extName: string, reviewId: number): Promise<void>

パラメーター

pubName: string

拡張機能を発行した発行元の名前

extName: string

拡張機能の名前

reviewId: number

更新する必要があるレビューの ID

戻り値

Promise<void>

extensionValidator(AzureRestApiRequestModel)

Azure パブリッシャーがサードパーティのコマースシナリオの拡張機能を所有しているかどうかを検証するための残りのエンドポイント。 Azure では POST 操作のみがサポートされており、上記の署名は REST 操作の一般的なものではありません。 http://sharepoint/sites/AzureUX/_layouts/15/WopiFrame2.aspx?sourcedoc={A793D31E-6DC6-4174-8FA3-DE3F82B51642}&file=Data%20Market%20Partner%20integration%20with%20Marketplace%20service.docx&action=default

function extensionValidator(azureRestApiRequestModel: AzureRestApiRequestModel): Promise<void>

パラメーター

azureRestApiRequestModel: AzureRestApiRequestModel

すべてのパラメーターが要求本文で送信されます

戻り値

Promise<void>

fetchDomainToken(string)

function fetchDomainToken(publisherName: string): Promise<string>

パラメーター

publisherName: string

戻り値

Promise<string>

generateKey(string, number)

function generateKey(keyType: string, expireCurrentSeconds?: number): Promise<void>

パラメーター

keyType: string

expireCurrentSeconds: number

戻り値

Promise<void>

getAcquisitionOptions(string, string, boolean, boolean)

function getAcquisitionOptions(itemId: string, installationTarget: string, testCommerce?: boolean, isFreeOrTrialInstall?: boolean): Promise<AcquisitionOptions>

パラメーター

itemId: string

installationTarget: string

testCommerce: boolean

isFreeOrTrialInstall: boolean

戻り値

Promise<AcquisitionOptions>

getAsset(string, string, string, string, boolean, String)

function getAsset(extensionId: string, version: string, assetType: string, accountToken?: string, acceptDefault?: boolean, accountTokenHeader?: String): Promise<ArrayBuffer>

パラメーター

extensionId: string

version: string

assetType: string

accountToken: string

acceptDefault: boolean

accountTokenHeader: String

アカウントトークンを渡すヘッダー

戻り値

Promise<ArrayBuffer>

getAssetAuthenticated(string, string, string, string, string, String)

function getAssetAuthenticated(publisherName: string, extensionName: string, version: string, assetType: string, accountToken?: string, accountTokenHeader?: String): Promise<ArrayBuffer>

パラメーター

publisherName: string

extensionName: string

version: string

assetType: string

accountToken: string

accountTokenHeader: String

アカウントトークンを渡すヘッダー

戻り値

Promise<ArrayBuffer>

getAssetByName(string, string, string, string, string, boolean, String)

function getAssetByName(publisherName: string, extensionName: string, version: string, assetType: string, accountToken?: string, acceptDefault?: boolean, accountTokenHeader?: String): Promise<ArrayBuffer>

パラメーター

publisherName: string

extensionName: string

version: string

assetType: string

accountToken: string

acceptDefault: boolean

accountTokenHeader: String

アカウントトークンを渡すヘッダー

戻り値

Promise<ArrayBuffer>

getAssetFromEditExtensionDraft(string, string, string, string)

function getAssetFromEditExtensionDraft(publisherName: string, draftId: string, assetType: string, extensionName: string): Promise<ArrayBuffer>

パラメーター

publisherName: string

draftId: string

assetType: string

extensionName: string

戻り値

Promise<ArrayBuffer>

getAssetFromNewExtensionDraft(string, string, string)

function getAssetFromNewExtensionDraft(publisherName: string, draftId: string, assetType: string): Promise<ArrayBuffer>

パラメーター

publisherName: string

draftId: string

assetType: string

戻り値

Promise<ArrayBuffer>

getAssetWithToken(string, string, string, string, string, string, boolean, String)

function getAssetWithToken(publisherName: string, extensionName: string, version: string, assetType: string, assetToken?: string, accountToken?: string, acceptDefault?: boolean, accountTokenHeader?: String): Promise<ArrayBuffer>

パラメーター

publisherName: string

extensionName: string

version: string

assetType: string

assetToken: string

accountToken: string

acceptDefault: boolean

accountTokenHeader: String

アカウントトークンを渡すヘッダー

戻り値

Promise<ArrayBuffer>

getCategories(string)

function getCategories(languages?: string): Promise<string[]>

パラメーター

languages: string

戻り値

Promise<string[]>

getCategoryDetails(string, string, string)

function getCategoryDetails(categoryName: string, languages?: string, product?: string): Promise<CategoriesResult>

パラメーター

categoryName: string

languages: string

product: string

戻り値

Promise<CategoriesResult>

getCategoryTree(string, string, number, string, string, string, string, string)

function getCategoryTree(product: string, categoryId: string, lcid?: number, source?: string, productVersion?: string, skus?: string, subSkus?: string, productArchitecture?: string): Promise<ProductCategory>

パラメーター

product: string

categoryId: string

lcid: number

source: string

productVersion: string

skus: string

subSkus: string

productArchitecture: string

戻り値

Promise<ProductCategory>

getCertificate(string, string, string)

function getCertificate(publisherName: string, extensionName: string, version?: string): Promise<ArrayBuffer>

パラメーター

publisherName: string

extensionName: string

version: string

戻り値

Promise<ArrayBuffer>

getContentVerificationLog(string, string)

function getContentVerificationLog(publisherName: string, extensionName: string): Promise<ArrayBuffer>

パラメーター

publisherName: string

extensionName: string

戻り値

Promise<ArrayBuffer>

getExtension(string, string, string, ExtensionQueryFlags, string, String)

function getExtension(publisherName: string, extensionName: string, version?: string, flags?: ExtensionQueryFlags, accountToken?: string, accountTokenHeader?: String): Promise<PublishedExtension>

パラメーター

publisherName: string

extensionName: string

version: string

flags: ExtensionQueryFlags

accountToken: string

accountTokenHeader: String

アカウントトークンを渡すヘッダー

戻り値

Promise<PublishedExtension>

getExtensionById(string, string, ExtensionQueryFlags)

function getExtensionById(extensionId: string, version?: string, flags?: ExtensionQueryFlags): Promise<PublishedExtension>

パラメーター

extensionId: string

version: string

flags: ExtensionQueryFlags

戻り値

Promise<PublishedExtension>

getExtensionDailyStats(string, string, number, Daily, Date)

function getExtensionDailyStats(publisherName: string, extensionName: string, days?: number, aggregate?: Daily, afterDate?: Date): Promise<ExtensionDailyStats>

パラメーター

publisherName: string

extensionName: string

days: number

aggregate: Daily

afterDate: Date

戻り値

Promise<ExtensionDailyStats>

getExtensionDailyStatsAnonymous(string, string, string)

このルート/場所 ID は、ページビューの毎日の統計を Marketplace クライアントからインクリメントできるように、匿名で HTTP POST のみをサポートします。このルートで GET を呼び出そうとすると、例外が発生します。この明示的な実装がない場合、このパブリックルートで GET を呼び出すと、上記の GET 実装 GetExtensionDailyStats が呼び出されます。

function getExtensionDailyStatsAnonymous(publisherName: string, extensionName: string, version: string): Promise<ExtensionDailyStats>

パラメーター

publisherName: string

発行元の名前

extensionName: string

拡張機能の名前

version: string

拡張機能のバージョン

戻り値

Promise<ExtensionDailyStats>

getExtensionEvents(string, string, number, Date, string, string)

拡張機能のインストール/アンインストールイベントを取得します。 count パラメーターと afterDate パラメーターの両方が指定されている場合は、count が優先されます。

function getExtensionEvents(publisherName: string, extensionName: string, count?: number, afterDate?: Date, include?: string, includeProperty?: string): Promise<ExtensionEvents>

パラメーター

publisherName: string

発行元の名前

extensionName: string

拡張機能の名前

count: number

フェッチするイベントの数。各イベントの種類に適用されます。

afterDate: Date

この日付以降に発生したイベントをフェッチする

include: string

フィルターオプション。サポートされている値: インストール、アンインストール、レビュー、取得、販売。既定では、すべての種類のイベントをフェッチします

includeProperty: string

含めるイベントプロパティ。現在、アンインストールイベントでは 'lastContactDetails' のみがサポートされています

戻り値

Promise<ExtensionEvents>

getExtensionReports(string, string, number, number, Date)

拡張機能レポートを返します

function getExtensionReports(publisherName: string, extensionName: string, days?: number, count?: number, afterDate?: Date): Promise<any>

パラメーター

publisherName: string

拡張機能を発行した発行元の名前

extensionName: string

拡張機能の名前

days: number

過去 n 日間のレポート。 afterDate と days を指定すると、日が優先されます

count: number

返されるイベントの数

afterDate: Date

指定した日付より新しいイベントをフェッチする場合は、を使用します。

戻り値

Promise<any>

getGalleryUserSettings(string, string)

特定のユーザー/すべてのユーザースコープのすべての設定エントリを取得する

function getGalleryUserSettings(userScope: string, key?: string): Promise<{[key: string]: any}>

パラメーター

userScope: string

値を取得する位置を User-Scope します。現在のユーザーの場合は "me"、すべてのユーザーの場合は "host" である必要があります。

key: string

すべてのエントリをフィルター処理する省略可能なキー

戻り値

Promise<{[key: string]: any}>

getPackage(string, string, string, string, boolean, String)

このエンドポイントは、Web UI から VSTS 拡張機能をダウンロードするとヒットします

function getPackage(publisherName: string, extensionName: string, version: string, accountToken?: string, acceptDefault?: boolean, accountTokenHeader?: String): Promise<ArrayBuffer>

パラメーター

publisherName: string

extensionName: string

version: string

accountToken: string

acceptDefault: boolean

accountTokenHeader: String

アカウントトークンを渡すヘッダー

戻り値

Promise<ArrayBuffer>

getPublisher(string, number)

function getPublisher(publisherName: string, flags?: number): Promise<Publisher>

パラメーター

publisherName: string

flags: number

戻り値

Promise<Publisher>

getPublisherAsset(string, string)

ロゴなどのパブリッシャーアセットをストリームとして取得する

function getPublisherAsset(publisherName: string, assetType?: string): Promise<ArrayBuffer>

パラメーター

publisherName: string

パブリッシャーの内部名

assetType: string

資産の種類。既定値は 'logo' です。

戻り値

Promise<ArrayBuffer>

getPublisherWithoutToken(string)

function getPublisherWithoutToken(publisherName: string): Promise<Publisher>

パラメーター

publisherName: string

戻り値

Promise<Publisher>

getQuestions(string, string, number, number, Date)

回答が拡張機能に関連付けられている質問の一覧を返します。

function getQuestions(publisherName: string, extensionName: string, count?: number, page?: number, afterDate?: Date): Promise<QuestionsResult>

パラメーター

publisherName: string

拡張機能を発行した発行元の名前。

extensionName: string

拡張機能の名前。

count: number

取得する質問の数 (既定値は 10)。

page: number

質問のセットを取得するページ番号。

afterDate: Date

指定した場合、この日付より後に投稿された結果の質問が返されます

戻り値

Promise<QuestionsResult>

getReviews(string, string, number, ReviewFilterOptions, Date, Date)

拡張機能に関連付けられているレビューの一覧を返します

function getReviews(publisherName: string, extensionName: string, count?: number, filterOptions?: ReviewFilterOptions, beforeDate?: Date, afterDate?: Date): Promise<ReviewsResult>

パラメーター

publisherName: string

拡張機能を発行した発行元の名前

extensionName: string

拡張機能の名前

count: number

取得するレビューの数 (既定値は 5)

filterOptions: ReviewFilterOptions

空のレビュー etcetera を除外する FilterOptions(既定値はなし)

beforeDate: Date

指定した日付より古いレビューをフェッチする場合はを使用します。既定値は null です

afterDate: Date

指定した日付より新しいレビューをフェッチする場合はを使用します。既定値は null です

戻り値

Promise<ReviewsResult>

getReviewsSummary(string, string, Date, Date)

レビューの概要を返します

function getReviewsSummary(pubName: string, extName: string, beforeDate?: Date, afterDate?: Date): Promise<ReviewSummary>

パラメーター

pubName: string

拡張機能を発行した発行元の名前

extName: string

拡張機能の名前

beforeDate: Date

指定した日付より古いレビューの概要を取得する場合に使用します。既定値は null です

afterDate: Date

指定した日付より新しいレビューの概要を取得する場合に使用します。既定値は null です

戻り値

Promise<ReviewSummary>

getRootCategories(string, number, string, string, string, string)

function getRootCategories(product: string, lcid?: number, source?: string, productVersion?: string, skus?: string, subSkus?: string): Promise<ProductCategoriesResult>

パラメーター

product: string

lcid: number

source: string

productVersion: string

skus: string

subSkus: string

戻り値

Promise<ProductCategoriesResult>

getSigningKey(string)

function getSigningKey(keyType: string): Promise<string>

パラメーター

keyType: string

戻り値

Promise<string>

getVerificationLog(string, string, string, string)

function getVerificationLog(publisherName: string, extensionName: string, version: string, targetPlatform?: string): Promise<ArrayBuffer>

パラメーター

publisherName: string

extensionName: string

version: string

targetPlatform: string

戻り値

Promise<ArrayBuffer>

incrementExtensionDailyStat(string, string, string, string, string)

拡張機能に関連付けられている日次統計をインクリメントします

function incrementExtensionDailyStat(publisherName: string, extensionName: string, version: string, statType: string, targetPlatform?: string): Promise<void>

パラメーター

publisherName: string

発行元の名前

extensionName: string

拡張機能の名前

version: string

拡張機能のバージョン

statType: string

インクリメントする統計の種類

targetPlatform: string

戻り値

Promise<void>

performEditExtensionDraftOperation(ExtensionDraftPatch, string, string, string)

function performEditExtensionDraftOperation(draftPatch: ExtensionDraftPatch, publisherName: string, extensionName: string, draftId: string): Promise<ExtensionDraft>

パラメーター

draftPatch: ExtensionDraftPatch

publisherName: string

extensionName: string

draftId: string

戻り値

Promise<ExtensionDraft>

performNewExtensionDraftOperation(ExtensionDraftPatch, string, string)

function performNewExtensionDraftOperation(draftPatch: ExtensionDraftPatch, publisherName: string, draftId: string): Promise<ExtensionDraft>

パラメーター

draftPatch: ExtensionDraftPatch

publisherName: string

draftId: string

戻り値

Promise<ExtensionDraft>

publishExtensionEvents(ExtensionEvents[])

拡張機能のインストール/アンインストールイベントを発行する API エンドポイント。これは、拡張機能のインストール/アンインストールに関連するデータを送信するためにのみ EMS によって呼び出されることを目的としています。

function publishExtensionEvents(extensionEvents: ExtensionEvents[]): Promise<void>

パラメーター

extensionEvents: ExtensionEvents[]

戻り値

Promise<void>

publishExtensionWithPublisherSignature(any, string, string, string, string, boolean)

function publishExtensionWithPublisherSignature(content: any, publisherName: string, extensionName: string, extensionType?: string, reCaptchaToken?: string, bypassScopeCheck?: boolean): Promise<PublishedExtension>

パラメーター

content: any

アップロードするコンテンツ

publisherName: string

extensionName: string

extensionType: string

reCaptchaToken: string

bypassScopeCheck: boolean

戻り値

Promise<PublishedExtension>

queryAssociatedAzurePublisher(string)

function queryAssociatedAzurePublisher(publisherName: string): Promise<AzurePublisher>

パラメーター

publisherName: string

戻り値

Promise<AzurePublisher>

queryExtensions(ExtensionQuery, string, String)

function queryExtensions(extensionQuery: ExtensionQuery, accountToken?: string, accountTokenHeader?: String): Promise<ExtensionQueryResult>

パラメーター

extensionQuery: ExtensionQuery

accountToken: string

accountTokenHeader: String

アカウントトークンを渡すヘッダー

戻り値

Promise<ExtensionQueryResult>

queryPublishers(PublisherQuery)

function queryPublishers(publisherQuery: PublisherQuery): Promise<PublisherQueryResult>

パラメーター

publisherQuery: PublisherQuery

戻り値

Promise<PublisherQueryResult>

reportQuestion(Concern, string, string, number)

拡張機能に関する既存の質問に関する懸念事項にフラグを設定します。

function reportQuestion(concern: Concern, pubName: string, extName: string, questionId: number): Promise<Concern>

パラメーター

concern: Concern

ユーザーが拡張機能に関する質問に関する懸念を報告しました。

pubName: string

拡張機能を発行した発行元の名前。

extName: string

拡張機能の名前。

questionId: number

拡張機能に対して更新する質問の識別子。

戻り値

Promise<Concern>

requestAcquisition(ExtensionAcquisitionRequest)

function requestAcquisition(acquisitionRequest: ExtensionAcquisitionRequest): Promise<ExtensionAcquisitionRequest>

パラメーター

acquisitionRequest: ExtensionAcquisitionRequest

戻り値

Promise<ExtensionAcquisitionRequest>

sendNotifications(NotificationsData)

通知の送信

function sendNotifications(notificationData: NotificationsData): Promise<void>

パラメーター

notificationData: NotificationsData

通知の送信に必要なデータを示す

戻り値

Promise<void>

setGalleryUserSettings({[key: string]: any}, string)

特定のユーザー/すべてのユーザースコープのすべての設定エントリを設定する

function setGalleryUserSettings(entries: {[key: string]: any}, userScope: string): Promise<void>

パラメーター

entries: {[key: string]: any}

設定する必要があるすべての設定のキーと値のペア

userScope: string

値を取得する位置を User-Scope します。現在のユーザーの場合は "me"、すべてのユーザーの場合は "host" である必要があります。

戻り値

Promise<void>

shareExtension(string, string, string)

function shareExtension(publisherName: string, extensionName: string, accountName: string): Promise<void>

パラメーター

publisherName: string

extensionName: string

accountName: string

戻り値

Promise<void>

shareExtensionById(string, string)

function shareExtensionById(extensionId: string, accountName: string): Promise<void>

パラメーター

extensionId: string

accountName: string

戻り値

Promise<void>

shareExtensionWithHost(string, string, string, string)

function shareExtensionWithHost(publisherName: string, extensionName: string, hostType: string, hostName: string): Promise<void>

パラメーター

publisherName: string

extensionName: string

hostType: string

hostName: string

戻り値

Promise<void>

unshareExtension(string, string, string)

function unshareExtension(publisherName: string, extensionName: string, accountName: string): Promise<void>

パラメーター

publisherName: string

extensionName: string

accountName: string

戻り値

Promise<void>

unshareExtensionById(string, string)

function unshareExtensionById(extensionId: string, accountName: string): Promise<void>

パラメーター

extensionId: string

accountName: string

戻り値

Promise<void>

unshareExtensionWithHost(string, string, string, string)

function unshareExtensionWithHost(publisherName: string, extensionName: string, hostType: string, hostName: string): Promise<void>

パラメーター

publisherName: string

extensionName: string

hostType: string

hostName: string

戻り値

Promise<void>

updateExtension(any, string, string, string, string, boolean)

拡張機能を更新するための REST エンドポイント。

function updateExtension(content: any, publisherName: string, extensionName: string, extensionType?: string, reCaptchaToken?: string, bypassScopeCheck?: boolean): Promise<PublishedExtension>

パラメーター

content: any

アップロードするコンテンツ

publisherName: string

発行元の名前

extensionName: string

拡張機能の名前

extensionType: string

reCaptchaToken: string

bypassScopeCheck: boolean

このパラメーターは、スコープの変更チェック呼び出す必要があるかどうかを決定します

戻り値

Promise<PublishedExtension>

updateExtensionById(string, string)

function updateExtensionById(extensionId: string, reCaptchaToken?: string): Promise<PublishedExtension>

パラメーター

extensionId: string

reCaptchaToken: string

戻り値

Promise<PublishedExtension>

updateExtensionProperties(string, string, PublishedExtensionFlags)

function updateExtensionProperties(publisherName: string, extensionName: string, flags: PublishedExtensionFlags): Promise<PublishedExtension>

パラメーター

publisherName: string

extensionName: string

flags: PublishedExtensionFlags

戻り値

Promise<PublishedExtension>

updateExtensionStatistics(ExtensionStatisticUpdate, string, string)

function updateExtensionStatistics(extensionStatisticsUpdate: ExtensionStatisticUpdate, publisherName: string, extensionName: string): Promise<void>

パラメーター

extensionStatisticsUpdate: ExtensionStatisticUpdate

publisherName: string

extensionName: string

戻り値

Promise<void>

updatePayloadInDraftForEditExtension(any, string, string, string, String)

function updatePayloadInDraftForEditExtension(content: any, publisherName: string, extensionName: string, draftId: string, fileName?: String): Promise<ExtensionDraft>

パラメーター

content: any

アップロードするコンテンツ

publisherName: string

extensionName: string

draftId: string

fileName: String

アップロードされたデータのファイル名を渡すヘッダー

戻り値

Promise<ExtensionDraft>

updatePayloadInDraftForNewExtension(any, string, string, String)

function updatePayloadInDraftForNewExtension(content: any, publisherName: string, draftId: string, fileName?: String): Promise<ExtensionDraft>

パラメーター

content: any

アップロードするコンテンツ

publisherName: string

draftId: string

fileName: String

アップロードされたデータのファイル名を渡すヘッダー

戻り値

Promise<ExtensionDraft>

updatePublisher(Publisher, string)

function updatePublisher(publisher: Publisher, publisherName: string): Promise<Publisher>

パラメーター

publisher: Publisher

publisherName: string

戻り値

Promise<Publisher>

updatePublisherAsset(any, string, string, String)

ロゴなどの発行元アセットを更新します。アセットファイルはオクテットストリームとして受け入れ、ファイル名はヘッダー値で渡されます。

function updatePublisherAsset(content: any, publisherName: string, assetType?: string, fileName?: String): Promise<{[key: string]: string}>

パラメーター

content: any

アップロードするコンテンツ

publisherName: string

パブリッシャーの内部名

assetType: string

資産の種類。既定値は 'logo' です。

fileName: String

アップロードされたデータのファイル名を渡すヘッダー

戻り値

Promise<{[key: string]: string}>

updatePublisherMembers(PublisherUserRoleAssignmentRef[], string, boolean)

パブリッシャーメンバーシップを追加/変更するエンドポイント。現在、一度に 1 人のユーザーの追加/変更のみをサポートしています。同じテナントのメンバーを追加する場合にのみ機能します。

function updatePublisherMembers(roleAssignments: PublisherUserRoleAssignmentRef[], publisherName: string, limitToCallerIdentityDomain?: boolean): Promise<PublisherRoleAssignment[]>

パラメーター

roleAssignments: PublisherUserRoleAssignmentRef[]

追加するユーザー識別子 (電子メールアドレス) とロールの一覧。現在サポートされているエントリは 1 つだけです。

publisherName: string

ユーザーを追加する必要がある発行元の名前/ID

limitToCallerIdentityDomain: boolean

テナント間の追加を許可する必要があります。

戻り値

Promise<PublisherRoleAssignment[]>

updateQuestion(Question, string, string, number)

拡張機能に関する既存の質問をUpdatesします。

function updateQuestion(question: Question, publisherName: string, extensionName: string, questionId: number): Promise<Question>

パラメーター

question: Question

拡張機能に設定する質問を更新しました。

publisherName: string

拡張機能を発行した発行元の名前。

extensionName: string

拡張機能の名前。

questionId: number

拡張機能に対して更新する質問の識別子。

戻り値

Promise<Question>

updateResponse(Response, string, string, number, number)

拡張機能に関する特定の質問に対する既存の回答をUpdatesします。

function updateResponse(response: Response, publisherName: string, extensionName: string, questionId: number, responseId: number): Promise<Response>

パラメーター

response: Response

拡張機能に対して設定される応答を更新しました。

publisherName: string

拡張機能を発行した発行元の名前。

extensionName: string

拡張機能の名前。

questionId: number

拡張機能の応答を更新する質問の識別子。

responseId: number

更新する必要がある応答の識別子。

戻り値

Promise<Response>

updateReview(ReviewPatch, string, string, number)

レビューをUpdatesまたはフラグを設定する

function updateReview(reviewPatch: ReviewPatch, pubName: string, extName: string, reviewId: number): Promise<ReviewPatch>

パラメーター

reviewPatch: ReviewPatch

レビューに適用する変更を含む ReviewPatch オブジェクト

pubName: string

拡張機能を発行した発行元の名前

extName: string

拡張機能の名前

reviewId: number

更新する必要があるレビューの ID

戻り値

Promise<ReviewPatch>

updateVSCodeWebExtensionStatistics(string, string, VSCodeWebExtensionStatisicsType)

function updateVSCodeWebExtensionStatistics(itemName: string, version: string, statType: VSCodeWebExtensionStatisicsType): Promise<void>

パラメーター

itemName: string

version: string

statType: VSCodeWebExtensionStatisicsType

戻り値

Promise<void>

verifyDomainToken(string)

function verifyDomainToken(publisherName: string): Promise<void>

パラメーター

publisherName: string

戻り値

Promise<void>

次の方法で共有

GalleryRestClient class

コンストラクター

プロパティ

メソッド

コンストラクターの詳細

GalleryRestClient(IVssRestClientOptions)

パラメーター

プロパティの詳細

RESOURCE_AREA_ID

プロパティ値

メソッドの詳細

addAssetForEditExtensionDraft(string, string, string, string, string)

パラメーター

戻り値

addAssetForNewExtensionDraft(string, string, string, string)

パラメーター

戻り値

associateAzurePublisher(string, string)

パラメーター

戻り値

createCategory(ExtensionCategory)

パラメーター

戻り値

createDraftForEditExtension(string, string)

パラメーター

戻り値

createDraftForNewExtension(any, string, String, String)

パラメーター

戻り値

createExtension(any, string, string)

パラメーター

戻り値

createExtensionWithPublisher(any, string, string, string)

パラメーター

戻り値

createPublisher(Publisher)

パラメーター

戻り値

createQuestion(Question, string, string)

パラメーター

戻り値

createResponse(Response, string, string, number)

パラメーター

戻り値

createReview(Review, string, string)

パラメーター

戻り値

createSupportRequest(CustomerSupportRequest)

パラメーター

戻り値

deleteExtension(string, string, string)

パラメーター

戻り値

deleteExtensionById(string, string)

パラメーター

戻り値

deletePublisher(string)

パラメーター

戻り値

deletePublisherAsset(string, string)

パラメーター

戻り値

deleteQuestion(string, string, number)

パラメーター

戻り値

deleteResponse(string, string, number, number)

パラメーター

戻り値

deleteReview(string, string, number)

パラメーター

戻り値

extensionValidator(AzureRestApiRequestModel)

パラメーター

戻り値

fetchDomainToken(string)

パラメーター

戻り値

generateKey(string, number)

パラメーター