注
クラウドパートナーポータル API は統合されており、パートナーセンターで引き続き動作します。 移行によって、小さな変化がもたらされます。 このドキュメントに記載されている CPP API の変更 点を確認して、パートナー センターに移行した後もコードが引き続き機能することを確認します。 CPP APIは、パートナー センターへの移行前にすでに統合されていた既存の製品にのみ使用すべきです。新しい製品には、パートナー センター提出 APIを使用してください。
Cloud パートナー ポータル REST API を使用すると、ワークロード、オファー、発行元プロファイルをプログラムで取得および操作できます。 API は、Azure ロールベースのアクセス制御 (Azure RBAC) を使用して、処理時に適切なアクセス許可を適用します。
このリファレンスでは、Cloud パートナー ポータル REST API の技術的な詳細について説明します。 このドキュメントのペイロード サンプルは参照用であり、新しい機能が追加されると変更される可能性があります。
前提条件と考慮事項
API を使用する前に、以下を確認する必要があります。
- アカウントにサービス プリンシパルを追加する方法と、認証用の Microsoft Entra アクセス トークンを取得する方法については、 前提条件 に関する記事を参照してください。
- これらの API を呼び出すために使用できる 2 つの 同時実行制御 戦略。
- バージョン管理やエラー処理など、その他の API に関する考慮事項。
パートナー センターへの移行後の CPP API の変更
| API | 変更の説明 | 影響 |
|---|---|---|
| POST公開、GoLive、キャンセル | 移行されたオファーの場合、応答ヘッダーの形式は異なりますが、操作の状態を取得するための相対パスを示すため、引き続き同じように機能します。 | オファーに対応する POST 要求のいずれかを送信する場合、Location ヘッダーは、オファーの移行状態に応じて、次の 2 つの形式のいずれかになります。
|
| GET操作 | 以前に応答の 'notification-email' フィールドをサポートしていたオファーの種類の場合、このフィールドは非推奨となり、移行されたオファーでは返されなくなります。 | 移行されたオファーについては、リクエストで指定されたメールの一覧に通知が送信されなくなります。 代わりに、API サービスは、パートナー センターの通知メール プロセスと連携してメールを送信します。 具体的には、パートナー センターの [アカウント設定] の [販売者の連絡先情報] セクションで設定されたメール アドレスに通知が送信され、運用の進行状況が通知されます。 パートナー センターの [アカウント設定 ] の [販売者の連絡先情報] セクションで設定されたメール アドレスを確認して、通知に正しいメールが提供されていることを確認します。 |
一般的なタスク
このリファレンスでは、次の一般的なタスクを実行するための API について詳しく説明します。
オファー
オペレーション
アプリの公開
その他のタスク
トラブルシューティング
API のバージョンと更新
| 更新 | 何が変わったのですか? |
|---|---|
| 12-2022 | CPP パブリック API (バージョン 2017-10-31) が更新され、顧客リードの構成中に Marketo コネクタの clientId と clientSecret がキャプチャされるようになりました。 リードの設定中に、今後は serverId フィールドを指定する必要はありません。 この API の更新には、バージョンの更新や破壊的変更は含まれません。 |