ターゲット プロファイルの管理Manage targeting profiles

プロモーション用の広告キャンペーンの各配信ラインで対象とするユーザー、地域、インベントリの種類を選択するには、Microsoft Store プロモーション API の以下のメソッドを使います。Use these methods in the Microsoft Store promotions API to select the users, geographies and inventory types that you want to target for each delivery line in a promotional ad campaign. ターゲット プロファイルは、複数の配信ライン間で作成して再利用できます。Targeting profiles can be created and reused across multiple delivery lines.

ターゲット プロファイルと広告キャンペーン、配信ライン、クリエイティブとの関係について詳しくは、「Microsoft Store サービスを使用した広告キャンペーンの実行」をご覧ください。For more information about the relationship between targeting profiles and ad campaigns, delivery lines, and creatives, see Run ad campaigns using Microsoft Store services.

前提条件Prerequisites

これらのメソッドを使うには、最初に次の作業を行う必要があります。To use these methods, you need to first do the following:

  • Microsoft Store プロモーション API に関するすべての前提条件を満たします (前提条件がまだ満たされていない場合)。If you have not done so already, complete all the prerequisites for the Microsoft Store promotions API.
  • これらのメソッドの要求ヘッダーで使う Azure AD アクセス トークンを取得します。Obtain an Azure AD access token to use in the request header for these methods. アクセス トークンを取得した後、アクセス トークンを使用できるのは、その有効期限が切れるまでの 60 分間です。After you obtain an access token, you have 60 minutes to use it before it expires. トークンの有効期限が切れたら新しいトークンを取得できます。After the token expires, you can obtain a new one.

要求Request

これらのメソッドでは、次の URL が使用されます。These methods have the following URIs.

メソッドの種類Method type 要求 URIRequest URI 説明Description
POSTPOST https://manage.devcenter.microsoft.com/v1.0/my/promotion/targeting-profile 新しいターゲット プロファイルを作成します。Creates a new targeting profile.
PUTPUT https://manage.devcenter.microsoft.com/v1.0/my/promotion/targeting-profile/{targetingProfileId} targetingProfileId により指定されたターゲット プロファイルを編集します。Edits the targeting profile specified by targetingProfileId.
GETGET https://manage.devcenter.microsoft.com/v1.0/my/promotion/targeting-profile/{targetingProfileId} targetingProfileId により指定されたターゲット プロファイルを取得します。Gets the targeting profile specified by targetingProfileId.
HeaderHeader 種類Type 説明Description
AuthorizationAuthorization stringstring 必須。Required. Bearer <トークン> という形式の Azure AD アクセス トークン。The Azure AD access token in the form Bearer <token>.
追跡 IDTracking ID GUIDGUID (省略可能)。Optional. 呼び出しフローを追跡する ID。An ID that tracks the call flow.

要求本文Request body

POST メソッドと PUT メソッドには、ターゲット プロファイル オブジェクトの必須フィールドと設定または変更する追加フィールドを持つ JSON 要求本文が必要です。The POST and PUT methods require a JSON request body with the required fields of a Targeting profile object and any additional fields you want to set or change.

要求の例Request examples

次の例は、POST メソッドを呼び出してターゲット プロファイルを作成する方法を示しています。The following example demonstrates how to call the POST method to create a targeting profile.

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

{
    "name": "Contoso App Campaign - Targeting Profile 1",
    "targetingType": "Manual",
    "age": [
      651,
      652],
    "gender": [
      700
    ],
    "country": [
      11,
      12
    ],
    "osVersion": [
      504
    ],
    "deviceType": [
      710
    ],
    "supplyType": [
      11470
    ]
}

次の例は、GET メソッドを呼び出してターゲット プロファイルを取得する方法を示しています。The following example demonstrates how to call the GET method to retrieve a targeting profile.

GET https://manage.devcenter.microsoft.com/v1.0/my/promotion/targeting-profile/310023951  HTTP/1.1
Authorization: Bearer <your access token>

応答Response

これらのメソッドは、作成、更新、または取得されたターゲット プロファイルに関する情報を含むターゲット プロファイル オブジェクトを持つ JSON 応答本文を返します。These methods return a JSON response body with a Targeting profile object that contains information about the targeting profile that was created, updated, or retrieved. これらのメソッドの応答本文を次の例に示します。The following example demonstrates a response body for these methods.

