Class ListYieldGroupsRequest (0.62.0)

public final class ListYieldGroupsRequest extends GeneratedMessage implements ListYieldGroupsRequestOrBuilder

Request object for ListYieldGroups method.

Protobuf type google.ads.admanager.v1.ListYieldGroupsRequest

Static Fields

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int

ORDER_BY_FIELD_NUMBER

public static final int ORDER_BY_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

SKIP_FIELD_NUMBER

public static final int SKIP_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ListYieldGroupsRequest getDefaultInstance()
Returns
Type Description
ListYieldGroupsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ListYieldGroupsRequest.Builder newBuilder()
Returns
Type Description
ListYieldGroupsRequest.Builder

newBuilder(ListYieldGroupsRequest prototype)

public static ListYieldGroupsRequest.Builder newBuilder(ListYieldGroupsRequest prototype)
Parameter
Name Description
prototype ListYieldGroupsRequest
Returns
Type Description
ListYieldGroupsRequest.Builder

parseDelimitedFrom(InputStream input)

public static ListYieldGroupsRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListYieldGroupsRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListYieldGroupsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListYieldGroupsRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ListYieldGroupsRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ListYieldGroupsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListYieldGroupsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListYieldGroupsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListYieldGroupsRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ListYieldGroupsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListYieldGroupsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListYieldGroupsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListYieldGroupsRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ListYieldGroupsRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListYieldGroupsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListYieldGroupsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ListYieldGroupsRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListYieldGroupsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListYieldGroupsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListYieldGroupsRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ListYieldGroupsRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ListYieldGroupsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListYieldGroupsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListYieldGroupsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ListYieldGroupsRequest> parser()
Returns
Type Description
Parser<ListYieldGroupsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ListYieldGroupsRequest getDefaultInstanceForType()
Returns
Type Description
ListYieldGroupsRequest

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:

  • displayName
  • name
  • status
  • targeting.geoTargeting.targetedGeos
  • targeting.inventoryTargeting.targetedAdUnits.adUnit
  • targeting.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:

  • displayName
  • name
  • status
  • targeting.geoTargeting.targetedGeos
  • targeting.inventoryTargeting.targetedAdUnits.adUnit
  • targeting.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.

getParserForType()

public Parser<ListYieldGroupsRequest> getParserForType()
Returns
Type Description
Parser<ListYieldGroupsRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ListYieldGroupsRequest.Builder newBuilderForType()
Returns
Type Description
ListYieldGroupsRequest.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected ListYieldGroupsRequest.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ListYieldGroupsRequest.Builder
Overrides

toBuilder()

public ListYieldGroupsRequest.Builder toBuilder()
Returns
Type Description
ListYieldGroupsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException