Class RetrievePartnerMatchReportRequest (0.24.0)

public final class RetrievePartnerMatchReportRequest extends GeneratedMessage implements RetrievePartnerMatchReportRequestOrBuilder

Request message for DM API ReportingService.RetrievePartnerMatchReport

Protobuf type google.ads.datamanager.v1.RetrievePartnerMatchReportRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > RetrievePartnerMatchReportRequest

Static Fields

CURRENCY_CODE_FIELD_NUMBER

public static final int CURRENCY_CODE_FIELD_NUMBER
Field Value
Type Description
int

END_DATE_FIELD_NUMBER

public static final int END_DATE_FIELD_NUMBER
Field Value
Type Description
int

FILTER_FIELD_NUMBER

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

START_DATE_FIELD_NUMBER

public static final int START_DATE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RetrievePartnerMatchReportRequest getDefaultInstance()
Returns
Type Description
RetrievePartnerMatchReportRequest

getDescriptor()

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

newBuilder()

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

newBuilder(RetrievePartnerMatchReportRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getCurrencyCode()

public String getCurrencyCode()

Optional. The currency to return the costs/fees in. If unspecified, defaults to the Data Partner's currency

string currency_code = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The currencyCode.

getCurrencyCodeBytes()

public ByteString getCurrencyCodeBytes()

Optional. The currency to return the costs/fees in. If unspecified, defaults to the Data Partner's currency

string currency_code = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for currencyCode.

getDefaultInstanceForType()

public RetrievePartnerMatchReportRequest getDefaultInstanceForType()
Returns
Type Description
RetrievePartnerMatchReportRequest

getEndDate()

public long getEndDate()

Optional. The end date (inclusive) of the report data to retrieve. Defaults to the current date if not populated. Should be in the format YYYYMMDD.

int64 end_date = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The endDate.

getFilter()

public String getFilter()

Optional. A filter string to apply to the list request. All fields need to be on the left hand side of each condition (for example: user_list_id = 123). Fields must be specified using either all camel case or all snake case. Don't use a combination of camel case and snake case.

Supported Operations:

  • AND
  • =
  • !=
  • >
  • >=
  • <
  • <=

    Supported Functions:

  • IN(field, value1, value2, ...): returns true if the field matches any of the values. Example: IN(user_list_id, 123, 456)

    Supported Fields:

  • advertiser_account.account_type

  • advertiser_account.account_id
  • campaign.campaign_id
  • ad_group.ad_group_id
  • user_list.user_list_id

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

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Optional. A filter string to apply to the list request. All fields need to be on the left hand side of each condition (for example: user_list_id = 123). Fields must be specified using either all camel case or all snake case. Don't use a combination of camel case and snake case.

Supported Operations:

  • AND
  • =
  • !=
  • >
  • >=
  • <
  • <=

    Supported Functions:

  • IN(field, value1, value2, ...): returns true if the field matches any of the values. Example: IN(user_list_id, 123, 456)

    Supported Fields:

  • advertiser_account.account_type

  • advertiser_account.account_id
  • campaign.campaign_id
  • ad_group.ad_group_id
  • user_list.user_list_id

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

Returns
Type Description
ByteString

The bytes for filter.

getPageSize()

public int getPageSize()

Optional. The maximum number of partner match report entries to return per page. The service may return fewer than this value. If unspecified, at most 50 reports will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

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

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. A page token, received from a previous RetrievePartnerMatchReport call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to RetrievePartnerMatchReport must match the call that provided the page token.

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

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. A page token, received from a previous RetrievePartnerMatchReport call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to RetrievePartnerMatchReport must match the call that provided the page token.

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

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The parent account that owns the user list. Format: accountTypes/{account_type}/accounts/{account}

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The parent account that owns the user list. Format: accountTypes/{account_type}/accounts/{account}

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStartDate()

public long getStartDate()

Required. The start date (inclusive) of the report data to retrieve. Only data from the last 2 years can be retrieved. If the start date is set to an older date, only data from the last 2 years will be returned. Should be in the format YYYYMMDD.

int64 start_date = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
long

The startDate.

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 RetrievePartnerMatchReportRequest.Builder newBuilderForType()
Returns
Type Description
RetrievePartnerMatchReportRequest.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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