public static final class RetrievePartnerMatchReportRequest.Builder extends GeneratedMessage.Builder<RetrievePartnerMatchReportRequest.Builder> implements RetrievePartnerMatchReportRequestOrBuilderRequest message for DM API ReportingService.RetrievePartnerMatchReport
Protobuf type google.ads.datamanager.v1.RetrievePartnerMatchReportRequest
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > RetrievePartnerMatchReportRequest.BuilderImplements
RetrievePartnerMatchReportRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
build()
public RetrievePartnerMatchReportRequest build()| Returns | |
|---|---|
| Type | Description |
RetrievePartnerMatchReportRequest |
|
buildPartial()
public RetrievePartnerMatchReportRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
RetrievePartnerMatchReportRequest |
|
clear()
public RetrievePartnerMatchReportRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
RetrievePartnerMatchReportRequest.Builder |
|
clearCurrencyCode()
public RetrievePartnerMatchReportRequest.Builder clearCurrencyCode()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 |
RetrievePartnerMatchReportRequest.Builder |
This builder for chaining. |
clearEndDate()
public RetrievePartnerMatchReportRequest.Builder clearEndDate()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 |
RetrievePartnerMatchReportRequest.Builder |
This builder for chaining. |
clearFilter()
public RetrievePartnerMatchReportRequest.Builder clearFilter() 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_typeadvertiser_account.account_idcampaign.campaign_idad_group.ad_group_iduser_list.user_list_id
string filter = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
RetrievePartnerMatchReportRequest.Builder |
This builder for chaining. |
clearPageSize()
public RetrievePartnerMatchReportRequest.Builder clearPageSize()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 |
RetrievePartnerMatchReportRequest.Builder |
This builder for chaining. |
clearPageToken()
public RetrievePartnerMatchReportRequest.Builder clearPageToken() 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 |
RetrievePartnerMatchReportRequest.Builder |
This builder for chaining. |
clearParent()
public RetrievePartnerMatchReportRequest.Builder clearParent() 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 |
RetrievePartnerMatchReportRequest.Builder |
This builder for chaining. |
clearStartDate()
public RetrievePartnerMatchReportRequest.Builder clearStartDate()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 |
RetrievePartnerMatchReportRequest.Builder |
This builder for chaining. |
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 |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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_typeadvertiser_account.account_idcampaign.campaign_idad_group.ad_group_iduser_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_typeadvertiser_account.account_idcampaign.campaign_idad_group.ad_group_iduser_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. |
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. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(RetrievePartnerMatchReportRequest other)
public RetrievePartnerMatchReportRequest.Builder mergeFrom(RetrievePartnerMatchReportRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
RetrievePartnerMatchReportRequest |
| Returns | |
|---|---|
| Type | Description |
RetrievePartnerMatchReportRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public RetrievePartnerMatchReportRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
RetrievePartnerMatchReportRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public RetrievePartnerMatchReportRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
RetrievePartnerMatchReportRequest.Builder |
|
setCurrencyCode(String value)
public RetrievePartnerMatchReportRequest.Builder setCurrencyCode(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe currencyCode to set. |
| Returns | |
|---|---|
| Type | Description |
RetrievePartnerMatchReportRequest.Builder |
This builder for chaining. |
setCurrencyCodeBytes(ByteString value)
public RetrievePartnerMatchReportRequest.Builder setCurrencyCodeBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for currencyCode to set. |
| Returns | |
|---|---|
| Type | Description |
RetrievePartnerMatchReportRequest.Builder |
This builder for chaining. |
setEndDate(long value)
public RetrievePartnerMatchReportRequest.Builder setEndDate(long value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
longThe endDate to set. |
| Returns | |
|---|---|
| Type | Description |
RetrievePartnerMatchReportRequest.Builder |
This builder for chaining. |
setFilter(String value)
public RetrievePartnerMatchReportRequest.Builder setFilter(String value) 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_typeadvertiser_account.account_idcampaign.campaign_idad_group.ad_group_iduser_list.user_list_id
string filter = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe filter to set. |
| Returns | |
|---|---|
| Type | Description |
RetrievePartnerMatchReportRequest.Builder |
This builder for chaining. |
setFilterBytes(ByteString value)
public RetrievePartnerMatchReportRequest.Builder setFilterBytes(ByteString value) 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_typeadvertiser_account.account_idcampaign.campaign_idad_group.ad_group_iduser_list.user_list_id
string filter = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for filter to set. |
| Returns | |
|---|---|
| Type | Description |
RetrievePartnerMatchReportRequest.Builder |
This builder for chaining. |
setPageSize(int value)
public RetrievePartnerMatchReportRequest.Builder setPageSize(int value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe pageSize to set. |
| Returns | |
|---|---|
| Type | Description |
RetrievePartnerMatchReportRequest.Builder |
This builder for chaining. |
setPageToken(String value)
public RetrievePartnerMatchReportRequest.Builder setPageToken(String value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
RetrievePartnerMatchReportRequest.Builder |
This builder for chaining. |
setPageTokenBytes(ByteString value)
public RetrievePartnerMatchReportRequest.Builder setPageTokenBytes(ByteString value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
RetrievePartnerMatchReportRequest.Builder |
This builder for chaining. |
setParent(String value)
public RetrievePartnerMatchReportRequest.Builder setParent(String value) Required. The parent account that owns the user list.
Format: accountTypes/{account_type}/accounts/{account}
string parent = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe parent to set. |
| Returns | |
|---|---|
| Type | Description |
RetrievePartnerMatchReportRequest.Builder |
This builder for chaining. |
setParentBytes(ByteString value)
public RetrievePartnerMatchReportRequest.Builder setParentBytes(ByteString value) Required. The parent account that owns the user list.
Format: accountTypes/{account_type}/accounts/{account}
string parent = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for parent to set. |
| Returns | |
|---|---|
| Type | Description |
RetrievePartnerMatchReportRequest.Builder |
This builder for chaining. |
setStartDate(long value)
public RetrievePartnerMatchReportRequest.Builder setStartDate(long value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
longThe startDate to set. |
| Returns | |
|---|---|
| Type | Description |
RetrievePartnerMatchReportRequest.Builder |
This builder for chaining. |