public final class SearchAdReviewCenterAdsRequest extends GeneratedMessageV3 implements SearchAdReviewCenterAdsRequestOrBuilder
Request object for SearchAdReviewCenterAds method.
Protobuf type google.ads.admanager.v1.SearchAdReviewCenterAdsRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
AD_REVIEW_CENTER_AD_ID_FIELD_NUMBER
public static final int AD_REVIEW_CENTER_AD_ID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
BUYER_ACCOUNT_ID_FIELD_NUMBER
public static final int BUYER_ACCOUNT_ID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DATE_TIME_RANGE_FIELD_NUMBER
public static final int DATE_TIME_RANGE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SEARCH_TEXT_FIELD_NUMBER
public static final int SEARCH_TEXT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
STATUS_FIELD_NUMBER
public static final int STATUS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static SearchAdReviewCenterAdsRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static SearchAdReviewCenterAdsRequest.Builder newBuilder()
newBuilder(SearchAdReviewCenterAdsRequest prototype)
public static SearchAdReviewCenterAdsRequest.Builder newBuilder(SearchAdReviewCenterAdsRequest prototype)
public static SearchAdReviewCenterAdsRequest parseDelimitedFrom(InputStream input)
public static SearchAdReviewCenterAdsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static SearchAdReviewCenterAdsRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SearchAdReviewCenterAdsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static SearchAdReviewCenterAdsRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchAdReviewCenterAdsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchAdReviewCenterAdsRequest parseFrom(CodedInputStream input)
public static SearchAdReviewCenterAdsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchAdReviewCenterAdsRequest parseFrom(InputStream input)
public static SearchAdReviewCenterAdsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static SearchAdReviewCenterAdsRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SearchAdReviewCenterAdsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<SearchAdReviewCenterAdsRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getAdReviewCenterAdId(int index)
public 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 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 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 ProtocolStringList 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];
getBuyerAccountId(int index)
public 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 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 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 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 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 |
|
getDefaultInstanceForType()
public SearchAdReviewCenterAdsRequest getDefaultInstanceForType()
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 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 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 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 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.
|
getParserForType()
public Parser<SearchAdReviewCenterAdsRequest> getParserForType()
Overrides
getSearchText(int index)
public 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 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 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 ProtocolStringList 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];
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getStatus()
public AdReviewCenterAdStatusEnum.AdReviewCenterAdStatus getStatus()
Required. Only return ads with the given status.
.google.ads.admanager.v1.AdReviewCenterAdStatusEnum.AdReviewCenterAdStatus status = 4 [(.google.api.field_behavior) = REQUIRED];
getStatusValue()
public 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 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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public SearchAdReviewCenterAdsRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SearchAdReviewCenterAdsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public SearchAdReviewCenterAdsRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides