Campaign Management API

Campaign Management APIは、アプリのプロモーションにAppLovinのAppDiscoveryを使用する広告主向けのAPIです。広告主（および広告主の企業アカウントの広告アクセス権を持つユーザー）は、これらのAPIへのアクセスを認証するためのOAuthアプリケーションを作成できます。また、多数の広告クライアント全体のキャンペーン管理を支援するサードパーティのOAuthアプリケーションを作成することも可能です。

サードパーティアプリの認証フロー

このセクションは、サードパーティのアプリを使用する企業に代わってCampaign Management APIを使用する企業を対象としています。自社のキャンペーンを管理する場合はファーストパーティのOAuthアプリを使用して、APIリクエスト認証のセクションに進んでください。

AppLovinサポートは標準のOAuth Webアプリケーションフローをサポートしています。すべてのクエリパラメーターは必須です。ユーザーをこのURLで誘導し、アプリにキャンペーンの管理を許可するようプロンプトを表示してください。

サードパーティアプリ認証フローのターゲットURL

https://oauth.applovin.com/oauth/initialize

サードパーティアプリ認証リクエストのクエリパラメーター

名前	説明	例
`client_id`	OAuthアプリのクライアントID	`34af7c430e24bbccbc647ca3dd5ac858`
`redirect_uri`	フロー完了後のユーザーのリダイレクト先。URLエンコードが必要です。OAuth作成プロセスで定義された`redirect_uri`と一致する必要があります。	`https%3A%2F%2Fmydomain.com%2Foauth_code`
`response_type`	これを`code`に設定します。	`code`
`scope`	このアプリで使用するスコープ。アプリで定義されたスコープのサブセットである必要があります。この値をURLエンコードします。サポート対象のスコープ：<ul><li>`campaigns:read`</li><li>`campaigns:write`</li><li>`creatives:read`</li><li>`creatives:write`</li><li>`source_bids:read`</li><li>`source_bids:write`</li></ul>	`campaigns%3Awrite%20creatives%3Awrite`
`state`	リクエストとコールバック間の状態を維持するためにクライアントが使用する、秘匿性の高い判読困難な値です。	`ab13221308fe6abad1d1`

サードパーティアプリ認証フローのサンプルリクエスト

https://oauth.applovin.com/oauth/initialize?response_type=code&client_id=34af7c430e24bbccbc647ca3dd5ac858&redirect_uri=https%3A%2F%2Fmydomain.com%2Foauth_code&scope=campaigns%3Awrite%20creatives%3Awrite&state=ab13221308fe6abad1d1

ユーザーがOAuthアプリの使用に同意した後、AppLovinはredirect_uriにコールバックを送信します。このコールバックには、ユーザーの認証コードが含まれます。

サードパーティアプリ認証レスポンスのクエリパラメーターの表

名前	説明	例
`code`	ユーザーに代わってアクセストークンとリフレッシュトークンを生成するためのコード値。APIリクエスト認証のセクションを参照してください。	`9aa19842db327e4e43cc426e6ad6c2d1eacd2e3d464`
`state`	AppLovin の初期化リクエストに渡されたステートのエコーバック	`ab13221308fe6abad1d1`

サードパーティアプリ認証フローのサンプルレスポンス

https://mydomain.com/oauth_code?code=9aa19842db327e4e43cc426e6ad6c2d1eacd2e3d464&state=ab13221308fe6abad1d1

APIリクエスト認証

クライアントIDとクライアントシークレットに基づいてセッショントークンを生成するには、このエンドポイントにPOSTリクエストを発行します。ファーストパーティのOAuthアプリケーションの場合、セッショントークンは60分間有効です。このエンドポイントから取得したアクセストークンを、他のすべてのリクエストでレスポンス内のaccessToken.access_tokenフィールドに配置してください。これを行うには、ヘッダーAuthorization: Bearer access_tokenを使用して指定します。

認証ターゲットURL

https://oauth.applovin.com/oauth/v1/access_token

認証コンテンツタイプ

multipart/form-data

アクセストークンのフォームフィールドの表

