public final class RetrievePartnerMatchReportRequest extends GeneratedMessage implements RetrievePartnerMatchReportRequestOrBuilder
Request message for DM API ReportingService.RetrievePartnerMatchReport
Protobuf type google.ads.datamanager.v1.RetrievePartnerMatchReportRequest
Inherited Members
com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)
com.google.protobuf.GeneratedMessage.canUseUnsafe()
com.google.protobuf.GeneratedMessage.emptyBooleanList()
com.google.protobuf.GeneratedMessage.emptyDoubleList()
com.google.protobuf.GeneratedMessage.emptyFloatList()
com.google.protobuf.GeneratedMessage.emptyIntList()
com.google.protobuf.GeneratedMessage.emptyLongList()
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)
com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)
com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)
com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)
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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static RetrievePartnerMatchReportRequest.Builder newBuilder()
newBuilder(RetrievePartnerMatchReportRequest prototype)
public static RetrievePartnerMatchReportRequest.Builder newBuilder(RetrievePartnerMatchReportRequest prototype)
public static RetrievePartnerMatchReportRequest parseDelimitedFrom(InputStream input)
public static RetrievePartnerMatchReportRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static RetrievePartnerMatchReportRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static RetrievePartnerMatchReportRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static RetrievePartnerMatchReportRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RetrievePartnerMatchReportRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RetrievePartnerMatchReportRequest parseFrom(CodedInputStream input)
public static RetrievePartnerMatchReportRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static RetrievePartnerMatchReportRequest parseFrom(InputStream input)
public static RetrievePartnerMatchReportRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static RetrievePartnerMatchReportRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static RetrievePartnerMatchReportRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<RetrievePartnerMatchReportRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
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()
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()
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()
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()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public RetrievePartnerMatchReportRequest.Builder newBuilderForType()
newBuilderForType(AbstractMessage.BuilderParent parent)
protected RetrievePartnerMatchReportRequest.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
toBuilder()
public RetrievePartnerMatchReportRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides