API: 予算更新（テクニカルガイド）

offers を管理するには、Mintegral token を使用する必要があります。詳細は Token を確認してください。

Mintegral API を使用して、offers の budget を管理・変更できます。

1. offer が promotion しているすべての regions に budget を追加することも、region ごとに異なる budget を追加することもできます。
   
2. offer 内のすべての target regions に budget を追加したい場合は、country_code を "ALL" のままにしてください。
   
3. offer 内の異なる regions に budget を追加する必要がある場合は、field "country_code" に該当 region の country code を追加してください。また、同じ "country_code" に複数の region code を追加した場合、その region group は budget を共有します。
   
   Notes:
   
   A) offer で targeting している regions に対してのみ budget を追加できます。
   
   B) region ごとに budget を管理する場合、当該 offer が targeting しているすべての regions に budget を設定していることを必ず確認してください。同じ region に対して複数の異なる budgets を追加することはできません。
   

Request address

https://ss-api.mintegral.com/api/open/v1/offer/budget

Request method

PUT

Request example

PUT /api/open/v1/offer/budget
HTTP/1.1 Host: ss-api.mintegral.com
Content-Type: application/json
{
  "offer_id": 123,
  "budget": [
    {
      "country_code": "US",
      "daily_cap_type": "BUDGET",
      "daily_cap": 0,
      "total_budget": "OPEN"
    },
    {
      "country_code": "CN",
      "daily_cap_type": "BUDGET",
      "daily_cap": 0,
      "total_budget": "OPEN"
    }
  ]
}

Request Parameter

Response

Response Example

{
  "msg": "success",
  "code": 200,
  "data": {}
}

Error Code

例:

{
  "code": 10000,
  "msg": "error",
  "data": {
    "budget": "The budget field is required."
  }
}

error code の詳細は以下を確認してください。

{
    "budget": "The budget field is required."
}

{
    "budget": "budget is not json string!"
}

{
    "country_code": "you can only set ALL budget
    or special budget!"
}

{
    "country_code": "KB cannot set budget, you can only 
    set budget on ALL or special country(AD,AE,AF,CN)!"
}

{
    "budget": "these (AD,AE,AF,CN) not set budget!"
}

{
    "daily_cap_type": "daily_cap_type must be
    BUDGET or CONVERSION!"
}

{
    "daily_cap": "daily_cap is empty!"
}

{
    "total_budget": "total_budget is empty!"
}

{
    "daily_cap": "daily_cap cannot less than 50!"
}