Interface SearchAdReviewCenterAdsRequestOrBuilder (0.39.0) 

public interface SearchAdReviewCenterAdsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAdReviewCenterAdId(int index)

public abstract String getAdReviewCenterAdId(int index)

Optional. If provided, only return ads with the given AdReviewCenterAd IDs.

repeated string ad_review_center_ad_id = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The adReviewCenterAdId at the given index.

getAdReviewCenterAdIdBytes(int index)

public abstract ByteString getAdReviewCenterAdIdBytes(int index)

Optional. If provided, only return ads with the given AdReviewCenterAd IDs.

repeated string ad_review_center_ad_id = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the adReviewCenterAdId at the given index.

getAdReviewCenterAdIdCount()

public abstract int getAdReviewCenterAdIdCount()

Optional. If provided, only return ads with the given AdReviewCenterAd IDs.

repeated string ad_review_center_ad_id = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of adReviewCenterAdId.

getAdReviewCenterAdIdList()

public abstract List<String> getAdReviewCenterAdIdList()

Optional. If provided, only return ads with the given AdReviewCenterAd IDs.

repeated string ad_review_center_ad_id = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<String>

A list containing the adReviewCenterAdId.

getBuyerAccountId(int index)

public abstract long getBuyerAccountId(int index)

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 via the ProgrammaticBuyerService.

repeated int64 buyer_account_id = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
long

The buyerAccountId at the given index.

getBuyerAccountIdCount()

public abstract int getBuyerAccountIdCount()

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 via the ProgrammaticBuyerService.

repeated int64 buyer_account_id = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of buyerAccountId.

getBuyerAccountIdList()

public abstract List<Long> getBuyerAccountIdList()

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 via the ProgrammaticBuyerService.

repeated int64 buyer_account_id = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Long>

A list containing the buyerAccountId.

getDateTimeRange()

public abstract Interval 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.

.google.type.Interval date_time_range = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
com.google.type.Interval

The dateTimeRange.

getDateTimeRangeOrBuilder()

public abstract IntervalOrBuilder getDateTimeRangeOrBuilder()

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.

.google.type.Interval date_time_range = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
com.google.type.IntervalOrBuilder

getPageSize()

public abstract int 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.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The pageSize.

getPageToken()

public abstract String getPageToken()

Optional. The page token to fetch the next page of AdReviewCenterAds. This is the value returned from a previous Search request, or empty.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

Optional. The page token to fetch the next page of AdReviewCenterAds. This is the value returned from a previous Search request, or empty.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public abstract String 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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public abstract ByteString getParentBytes()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getSearchText(int index)

public abstract String getSearchText(int index)

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".

repeated string search_text = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The searchText at the given index.

getSearchTextBytes(int index)

public abstract ByteString getSearchTextBytes(int index)

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".

repeated string search_text = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the searchText at the given index.

getSearchTextCount()

public abstract int getSearchTextCount()

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".

repeated string search_text = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of searchText.

getSearchTextList()

public abstract List<String> getSearchTextList()

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".

repeated string search_text = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<String>

A list containing the searchText.

getStatus()

public abstract AdReviewCenterAdStatusEnum.AdReviewCenterAdStatus getStatus()

Required. Only return ads with the given status.

.google.ads.admanager.v1.AdReviewCenterAdStatusEnum.AdReviewCenterAdStatus status = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
AdReviewCenterAdStatusEnum.AdReviewCenterAdStatus

The status.

getStatusValue()

public abstract int getStatusValue()

Required. Only return ads with the given status.

.google.ads.admanager.v1.AdReviewCenterAdStatusEnum.AdReviewCenterAdStatus status = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for status.

hasDateTimeRange()

public abstract boolean hasDateTimeRange()

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.

.google.type.Interval date_time_range = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the dateTimeRange field is set.