名前	説明	例
`client_id`	OAuthアプリのクライアントID	`34af7c430e24bbccbc647ca3dd5ac858`
`client_secret`	OAuthアプリのクライアントシークレット	`9538e854765525d0b34af7c430e24bbcdfd58b83f3836fd0e83cbfd1b`
`code`	外部企業の`redirect_url`への認証コールバックからの`code`値。`grant_type=authorization_code`に必須で、それ以外では無効です。	`9aa19842db327e4e43cc426e6ad6c2d1eacd2e3d464`
`grant_type`	付与のタイプ。ファーストパーティアプリの場合、これを`client_credentials`に設定します。認証コードで認証するサードパーティアプリの場合は、`authorization_code`に設定します。リフレッシュトークンで認証するサードパーティアプリに対しては、`refresh_token`に設定してください。	`client_credentials`
`redirect_uri`	サードパーティアプリケーションのリダイレクトURI。ファーストパーティアプリケーションでは無効です。	`https://mydomain.com/oauth_code`
`refresh_token`	新しいアクセストークンとリフレッシュトークンを生成するためのユーザーのリフレッシュトークン。各リフレッシュトークンは一度のみ使用可能です。呼び出しごとに新しいリフレッシュフレッシュトークンが返されます。リフレッシュトークンは30日で期限切れになります。`grant_type=refresh_token`に必須で、それ以外では無効です。	`c75742c98f382264fca6a0a5759354b6eb95ea1a7c44d0e0b22e36ff26f8`
`scope`	このセッショントークンで使用するスコープ。アプリで定義されたスコープのサブセットである必要があります。書き込みスコープには読み取りパーミッションが自動的に付与されます。複数のスコープはスペースで区切ります。サポート対象のスコープ：<ul><li>`campaigns:read`</li><li>`campaigns:write`</li><li>`creatives:read`</li><li>`creatives:write`</li><li>`source_bids:read`</li><li>`source_bids:write`</li></ul>`grant_type=client_credentials`には必須、`grant_type=refresh_token`には任意、`grant_type=authorization_code`には無効	`campaigns:write creatives:write`

ファーストパーティアプリのレスポンスボディのサンプル
サードパーティアプリのレスポンスボディのサンプル

{
  "accessToken":{
    "token_type":"Bearer",
    "expires_in":3600,
    "access_token":"cLXHaoel3iWi5Z3D"
  }
}

{
  "accessToken": {
    "token_type": "Bearer",
    "expires_in": 3600,
    "access_token": "JeUqLpg1KbJTICq4J28gNfV0TWGDedLDZgwlq3W91R2_eiNG1IwTznW8twia7",
    "refresh_token": "c75742c98f382264fca6a0a5759354b6eb95ea1a7c44d0e0b22e36ff26f8"
  }
}

<code>/campaign/<var>campaign_id</var></code>

個々のキャンペーンの詳細を表示するには、このエンドポイントにGETリクエストを送信します。

キャンペーンの詳細を個別に編集したり、新しいキャンペーンを作成したりするには、このエンドポイントにPOSTリクエストを送信します。新しいキャンペーンを作成する際、リクエストURLやリクエストボディに<var>campaign_id</var>を含めないでください。

<code>/campaign/<var>campaign_id</var></code>ターゲットURL

https://o.applovin.com/campaign_management/v1/campaign/«campaign-ID»

<code>/campaign/<var>campaign_id</var></code>レスポンスボディのサンプル

{
  "name": "Test Campaign Name - iOS",
  "campaign_id": "29d66efc22ae53a201e1532265b83f12",
  "package_name": "123456789",
  "bundle_id":"com.sample.app.ios",
  "platform": "ios",
  "category": "101",
  "bid_type": "CPI",
  "tracking_method": "adjust",
  "status": true,
  "created_at": "2021-06-29 00:00:00",
  "impressions": 21,
  "clicks": 4,
  "installs": 1,
  "spend": "1.4300"
}

<code>/campaign/<var>campaign_id</var></code>リクエストボディのサンプル

更新
作成

{
  "campaign_id": "29d66efc22ae53a201e1532265b83f12",
  "status": false
}

{
  "name": "My New Campaign Name",
  "package_name": "987654321",
  "bundle_id":"com.sample.app.ios",
  "platform": "ios",
  "category": "108",
  "bid_type": "CPE",
  "tracking_method": "adjust",
  "status": "true"
}

<code>/campaign/<var>campaign_id</var></code>リクエスト/レスポンスボディフィールド

名前	説明	作成時に必須	更新時に必須
`bid_type`<sup>1</sup>	キャンペーンの入札タイプ（`CPI`、<code>CPP_GOAL</code>、`RET`、`CPE`、<code>ROAS_AD_BASED</code>、または`ROAS_IAP`）<p>例：`"CPI"`</p>	いいえ	はい
`bundle_id`<sup>1</sup>	昇格したアプリのバンドルID（iOSのみ）<p>例：`"com.sample.app.ios"`</p>	いいえ	はい
`campaign_id`<sup>1</sup>	一意のキャンペーン識別子<p>例：`"29d66efc22ae53a201e1532265b83f12"`</p>	はい	いいえ
`category`	キャンペーンのカテゴリー<p>`例："105"`</p>	いいえ	はい
`clicks`<sup>1</sup>	前日のクリック数<p>例：`12`</p>	いいえ	はい
`created`<sup>1</sup>	キャンペーンの作成日<p>例：`"2021-06-30 00:00:00"`</p>	いいえ	はい
`goal_period`<sup>1</sup>	目標を計測するインストール後の日数。`bid_type`に指定できる値は次のとおりです。<table><thead><th scope=“col”>`bid_type`</th><th scope=“col”>値</th></thead><tbody><tr><td>`CPI`</td><td>n/a</td></tr><tr><td>`CPP`</td><td>7</td></tr><tr><td>`CPE`</td><td>7</td></tr><tr><td>`RET`</td><td>1、3、7</td></tr><tr><td>`ROAS_AD_BASED`</td><td>0</td></tr><tr><td>`ROAS_IAP`</td><td>0、7</td></tr></tbody></table><br />例：`0`	いいえ	いいえ
`impressions`<sup>1</sup>	前日のインプレッション数<p>例：`125`</p>	いいえ	はい
`installs`<sup>1</sup>	前日のインストール数<p>例：`2`</p>	いいえ	いいえ
`name`	キャンペーン名<p>例：`"Test Campaign - iOS"`</p>	はい	いいえ
`package_name`<sup>1</sup>	プロモーション対象アプリのパッケージ名。iOSではiTunes IDの数値部分を使用してください例：`"123456789"`	いいえ	はい
`platform`<sup>1</sup>	プロモーション対象プラットフォーム（`ios`または`android`）<p>例：`"ios"`</p>	いいえ	はい
`spend`<sup>1</sup>	前日の支出<p>例：`"2.5000"`</p>	いいえ	はい
`status`	キャンペーンがアクティブかどうか例：`true`</p>	いいえ	いいえ
`tracking_method`	キャンペーンのトラッキング方法。以下のトラッキング方法の表をご覧ください。<p>例：`"adjust"`</p>	いいえ	はい

1読み取り専用

`/campaigns`

すべてのキャンペーンを表示するには、このエンドポイントにGETリクエストを送信します。このエンドポイントではキャンペーンを編集できません。

`/campaigns`ターゲットURL

https://o.applovin.com/campaign_management/v1/campaigns

`/campaigns`レスポンスボディのサンプル

[
  {
    "name": "Test Campaign Name - iOS",
    "campaign_id": "29d66efc22ae53a201e1532265b83f12",
    "package_name": "123456789",
    "bundle_id": "com.sample.app.ios",
    "platform": "ios",
    "category": "101",
    "bid_type": "CPI",
    "tracking_method": "adjust",
    "status": false,
    "created_at": "2021-06-29 00:00:00",
    "impressions": 21,
    "clicks": 4,
    "installs": 1,
    "spend": "1.4300"
  },
  {
    "name": "Test Campaign Name - Android",
    "campaign_id": "265b83f129d66efc22ae201e153253a2",
    "package_name": "com.sample.app.android",
    "platform": "android",
    "category": "201",
    "bid_type": "CPI",
    "status": false,
    "created_at": "2021-06-29 00:00:00",
    "impressions": 39,
    "clicks": 9,
    "installs": 2,
    "spend": "1.8600"
  }
]

`/campaigns`レスポンスボディのフィールド

<code>/campaign/<var>campaign_id</var></code>のリクエスト/レスポンスフィールドの表を参照してください。

<code>/creative_set/<var>creative_set_id</var></code>

クリエイティブセットの名前を更新する、または新しいクリエイティブセットを作成するには、このエンドポイントにPOSTリクエストを送信します。新しいクリエイティブセットを作成する場合、リクエストURLやリクエストボディに<var>creative_set_id</var>を含めないでください。クリエイティブセットは組み合わせ可能なアセットの集合で、多数の広告を生成するために使用します。クリエイティブセットを組み立てる際、各アセットを何度もアップロードする必要はありません。クリエイティブセットには、基盤となるアセットの言語情報も含まれています。

<code>/creative_set/<var>creative_set_id</var></code>ターゲットURL

https://o.applovin.com/campaign_management/v1/creative_set/«creative-set-ID»

<code>/creative_set/<var>creative_set_id</var></code>レスポンスボディのサンプル

{
  "campaign_id":"f87ece84f46b55cfbf24427ff8746a40",
  "name":"My Test Creative Set 0",
  "countries":["us","gb"],
  "languages":[
    "en"
  ],
  "ads":[],
  "assets":[],
  "product_page": null,
  "sizes": {
    "INTER":true,
    "BANNER":false
  }
}

<code>/creative_set/<var>creative_set_id</var></code>リクエスト/レスポンスボディフィールド

名前	説明	例
`ads`<sup>1</sup>	このクリエイティブセットに関連付けられた広告オブジェクトの配列。これらのオブジェクトは、<code>/ad/<var>ad_id</var></code>エンドポイントからのレスポンスボディと同じフォーマットです。
`assets`<sup>1</sup>	このクリエイティブセットに関連付けられたアセットオブジェクトの配列。下の表を参照してください。
`campaign_id`<sup>1</sup>	キャンペーンID	`"29d66efc22ae53a201e1532265b83f12"`
`countries`	このクリエイティブセットが制限される国（例：国別のプロモーション）。各クリエイティブセットにキャンペーンターゲティングを複製する必要はありません。このリストが空白の場合、キャンペーンで定義された国が対象となります。このリストにキャンペーンの対象外の国が含まれている場合、それらの国は対象外となります。	`["za", "gb"]`
`languages`	言語の一覧。完全なリストについては、下の表を参照してください。	`["en"]`
`name`	クリエイティブセット名
`product_page`	クリエイティブセットに関連付けられたiOSカスタム製品ページまたはAndroidストアリスティング
`sizes`<sup>1</sup>	クリエイティブのサイズのオプションと、そのサイズの広告がセットで生成可能かどうか	`{ "INTER":true, "BANNER":false }`（セットには`INTER`と`BANNER`サイズの広告が含まれているが、`BANNER`サイズの広告は現在無効であることを示します。）

1読み取り専用

アセットオブジェクトフィールドの表

名前	説明	例
`asset`	アセットのURL、ハッシュ、またはテキスト文字列	`"https://res1.applovin.com/oab49763/foobidyfoo_v23_phone.mp4"`
`status`	Campaign Management APIはアセットを非同期的に処理します。まず、`status`を`processing`に設定します。次に、`status`を`error`（失敗時）または`ready`（成功時）に設定します。	`"processing"`、`"error"`、`"ready"`
`type`	アセットタイプ。利用可能なアセットタイプについては、以下の表を参照してください。	`"TXT_TITLE"`

<code>/creative_set/<var>creative_set_id</var>/sizes</code>

クリエイティブセット内で1つ以上のクリエイティブサイズを有効または無効にするには、このエンドポイントにPOSTリクエストを送信します。

<code>/creative_set/<var>creative_set_id</var>/sizes</code>ターゲットURL

https://o.applovin.com/campaign_management/v1/creative_set/«creative-set-ID»/sizes

<code>/creative_set/<var>creative_set_id</var>/sizes</code>リクエストボディのサンプル

{
  "INTER":true,
  "BANNER":false
}

有効なサイズ指定子はBANNER、CTV、INTER、およびPRELOADです。

上記の例では、セット内のサイズがBANNERの広告が無効になり、サイズがINTERの広告は有効となります。他のサイズの広告は影響を受けません。

<code>/creative_sets/<var>campaign_id</var></code>

キャンペーンに関連するすべてのクリエイティブセットを表示するには、このエンドポイントにGETリクエストを送信します。

<code>/creative_set/<var>creative_set_id</var></code>ターゲットURL

https://o.applovin.com/campaign_management/v1/creative_sets/«campaign-ID»

<code>/creative_sets/<var>campaign_id</var></code>レスポンスボディのサンプル

[
  {
    "campaign_id":"f87ece84f46b55cfbf24427ff8746a40",
    "name":"My Test Creative Set 0",
    "countries":["us","gb"],
    "languages":[
      "en"
    ],
    "ads":[…],
    "assets":[…],
    "product_page": null,
    "sizes": {
      "INTER":true,
      "BANNER":false
    }
  }
]

<code>/creative_sets/<var>campaign_id</var>レスポンスボディフィールド

詳しくは、<code>/creative_set/<var>creative_set_id</var></code>のレスポンスフィールドの表

<code>/creative_set_assets/<var>creative_set_id</var></code>

クリエイティブセットに関連するアセットをアップロード、更新、または削除するには、このエンドポイントにPOSTリクエストを送信します。 1回のリクエストで管理できるアセットは1つのみです。レスポンスには、クリエイティブセット内のすべてのアセットが含まれます。

`POST`<code>/creative_set_assets/<var>creative_set_id</var></code>ターゲットURL

https://o.applovin.com/campaign_management/v1/creative_set_assets/«creative-set-ID»

`POST`<code>/creative_set_assets/<var>creative_set_id</var></code>コンテンツタイプ

multipart/form-data

リクエストアセットフォームのフィールドの表

名前	説明	例
`asset`<sup>1</sup>	アセットのURL、ハッシュ、またはテキスト文字列。	`"https://res1.applovin.com/ob7cb6fc/foobidyfoo_v23_phone.mp4"`、`"3f5a01dc0980f3d04188e73e91c"`、`"Best app you’ll ever play"`
`file`<sup>2</sup>	画像、動画、またはHTMLファイル。	広告のルール、仕様、ガイドラインをご覧ください。
`remove`<sup>3</sup>	（オプション）アセットタイプを削除するには、`true`を渡します。	`true`または`false`
`type`<sup>1</sup>	アセットタイプ。利用可能なアセットタイプについては、以下の表を参照してください。	“TXT_TITLE”
`update`	（オプション）アセットのタイプを更新するには、`true`を渡します。	`true`または`false`

1アセットを追加または更新する際に渡す必要があるのは、assetパラメーターまたはfileパラメーターのいずれかのみです。2ファイルのアセットを追加または更新するためにファイルに渡すとき、ファイルのプロパティからtypeが計算されます。3アセットを削除する際は、typeパラメーターのみを渡す必要があります。

`POST`<code>/creative_set_assets/<var>creative_set_id</var></code>レスポンスボディのサンプル

[
  {
    "asset":"https://res1.applovin.com/oab7a439/foobidyfoo_v23_phone.mp4",
    "status":"ready",
    "type":"VID_LONG_P"
  },
  {
    "asset":"Help the heroes to defeat the villains and save the world!",
    "status":"ready",
    "type":"TXT_SUBTITLE"
  }
]

`POST` <code>/creative_set_assets/<var>creative_set_id</var></code>レスポンスアセットのオブジェクトフィールド

