配送ラインの管理

2025-06-10

Microsoft Store プロモーション API の以下の方法を使用して、1 つ以上の 配信ラインを作成して、インベントリを購入し、プロモーション広告キャンペーンの広告を配信します。配信ラインごとに、予算を設定し、使用するクリエイティブにリンクすることで、ターゲット設定の設定、入札単価の設定、支出額の決定を行うことができます。

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

注この API を使用して広告キャンペーンの配信ラインを正常に作成するには、まずパートナーセンターの広告キャンペーンページを使用して 1 つの有料広告キャンペーンを作成必要があり、このページに少なくとも 1 つの支払い方法を追加する必要があります。この操作を行うと、この API を使用して広告キャンペーンの請求可能な配信ラインを正常に作成できるようになります。 API を使用して作成した広告キャンペーンは、パートナーセンターの [広告キャンペーン] ページで選択した既定の支払い方法に自動的に課金されます。

[前提条件]

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

まだ行っていない場合は、Microsoft Store プロモーション API の前提条件をすべて満たしてください。

注

前提条件の一環として、パートナーセンターで少なくとも 1 つの有料広告キャンペーンを作成し、パートナーセンターで広告キャンペーンに少なくとも 1 つの支払い方法を追加していることを確認してください。この API を使用して作成した配信ラインは、パートナーセンターの [広告キャンペーン] ページで選択した既定の支払い方法に自動的に課金されます。
これらのメソッドの要求ヘッダーで使用する Azure AD アクセストークンを取得します。アクセストークンを取得すると、有効期限が切れるまで 60 分かかります。トークンの有効期限が切れた後、新しいトークンを取得できます。

リクエスト

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

メソッドの型	URI リクエスト	説明
投稿	`https://manage.devcenter.microsoft.com/v1.0/my/promotion/line`	新しい配送ラインを作成します。
配置する	`https://manage.devcenter.microsoft.com/v1.0/my/promotion/line/{lineId}`	lineIdで指定された配信ラインを編集します。
取得する	`https://manage.devcenter.microsoft.com/v1.0/my/promotion/line/{lineId}`	lineIdで指定配信ラインを取得します。

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

リクエストの本文

POST メソッドと PUT メソッドには JSON 要求本文が必要で、Delivery line オブジェクトの必須フィールドと、設定または変更する追加フィールドが含まれます。

リクエスト例

次の例では、POST メソッドを呼び出して配信ラインを作成する方法を示します。

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

{
    "name": "Contoso App Campaign - Paid Line",
    "configuredStatus": "Active",
    "startDateTime": "2017-01-19T12:09:34Z",
    "endDateTime": "2017-01-31T23:59:59Z",
    "bidAmount": 0.4,
    "dailyBudget": 20,
    "targetProfileId": {
        "id": 310021746
    },
    "creatives": [
        {
            "id": 106851
        }
    ],
    "campaignId": 31043481,
    "minMinutesPerImp ": 1
}

次の例では、GET メソッドを呼び出して配信ラインを取得する方法を示します。

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

[応答]

これらのメソッドは、作成、更新、または取得された配信ラインに関する情報を含む、配信ラインオブジェクトを含む JSON 応答本文を返します。次の例は、これらのメソッドの応答本文を示しています。

{
    "Data": {
        "id": 31043476,
        "name": "Contoso App Campaign - Paid Line",
        "configuredStatus": "Active",
        "effectiveStatus": "Active",
        "effectiveStatusReasons": [
            "{\"ValidationStatusReasons\":null}"
        ],
        "startDateTime": "2017-01-19T12:09:34Z",
        "endDateTime": "2017-01-31T23:59:59Z",
        "createdDateTime": "2017-01-17T10:28:34Z",
        "bidType": "CPM",
        "bidAmount": 0.4,
        "dailyBudget": 20,
        "targetProfileId": {
            "id": 310021746
        },
        "creatives": [
            {
                "id": 106126
            }
        ],
        "campaignId": 31043481,
        "minMinutesPerImp ": 1,
        "pacingType ": "SpendEvenly",
        "currencyId ": 732
    }
}

配信ラインオブジェクト

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

フィールド	タイプ	説明	読み取り専用	既定値	POST/PUT 操作に必要
身分証明書	整数 (integer)	配信ラインの ID。	イエス		いいえ
名前	ひも	配信ラインの名前。	いいえ		投稿
構成済みステータス	ひも	開発者が指定した配信ラインの状態を指定する次のいずれかの値。アクティブ非アクティブ	いいえ		投稿
有効状態	ひも	システム検証に基づいて配信ラインの有効な状態を指定する次のいずれかの値。アクティブ非アクティブ処理失敗	イエス		いいえ
有効なステータスの理由	配列	配信ラインの有効なステータスの理由を指定する次の値のうち 1 つ以上。広告クリエイティブが非アクティブ検証に失敗しました	イエス		いいえ
開始日時	ひも	ISO 8601 形式の納入ラインの開始日と時刻。この値は、既に過去の値である場合は変更できません。	いいえ		POST、PUT
終了日時	ひも	納入ラインの終了日時は、ISO 8601 形式で指定されます。この値は、既に過去の値である場合は変更できません。	いいえ		POST、PUT
作成日時	ひも	ISO 8601 形式で配信ラインが作成された日時。	イエス		いいえ
入札タイプ	ひも	配信ラインの入札の種類を指定する値。現在、サポートされている唯一の値は CPMです。	いいえ	コスト・パー・ミル	いいえ
入札金額	小数点	広告リクエストの入札に使用する入札単価です。	いいえ	ターゲット市場に基づく平均 CPM 値 (この値は定期的に改訂されます)。	いいえ
1日あたりの予算	小数点	配送ラインの 1 日の予算。どちらか一方、dailyBudget または lifetimeBudget を設定する必要があります。	いいえ		POST、PUT (の lifetimeBudget が設定されていない場合)
生涯予算	小数点	配送ラインの有効期間の予算。 lifetimeBudget* または dailyBudget を設定する必要があります。	いいえ		POST、PUT (が dailyBudget に設定されていない場合)
ターゲティングプロファイルID	オブジェクト	この配信ラインのターゲットにするユーザー、地域、および在庫の種類を記述するターゲットプロファイルを識別するオブジェクト。このオブジェクトは、ターゲットプロファイルの ID を指定する 1 つの ID フィールドで構成されます。	いいえ		いいえ
クリエイティブ	配列	配信ラインに関連付けられているクリエイティブを表す 1 つ以上のオブジェクト。このフィールドの各オブジェクトは、クリエイティブの ID を指定する 1 つの ID フィールドで構成されます。	いいえ		いいえ
キャンペーンID	整数 (integer)	親広告キャンペーンの ID。	いいえ		いいえ
minMinutesPerImp	整数 (integer)	この配信ラインから同じユーザーに表示される 2 つのインプレッション間の最小時間間隔 (分単位) を指定します。	いいえ	4000	いいえ
ペーシングタイプ	ひも	次の値のうち、ペーシングタイプを指定するもの。均等に費やすできるだけ早く使い切る	いいえ	均等に使う	いいえ
通貨ID	整数 (integer)	キャンペーンの通貨の ID。	イエス	開発者アカウントの通貨 (POST または PUT 呼び出しでこのフィールドを指定する必要はありません)	いいえ

Microsoft Store Services を使用して広告キャンペーンを実行する
広告キャンペーンを管理する
広告キャンペーンのターゲットプロファイルを管理する
広告キャンペーンのクリエイティブを管理する
広告キャンペーンのパフォーマンスデータを取得

次の方法で共有