Google Ads Ad Manager V1 Client - Class AdReviewCenterAd (0.15.1)

Reference documentation and code samples for the Google Ads Ad Manager V1 Client class AdReviewCenterAd.

Represents an ad that can be acted on or viewed in the Ad Review Center.

AdReviewCenterAd.

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

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 AdReviewCenterAd. Format: networks/{network_code}/webProperties/{web_property_code}/adReviewCenterAds/{ad_review_center_ad_id}
↳ ad_review_center_ad_id string

Output only. AdReviewCenterAd ID.
↳ product_type int

Output only. Specifies the ExchangeSyndicationProduct for this AdReviewCenterAd.
↳ status int

The status of the AdReviewCenterAd.
↳ manual_review_statuses int[]

Output only. The manual review status of the AdReviewCenterAd (for web properties in MCR mode). For MCR mode, a single ad could have multiple statuses (for example, pending and serving at the same time, if the ad is affected by a protection in certain inventory only). This field is not set for the standard mode.
↳ preview_url string

Output only. The preview URL that can be embedded or accessed directly which will present the rendered contents of the ad. This URL expires 72 hours after being retrieved.
↳ asset_preview_urls string[]

Output only. The preview URLs that can be embedded or accessed directly which will present the rendered contents of the ad, each with a different asset. These URLs expire 72 hours after being retrieved.
↳ advertiser_display_name string

Output only. The advertiser name of the Ad Review Center ad. Specifies the detected advertiser for Google Display Network (GDN) ads, and individual network name for real-time bidding (RTB) ads.
↳ language_codes string[]

Output only. The language codes of the Ad Review Center ad. Languages detected are represented by their BCP 47 code. For example, 'en', 'fr', 'es-419', or 'zh-cn'.
↳ region_codes string[]

Output only. The region codes of the Ad Review Center ad.
↳ ad_types int[]

Output only. The ad types of the Ad Review Center ad.
↳ destination_urls string[]

Output only. The destination URLs of the Ad Review Center ad.
↳ label_ids string[]

Output only. The labelIds associated with this Ad Review Center ad.

getName

Identifier. The resource name of the AdReviewCenterAd.

Format: networks/{network_code}/webProperties/{web_property_code}/adReviewCenterAds/{ad_review_center_ad_id}

Returns
Type Description
string

setName

Identifier. The resource name of the AdReviewCenterAd.

Format: networks/{network_code}/webProperties/{web_property_code}/adReviewCenterAds/{ad_review_center_ad_id}

Parameter
Name Description
var string
Returns
Type Description
$this

getAdReviewCenterAdId

Output only. AdReviewCenterAd ID.

Returns
Type Description
string

setAdReviewCenterAdId

Output only. AdReviewCenterAd ID.

Parameter
Name Description
var string
Returns
Type Description
$this

getProductType

Output only. Specifies the ExchangeSyndicationProduct for this AdReviewCenterAd.

Returns
Type Description
int Enum of type ExchangeSyndicationProduct.

setProductType

Output only. Specifies the ExchangeSyndicationProduct for this AdReviewCenterAd.

Parameter
Name Description
var int

Enum of type ExchangeSyndicationProduct.

Returns
Type Description
$this

getStatus

The status of the AdReviewCenterAd.

Returns
Type Description
int Enum of type AdReviewCenterAdStatus.

setStatus

The status of the AdReviewCenterAd.

Parameter
Name Description
var int

Enum of type AdReviewCenterAdStatus.

Returns
Type Description
$this

getManualReviewStatuses

Output only. The manual review status of the AdReviewCenterAd (for web properties in MCR mode). For MCR mode, a single ad could have multiple statuses (for example, pending and serving at the same time, if the ad is affected by a protection in certain inventory only). This field is not set for the standard mode.

Returns
Type Description
Google\Protobuf\RepeatedField<int>

setManualReviewStatuses

Output only. The manual review status of the AdReviewCenterAd (for web properties in MCR mode). For MCR mode, a single ad could have multiple statuses (for example, pending and serving at the same time, if the ad is affected by a protection in certain inventory only). This field is not set for the standard mode.

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

getPreviewUrl

Output only. The preview URL that can be embedded or accessed directly which will present the rendered contents of the ad. This URL expires 72 hours after being retrieved.

Returns
Type Description
string

hasPreviewUrl

clearPreviewUrl

setPreviewUrl

Output only. The preview URL that can be embedded or accessed directly which will present the rendered contents of the ad. This URL expires 72 hours after being retrieved.

Parameter
Name Description
var string
Returns
Type Description
$this

getAssetPreviewUrls

Output only. The preview URLs that can be embedded or accessed directly which will present the rendered contents of the ad, each with a different asset. These URLs expire 72 hours after being retrieved.

Returns
Type Description
Google\Protobuf\RepeatedField<string>

setAssetPreviewUrls

Output only. The preview URLs that can be embedded or accessed directly which will present the rendered contents of the ad, each with a different asset. These URLs expire 72 hours after being retrieved.

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

getAdvertiserDisplayName

Output only. The advertiser name of the Ad Review Center ad. Specifies the detected advertiser for Google Display Network (GDN) ads, and individual network name for real-time bidding (RTB) ads.

Returns
Type Description
string

setAdvertiserDisplayName

Output only. The advertiser name of the Ad Review Center ad. Specifies the detected advertiser for Google Display Network (GDN) ads, and individual network name for real-time bidding (RTB) ads.

Parameter
Name Description
var string
Returns
Type Description
$this

getLanguageCodes

Output only. The language codes of the Ad Review Center ad. Languages detected are represented by their BCP 47 code. For example, 'en', 'fr', 'es-419', or 'zh-cn'.

Returns
Type Description
Google\Protobuf\RepeatedField<string>

setLanguageCodes

Output only. The language codes of the Ad Review Center ad. Languages detected are represented by their BCP 47 code. For example, 'en', 'fr', 'es-419', or 'zh-cn'.

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

getRegionCodes

Output only. The region codes of the Ad Review Center ad.

Returns
Type Description
Google\Protobuf\RepeatedField<string>

setRegionCodes

Output only. The region codes of the Ad Review Center ad.

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

getAdTypes

Output only. The ad types of the Ad Review Center ad.

Returns
Type Description
Google\Protobuf\RepeatedField<int>

setAdTypes

Output only. The ad types of the Ad Review Center ad.

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

getDestinationUrls

Output only. The destination URLs of the Ad Review Center ad.

Returns
Type Description
Google\Protobuf\RepeatedField<string>

setDestinationUrls

Output only. The destination URLs of the Ad Review Center ad.

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

getLabelIds

Output only. The labelIds associated with this Ad Review Center ad.

Returns
Type Description
Google\Protobuf\RepeatedField<string>

setLabelIds

Output only. The labelIds associated with this Ad Review Center ad.

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