名前	説明	例
`asset`	アセットのURL、ハッシュ、またはテキスト文字列	`"https://res1.applovin.com/oab49763/foobidyfoo_v23_phone.mp4"`
`status`	Campaign Management APIはアセットを非同期的に処理します。まず、`status`を`processing`に設定します。次に、`status`を`error`（失敗時）または`ready`（成功時）に設定します。	`"processing"`、`"error"`、`"ready"`
`type`	アセットタイプ。利用可能なアセットタイプについては、以下の表を参照してください。	`"TXT_TITLE"`

<code>/ad/<var>ad_id</var></code>

広告のプロパティを表示するには、このエンドポイントにGETリクエストを送信します。

広告の名前またはステータスを編集するには、このエンドポイントにPOSTリクエストを送信します。広告テンプレートに必要なすべてのアセットをUI経由、または<code>/creative_set/<var>creative_set_id</var></code>へのAPIコール経由でアップロードすると、広告が自動的に作成されます。

<code>/ad/<var>ad_id</var></code>ターゲットURL

https://o.applovin.com/campaign_management/v1/ad/«ad-ID»

<code>/ad/<var>ad_id</var></code>レスポンスボディのサンプル

{
  "name":"Banner_AppIconSimple_MyTestCreativeSet0",
  "id":10780437,
  "creative_set_name":"My Test Creative Set 0",
  "creative_set_id":"37057c98a951078bf06b6d7c3561fd1a",
  "size":"BANNER",
  "status":true,
  "template":"App Icon Simple"
}

Table of <code>/ad/<var>ad_id</var></code> Request/Response Body Fields

名前	説明
`creative_set_id`<sup>1</sup>	親クリエイティブセットID
`creative_set_name`<sup>1</sup>	親クリエイティブセット名
`id`<sup>1</sup>	広告ID
`name`	広告名
`size`<sup>1</sup>	広告サイズ：`BANNER`、`INTER`、`LEADER`、`MREC`、`NATIVE`、`WIDGET`のいずれか
`status`	広告がアクティブか（`true`）アクティブでないか（`false`）
`template`<sup>1</sup>	広告テンプレート名

1読み取り専用

<code>/ads/<var>creative_set_id</var></code>

クリエイティブセットに関連するすべての広告を表示するには、このエンドポイントにGETリクエストを送信します。

<code>/ads/<var>creative_set_id</var></code>ターゲットURL

https://o.applovin.com/campaign_management/v1/ads/«creative-set-ID»

<code>/ads/<var>creative_set_id</var></code>レスポンスボディのサンプル

[
  {
    "name":"Banner_AppIconSimple_MyTestCreativeSet0",
    "id":10780437,
    "creative_set_name":"My Test Creative Set 0",
    "creative_set_id":"37057c98a951078bf06b6d7c3561fd1a",
    "size":"BANNER",
    "status":true,
    "template":"App Icon Simple"
  }
]

広告オブジェクトのフィールドの表

<code>/ad/<var>ad_id</var></code>のリクエスト/レスポンスフィールドの表を参照してください。

<code>/creative_sets/<var>campaign_id</var></code>

キャンペーンに関連するすべてのクリエイティブセットを表示するには、このエンドポイントにGETリクエストを送信します。

<code>/creative_set/<var>creative_set_id</var></code>ターゲットURL

https://o.applovin.com/campaign_management/v1/creative_sets/«campaign-ID»

<code>/creative_sets/<var>campaign_id</var></code>レスポンスボディのサンプル

[
  {
    "campaign_id":"f87ece84f46b55cfbf24427ff8746a40",
    "name":"My Test Creative Set 0",
    "countries":["us","gb"],
    "languages":[
      "en"
    ],
    "ads":[…],
    "assets":[…],
    "product_page": null
  }
]

<code>/creative_sets/<var>campaign_id</var>レスポンスボディフィールド

<code>/ad/<var>ad_id</var></code>のリクエスト/レスポンスフィールドの表を参照してください。

<code>/campaign_targets/<var>campaign_id</var></code>

キャンペーンのターゲティング、URL、入札、予算を表示するには、このエンドポイントにGETリクエストを送信します。

これらの属性を更新するには、このエンドポイントにPOSTリクエストを送信します。

<code>/campaign_targets/<var>campaign_id</var></code>ターゲットURL

https://o.applovin.com/campaign_management/v1/campaign_targets/«campaign-ID»

<code>/campaign_targets/<var>campaign_id</var></code>レスポンスボディのサンプル

{
  "bid_type": "CPI",
  "countries":[
    {
      "DEFAULT":{
        "click_url":"https://app.adjust.com/123abc?campaign={CAMPAIGN_NAME}%20({CAMPAIGN_ID})&adgroup={APP_ID}&idfa={IDFA}&country={CC}&gps_adid={IDFA}&campaign_id={CAMPAIGN_ID}&device_type={DEVICE_TYPE}&publisher_id={APP_ID}&tracker_limit=100000&applovin_click_id={DID}&external_tracker_ids=1&android_id_lower_sha1={HADID}",
        "impression_url":"https://s2s.adjust.com/impression/123abc?campaign={CAMPAIGN_NAME}%20({CAMPAIGN_ID})&adgroup={APP_ID}&idfa={IDFA}&country={CC}&gps_adid={IDFA}&campaign_id={CAMPAIGN_ID}&device_type={DEVICE_TYPE}&publisher_id={APP_ID}&tracker_limit=100000&applovin_click_id={DID}&external_tracker_ids=1&android_id_lower_sha1={HADID}&s2s=1"
      }
    },
    {
      "us":{
        "bid":2.9,
        "budget":300,
        "disabled":false
      }
    },
    {
      "gb":{
        "bid":2.5,
        "budget":250,
        "disabled":false
      }
    }
  ],
  "device_types":[
    "phone"
  ],
  "os_major_version_min":9
}