{
  "Data": {
    "id": 310021746,
    "name": "Contoso App Campaign - Targeting Profile 1",
    "targetingType": "Manual",
    "age": [
      651,
      652
    ],
    "gender": [
      700
    ],
    "country": [
      6,
      13,
      29
    ],
    "osVersion": [
      504,
      505,
      506,
      507,
      508
    ],
    "deviceType": [
      710,
      711
    ],
    "supplyType": [
      11470
    ]
  }
}

ターゲット プロファイル オブジェクトTargeting profile object

これらのメソッドの要求本文と応答本文には、次のフィールドが含まれています。The request and response bodies for these methods contain the following fields. この表は、読み取り専用のフィールド (つまり、PUT メソッドで変更できない) と POST メソッドの要求本文で必須のフィールドを示しています。This table shows which fields are read-only (meaning that they cannot be changed in the PUT method) and which fields are required in the request body for the POST method.

フィールドField 種類Type 説明Description 読み取り専用かどうかRead only DefaultDefault POST に必須かどうかRequired for POST
idid 整数integer ターゲット プロファイルの ID。The ID of the targeting profile. Yes XNo
namename stringstring ターゲット プロファイルの名前。The name of the targeting profile. いいえNo Yes
targetingTypetargetingType stringstring 次のいずれかの値です。One of the following values:
  • 自動:Microsoft パートナー センターでアプリの設定に基づいて対象とするプロファイルを選択することを許可するには、この値を指定します。Auto: Specify this value to allow Microsoft to choose the targeting profile based on the settings for your app in Partner Center.
  • 手動:独自のプロファイルのターゲットを定義するには、この値を指定します。Manual: Specify this value to define your own targeting profile.
いいえNo AutoAuto Yes
ageage arrayarray 対象とするユーザーの年齢範囲を識別する 1 つ以上の整数です。One or more integers that identify the age ranges of the users to target. 整数の詳しい一覧については、この記事の「年齢の値」をご覧ください。For a complete list of integers, see Age values in this article. いいえNo nullnull XNo
gendergender arrayarray 対象とするユーザーの性別を識別する 1 つ以上の整数です。One or more integers that identify the genders of the users to target. 整数の詳しい一覧については、この記事の「性別の値」をご覧ください。For a complete list of integers, see Gender values in this article. XNo nullnull いいえNo
countrycountry arrayarray 対象とするユーザーの国コードを識別する 1 つ以上の整数です。One or more integers that identify the country codes of the users to target. 整数の詳しい一覧については、この記事の「国コードの値」をご覧ください。For a complete list of integers, see Country code values in this article. XNo nullnull XNo
osVersionosVersion arrayarray 対象とするユーザーの OS バージョンを識別する 1 つ以上の整数です。One or more integers that identify the OS versions of the users to target. 整数の詳しい一覧については、この記事の「OS バージョンの値」をご覧ください。For a complete list of integers, see OS version values in this article. いいえNo nullnull いいえNo
deviceTypedeviceType arrayarray 対象とするユーザーのデバイスの種類を識別する 1 つ以上の整数です。One or more integers that identify the device types of the users to target. 整数の詳しい一覧については、この記事の「デバイスの種類の値」をご覧ください。For a complete list of integers, see Device type values in this article. いいえNo nullnull XNo
supplyTypesupplyType arrayarray キャンペーンの広告が表示されるインベントリの種類を識別する 1 つ以上の整数です。One or more integers that identify the type of inventory where the campaign's ads will be shown. 整数の詳しい一覧については、この記事の「サプライの種類の値」をご覧ください。For a complete list of integers, see Supply type values in this article. XNo nullnull XNo

年齢の値Age values

TargetingProfile オブジェクトの age フィールドには、対象とするユーザーの年齢範囲を識別する次の整数が 1 つ以上含まれています。The age field in the TargetingProfile object contains one or more of the following integers that identify the age ranges of the users to target.

age フィールドの整数値Integer value for age field 対応する年齢範囲Corresponding age range
651651 13 ~ 1713 to 17
652652 18 ~ 2418 to 24
653653 25 ~ 3425 to 34
654654 35 ~ 4935 to 49
655655 50 以上50 and above

age フィールドでサポートされる値をプログラムにより取得するには、次の GET メソッドを呼び出します。To get the supported values for the age field programmatically, you can call the following GET method. Authorizationヘッダー形式で Azure AD アクセス トークンを渡すベアラー <トークン>します。For the Authorization header, pass your Azure AD access token in the form Bearer <token>.

GET https://manage.devcenter.microsoft.com/v1.0/my/promotion/reference/age
Authorization: Bearer <your access token>

次の例は、このメソッドの応答本文を示します。The following example shows the response body for this method.

{
  "Data": {
    "Age": {
      "651": "Age13To17",
      "652": "Age18To24",
      "653": "Age25To34",
      "654": "Age35To49",
      "655": "Age50AndAbove"
    }
  }
}

性別の値Gender values

TargetingProfile オブジェクトの gender フィールドには、対象とするユーザーの性別を識別する次の整数が 1 つ以上含まれています。The gender field in the TargetingProfile object contains one or more of the following integers that identify the genders of the users to target.

gender フィールドの整数値Integer value for gender field 対応する性別Corresponding gender
700700 男性Male
701701 女性Female

gender フィールドでサポートされる値をプログラムにより取得するには、次の GET メソッドを呼び出します。To get the supported values for the gender field programmatically, you can call the following GET method. Authorizationヘッダー形式で Azure AD アクセス トークンを渡すベアラー <トークン>します。For the Authorization header, pass your Azure AD access token in the form Bearer <token>.

GET https://manage.devcenter.microsoft.com/v1.0/my/promotion/reference/gender
Authorization: Bearer <your access token>

次の例は、このメソッドの応答本文を示します。The following example shows the response body for this method.

{
  "Data": {
    "Gender": {
      "700": "Male",
      "701": "Female"
    }
  }
}

OS バージョンの値OS version values

TargetingProfile オブジェクトの osVersion フィールドには、対象とするユーザーの OS バージョンを識別する次の整数が 1 つ以上含まれています。The osVersion field in the TargetingProfile object contains one or more of the following integers that identify the OS versions of the users to target.

osVersion フィールドの整数値Integer value for osVersion field 対応する OS バージョンCorresponding OS version
500500 Windows Phone 7Windows Phone 7
501501 Windows Phone 7.1Windows Phone 7.1
502502 Windows Phone 7.5Windows Phone 7.5
503503 Windows Phone 7.8Windows Phone 7.8
504504 Windows Phone 8.0Windows Phone 8.0
505505 Windows Phone 8.1Windows Phone 8.1
506506 Windows 8.0Windows 8.0
507507 Windows 8.1Windows 8.1
508508 Windows 10Windows 10
509509 Windows 10 MobileWindows 10 Mobile

osVersion フィールドでサポートされる値をプログラムにより取得するには、次の GET メソッドを呼び出します。To get the supported values for the osVersion field programmatically, you can call the following GET method. Authorizationヘッダー形式で Azure AD アクセス トークンを渡すベアラー <トークン>します。For the Authorization header, pass your Azure AD access token in the form Bearer <token>.

GET https://manage.devcenter.microsoft.com/v1.0/my/promotion/reference/osversion
Authorization: Bearer <your access token>

次の例は、このメソッドの応答本文を示します。The following example shows the response body for this method.

{
  "Data": {
    "OsVersion": {
      "500": "WindowsPhone70",
      "501": "WindowsPhone71",
      "502": "WindowsPhone75",
      "503": "WindowsPhone78",
      "504": "WindowsPhone80",
      "505": "WindowsPhone81",
      "506": "Windows80",
      "507": "Windows81",
      "508": "Windows10",
      "509": "WindowsPhone10"
    }
  }
}

デバイスの種類の値Device type values

TargetingProfile オブジェクトの deviceType フィールドには、対象とするユーザーのデバイスの種類を識別する次の整数が 1 つ以上含まれています。The deviceType field in the TargetingProfile object contains one or more of the following integers that identify the device types of the users to target.

deviceType フィールドの整数値Integer value for deviceType field 対応するデバイスの種類Corresponding device type 説明Description
710710 WindowsWindows これは、Windows 10 または Windows 8.x のデスクトップ バージョンを実行しているデバイスを表しています。This represents devices running a desktop version of Windows 10 or Windows 8.x.
711711 PhonePhone これは、Windows 10 Mobile、Windows Phone 8.x、Windows Phone 7.x を実行しているデバイスを表しています。This represents devices running Windows 10 Mobile, Windows Phone 8.x, or Windows Phone 7.x.

