Method: accounts.apps.list

指定した AdMob アカウントのアプリを一覧表示します。

HTTP リクエスト

GET https://admob.googleapis.com/v1/{parent=accounts/*}/apps

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
parent

string

必須。アプリを一覧表示するアカウントのリソース名。例: accounts/pub-9876543210987654

クエリ パラメータ

パラメータ
pageSize

integer

返すアプリの最大数。指定されていない場合、または 0 の場合は、最大 10,000 個のアプリが返されます。最大値は 20,000 です。20,000 を超える値は 20,000 に強制変換されます。

pageToken

string

最後の ListAppsResponse で返された値。これは以前の apps.list 呼び出しの続きであり、システムがデータの次のページを返すことを示します。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

アプリリスト リクエストに対するレスポンス。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現
{
  "apps": [
    {
      object (App)
    }
  ],
  "nextPageToken": string
}
フィールド
apps[]

object (App)

リクエストされたアカウントのアプリ。

nextPageToken

string

空でない場合、リクエストに対してさらにアプリがある可能性があることを示します。この値は、新しい ListAppsRequest で渡す必要があります。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/admob.readonly

詳細については、OAuth 2.0 Overview をご覧ください。

アプリ

特定のプラットフォーム(Android や iOS など)の AdMob アプリを表します。

JSON 表現
{
  "name": string,
  "appId": string,
  "platform": string,
  "manualAppInfo": {
    object (ManualAppInfo)
  },
  "linkedAppInfo": {
    object (LinkedAppInfo)
  },
  "appApprovalState": enum (AppApprovalState)
}
フィールド
name

string

このアプリのリソース名。形式は accounts/{publisherId}/apps/{app_id_fragment} です。例: accounts/pub-9876543210987654/apps/0123456789

appId

string

AdMob SDK との統合に使用できる、アプリの外部に公開される ID。これは読み取り専用のプロパティです。例: ca-app-pub-9876543210987654~0123456789

platform

string

アプリのプラットフォームを説明します。「IOS」と「ANDROID」に限定されます。

manualAppInfo

object (ManualAppInfo)

アプリストアにリンクされていないアプリの情報。

アプリをリンクした後も、この情報を取得できます。作成時にアプリの名前が指定されていない場合は、プレースホルダ名が使用されます。

linkedAppInfo

object (LinkedAppInfo)

変更不可。アプリストアにリンクされているアプリの情報。

このフィールドは、アプリがアプリストアにリンクされている場合にのみ存在します。

appApprovalState

enum (AppApprovalState)

出力専用。アプリの承認状態。このフィールドは読み取り専用です。

ManualAppInfo

アプリストア(Google Play、App Store など)にリンクされていない手動アプリについて提供される情報。

JSON 表現
{
  "displayName": string
}
フィールド
displayName

string

ユーザーが提供する、AdMob の UI に表示されるアプリの表示名。最大文字数は 80 文字です。

LinkedAppInfo

アプリがアプリストアにリンクされている場合は、アプリストアからの情報。

JSON 表現
{
  "appStoreId": string,
  "displayName": string
}
フィールド
appStoreId

string

アプリのアプリストア ID。アプリがアプリストアにリンクされている場合にのみ存在します。

アプリが Google Play ストアに追加されている場合は、アプリのアプリケーション ID になります(例: 「com.example.myapp」)。https://developer.android.com/studio/build/application-id をご覧ください。

アプリが Apple App Store に追加されている場合は、App Store ID になります。例: 「105169111」。

アプリストア ID の設定は取り消し不可能な操作と見なされます。アプリをリンクすると、リンクを解除することはできません。

displayName

string

出力専用。アプリストアに表示されるアプリの表示名。これは出力専用のフィールドです。アプリがストアで見つからない場合は空になることがあります。

AppApprovalState

モバイルアプリのアプリ承認ステータス。

列挙型
APP_APPROVAL_STATE_UNSPECIFIED 設定されていないフィールドのデフォルト値です。使用しないでください。
ACTION_REQUIRED アプリを承認するには、ユーザーによる追加の操作が必要です。詳細と次の手順については、https://support.google.com/admob/answer/10564477 をご覧ください。
IN_REVIEW アプリは審査待ちです。
APPROVED アプリが承認され、広告を配信できます。