AI-generated Key Takeaways
-
You can list the apps under a specified AdMob account using a GET request to the provided URL.
-
The request requires the
parent
path parameter, specifying the resource name of the account. -
Optional query parameters include
pageSize
for controlling the number of results andpageToken
for pagination. -
A successful response will include a list of
App
objects and potentially anextPageToken
for retrieving more results. -
The request requires the
https://www.googleapis.com/auth/admob.readonly
OAuth scope for authorization.
- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- App
- ManualAppInfo
- LinkedAppInfo
- AppApprovalState
- Examples
- Try it!
List the apps under the specified AdMob account.
HTTP request
GET https://admob.googleapis.com/v1/{parent=accounts/*}/apps
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
parent |
Required. Resource name of the account to list apps for. Example: accounts/pub-9876543210987654 |
Query parameters
Parameters | |
---|---|
pageSize |
The maximum number of apps to return. If unspecified or 0, at most 10,000 apps will be returned. The maximum value is 20,000; values above 20,000 will be coerced to 20,000. |
pageToken |
The value returned by the last |
Request body
The request body must be empty.
Response body
Response for the apps list request.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"apps": [
{
object ( |
Fields | |
---|---|
apps[] |
The resulting apps for the requested account. |
nextPageToken |
If not empty, indicates that there may be more apps for the request; this value should be passed in a new |
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/admob.readonly
For more information, see the OAuth 2.0 Overview.
App
Describes an AdMob app for a specific platform (For example: Android or iOS).
JSON representation |
---|
{ "name": string, "appId": string, "platform": string, "manualAppInfo": { object ( |
Fields | |
---|---|
name |
Resource name for this app. Format is accounts/{publisherId}/apps/{app_id_fragment} Example: accounts/pub-9876543210987654/apps/0123456789 |
appId |
The externally visible ID of the app which can be used to integrate with the AdMob SDK. This is a read only property. Example: ca-app-pub-9876543210987654~0123456789 |
platform |
Describes the platform of the app. Limited to "IOS" and "ANDROID". |
manualAppInfo |
The information for an app that is not linked to any app store. After an app is linked, this information is still retrivable. If no name is provided for the app upon creation, a placeholder name will be used. |
linkedAppInfo |
Immutable. The information for an app that is linked to an app store. This field is present if and only if the app is linked to an app store. |
appApprovalState |
Output only. The approval state for the app. The field is read-only. |
ManualAppInfo
Information provided for manual apps which are not linked to an application store (Example: Google Play, App Store).
JSON representation |
---|
{ "displayName": string } |
Fields | |
---|---|
displayName |
The display name of the app as shown in the AdMob UI, which is provided by the user. The maximum length allowed is 80 characters. |
LinkedAppInfo
Information from the app store if the app is linked to an app store.
JSON representation |
---|
{ "appStoreId": string, "displayName": string } |
Fields | |
---|---|
appStoreId |
The app store ID of the app; present if and only if the app is linked to an app store. If the app is added to the Google Play store, it will be the application ID of the app. For example: "com.example.myapp". See https://developer.android.com/studio/build/application-id. If the app is added to the Apple App Store, it will be app store ID. For example "105169111". Note that setting the app store id is considered an irreversible action. Once an app is linked, it cannot be unlinked. |
displayName |
Output only. Display name of the app as it appears in the app store. This is an output-only field, and may be empty if the app cannot be found in the store. |
AppApprovalState
The app approval states for a mobile app.
Enums | |
---|---|
APP_APPROVAL_STATE_UNSPECIFIED |
Default value for an unset field. Do not use. |
ACTION_REQUIRED |
The app requires additional user action to be approved. Please refer to https://support.google.com/admob/answer/10564477 for details and next steps. |
IN_REVIEW |
The app is pending review. |
APPROVED |
The app is approved and can serve ads. |