deviceType フィールドでサポートされる値をプログラムにより取得するには、次の GET メソッドを呼び出します。To get the supported values for the deviceType field programmatically, you can call the following GET method. Authorizationヘッダー形式で Azure AD アクセス トークンを渡すベアラー <トークン>します。For the Authorization header, pass your Azure AD access token in the form Bearer <token>.

GET https://manage.devcenter.microsoft.com/v1.0/my/promotion/reference/devicetype
Authorization: Bearer <your access token>

次の例は、このメソッドの応答本文を示します。The following example shows the response body for this method.

{
  "Data": {
    "DeviceType": {
      "710": "Windows",
      "711": "Phone"
    }
  }
}

サプライの種類の値Supply type values

TargetingProfile オブジェクトの supplyType フィールドには、キャンペーンの広告が表示されるインベントリの種類を識別する次の整数が 1 つ以上含まれています。The supplyType field in the TargetingProfile object contains one or more of the following integers that identify the type of inventory where the campaign's ads will be shown.

supplyType フィールドの整数値Integer value for supplyType field 対応するサプライの種類Corresponding supply type 説明Description
1147011470 AppApp これは、アプリにのみ表示される広告を示しています。This refers to ads that appear in apps only.
1147111471 ユニバーサルUniversal これは、アプリ、Web、および他のディスプレイ サーフェスに表示される広告を示しています。This refers to ads that appear in apps, on the Web, and on and other display surfaces.

supplyType フィールドでサポートされる値をプログラムにより取得するには、次の GET メソッドを呼び出します。To get the supported values for the supplyType field programmatically, you can call the following GET method. Authorizationヘッダー形式で Azure AD アクセス トークンを渡すベアラー <トークン>します。For the Authorization header, pass your Azure AD access token in the form Bearer <token>.

GET https://manage.devcenter.microsoft.com/v1.0/my/promotion/reference/supplytype
Authorization: Bearer <your access token>

次の例は、このメソッドの応答本文を示します。The following example shows the response body for this method.

{
  "Data": {
    "SupplyType": {
      "11470": "App",
      "11471": "Universal"
    }
  }
}

国コードの値Country code values

TargetingProfile オブジェクトの country フィールドには、対象とするユーザーの ISO 3166-1 alpha-2 国コードを識別する次の整数が 1 つ以上含まれています。The country field in the TargetingProfile object contains one or more of the following integers that identify the ISO 3166-1 alpha-2 country codes of the users to target.

country フィールドの整数値Integer value for country field 対応する国コードCorresponding country code
11 USUS
22 AUAU
33 ATAT
44 BEBE
55 BRBR
66 CACA
77 DKDK
88 FIFI
99 FRFR
1010 DEDE
1111 GRGR
1212 HKHK
1313 ININ
1414 Internet ExplorerIE
1515 ITIT
1616 JPJP
1717 LULU
1818 MXMX
1919 NLNL
2020 NZNZ
2121 使用不可NO
2222 PLPL
2323 PTPT
2424 SGSG
2525 ESES
2626 SESE
2727 CHCH
2828 TWTW
2929 GBGB
3030 RURU
3131 CLCL
3232 COCO
3333 CZCZ
3434 HUHU
3535 ZAZA
3636 KRKR
3737 CNCN
3838 RORO
3939 TRTR
4040 SKSK
4141 ILIL
4242 IDID
4343 ARAR
4444 MYMY
4545 PHPH
4646 PEPE
4747 UAUA
4848 AEAE
4949 THTH
5050 IQIQ
5151 VNVN
5252 CRCR
5353 VEVE
5454 QAQA
5555 SISI
5656 BGBG
5757 LTLT
5858 RSRS
5959 HRHR
6060 HRHR
6161 LVLV
6262 EEEE
6363 ISIS
6464 KZKZ
6565 SASA
6767 ALAL
6868 DZDZ
7070 AOAO
7272 AMAM
7373 AZAZ
7474 BSBS
7575 BDBD
7676 BBBB
7777 BYBY
8181 BOBO
8282 BABA
8383 BWBW
8787 KHKH
8888 CMCM
9494 CDCD
9595 CICI
9696 CYCY
9999 DODO
100100 ECEC
101101 EGEG
102102 SVSV
107107 FJFJ
108108 GAGA
110110 GEGE
111111 GHGH
114114 GTGT
118118 HTHT
119119 HNHN
120120 JMJM
121121 JOJO
122122 KEKE
124124 KWKW
125125 KGKG
126126 LALA
127127 LBLB
133133 MKMK
135135 MWMW
138138 MTMT
141141 MUMU
145145 MEME
146146 MAMA
147147 MZMZ
148148 該当なしNA
150150 NPNP
151151 NINI
153153 NGNG
154154 OMOM
155155 PKPK
157157 PAPA
159159 PYPY
167167 SNSN
172172 LKLK
176176 TZTZ
180180 TTTT
181181 TNTN
184184 UGUG
185185 UYUY
186186 UZUZ
189189 ZMZM
190190 ZWZW
219219 MDMD
224224 PSPS
225225 RERE
246246 PRPR

