メニュー

API: オファーリスト取得（テクニカルガイド）

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

ad offer list を取得します。campaign_id、campaign_name、offer_id、offer_name、offer_uuid、status、package_name、ext_fields による検索に対応しています。

Request address

https://ss-api.mintegral.com/api/open/v1/offers

Request method

GET

Request example

json Copy

GET /api/open/v1/offers
HTTP/1.1 Host: ss-api.mintegral.com
Content-Type: application/json
{ "page": 1, "campaign_id": "12,13,15", "limit": 10 }

Request Parameter

Fields	Type	Explanations	Default Value	Examples
campaign_id `Optional`	string	Campaign ID。複数 ID はカンマで区切ります。	—	`"12,13,15"`
campaign_name `Optional`	string	Campaign name。Fuzzy query に対応しています。	""	`"campaign_test"`
offer_id `Optional`	string	Offer ID。複数 ID はカンマで区切ります。	—	`"123,124,125"`
offer_name `Optional`	string	Offer name。Fuzzy query に対応しています。	""	`"offer_test"`
offer_uuid `Optional`	string	自動生成される unique offer name	—	`"ss_offer_test"`
package_name `Optional`	string	promotion application の Package name。Fuzzy query に対応しています。	""	`"test"`
ext_fields `Optional`	string	Extended queries。複数 queries はカンマで区切ります。対応 query: bid_rate_by_mtgid => specific publisher の bid rate target_app => specific apps を block または target するために使用される field	""	`"bid_rate_by_mtgid"`
page `Optional`	int	Page	1	`1`
limit `Optional`	int	各 page の limit Maximam: 50 >50 の場合は 50 を返します。	10	`15`
status `Optional`	string	optional field。複数 status に対応します。 [ENUM-Offer Status] を確認してください。	""	`"RUNNING"`

Response

Fields	Type	Explanations
code	int	200 code は成功を示します。それ以外は失敗です。
msg	string	成功時は “success” を返します。失敗時は詳細なエラー情報を返します。
data	json	成功時は “Offer” を返します。失敗時は詳細なエラー情報を返します。
page	int	current page
limit	int	quantity limit
total	int	total amount
list	array<json>	offer list
campaign_id	int	campaign の一意の id
campaign_name	string	Campaign Name
offer_id	int	offer の一意の id
uuid	string	自動生成される unique offer name。tracking url の設定によく使用されます。
offer_name	string	設定した Offer name
promote_timezone	number	promotion period の timezone setting（例: -5）
start_time	string	promotion start time の timestamp
end_time	string	promotion end time の timestamp
status	string	Offer Status。Enum value：[ENUM-Offer Status]
country_code	string	promotion の Target geos。例: `"US,CN"`
stage	string	offer dimension の cold start phase
bid_type	string	Pricing model
bid_rate	float	すべての offer target geos に対する default bidding price value。specific geo または application bid が設定されていない場合にのみ適用されます。
bid_rate_by_location	array<json>	specific geos の Bidding price value。sample: [{"target_geo":"US","bid_rate":"8.010"},{"country_code":"CN","bid_rate":"3.920"}]
budget	array<json>	Budget info
offer_stop_reason	string	offer が paused された理由。例: account balance insufficient、利用可能な creative がない、click tracking link が invalid など。
settlement_event	string	CPE promotion の Settlement event。
tracking_method	string	Tracking method。Enum value：[ENUM-Tracking Method]
click_url	string	Click attribution tracking URL
impression_url	string	View-through attribution tracking URL。
os_version_min	string	Minimum OS version
custom_ad_schedule	string	Promotion schedule
network	string	device network status の target
target_ad_type	string	Ad type
currency	string	Settlement currency。Enum value: `"CNY"`, `"USD"`
target_device	string	Target device type
click_url_status	string	click attribution tracking URL の testing status。Enum value: PENDDING => Click URL は test 待ち、または click url が未通過で引き続き testing 中 PASS => Click URL は利用可能 NOT_EXIST => Click URL は null
target_app	array<json>	block または target された apps の詳細
switch	int	1=>target apps；2=> block apps；0=>unlimited
mtg_id	array<string>	mtgid
package	array<string>	package name
bid_rate_for_mtgid	array<json>	specific publishers の Bidding price value
apply_in_area	string	Targeted geos
mtgid	string	publisher の一意の id
bid_rate	string	specific area における specific publisher の bidding price value
maintain_by	string	offer を変更する access。maintain_by="AM" の場合、campaign または offer の details のみ確認できます。maintain_by="ADV" の場合、campaign または offer の settings を自由に変更できます。
include_ta_id	array<int>	include target audience id
exclude_ta_id	array<int>	exclude target audience id
target_mtg_event	array<string>	最適化対象。Target-ROAS または Target-CPE の場合のみ返されます。
target_original_event	string	最適化する Original event。Target-CPE の場合のみ返されます。
target_goal_window	string	optimization goal の time window。enumeration value: D0, D7。Target-ROAS または Target-CPE の場合のみ返されます。
target_goal	double	offer dimension で最適化する goal value。Target-ROAS または Target-CPE の場合のみ返されます。
target_goal_by_geo	array<json>	geo dimension で最適化する objective value。Target-ROAS または Target-CPE の場合のみ返されます。
geo	string	geo
target_goal	double	target value を最適化します。

Response Example

json Copy

{
  "msg": "success",
  "code": 200,
  "data": {
    "page": 1,
    "limit": 10,
    "total": 520,
    "list": [
      {
        "campaign_id": 111,
        "campaign_name": "campaign_test",
        "offer_id": 10010,
        "uuid": "campaign_test",
        "offer_name": "campaign_test_1",
        "promote_timezone": 8,
        "start_time": "2019-10-01",
        "end_time": "2019-11-02",
        "status": "RUNNING",
        "country_code": "US,CN",
        "bid_type": "CPI",
        "bid_rate": "5.200",
        "currency": "CNY",
        "include_ta_id": [1,2,3],
        "exclude_ta_id": [],
        "bid_rate_by_location": [
          { "country_code": "US", "bid_rate": "8.010" },
          { "country_code": "CN", "bid_rate": "3.920" }
        ],
        "budget": [
          {
            "country_code": "US",
            "total_budget": "OPEN",
            "daily_cap_type": "BUDGET",
            "daily_cap": "OPEN"
          }
        ],
        "maintain_by": "ADV"
      }
    ]
  }
}

API: オファー管理の概要（テクニカルガイド）

次

API: オファー作成（テクニカルガイド）

最近変更された: 2026-08-06

概要