<code>/campaign_targets/<var>campaign_id</var></code>リクエスト/レスポンスボディフィールド

名前	説明	例
`bid_type`<sup>1</sup>	このキャンペーンで使用される入札のタイプ。キャンペーンオブジェクトに設定されているものと同じです。	`CPI`
`countries`	国オブジェクトのリスト。以下をご覧ください。	下の表を参照
`device_types`	対象のデバイスタイプの一覧。リストが空の場合、すべてのデバイスタイプが対象です。オプションは`"phone"`、`"tablet"`、`"other"`です。iOSでのみサポートされます。	`["phone", "other"]`
`os_major_version_min`	キャンペーン配信が可能なOSの最小バージョン。`10`はバージョン10.0以降を意味します。	`9`

1読み取り専用

国オブジェクトのフィールドの表

キャンペーンには、すべての国が共有する予算の合計、または国ごとに指定した予算が必要です。したがって、入札、予算、URLの値はDEFAULTオブジェクト、または各国固有のオブジェクトのいずれかに含まれている必要があります。このエンドポイントへのPOSTリクエストは、リクエストに含まれる国のみを更新します。リクエストに含まれていないターゲット国は更新されません。国を無効にするには、disabledをtrueに設定します。

名前	説明	例
`bid`	特定の国の入札値。`CPI`キャンペーンの場合、これはCPI（米ドル）です。`RET`、`ROAS_AD_BASED`、`ROAS_IAP`の場合、これはパーセント目標です（`50`=50%）。`CPP`および`CPE`の場合、これは目標イベント値（米ドル）です。	`2.9`
`budget`	1日あたりの予算（米ドル）	`1000`
`click_url`	クリックトラッキングURL	`https://s2s.adjust.com/impression/123abc?campaign={CAMPAIGN_NAME}%20({CAMPAIGN_ID})&gps_adid={IDFA}`
`country`	`"DEFAULT"`または2文字の国コード	`"gb"`
`disabled`	APIはアクティブな国のみを返します。国を無効にするには、更新時にこの値を`true`に設定します。	`false`
`impression_url`	インプレッショントラッキングURL	`https://app.adjust.com/123abc?campaign={CAMPAIGN_NAME}%20({CAMPAIGN_ID})&gps_adid={IDFA}`

<code>/sources/<var>campaign_id</var></code>

キャンペーンを配信するソースのステータスを表示するには、このエンドポイントにGETリクエストを送信します。

キャンペーン全体のソースのステータスを更新するには、このエンドポイントにPOSTリクエストを送信します。

<code>/sources/<var>campaign_id</var></code>ターゲットURL

シンプルなGETまたはPOST
ページネーション対応のGET

https://o.applovin.com/campaign_management/v1/sources/«campaign-ID»

https://o.applovin.com/campaign_management/v1/sources/«campaign-ID»?limit=«xxxx»&offset=«yyyy»

<code>/sources/<var>campaign_id</var></code>レスポンスボディのサンプル

[
  {
    "app_id": "da605e6f950f1aec838816df845e95e0c8d5cb7a994d71ae0ef2",
    "app_id_external": "3a2ccd1298a9eaa1a5de114c323c8b1d",
    "status": true
  },
  {
    "app_id": "ecf49bef2a8026d53f7a3d245e890cc0b59b85c82c16c8d63bf4a5",
    "app_id_external": "ca3cc7d0636891d98ee2267a34d5301e",
    "status": false
  }
]

<code>/sources/<var>campaign_id</var>?limit=2&offset=2000</code>レスポンスボディのサンプル

{
  "offset": 2000,
  "limit": 2,
  "sources": [
    {
      "app_id": "da605e6f950f1aec838816df845e95e0c8d5cb7a994d71ae0ef2",
      "app_id_external": "3a2ccd1298a9eaa1a5de114c323c8b1d",
      "status": true
    },
    {
      "app_id": "ecf49bef2a8026d53f7a3d245e890cc0b59b85c82c16c8d63bf4a5",
      "app_id_external": "ca3cc7d0636891d98ee2267a34d5301e",
      "status": false
    }
  ]
}

<code>/sources/<var>campaign_id</var></code>リクエスト/レスポンスボディフィールド

名前	説明	例
`app_id`<sup>1</sup>	切り替え可能なアプリへの参照	`da605e6f950f1aec838816df845e95e0c8d5cb7a994d71ae0ef2`
`app_id_external`<sup>2</sup>	外部アプリID（読み取り専用）	`f950f1aec838816df845e95e0c8da605e6`
`status`	アプリがアクティブかどうか	`true`

