public static final class ListPlacementsRequest.Builder extends GeneratedMessageV3.Builder<ListPlacementsRequest.Builder> implements ListPlacementsRequestOrBuilder Request object for ListPlacements method.
Protobuf type google.ads.admanager.v1.ListPlacementsRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListPlacementsRequest.BuilderImplements
ListPlacementsRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ListPlacementsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ListPlacementsRequest.Builder |
|
build()
public ListPlacementsRequest build()| Returns | |
|---|---|
| Type | Description |
ListPlacementsRequest |
|
buildPartial()
public ListPlacementsRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
ListPlacementsRequest |
|
clear()
public ListPlacementsRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
ListPlacementsRequest.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public ListPlacementsRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
ListPlacementsRequest.Builder |
|
clearFilter()
public ListPlacementsRequest.Builder clearFilter()Optional. Expression to filter the response. See syntax details at https://developers.google.com/ad-manager/api/beta/filters
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ListPlacementsRequest.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ListPlacementsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
ListPlacementsRequest.Builder |
|
clearOrderBy()
public ListPlacementsRequest.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 |
ListPlacementsRequest.Builder |
This builder for chaining. |
clearPageSize()
public ListPlacementsRequest.Builder clearPageSize() Optional. The maximum number of Placements to return. The service may
return fewer than this value. If unspecified, at most 50 Placements will
be returned. The maximum value is 1000; values above 1000 will be coerced
to 1000.
int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ListPlacementsRequest.Builder |
This builder for chaining. |
clearPageToken()
public ListPlacementsRequest.Builder clearPageToken() Optional. A page token, received from a previous ListPlacements call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListPlacements must
match the call that provided the page token.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ListPlacementsRequest.Builder |
This builder for chaining. |
clearParent()
public ListPlacementsRequest.Builder clearParent() Required. The parent, which owns this collection of Placements.
Format: networks/{network_code}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ListPlacementsRequest.Builder |
This builder for chaining. |
clearSkip()
public ListPlacementsRequest.Builder clearSkip()Optional. Number of individual resources to skip while paginating.
int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ListPlacementsRequest.Builder |
This builder for chaining. |
clone()
public ListPlacementsRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
ListPlacementsRequest.Builder |
|
getDefaultInstanceForType()
public ListPlacementsRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ListPlacementsRequest |
|
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
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
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 Placements to return. The service may
return fewer than this value. If unspecified, at most 50 Placements will
be returned. The maximum value is 1000; values above 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 ListPlacements call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListPlacements 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 ListPlacements call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListPlacements 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 Placements.
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 Placements.
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 GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(ListPlacementsRequest other)
public ListPlacementsRequest.Builder mergeFrom(ListPlacementsRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
ListPlacementsRequest |
| Returns | |
|---|---|
| Type | Description |
ListPlacementsRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ListPlacementsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ListPlacementsRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ListPlacementsRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ListPlacementsRequest.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListPlacementsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListPlacementsRequest.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public ListPlacementsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ListPlacementsRequest.Builder |
|
setFilter(String value)
public ListPlacementsRequest.Builder setFilter(String value)Optional. Expression to filter the response. See syntax details at https://developers.google.com/ad-manager/api/beta/filters
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe filter to set. |
| Returns | |
|---|---|
| Type | Description |
ListPlacementsRequest.Builder |
This builder for chaining. |
setFilterBytes(ByteString value)
public ListPlacementsRequest.Builder setFilterBytes(ByteString value)Optional. Expression to filter the response. See syntax details at https://developers.google.com/ad-manager/api/beta/filters
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for filter to set. |
| Returns | |
|---|---|
| Type | Description |
ListPlacementsRequest.Builder |
This builder for chaining. |
setOrderBy(String value)
public ListPlacementsRequest.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 |
ListPlacementsRequest.Builder |
This builder for chaining. |
setOrderByBytes(ByteString value)
public ListPlacementsRequest.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 |
ListPlacementsRequest.Builder |
This builder for chaining. |
setPageSize(int value)
public ListPlacementsRequest.Builder setPageSize(int value) Optional. The maximum number of Placements to return. The service may
return fewer than this value. If unspecified, at most 50 Placements will
be returned. The maximum value is 1000; values above 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 |
ListPlacementsRequest.Builder |
This builder for chaining. |
setPageToken(String value)
public ListPlacementsRequest.Builder setPageToken(String value) Optional. A page token, received from a previous ListPlacements call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListPlacements 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 |
ListPlacementsRequest.Builder |
This builder for chaining. |
setPageTokenBytes(ByteString value)
public ListPlacementsRequest.Builder setPageTokenBytes(ByteString value) Optional. A page token, received from a previous ListPlacements call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListPlacements 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 |
ListPlacementsRequest.Builder |
This builder for chaining. |
setParent(String value)
public ListPlacementsRequest.Builder setParent(String value) Required. The parent, which owns this collection of Placements.
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 |
ListPlacementsRequest.Builder |
This builder for chaining. |
setParentBytes(ByteString value)
public ListPlacementsRequest.Builder setParentBytes(ByteString value) Required. The parent, which owns this collection of Placements.
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 |
ListPlacementsRequest.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ListPlacementsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ListPlacementsRequest.Builder |
|
setSkip(int value)
public ListPlacementsRequest.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 |
ListPlacementsRequest.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final ListPlacementsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListPlacementsRequest.Builder |
|