Reference documentation and code samples for the Google Ads Ad Manager V1 Client class SearchAdReviewCenterAdsRequest.
Request object for SearchAdReviewCenterAds method.
Generated from protobuf message google.ads.admanager.v1.SearchAdReviewCenterAdsRequest
Namespace
Google \ Ads \ AdManager \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ status |
int
Optional. Only return ads with the given status. Use this filter for web properties where Manual Creative Review (MCR) is not enabled. |
↳ manual_review_status |
int
Optional. Only return ads with the given manual review status. Use this filter for web properties where Manual Creative Review (MCR) is enabled. |
↳ parent |
string
Required. The parent, which owns this collection of AdReviewCenterAds. Format: networks/{network_code}/webProperties/{web_property_code} Since a network can only have a single web property of each |
↳ page_size |
int
Optional. The maximum number of AdReviewCenterAds to return. The service may return fewer than this value. If unspecified, at most 50 AdReviewCenterAds will be returned. The maximum value is 1000; values greater than 1000 will be coerced to 1000. |
↳ page_token |
string
Optional. The page token to fetch the next page of AdReviewCenterAds. This is the value returned from a previous Search request, or empty. |
↳ ad_review_center_ad_id |
string[]
Optional. Only return ads with the given AdReviewCenterAd IDs. If provided, no other filter can be set (other than page size and page token). |
↳ date_time_range |
Google\Type\Interval
Optional. If provided, only return ads that served within the given date range (inclusive). The date range must be within the last 30 days. If not provided, the date range will be the last 30 days. |
↳ search_text |
string[]
Optional. If provided, restrict the search to AdReviewCenterAds associated with the text (including any text on the ad or in the destination URL). If more than one value is provided, the search will combine them in a logical AND. For example, ['car', 'blue'] will match ads that contain both "car" and "blue", but not an ad that only contains "car". |
↳ buyer_account_id |
int[]|string[]
Optional. If provided, restrict the search to creatives belonging to one of the given Adx buyer account IDs. Only applicable to RTB creatives. Adx buyer account IDs can be found using the |
↳ ad_response_id |
string[]
Optional. If provided, only return ads with the given ad response IDs. This filter is exclusive and cannot be combined with any other filters. Maximum of 10 IDs can be specified. |
↳ advertiser_display_names |
string[]
Optional. If provided, restrict the search to creatives with the given advertiser names. |
↳ language_codes |
string[]
Optional. If provided, restrict the search to creatives serving in the given language codes. |
↳ region_codes |
string[]
Optional. If provided, restrict the search to creatives serving in the given region codes. |
↳ ad_types |
int[]
Optional. If provided, restrict the search to creatives with the given ad types. |
↳ advertiser_apps |
string[]
Optional. If provided, restrict the search to creatives promoting the given app. |
↳ publisher_domains |
string[]
Optional. If provided, restrict the search to creatives belonging to the given publisher domain. |
↳ new_in_last_days |
int
Optional. If provided, restrict the search to creatives which appeared for the first time within the past X days. Must be within the last 30 days (1 to 30, inclusive). |
↳ label_ids |
string[]
Optional. If provided, restrict the search to creatives associated with the given custom label IDs. |
getStatus
Optional. Only return ads with the given status.
Use this filter for web properties where Manual Creative Review (MCR) is not enabled.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type AdReviewCenterAdStatus. |
hasStatus
setStatus
Optional. Only return ads with the given status.
Use this filter for web properties where Manual Creative Review (MCR) is not enabled.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type AdReviewCenterAdStatus. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getManualReviewStatus
Optional. Only return ads with the given manual review status.
Use this filter for web properties where Manual Creative Review (MCR) is enabled.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type ManualAdReviewCenterAdStatus. |
hasManualReviewStatus
setManualReviewStatus
Optional. Only return ads with the given manual review status.
Use this filter for web properties where Manual Creative Review (MCR) is enabled.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type ManualAdReviewCenterAdStatus. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getParent
Required. The parent, which owns this collection of AdReviewCenterAds.
Format: networks/{network_code}/webProperties/{web_property_code}
Since a network can only have a single web property of each
ExchangeSyndicationProduct, you can use the
ExchangeSyndicationProduct as an alias for the web property code:
networks/{network_code}/webProperties/display
networks/{network_code}/webProperties/videoAndAudio
networks/{network_code}/webProperties/mobileApp
networks/{network_code}/webProperties/games
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. The parent, which owns this collection of AdReviewCenterAds.
Format: networks/{network_code}/webProperties/{web_property_code}
Since a network can only have a single web property of each
ExchangeSyndicationProduct, you can use the
ExchangeSyndicationProduct as an alias for the web property code:
networks/{network_code}/webProperties/display
networks/{network_code}/webProperties/videoAndAudio
networks/{network_code}/webProperties/mobileApp
networks/{network_code}/webProperties/games
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageSize
Optional. The maximum number of AdReviewCenterAds to return. The service may return fewer than this value. If unspecified, at most 50 AdReviewCenterAds will be returned. The maximum value is 1000; values greater than 1000 will be coerced to 1000.
| Returns | |
|---|---|
| Type | Description |
int |
|
setPageSize
Optional. The maximum number of AdReviewCenterAds to return. The service may return fewer than this value. If unspecified, at most 50 AdReviewCenterAds will be returned. The maximum value is 1000; values greater than 1000 will be coerced to 1000.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageToken
Optional. The page token to fetch the next page of AdReviewCenterAds. This is the value returned from a previous Search request, or empty.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPageToken
Optional. The page token to fetch the next page of AdReviewCenterAds. This is the value returned from a previous Search request, or empty.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAdReviewCenterAdId
Optional. Only return ads with the given AdReviewCenterAd IDs. If provided, no other filter can be set (other than page size and page token).
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<string> |
|
setAdReviewCenterAdId
Optional. Only return ads with the given AdReviewCenterAd IDs. If provided, no other filter can be set (other than page size and page token).
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDateTimeRange
Optional. If provided, only return ads that served within the given date range (inclusive). The date range must be within the last 30 days. If not provided, the date range will be the last 30 days.
| Returns | |
|---|---|
| Type | Description |
Google\Type\Interval|null |
|
hasDateTimeRange
clearDateTimeRange
setDateTimeRange
Optional. If provided, only return ads that served within the given date range (inclusive). The date range must be within the last 30 days. If not provided, the date range will be the last 30 days.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Type\Interval
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSearchText
Optional. If provided, restrict the search to AdReviewCenterAds associated with the text (including any text on the ad or in the destination URL). If more than one value is provided, the search will combine them in a logical AND. For example, ['car', 'blue'] will match ads that contain both "car" and "blue", but not an ad that only contains "car".
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<string> |
|
setSearchText
Optional. If provided, restrict the search to AdReviewCenterAds associated with the text (including any text on the ad or in the destination URL). If more than one value is provided, the search will combine them in a logical AND. For example, ['car', 'blue'] will match ads that contain both "car" and "blue", but not an ad that only contains "car".
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBuyerAccountId
Optional. If provided, restrict the search to creatives belonging to one of
the given Adx buyer account IDs. Only applicable to RTB creatives. Adx
buyer account IDs can be found using the ProgrammaticBuyerService.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<int>|Google\Protobuf\RepeatedField<string> |
|
setBuyerAccountId
Optional. If provided, restrict the search to creatives belonging to one of
the given Adx buyer account IDs. Only applicable to RTB creatives. Adx
buyer account IDs can be found using the ProgrammaticBuyerService.
| Parameter | |
|---|---|
| Name | Description |
var |
int[]|string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAdResponseId
Optional. If provided, only return ads with the given ad response IDs.
This filter is exclusive and cannot be combined with any other filters. Maximum of 10 IDs can be specified.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<string> |
|
setAdResponseId
Optional. If provided, only return ads with the given ad response IDs.
This filter is exclusive and cannot be combined with any other filters. Maximum of 10 IDs can be specified.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAdvertiserDisplayNames
Optional. If provided, restrict the search to creatives with the given advertiser names.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<string> |
|
setAdvertiserDisplayNames
Optional. If provided, restrict the search to creatives with the given advertiser names.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLanguageCodes
Optional. If provided, restrict the search to creatives serving in the given language codes.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<string> |
|
setLanguageCodes
Optional. If provided, restrict the search to creatives serving in the given language codes.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRegionCodes
Optional. If provided, restrict the search to creatives serving in the given region codes.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<string> |
|
setRegionCodes
Optional. If provided, restrict the search to creatives serving in the given region codes.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAdTypes
Optional. If provided, restrict the search to creatives with the given ad types.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<int> |
|
setAdTypes
Optional. If provided, restrict the search to creatives with the given ad types.
| Parameter | |
|---|---|
| Name | Description |
var |
int[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAdvertiserApps
Optional. If provided, restrict the search to creatives promoting the given app.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<string> |
|
setAdvertiserApps
Optional. If provided, restrict the search to creatives promoting the given app.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPublisherDomains
Optional. If provided, restrict the search to creatives belonging to the given publisher domain.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<string> |
|
setPublisherDomains
Optional. If provided, restrict the search to creatives belonging to the given publisher domain.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNewInLastDays
Optional. If provided, restrict the search to creatives which appeared for the first time within the past X days. Must be within the last 30 days (1 to 30, inclusive).
| Returns | |
|---|---|
| Type | Description |
int |
|
hasNewInLastDays
clearNewInLastDays
setNewInLastDays
Optional. If provided, restrict the search to creatives which appeared for the first time within the past X days. Must be within the last 30 days (1 to 30, inclusive).
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLabelIds
Optional. If provided, restrict the search to creatives associated with the given custom label IDs.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<string> |
|
setLabelIds
Optional. If provided, restrict the search to creatives associated with the given custom label IDs.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAdReviewStatus
| Returns | |
|---|---|
| Type | Description |
string |
|
static::build
| Parameter | |
|---|---|
| Name | Description |
parent |
string
Required. The parent, which owns this collection of AdReviewCenterAds. Format: networks/{network_code}/webProperties/{web_property_code} Since a network can only have a single web property of each
|
| Returns | |
|---|---|
| Type | Description |
SearchAdReviewCenterAdsRequest |
|