1この値は、Reporting APIの「external_placement_id」列、トラッキングURLマクロの{PLACEMENT_ID}、またはCSV入札用のUIツールで確認できます。

2この値は、Reporting APIの「app_id_external」列またはトラッキングURLマクロの{APP_ID}で確認できます。この値は、POSTリクエストでは無視されます。これは、下位互換性のためにGETリクエストに含まれています。

<code>/sources/<var>campaign_id</var>?limit=<var>xxxx</var>&offset=<var>yyyy</var></code>レスポンスボディフィールド

名前	説明	例
`limit`	このレスポンスで返される行数。大規模なレスポンスのページネーションに役立ちます。	`5000`
`offset`	このレスポンスでスキップするデータセットの行数。大規模なレスポンスのページネーションに役立ちます。	`15000`
`sources`	ソースのリスト。フィールドの定義については、<code>/sources/<var>campaign_id</var></code>リクエスト/レスポンスボディフィールドを参照してください。
`total_row_count`	このキャンペーンに関連するソース入札のオーバーライド数。	`8192`

トラッキング方法の表

API名	MMP名
adjust	Adjust
applovin	AppLovin
appsflyer	AppsFlyer
apsalar	Singular
branch	Branch
custom_track	カスタム
justtrack	JustTrack
kochava	Kochava
tenjin	Tenjin

言語コード

言語コード	言語
ar	アラビア語
bg	ブルガリア語
bn	ベンガル語
bs	ボスニア語
ca	カタルーニャ語
cs	チェコ語
da	デンマーク語
de	ドイツ語
el	ギリシャ語
en	英語
es	スペイン語
et	エストニア語
eu	バスク語
fa	ペルシア語
fi	フィンランド語
fr	フランス語
he	ヘブライ語
hi	ヒンディー語
hr	クロアチア語
hu	ハンガリー語
id	インドネシア語
is	アイスランド語
it	イタリア語
he	ヘブライ語
hi	ヒンディー語
iw	ヘブライ語
ja	日本語
jv	ジャワ語
ka	ジョージア語
ko	韓国語
lt	リトアニア語
lv	ラトビア語
mk	マケドニア語
mr	マラーティー語
ms	マレー語
nb	ノルウェー語
nl	オランダ語
no	ノルウェー語
pl	ポーランド語
pt	ポルトガル語
ro	ルーマニア語
ru	ロシア語
sk	スロバキア語
sq	アルバニア語
sr	セルビア語
su	スンダ語
sv	スウェーデン語
th	タイ語
tr	トルコ語
ug	ウイグル語
uk	ウクライナ語
ur	ウルドゥー語
vi	ベトナム語
zh	中国語（簡体字・繁体字）
zh_hans	中国語（簡体字）
zh_hant	中国語（繁体字）

アセットタイプ

API名	アセットタイプ名	説明
`HOSTED_HTML`	Playable File	プレイアブル広告ファイル
`IMG_BANNER`	Banner Image	320×50
`IMG_ICON`	App Icon	ストアで使用されているアイコンと一致する必要あり
`IMG_INTER_L`	Landscape Image	静的インタースティシャル広告や動画のエンドカードとして使用
`IMG_INTER_P`	Portrait Image	静的インタースティシャル広告や動画のエンドカードとして使用
`IMG_LEADER`	Leader Image	728×90
`IMG_MREC`	Medium Rectangle (MREC) Image	300×250
`IMG_NATIVE`	Native Image	ネイティブ広告のメイン画像：1200×628または1200×627
`TXT_BUTTON`	Button	ボタンテキスト
`TXT_RATING`	App Rating	0.0～5.0、0.5の増分のみ可能
`TXT_SUBTITLE`	Subline	一部の広告でアプリの説明に使用される補助テキスト
`TXT_TITLE`	App name	バナー広告や一部の動画テンプレートで使用
`VID_LONG_P`	Long Portrait Video	15秒以上の縦向きロング動画（ポートレート）
`VID_SHORT_P`	Short Portrait Video	15秒以内の縦向きショート動画（ポートレート）

テンプレート

サイズ	テンプレート名	アセット
バナー	Standard	`IMG_BANNER`
インタースティシャル	Portrait — Over 15s	`IMG_INTER_P`、`IMG_INTER_L`、`VID_LONG_P`
インタースティシャル	Portrait — Under 15s	`IMG_INTER_P`、`IMG_INTER_L`、`VID_SHORT_P`
インタースティシャル	Portrait Playable Endcard — Over 15s	`HOSTED_HTML`、`VID_LONG_P`
インタースティシャル	Portrait Playable Endcard — Under 15s	`HOSTED_HTML`、`VID_SHORT_P`
インタースティシャル	Rewarded Playable	`HOSTED_HTML`
インタースティシャル	Standard	`IMG_INTER_P`、`IMG_INTER_L`
インタースティシャル	Standard Playable	`HOSTED_HTML`
リーダー	Standard	`IMG_LEADER`
MREC	Standard	`IMG_MREC`
プリロード	Standard	n/a

