Share via

Cloud パートナー ポータルの API リファレンス

  • [アーティクル]

Note

Cloud パートナー ポータル API はパートナー センターと統合されており、引き続き機能します。 切り替えにより、小さな変更が加えられました。 このドキュメントに記載されている CPP API の変更点を調べて、パートナー センターへの切り替え後にコードが機能し続けることを確認してください。 CPP API は、パートナー センターへの切り替え前に既に統合されている既存の製品に対してのみ使用してください。新しい製品では、パートナー センター申請 API を使用する必要があります。

Cloud パートナー ポータルの REST API を使用すると、ワークロード、プラン、発行元プロファイルのプログラムによる取得と操作が可能になります。 API は、処理時に正しいアクセス許可を実施するために、Azure ロールベースのアクセス制御 (Azure RBAC) を使用します。

このリファレンスでは、Cloud パートナー ポータル REST API の技術的な詳細について説明します。 このドキュメントのペイロードのサンプルは参考にすぎず、新しい機能が追加されると変更される可能性があります。

前提条件と考慮事項

API を使用する前に、次の点を確認してください。

パートナー センターへの移行後の CPP API の変更点

API 変更の説明 影響
公開、GoLive、キャンセル後 移行されたオファーの場合、応答ヘッダーの形式は異なりますが、操作の状態を取得するための相対パスを示す同じ方法で動作し続けます。 オファーに対して対応する POST 要求のいずれかを送信する場合、Location ヘッダーには、オファーの移行状態に応じて次の 2 つの形式のいずれかが含まれます。
  • 未割り当てプラン
    /api/operations/{PublisherId}${offerId}$2$preview?api-version=2017-10-31
  • 移行されたオファー
    /api/publishers/{PublisherId}/offers/{offereId}/operations/408a4835-0000-1000-0000-000000000000?api-version=2017-10-31
GET 操作 以前に応答の 'notification-email' フィールドをサポートしていたオファーの種類の場合、このフィールドは非推奨になり、移行されたオファーでは返されなくなります。 移行されたオファーの場合、要求で指定されたメール アドレスのリストに通知が送信されなくなります。 代わりに、API サービスはパートナー センターの通知メール プロセスに合わせて、電子メールを送信します。 具体的には、パートナー センターの [アカウント設定] の [販売元の連絡先情報] セクションに設定されたメール アドレスに通知が送信され、操作の進行状況が通知されます。

パートナー センターのアカウント設定の [販売者の連絡先情報] セクションで設定されたメール アドレスを確認し、通知用に正しいメールが提供されていることを確認します。

一般的なタスク

このリファレンスでは、以下の一般的なタスクを実行するための API について詳しく説明します。

オファー

操作

アプリを公開

その他のタスク

トラブルシューティング

API のバージョンと更新プログラム

を更新する どのような点が変わりましたか?
12-2022 CPP パブリック API (バージョン 2017-10-31) が更新され、顧客リードの構成中に Marketo コネクタ用の clientId と clientSecret がキャプチャされるようになりました。 リードの構成中に、今後 serverId フィールドを指定する必要はありません。 この API の更新には、バージョンの更新や破壊的変更は含まれません。