REST Resource: networks.applications

  • The Application resource represents a mobile app claimed by a network for targeting purposes.

  • Applications are identified by a name which follows the format networks/{networkCode}/applications/{application_id} and can have an optional displayName.

  • The API provides get and list methods to retrieve individual Application objects or a list of Application objects, respectively.

Resource: Application

An application that has been added to or "claimed" by the network to be used for targeting purposes. These mobile apps can come from various app stores.

JSON representation 
{
  "name": string,
  "appStores": [
    enum (ApplicationStore)
  ],
  "displayName": string,
  "appStoreId": string,
  "archived": boolean,
  "appStoreDisplayName": string,
  "applicationCode": string,
  "developer": string,
  "platform": enum (ApplicationPlatform),
  "free": boolean,
  "downloadUrl": string,
  "approvalStatus": enum (ApplicationApprovalStatus),
  "webviewClaimingStatus": enum (WebviewClaimingStatus)
}
Fields
name

string

Identifier. The resource name of the Application. Format: networks/{networkCode}/applications/{application_id}
appStores[]

enum (ApplicationStore)

Optional. The app stores the application belongs to. This attribute is mutable to allow for third party app store linking.
displayName

string

Required. The display name of the application.
appStoreId

string

Optional. The app store ID of the app to claim.
archived

boolean

Output only. The archival status of the application.

When true, an application cannot be targeted and will not serve ads, regardless of its status.
appStoreDisplayName

string

Output only. The name of the application on the app store.
applicationCode

string

Output only. The application code used to identify the app in the SDK.

Note that the UI refers to this as "App ID".
developer

string

Output only. The name of the developer of the application.
platform

enum (ApplicationPlatform)

Output only. The platform the application runs on.
free

boolean

Output only. Whether the application is free on the app store it belongs to.
downloadUrl

string

Output only. The download URL of the application on the app store it belongs to.
approvalStatus

enum (ApplicationApprovalStatus)

Output only. The approval status for the application.
webviewClaimingStatus

enum (WebviewClaimingStatus)

Output only. The webview claiming status for the application.

ApplicationStore

The application store that distributes applications.

Enums
APPLICATION_STORE_UNSPECIFIED Not specified value.
APPLE_APP_STORE Apple App Store (iTunes).
GOOGLE_PLAY_STORE Google Play (ex. Google Market).
AMAZON_APP_STORE Amazon App Store.
OPPO_APP_STORE Oppo App Market.
SAMSUNG_APP_STORE Samsung Galaxy Store.
VIVO_APP_STORE Vivo App Store.
XIAOMI_APP_STORE Mi GetApps.
AMAZON_FIRETV_STORE Application store for Amazon Fire TV apps.
LG_TV_STORE Application store for LG TV apps.
PLAYSTATION_STORE Application store for Playstation apps.
ROKU_STORE Application store for Roku apps.
SAMSUNG_TV_STORE Application store for Samsung TV apps.
XBOX_STORE Application store for Xbox apps.

ApplicationPlatform

A platform a Application can run on.

Enums
APPLICATION_PLATFORM_UNSPECIFIED Default value. This value is unused.
UNSUPPORTED Platform for apps with platforms we don't support yet or don't have a representation for.
AMAZON_TV Platform for Amazon Fire TV compatible apps.
ANDROID Platform for Android compatible apps.
IOS Platform for IOS compatible apps.
LG_TV Platform for LG TV compatible apps.
PLAYSTATION Platform for Playstation compatible apps.
ROKU Platform for Roku compatible apps.
SAMSUNG_TV Platform for Samsung TV compatible apps.
XBOX Platform for Xbox compatible apps.

ApplicationApprovalStatus

The approval status of the application.

Enums
APPLICATION_APPROVAL_STATUS_UNSPECIFIED Default value. This value is unused.
APPEALING The application is disapproved but has a pending review status, signaling an appeal.
APPROVED The application can serve ads.
DISAPPROVED The application failed approval checks and it cannot serve any ads.
DRAFT The application is not yet ready for review.
UNCHECKED The application has not yet been reviewed.

WebviewClaimingStatus

The webview claiming status of a Application.

Enums
WEBVIEW_CLAIMING_STATUS_UNSPECIFIED Default value. This value is unused.
SOFT_CLAIMED The application is soft claimed (claimed for targeting, but not ownership).
SOFT_CLAIMING_REVERTED The application had its soft claiming status reverted (usually by a user action).

Methods

batchArchive

 / API to batch archive Application objects.

batchCreate

 API to batch create Application objects.

batchUnarchive

 / API to batch unarchive Application objects.

batchUpdate

 API to batch update Application objects.

create

 API to create a Application object.

get

 API to retrieve a Application object.

list

 API to retrieve a list of Application objects.

patch

 API to update a Application object.