Google Ads Ad Manager V1 Client - Class Application (0.7.0)

Reference documentation and code samples for the Google Ads Ad Manager V1 Client class 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.

Generated from protobuf message google.ads.admanager.v1.Application

Namespace

Google \ Ads \ AdManager \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Identifier. The resource name of the Application. Format: networks/{network_code}/applications/{application_id}
↳ display_name string

Required. The display name of the application.
↳ app_store_id string

Optional. The app store ID of the app to claim.
↳ app_stores int[]

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

Output only. The archival status of the application. When true, an application cannot be targeted and will not serve ads, regardless of its status.
↳ app_store_display_name string

Output only. The name of the application on the app store.
↳ application_code 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 int

Output only. The platform the application runs on.
↳ free bool

Output only. Whether the application is free on the app store it belongs to.
↳ download_url string

Output only. The download URL of the application on the app store it belongs to.
↳ approval_status int

Output only. The approval status for the application.
↳ webview_claiming_status int

Output only. The webview claiming status for the application.

getName

Identifier. The resource name of the Application.

Format: networks/{network_code}/applications/{application_id}

Returns
Type Description
string

setName

Identifier. The resource name of the Application.

Format: networks/{network_code}/applications/{application_id}

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

Required. The display name of the application.

Returns
Type Description
string

hasDisplayName

clearDisplayName

setDisplayName

Required. The display name of the application.

Parameter
Name Description
var string
Returns
Type Description
$this

getAppStoreId

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

Returns
Type Description
string

hasAppStoreId

clearAppStoreId

setAppStoreId

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

Parameter
Name Description
var string
Returns
Type Description
$this

getAppStores

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

Returns
Type Description
Google\Protobuf\RepeatedField<int>

setAppStores

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

Parameter
Name Description
var int[]
Returns
Type Description
$this

getArchived

Output only. The archival status of the application.

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

Returns
Type Description
bool

hasArchived

clearArchived

setArchived

Output only. The archival status of the application.

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

Parameter
Name Description
var bool
Returns
Type Description
$this

getAppStoreDisplayName

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

Returns
Type Description
string

hasAppStoreDisplayName

clearAppStoreDisplayName

setAppStoreDisplayName

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

Parameter
Name Description
var string
Returns
Type Description
$this

getApplicationCode

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

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

Returns
Type Description
string

hasApplicationCode

clearApplicationCode

setApplicationCode

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

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

Parameter
Name Description
var string
Returns
Type Description
$this

getDeveloper

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

Returns
Type Description
string

hasDeveloper

clearDeveloper

setDeveloper

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

Parameter
Name Description
var string
Returns
Type Description
$this

getPlatform

Output only. The platform the application runs on.

Returns
Type Description
int

hasPlatform

clearPlatform

setPlatform

Output only. The platform the application runs on.

Parameter
Name Description
var int
Returns
Type Description
$this

getFree

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

Returns
Type Description
bool

hasFree

clearFree

setFree

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

Parameter
Name Description
var bool
Returns
Type Description
$this

getDownloadUrl

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

Returns
Type Description
string

hasDownloadUrl

clearDownloadUrl

setDownloadUrl

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

Parameter
Name Description
var string
Returns
Type Description
$this

getApprovalStatus

Output only. The approval status for the application.

Returns
Type Description
int

hasApprovalStatus

clearApprovalStatus

setApprovalStatus

Output only. The approval status for the application.

Parameter
Name Description
var int
Returns
Type Description
$this

getWebviewClaimingStatus

Output only. The webview claiming status for the application.

Returns
Type Description
int

hasWebviewClaimingStatus

clearWebviewClaimingStatus

setWebviewClaimingStatus

Output only. The webview claiming status for the application.

Parameter
Name Description
var int
Returns
Type Description
$this