Skip to main content
アプリAPIを使うと、プロジェクトに登録されたアプリを取得できます。広告ユニットAPIでユニットを作成するときに指定するアプリIDを調べたり、ユニットのappがどのアプリかを確認したりするときに使います。
アプリはAPIで作成・更新・削除できません。アプリの登録と管理はコンソールで行ってください。アプリの管理を参照してください。

事前準備

  • app:readスコープを持つAPIキーが必要です。このスコープは、コンソールの [設定] > [連携] メニューでは選択できません。Adropにご依頼いただければ、スコープを含むキーを発行します。広告ユニットAPIと広告商品APIのスコープも、同じキーにあわせて含めることができます。
APIはサーバーからのみ呼び出してください。APIキーをアプリやウェブページに含めないでください。

基本情報


エンドポイント

パスはBase URLを基準とします。

アプリオブジェクト

SDKの初期化に使うアプリキーなどの設定情報は、レスポンスに含まれません。

アプリ一覧の取得

プロジェクトのアプリをページ単位で返します。並び順はおおむね登録した順ですが、古いアプリは順序が異なる場合があります。順序に頼らず、nextで続きを読み込んでください。

リクエスト

app:readスコープが必要です。

クエリパラメーター

リクエスト例

レスポンス例

200で、items(アプリの一覧)とnext(次のページのカーソル)を返します。nextがなければ最後のページです。

アプリの取得

1つのアプリを返します。

リクエスト

app:readスコープが必要です。

リクエスト例

レスポンス

200でアプリオブジェクトを返します。

エラー

  • 404 PROJECT_APP_NOT_FOUND: アプリが存在しないか、ほかのプロジェクトのアプリです。

エラー処理

エラーレスポンスにはstatusCodeが含まれ、下の表でerrorCodeの欄が-ではないエラーにはerrorCodeも含まれます。処理はerrorCodeで分け、errorCodeがない場合はstatusCodeで分けてください。リクエスト形式のエラー(VALIDATION_FAILED)では、誤っている箇所をdetail.errors[]のpathで知らせます。