ご利用規約 | プライバシー | EULA | DMCA | Cookie設定

Campaign Management API

サードパーティアプリの認証フロー

サードパーティアプリ認証フローのターゲットURL

サードパーティアプリ認証リクエストのクエリパラメーター

サードパーティアプリ認証フローのサンプルリクエスト

サードパーティアプリ認証レスポンスのクエリパラメーターの表

サードパーティアプリ認証フローのサンプルレスポンス

APIリクエスト認証

認証ターゲットURL

認証コンテンツタイプ

アクセストークンのフォームフィールドの表

<code>/campaign/<var>campaign_id</var></code>

<code>/campaign/<var>campaign_id</var></code>ターゲットURL

<code>/campaign/<var>campaign_id</var></code>レスポンスボディのサンプル

<code>/campaign/<var>campaign_id</var></code>リクエストボディのサンプル

<code>/campaign/<var>campaign_id</var></code>リクエスト/レスポンスボディフィールド

/campaigns

/campaignsターゲットURL

/campaignsレスポンスボディのサンプル

/campaignsレスポンスボディのフィールド

<code>/creative_set/<var>creative_set_id</var></code>

<code>/creative_set/<var>creative_set_id</var></code>ターゲットURL

<code>/creative_set/<var>creative_set_id</var></code>レスポンスボディのサンプル

<code>/creative_set/<var>creative_set_id</var></code>リクエスト/レスポンスボディフィールド

アセットオブジェクトフィールドの表

<code>/creative_set/<var>creative_set_id</var>/sizes</code>

<code>/creative_set/<var>creative_set_id</var>/sizes</code>ターゲットURL

<code>/creative_set/<var>creative_set_id</var>/sizes</code>リクエストボディのサンプル

<code>/creative_sets/<var>campaign_id</var></code>

<code>/creative_set/<var>creative_set_id</var></code>ターゲットURL

<code>/creative_sets/<var>campaign_id</var></code>レスポンスボディのサンプル

<code>/creative_sets/<var>campaign_id</var>レスポンスボディフィールド

<code>/creative_set_assets/<var>creative_set_id</var></code>

POST<code>/creative_set_assets/<var>creative_set_id</var></code>ターゲットURL

POST<code>/creative_set_assets/<var>creative_set_id</var></code>コンテンツタイプ

リクエストアセットフォームのフィールドの表

POST<code>/creative_set_assets/<var>creative_set_id</var></code>レスポンスボディのサンプル

POST <code>/creative_set_assets/<var>creative_set_id</var></code>レスポンスアセットのオブジェクトフィールド

<code>/ad/<var>ad_id</var></code>

<code>/ad/<var>ad_id</var></code>ターゲットURL

<code>/ad/<var>ad_id</var></code>レスポンスボディのサンプル

Table of <code>/ad/<var>ad_id</var></code> Request/Response Body Fields

<code>/ads/<var>creative_set_id</var></code>

<code>/ads/<var>creative_set_id</var></code>ターゲットURL

<code>/ads/<var>creative_set_id</var></code>レスポンスボディのサンプル

広告オブジェクトのフィールドの表

<code>/creative_sets/<var>campaign_id</var></code>

<code>/creative_set/<var>creative_set_id</var></code>ターゲットURL

<code>/creative_sets/<var>campaign_id</var></code>レスポンスボディのサンプル

<code>/creative_sets/<var>campaign_id</var>レスポンスボディフィールド

<code>/campaign_targets/<var>campaign_id</var></code>

<code>/campaign_targets/<var>campaign_id</var></code>ターゲットURL

<code>/campaign_targets/<var>campaign_id</var></code>レスポンスボディのサンプル

<code>/campaign_targets/<var>campaign_id</var></code>リクエスト/レスポンスボディフィールド

国オブジェクトのフィールドの表

<code>/sources/<var>campaign_id</var></code>

<code>/sources/<var>campaign_id</var></code>ターゲットURL

<code>/sources/<var>campaign_id</var></code>レスポンスボディのサンプル

<code>/sources/<var>campaign_id</var>?limit=2&offset=2000</code>レスポンスボディのサンプル

<code>/sources/<var>campaign_id</var></code>リクエスト/レスポンスボディフィールド

<code>/sources/<var>campaign_id</var>?limit=<var>xxxx</var>&offset=<var>yyyy</var></code>レスポンスボディフィールド

トラッキング方法の表

言語コード

アセットタイプ

テンプレート

`/campaigns`

`/campaigns`ターゲットURL

`/campaigns`レスポンスボディのサンプル

`/campaigns`レスポンスボディのフィールド

`POST`<code>/creative_set_assets/<var>creative_set_id</var></code>ターゲットURL

`POST`<code>/creative_set_assets/<var>creative_set_id</var></code>コンテンツタイプ

`POST`<code>/creative_set_assets/<var>creative_set_id</var></code>レスポンスボディのサンプル

`POST` <code>/creative_set_assets/<var>creative_set_id</var></code>レスポンスアセットのオブジェクトフィールド