public static final class ListYieldGroupsRequest.Builder extends GeneratedMessage.Builder<ListYieldGroupsRequest.Builder> implements ListYieldGroupsRequestOrBuilder Request object for ListYieldGroups method.
Protobuf type google.ads.admanager.v1.ListYieldGroupsRequest
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > ListYieldGroupsRequest.BuilderImplements
ListYieldGroupsRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
build()
public ListYieldGroupsRequest build()| Returns | |
|---|---|
| Type | Description |
ListYieldGroupsRequest |
|
buildPartial()
public ListYieldGroupsRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
ListYieldGroupsRequest |
|
clear()
public ListYieldGroupsRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
ListYieldGroupsRequest.Builder |
|
clearFilter()
public ListYieldGroupsRequest.Builder clearFilter()Optional. Expression to filter the response. See syntax details at https://developers.google.com/ad-manager/api/beta/filters
Syntax summary: double-quoted "..." (never '...') strings and RFC 3339
timestamps, full resource names on reference fields (for example, order =
"networks/123/orders/456", not Id or bare IDs), prefix or suffix
wildcards with = (displayName = "foo*"), : for substring or
repeated-field matching, unquoted enums and booleans, uppercase
AND/OR/NOT, and standalone IN(field, SET(v1, v2)) (not field IN
(...)).
Filterable fields:
displayNamenamestatustargeting.geoTargeting.targetedGeostargeting.inventoryTargeting.targetedAdUnits.adUnittargeting.mobileApplicationTargeting.firstPartyTargeting.targetedApplications
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ListYieldGroupsRequest.Builder |
This builder for chaining. |
clearOrderBy()
public ListYieldGroupsRequest.Builder clearOrderBy()Optional. Expression to specify sorting order. See syntax details at https://developers.google.com/ad-manager/api/beta/filters#order
string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ListYieldGroupsRequest.Builder |
This builder for chaining. |
clearPageSize()
public ListYieldGroupsRequest.Builder clearPageSize() Optional. The maximum number of YieldGroups to return. The service may
return fewer than this value. If unspecified, at most 50 YieldGroups 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 |
ListYieldGroupsRequest.Builder |
This builder for chaining. |
clearPageToken()
public ListYieldGroupsRequest.Builder clearPageToken() Optional. A page token, received from a previous ListYieldGroups call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListYieldGroups must
match the call that provided the page token.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ListYieldGroupsRequest.Builder |
This builder for chaining. |
clearParent()
public ListYieldGroupsRequest.Builder clearParent() Required. The parent, which owns this collection of YieldGroups.
Format: networks/{network_code}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ListYieldGroupsRequest.Builder |
This builder for chaining. |
clearSkip()
public ListYieldGroupsRequest.Builder clearSkip()Optional. Number of individual resources to skip while paginating.
int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ListYieldGroupsRequest.Builder |
This builder for chaining. |
getDefaultInstanceForType()
public ListYieldGroupsRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ListYieldGroupsRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getFilter()
public String getFilter()Optional. Expression to filter the response. See syntax details at https://developers.google.com/ad-manager/api/beta/filters
Syntax summary: double-quoted "..." (never '...') strings and RFC 3339
timestamps, full resource names on reference fields (for example, order =
"networks/123/orders/456", not Id or bare IDs), prefix or suffix
wildcards with = (displayName = "foo*"), : for substring or
repeated-field matching, unquoted enums and booleans, uppercase
AND/OR/NOT, and standalone IN(field, SET(v1, v2)) (not field IN
(...)).
Filterable fields:
displayNamenamestatustargeting.geoTargeting.targetedGeostargeting.inventoryTargeting.targetedAdUnits.adUnittargeting.mobileApplicationTargeting.firstPartyTargeting.targetedApplications
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The filter. |
getFilterBytes()
public ByteString getFilterBytes()Optional. Expression to filter the response. See syntax details at https://developers.google.com/ad-manager/api/beta/filters
Syntax summary: double-quoted "..." (never '...') strings and RFC 3339
timestamps, full resource names on reference fields (for example, order =
"networks/123/orders/456", not Id or bare IDs), prefix or suffix
wildcards with = (displayName = "foo*"), : for substring or
repeated-field matching, unquoted enums and booleans, uppercase
AND/OR/NOT, and standalone IN(field, SET(v1, v2)) (not field IN
(...)).
Filterable fields:
displayNamenamestatustargeting.geoTargeting.targetedGeostargeting.inventoryTargeting.targetedAdUnits.adUnittargeting.mobileApplicationTargeting.firstPartyTargeting.targetedApplications
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for filter. |
getOrderBy()
public String getOrderBy()Optional. Expression to specify sorting order. See syntax details at https://developers.google.com/ad-manager/api/beta/filters#order
string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The orderBy. |
getOrderByBytes()
public ByteString getOrderByBytes()Optional. Expression to specify sorting order. See syntax details at https://developers.google.com/ad-manager/api/beta/filters#order
string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for orderBy. |
getPageSize()
public int getPageSize() Optional. The maximum number of YieldGroups to return. The service may
return fewer than this value. If unspecified, at most 50 YieldGroups 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. A page token, received from a previous ListYieldGroups call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListYieldGroups must
match the call that provided the page token.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The pageToken. |
getPageTokenBytes()
public ByteString getPageTokenBytes() Optional. A page token, received from a previous ListYieldGroups call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListYieldGroups must
match the call that provided the page token.
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 YieldGroups.
Format: networks/{network_code}
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 YieldGroups.
Format: networks/{network_code}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for parent. |
getSkip()
public int getSkip()Optional. Number of individual resources to skip while paginating.
int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The skip. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(ListYieldGroupsRequest other)
public ListYieldGroupsRequest.Builder mergeFrom(ListYieldGroupsRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
ListYieldGroupsRequest |
| Returns | |
|---|---|
| Type | Description |
ListYieldGroupsRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ListYieldGroupsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ListYieldGroupsRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ListYieldGroupsRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ListYieldGroupsRequest.Builder |
|
setFilter(String value)
public ListYieldGroupsRequest.Builder setFilter(String value)Optional. Expression to filter the response. See syntax details at https://developers.google.com/ad-manager/api/beta/filters
Syntax summary: double-quoted "..." (never '...') strings and RFC 3339
timestamps, full resource names on reference fields (for example, order =
"networks/123/orders/456", not Id or bare IDs), prefix or suffix
wildcards with = (displayName = "foo*"), : for substring or
repeated-field matching, unquoted enums and booleans, uppercase
AND/OR/NOT, and standalone IN(field, SET(v1, v2)) (not field IN
(...)).
Filterable fields:
displayNamenamestatustargeting.geoTargeting.targetedGeostargeting.inventoryTargeting.targetedAdUnits.adUnittargeting.mobileApplicationTargeting.firstPartyTargeting.targetedApplications
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe filter to set. |
| Returns | |
|---|---|
| Type | Description |
ListYieldGroupsRequest.Builder |
This builder for chaining. |
setFilterBytes(ByteString value)
public ListYieldGroupsRequest.Builder setFilterBytes(ByteString value)Optional. Expression to filter the response. See syntax details at https://developers.google.com/ad-manager/api/beta/filters
Syntax summary: double-quoted "..." (never '...') strings and RFC 3339
timestamps, full resource names on reference fields (for example, order =
"networks/123/orders/456", not Id or bare IDs), prefix or suffix
wildcards with = (displayName = "foo*"), : for substring or
repeated-field matching, unquoted enums and booleans, uppercase
AND/OR/NOT, and standalone IN(field, SET(v1, v2)) (not field IN
(...)).
Filterable fields:
displayNamenamestatustargeting.geoTargeting.targetedGeostargeting.inventoryTargeting.targetedAdUnits.adUnittargeting.mobileApplicationTargeting.firstPartyTargeting.targetedApplications
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for filter to set. |
| Returns | |
|---|---|
| Type | Description |
ListYieldGroupsRequest.Builder |
This builder for chaining. |
setOrderBy(String value)
public ListYieldGroupsRequest.Builder setOrderBy(String value)Optional. Expression to specify sorting order. See syntax details at https://developers.google.com/ad-manager/api/beta/filters#order
string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe orderBy to set. |
| Returns | |
|---|---|
| Type | Description |
ListYieldGroupsRequest.Builder |
This builder for chaining. |
setOrderByBytes(ByteString value)
public ListYieldGroupsRequest.Builder setOrderByBytes(ByteString value)Optional. Expression to specify sorting order. See syntax details at https://developers.google.com/ad-manager/api/beta/filters#order
string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for orderBy to set. |
| Returns | |
|---|---|
| Type | Description |
ListYieldGroupsRequest.Builder |
This builder for chaining. |
setPageSize(int value)
public ListYieldGroupsRequest.Builder setPageSize(int value) Optional. The maximum number of YieldGroups to return. The service may
return fewer than this value. If unspecified, at most 50 YieldGroups 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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe pageSize to set. |
| Returns | |
|---|---|
| Type | Description |
ListYieldGroupsRequest.Builder |
This builder for chaining. |
setPageToken(String value)
public ListYieldGroupsRequest.Builder setPageToken(String value) Optional. A page token, received from a previous ListYieldGroups call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListYieldGroups must
match the call that provided the page token.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
ListYieldGroupsRequest.Builder |
This builder for chaining. |
setPageTokenBytes(ByteString value)
public ListYieldGroupsRequest.Builder setPageTokenBytes(ByteString value) Optional. A page token, received from a previous ListYieldGroups call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListYieldGroups must
match the call that provided the page token.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
ListYieldGroupsRequest.Builder |
This builder for chaining. |
setParent(String value)
public ListYieldGroupsRequest.Builder setParent(String value) Required. The parent, which owns this collection of YieldGroups.
Format: networks/{network_code}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe parent to set. |
| Returns | |
|---|---|
| Type | Description |
ListYieldGroupsRequest.Builder |
This builder for chaining. |
setParentBytes(ByteString value)
public ListYieldGroupsRequest.Builder setParentBytes(ByteString value) Required. The parent, which owns this collection of YieldGroups.
Format: networks/{network_code}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for parent to set. |
| Returns | |
|---|---|
| Type | Description |
ListYieldGroupsRequest.Builder |
This builder for chaining. |
setSkip(int value)
public ListYieldGroupsRequest.Builder setSkip(int value)Optional. Number of individual resources to skip while paginating.
int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe skip to set. |
| Returns | |
|---|---|
| Type | Description |
ListYieldGroupsRequest.Builder |
This builder for chaining. |