次の方法で共有

クリエイティブを管理する

Microsoft Store プロモーション API の以下の方法を使用して、プロモーション広告キャンペーンで使用する独自のカスタム クリエイティブをアップロードしたり、既存のクリエイティブを取得したりできます。 クリエイティブは、常に同じアプリを表す場合、広告キャンペーン全体であっても、1 つ以上の配信ラインに関連付けられます。

クリエイティブと広告キャンペーン、配信ライン、ターゲット プロファイルの関係の詳細については、「 Microsoft Store サービスを使用して広告キャンペーンを実行する」を参照してください。

注

この API を使用して独自のクリエイティブをアップロードする場合、クリエイティブの最大許容サイズは 40 KB です。 これより大きいクリエイティブ ファイルを送信した場合、この API はエラーを返しませんが、キャンペーンは正常に作成されません。

[前提条件]

これらのメソッドを使用するには、まず次の操作を行う必要があります。

リクエスト

これらのメソッドには、次の URI があります。

メソッドの型 URI リクエスト 説明
投稿 https://manage.devcenter.microsoft.com/v1.0/my/promotion/creative 新しいクリエイティブを作成します。
取得する https://manage.devcenter.microsoft.com/v1.0/my/promotion/creative/{creativeId} 指定されたクリエイティブIDのクリエイティブ を取得します。

注

この API は現在、PUT メソッドをサポートしていません。

ヘッダ タイプ 説明
認証 ひも 必須。 Bearer<token> 形式の Azure AD アクセス トークン。
追跡 ID GUID（グローバルユニーク識別子） 任意。 呼び出しフローを追跡する ID。

リクエストの本文

POST メソッドには、 Creative オブジェクトの必須フィールドを含む JSON 要求本文が必要です。

リクエスト例

次の例では、POST メソッドを呼び出してクリエイティブを作成する方法を示します。 この例では、 簡潔にするためにコンテンツ 値が短縮されています。

POST https://manage.devcenter.microsoft.com/v1.0/my/promotion/creative HTTP/1.1
Authorization: Bearer <your access token>

{
  "name": "Contoso App Campaign - Creative 1",
  "content": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEAAQABAAD/2wBDAAgGB...other base64 data shortened for brevity...",
  "height": 80,
  "width": 480,
  "imageAttributes":
  {
    "imageExtension": "PNG"
  }
}

次の例では、GET メソッドを呼び出してクリエイティブを取得する方法を示します。

GET https://manage.devcenter.microsoft.com/v1.0/my/promotion/creative/106851  HTTP/1.1
Authorization: Bearer <your access token>

[応答]

これらのメソッドは、作成または取得されたクリエイティブに関する情報を含む Creative オブジェクトを含む JSON 応答本文を返します。 次の例は、これらのメソッドの応答本文を示しています。 この例では、 簡潔にするためにコンテンツ 値が短縮されています。

{
    "Data": {
        "id": 106126,
        "name": "Contoso App Campaign - Creative 2",
        "content": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEAAQABAAD/2wBDAAgGB...other base64 data shortened for brevity...",
        "height": 50,
        "width": 300,
        "format": "Banner",
        "imageAttributes":
        {
          "imageExtension": "PNG"
        },
        "storeProductId": "9nblggh42cfd"
    }
}

創造的な対象

これらのメソッドの要求と応答の本文には、次のフィールドが含まれています。 次の表は、どのフィールドが読み取り専用か (つまり、PUT メソッドでは変更できません)、POST メソッドの要求本文で必要なフィールドを示しています。

フィールド タイプ 説明 読み取り専用 既定値 POST に必須
身分証明書 整数 (integer) クリエイティブの ID。 イエス いいえ
名前 ひも クリエイティブの名前。 いいえ イエス
内容 ひも Base64 でエンコードされた形式のクリエイティブ イメージのコンテンツ。

手記 クリエイティブの最大許容サイズは 40 KB です。 これより大きいクリエイティブ ファイルを送信した場合、この API はエラーを返しませんが、キャンペーンは正常に作成されません。		 いいえ イエス
高さ 整数 (integer) 創造性の頂点。 いいえ イエス
幅 整数 (integer) クリエイティブの幅。 いいえ イエス
ランディングURL ひも AppsFlyer、Kochava、Tune、Vungle などのキャンペーン追跡サービスを使用してアプリのインストール分析を測定する場合は、POST メソッドを呼び出すときにこのフィールドに追跡 URL を割り当てます (指定されている場合、この値は有効な URI である必要があります)。 キャンペーン追跡サービスを使用していない場合は、POST メソッドを呼び出すときにこの値を省略します (この場合、この URL は自動的に作成されます)。 いいえ イエス
フォーマット ひも 広告の形式。 現在、サポートされている値は Banner のみです。 いいえ バナー いいえ
画像属性 ImageAttributes クリエイティブの属性を提供します。 いいえ イエス
ストア商品ID ひも この広告キャンペーンが関連付けられているアプリの ストア ID。 製品のストア ID の例は 9nblggh42cfd です。 いいえ いいえ

ImageAttributes オブジェクト

フィールド タイプ 説明 読み取り専用 既定値 POST に必須
imageExtension ひも 次のいずれかの値: PNG または JPG。 いいえ イエス