country フィールドでサポートされる値をプログラムにより取得するには、次の GET メソッドを呼び出します。To get the supported values for the country field programmatically, you can call the following GET method. Authorizationヘッダー形式で Azure AD アクセス トークンを渡すベアラー <トークン>します。For the Authorization header, pass your Azure AD access token in the form Bearer <token>.

GET https://manage.devcenter.microsoft.com/v1.0/my/promotion/reference/country
Authorization: Bearer <your access token>

次の例は、このメソッドの応答本文を示します。The following example shows the response body for this method.

{
  "Data": {
    "Country": {
      "1": "US",
      "2": "AU",
      "3": "AT",
      "4": "BE",
      "5": "BR",
      "6": "CA",
      "7": "DK",
      "8": "FI",
      "9": "FR",
      "10": "DE",
      "11": "GR",
      "12": "HK",
      "13": "IN",
      "14": "IE",
      "15": "IT",
      "16": "JP",
      "17": "LU",
      "18": "MX",
      "19": "NL",
      "20": "NZ",
      "21": "NO",
      "22": "PL",
      "23": "PT",
      "24": "SG",
      "25": "ES",
      "26": "SE",
      "27": "CH",
      "28": "TW",
      "29": "GB",
      "30": "RU",
      "31": "CL",
      "32": "CO",
      "33": "CZ",
      "34": "HU",
      "35": "ZA",
      "36": "KR",
      "37": "CN",
      "38": "RO",
      "39": "TR",
      "40": "SK",
      "41": "IL",
      "42": "ID",
      "43": "AR",
      "44": "MY",
      "45": "PH",
      "46": "PE",
      "47": "UA",
      "48": "AE",
      "49": "TH",
      "50": "IQ",
      "51": "VN",
      "52": "CR",
      "53": "VE",
      "54": "QA",
      "55": "SI",
      "56": "BG",
      "57": "LT",
      "58": "RS",
      "59": "HR",
      "60": "BH",
      "61": "LV",
      "62": "EE",
      "63": "IS",
      "64": "KZ",
      "65": "SA",
      "67": "AL",
      "68": "DZ",
      "70": "AO",
      "72": "AM",
      "73": "AZ",
      "74": "BS",
      "75": "BD",
      "76": "BB",
      "77": "BY",
      "81": "BO",
      "82": "BA",
      "83": "BW",
      "87": "KH",
      "88": "CM",
      "94": "CD",
      "95": "CI",
      "96": "CY",
      "99": "DO",
      "100": "EC",
      "101": "EG",
      "102": "SV",
      "107": "FJ",
      "108": "GA",
      "110": "GE",
      "111": "GH",
      "114": "GT",
      "118": "HT",
      "119": "HN",
      "120": "JM",
      "121": "JO",
      "122": "KE",
      "124": "KW",
      "125": "KG",
      "126": "LA",
      "127": "LB",
      "133": "MK",
      "135": "MW",
      "138": "MT",
      "141": "MU",
      "145": "ME",
      "146": "MA",
      "147": "MZ",
      "148": "NA",
      "150": "NP",
      "151": "NI",
      "153": "NG",
      "154": "OM",
      "155": "PK",
      "157": "PA",
      "159": "PY",
      "167": "SN",
      "172": "LK",
      "176": "TZ",
      "180": "TT",
      "181": "TN",
      "184": "UG",
      "185": "UY",
      "186": "UZ",
      "189": "ZM",
      "190": "ZW",
      "219": "MD",
      "224": "PS",
      "225": "RE",
      "246": "PR"
    }
  }
}