public final class ReportDefinition extends GeneratedMessageV3 implements ReportDefinitionOrBuilderThe definition of how a report should be run.
Protobuf type google.ads.admanager.v1.ReportDefinition
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ReportDefinitionImplements
ReportDefinitionOrBuilderStatic Fields
COMPARISON_DATE_RANGE_FIELD_NUMBER
public static final int COMPARISON_DATE_RANGE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
CREATIVE_CUSTOM_FIELD_IDS_FIELD_NUMBER
public static final int CREATIVE_CUSTOM_FIELD_IDS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
CURRENCY_CODE_FIELD_NUMBER
public static final int CURRENCY_CODE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
CUSTOM_DIMENSION_KEY_IDS_FIELD_NUMBER
public static final int CUSTOM_DIMENSION_KEY_IDS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
DATE_RANGE_FIELD_NUMBER
public static final int DATE_RANGE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
DIMENSIONS_FIELD_NUMBER
public static final int DIMENSIONS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
FILTERS_FIELD_NUMBER
public static final int FILTERS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
FLAGS_FIELD_NUMBER
public static final int FLAGS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
LINE_ITEM_CUSTOM_FIELD_IDS_FIELD_NUMBER
public static final int LINE_ITEM_CUSTOM_FIELD_IDS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
METRICS_FIELD_NUMBER
public static final int METRICS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
ORDER_CUSTOM_FIELD_IDS_FIELD_NUMBER
public static final int ORDER_CUSTOM_FIELD_IDS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
REPORT_TYPE_FIELD_NUMBER
public static final int REPORT_TYPE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
SORTS_FIELD_NUMBER
public static final int SORTS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
TIME_PERIOD_COLUMN_FIELD_NUMBER
public static final int TIME_PERIOD_COLUMN_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
TIME_ZONE_FIELD_NUMBER
public static final int TIME_ZONE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
TIME_ZONE_SOURCE_FIELD_NUMBER
public static final int TIME_ZONE_SOURCE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
Static Methods
getDefaultInstance()
public static ReportDefinition getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
ReportDefinition |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static ReportDefinition.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
ReportDefinition.Builder |
|
newBuilder(ReportDefinition prototype)
public static ReportDefinition.Builder newBuilder(ReportDefinition prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
ReportDefinition |
| Returns | |
|---|---|
| Type | Description |
ReportDefinition.Builder |
|
parseDelimitedFrom(InputStream input)
public static ReportDefinition parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
ReportDefinition |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ReportDefinition parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ReportDefinition |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static ReportDefinition parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
ReportDefinition |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ReportDefinition parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ReportDefinition |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static ReportDefinition parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
ReportDefinition |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ReportDefinition parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ReportDefinition |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static ReportDefinition parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
ReportDefinition |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ReportDefinition parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ReportDefinition |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static ReportDefinition parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
ReportDefinition |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ReportDefinition parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ReportDefinition |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static ReportDefinition parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
ReportDefinition |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ReportDefinition parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ReportDefinition |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<ReportDefinition> parser()| Returns | |
|---|---|
| Type | Description |
Parser<ReportDefinition> |
|
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getComparisonDateRange()
public Report.DateRange getComparisonDateRange()Optional. The comparison date range of this report. If unspecified, the report will not have any comparison metrics.
optional .google.ads.admanager.v1.Report.DateRange comparison_date_range = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Report.DateRange |
The comparisonDateRange. |
getComparisonDateRangeOrBuilder()
public Report.DateRangeOrBuilder getComparisonDateRangeOrBuilder()Optional. The comparison date range of this report. If unspecified, the report will not have any comparison metrics.
optional .google.ads.admanager.v1.Report.DateRange comparison_date_range = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Report.DateRangeOrBuilder |
|
getCreativeCustomFieldIds(int index)
public long getCreativeCustomFieldIds(int index)Optional. Custom field IDs that represent CREATIVE_CUSTOM_FIELD_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, creative_custom_field_ids[0] describes CREATIVE_CUSTOM_FIELD_0_OPTION_ID and CREATIVE_CUSTOM_FIELD_0_VALUE.
repeated int64 creative_custom_field_ids = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
long |
The creativeCustomFieldIds at the given index. |
getCreativeCustomFieldIdsCount()
public int getCreativeCustomFieldIdsCount()Optional. Custom field IDs that represent CREATIVE_CUSTOM_FIELD_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, creative_custom_field_ids[0] describes CREATIVE_CUSTOM_FIELD_0_OPTION_ID and CREATIVE_CUSTOM_FIELD_0_VALUE.
repeated int64 creative_custom_field_ids = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The count of creativeCustomFieldIds. |
getCreativeCustomFieldIdsList()
public List<Long> getCreativeCustomFieldIdsList()Optional. Custom field IDs that represent CREATIVE_CUSTOM_FIELD_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, creative_custom_field_ids[0] describes CREATIVE_CUSTOM_FIELD_0_OPTION_ID and CREATIVE_CUSTOM_FIELD_0_VALUE.
repeated int64 creative_custom_field_ids = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<Long> |
A list containing the creativeCustomFieldIds. |
getCurrencyCode()
public String getCurrencyCode()Optional. The ISO 4217 currency code for this report. Defaults to publisher currency code if not specified.
string currency_code = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The currencyCode. |
getCurrencyCodeBytes()
public ByteString getCurrencyCodeBytes()Optional. The ISO 4217 currency code for this report. Defaults to publisher currency code if not specified.
string currency_code = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for currencyCode. |
getCustomDimensionKeyIds(int index)
public long getCustomDimensionKeyIds(int index)Optional. Custom Dimension keys that represent CUSTOM_DIMENSION_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, custom_dimension_key_ids[0] describes CUSTOM_DIMENSION_0_VALUE_ID and CUSTOM_DIMENSION_0_VALUE.
repeated int64 custom_dimension_key_ids = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
long |
The customDimensionKeyIds at the given index. |
getCustomDimensionKeyIdsCount()
public int getCustomDimensionKeyIdsCount()Optional. Custom Dimension keys that represent CUSTOM_DIMENSION_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, custom_dimension_key_ids[0] describes CUSTOM_DIMENSION_0_VALUE_ID and CUSTOM_DIMENSION_0_VALUE.
repeated int64 custom_dimension_key_ids = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The count of customDimensionKeyIds. |
getCustomDimensionKeyIdsList()
public List<Long> getCustomDimensionKeyIdsList()Optional. Custom Dimension keys that represent CUSTOM_DIMENSION_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, custom_dimension_key_ids[0] describes CUSTOM_DIMENSION_0_VALUE_ID and CUSTOM_DIMENSION_0_VALUE.
repeated int64 custom_dimension_key_ids = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<Long> |
A list containing the customDimensionKeyIds. |
getDateRange()
public Report.DateRange getDateRange()Required. The primary date range of this report.
.google.ads.admanager.v1.Report.DateRange date_range = 6 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Report.DateRange |
The dateRange. |
getDateRangeOrBuilder()
public Report.DateRangeOrBuilder getDateRangeOrBuilder()Required. The primary date range of this report.
.google.ads.admanager.v1.Report.DateRange date_range = 6 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Report.DateRangeOrBuilder |
|
getDefaultInstanceForType()
public ReportDefinition getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ReportDefinition |
|
getDimensions(int index)
public Report.Dimension getDimensions(int index)Required. The list of dimensions to report on. If empty, the report will have no dimensions, and any metrics will be totals.
repeated .google.ads.admanager.v1.Report.Dimension dimensions = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
Report.Dimension |
The dimensions at the given index. |
getDimensionsCount()
public int getDimensionsCount()Required. The list of dimensions to report on. If empty, the report will have no dimensions, and any metrics will be totals.
repeated .google.ads.admanager.v1.Report.Dimension dimensions = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
int |
The count of dimensions. |
getDimensionsList()
public List<Report.Dimension> getDimensionsList()Required. The list of dimensions to report on. If empty, the report will have no dimensions, and any metrics will be totals.
repeated .google.ads.admanager.v1.Report.Dimension dimensions = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
List<Dimension> |
A list containing the dimensions. |
getDimensionsValue(int index)
public int getDimensionsValue(int index)Required. The list of dimensions to report on. If empty, the report will have no dimensions, and any metrics will be totals.
repeated .google.ads.admanager.v1.Report.Dimension dimensions = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire of dimensions at the given index. |
getDimensionsValueList()
public List<Integer> getDimensionsValueList()Required. The list of dimensions to report on. If empty, the report will have no dimensions, and any metrics will be totals.
repeated .google.ads.admanager.v1.Report.Dimension dimensions = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
List<Integer> |
A list containing the enum numeric values on the wire for dimensions. |
getFilters(int index)
public Report.Filter getFilters(int index)Optional. The filters for this report.
repeated .google.ads.admanager.v1.Report.Filter filters = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Report.Filter |
|
getFiltersCount()
public int getFiltersCount()Optional. The filters for this report.
repeated .google.ads.admanager.v1.Report.Filter filters = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getFiltersList()
public List<Report.Filter> getFiltersList()Optional. The filters for this report.
repeated .google.ads.admanager.v1.Report.Filter filters = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<Filter> |
|
getFiltersOrBuilder(int index)
public Report.FilterOrBuilder getFiltersOrBuilder(int index)Optional. The filters for this report.
repeated .google.ads.admanager.v1.Report.Filter filters = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Report.FilterOrBuilder |
|
getFiltersOrBuilderList()
public List<? extends Report.FilterOrBuilder> getFiltersOrBuilderList()Optional. The filters for this report.
repeated .google.ads.admanager.v1.Report.Filter filters = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.ads.admanager.v1.Report.FilterOrBuilder> |
|
getFlags(int index)
public Report.Flag getFlags(int index)Optional. List of flags for this report. Used to flag rows in a result set based on a set of defined filters.
repeated .google.ads.admanager.v1.Report.Flag flags = 14 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Report.Flag |
|
getFlagsCount()
public int getFlagsCount()Optional. List of flags for this report. Used to flag rows in a result set based on a set of defined filters.
repeated .google.ads.admanager.v1.Report.Flag flags = 14 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getFlagsList()
public List<Report.Flag> getFlagsList()Optional. List of flags for this report. Used to flag rows in a result set based on a set of defined filters.
repeated .google.ads.admanager.v1.Report.Flag flags = 14 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<Flag> |
|
getFlagsOrBuilder(int index)
public Report.FlagOrBuilder getFlagsOrBuilder(int index)Optional. List of flags for this report. Used to flag rows in a result set based on a set of defined filters.
repeated .google.ads.admanager.v1.Report.Flag flags = 14 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Report.FlagOrBuilder |
|
getFlagsOrBuilderList()
public List<? extends Report.FlagOrBuilder> getFlagsOrBuilderList()Optional. List of flags for this report. Used to flag rows in a result set based on a set of defined filters.
repeated .google.ads.admanager.v1.Report.Flag flags = 14 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.ads.admanager.v1.Report.FlagOrBuilder> |
|
getLineItemCustomFieldIds(int index)
public long getLineItemCustomFieldIds(int index)Optional. Custom field IDs that represent LINE_ITEM_CUSTOM_FIELD_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, line_item_custom_field_ids[0] describes LINE_ITEM_CUSTOM_FIELD_0_OPTION_ID and LINE_ITEM_CUSTOM_FIELD_0_VALUE.
repeated int64 line_item_custom_field_ids = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
long |
The lineItemCustomFieldIds at the given index. |
getLineItemCustomFieldIdsCount()
public int getLineItemCustomFieldIdsCount()Optional. Custom field IDs that represent LINE_ITEM_CUSTOM_FIELD_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, line_item_custom_field_ids[0] describes LINE_ITEM_CUSTOM_FIELD_0_OPTION_ID and LINE_ITEM_CUSTOM_FIELD_0_VALUE.
repeated int64 line_item_custom_field_ids = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The count of lineItemCustomFieldIds. |
getLineItemCustomFieldIdsList()
public List<Long> getLineItemCustomFieldIdsList()Optional. Custom field IDs that represent LINE_ITEM_CUSTOM_FIELD_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, line_item_custom_field_ids[0] describes LINE_ITEM_CUSTOM_FIELD_0_OPTION_ID and LINE_ITEM_CUSTOM_FIELD_0_VALUE.
repeated int64 line_item_custom_field_ids = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<Long> |
A list containing the lineItemCustomFieldIds. |
getMetrics(int index)
public Report.Metric getMetrics(int index)Required. The list of metrics to report on. If empty, the report will have no metrics.
repeated .google.ads.admanager.v1.Report.Metric metrics = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
Report.Metric |
The metrics at the given index. |
getMetricsCount()
public int getMetricsCount()Required. The list of metrics to report on. If empty, the report will have no metrics.
repeated .google.ads.admanager.v1.Report.Metric metrics = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
int |
The count of metrics. |
getMetricsList()
public List<Report.Metric> getMetricsList()Required. The list of metrics to report on. If empty, the report will have no metrics.
repeated .google.ads.admanager.v1.Report.Metric metrics = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
List<Metric> |
A list containing the metrics. |
getMetricsValue(int index)
public int getMetricsValue(int index)Required. The list of metrics to report on. If empty, the report will have no metrics.
repeated .google.ads.admanager.v1.Report.Metric metrics = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire of metrics at the given index. |
getMetricsValueList()
public List<Integer> getMetricsValueList()Required. The list of metrics to report on. If empty, the report will have no metrics.
repeated .google.ads.admanager.v1.Report.Metric metrics = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
List<Integer> |
A list containing the enum numeric values on the wire for metrics. |
getOrderCustomFieldIds(int index)
public long getOrderCustomFieldIds(int index)Optional. Custom field IDs that represent ORDER_CUSTOM_FIELD_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, order_custom_field_ids[0] describes ORDER_CUSTOM_FIELD_0_OPTION_ID and ORDER_CUSTOM_FIELD_0_VALUE.
repeated int64 order_custom_field_ids = 12 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
long |
The orderCustomFieldIds at the given index. |
getOrderCustomFieldIdsCount()
public int getOrderCustomFieldIdsCount()Optional. Custom field IDs that represent ORDER_CUSTOM_FIELD_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, order_custom_field_ids[0] describes ORDER_CUSTOM_FIELD_0_OPTION_ID and ORDER_CUSTOM_FIELD_0_VALUE.
repeated int64 order_custom_field_ids = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The count of orderCustomFieldIds. |
getOrderCustomFieldIdsList()
public List<Long> getOrderCustomFieldIdsList()Optional. Custom field IDs that represent ORDER_CUSTOM_FIELD_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, order_custom_field_ids[0] describes ORDER_CUSTOM_FIELD_0_OPTION_ID and ORDER_CUSTOM_FIELD_0_VALUE.
repeated int64 order_custom_field_ids = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<Long> |
A list containing the orderCustomFieldIds. |
getParserForType()
public Parser<ReportDefinition> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<ReportDefinition> |
|
getReportType()
public Report.ReportType getReportType()Required. The type of this report.
.google.ads.admanager.v1.Report.ReportType report_type = 8 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Report.ReportType |
The reportType. |
getReportTypeValue()
public int getReportTypeValue()Required. The type of this report.
.google.ads.admanager.v1.Report.ReportType report_type = 8 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for reportType. |
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
getSorts(int index)
public Report.Sort getSorts(int index)Optional. Default sorts to apply to this report.
repeated .google.ads.admanager.v1.Report.Sort sorts = 15 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Report.Sort |
|
getSortsCount()
public int getSortsCount()Optional. Default sorts to apply to this report.
repeated .google.ads.admanager.v1.Report.Sort sorts = 15 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getSortsList()
public List<Report.Sort> getSortsList()Optional. Default sorts to apply to this report.
repeated .google.ads.admanager.v1.Report.Sort sorts = 15 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<Sort> |
|
getSortsOrBuilder(int index)
public Report.SortOrBuilder getSortsOrBuilder(int index)Optional. Default sorts to apply to this report.
repeated .google.ads.admanager.v1.Report.Sort sorts = 15 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Report.SortOrBuilder |
|
getSortsOrBuilderList()
public List<? extends Report.SortOrBuilder> getSortsOrBuilderList()Optional. Default sorts to apply to this report.
repeated .google.ads.admanager.v1.Report.Sort sorts = 15 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.ads.admanager.v1.Report.SortOrBuilder> |
|
getTimePeriodColumn()
public Report.TimePeriodColumn getTimePeriodColumn()Optional. Include a time period column to introduce comparison columns in the report for each generated period. For example, set to "QUARTERS" here to have a column for each quarter present in the primary date range. If "PREVIOUS PERIOD" is specified in comparison_date_range, then each quarter column will also include comparison values for its relative previous quarter.
.google.ads.admanager.v1.Report.TimePeriodColumn time_period_column = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Report.TimePeriodColumn |
The timePeriodColumn. |
getTimePeriodColumnValue()
public int getTimePeriodColumnValue()Optional. Include a time period column to introduce comparison columns in the report for each generated period. For example, set to "QUARTERS" here to have a column for each quarter present in the primary date range. If "PREVIOUS PERIOD" is specified in comparison_date_range, then each quarter column will also include comparison values for its relative previous quarter.
.google.ads.admanager.v1.Report.TimePeriodColumn time_period_column = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for timePeriodColumn. |
getTimeZone()
public String getTimeZone()Optional. If time_zone_source is PROVIDED, this is the time zone to use for this report. Leave empty for any other time zone source. Time zone in IANA format (e.g. "America/New_York").
string time_zone = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The timeZone. |
getTimeZoneBytes()
public ByteString getTimeZoneBytes()Optional. If time_zone_source is PROVIDED, this is the time zone to use for this report. Leave empty for any other time zone source. Time zone in IANA format (e.g. "America/New_York").
string time_zone = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for timeZone. |
getTimeZoneSource()
public Report.TimeZoneSource getTimeZoneSource()Optional. Where to get the time zone for this report. Defaults to using the network time zone setting (PUBLISHER). If source is PROVIDED, the time_zone field in the report definition must also be provided with the desired time zone.
.google.ads.admanager.v1.Report.TimeZoneSource time_zone_source = 20 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Report.TimeZoneSource |
The timeZoneSource. |
getTimeZoneSourceValue()
public int getTimeZoneSourceValue()Optional. Where to get the time zone for this report. Defaults to using the network time zone setting (PUBLISHER). If source is PROVIDED, the time_zone field in the report definition must also be provided with the desired time zone.
.google.ads.admanager.v1.Report.TimeZoneSource time_zone_source = 20 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for timeZoneSource. |
hasComparisonDateRange()
public boolean hasComparisonDateRange()Optional. The comparison date range of this report. If unspecified, the report will not have any comparison metrics.
optional .google.ads.admanager.v1.Report.DateRange comparison_date_range = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the comparisonDateRange field is set. |
hasDateRange()
public boolean hasDateRange()Required. The primary date range of this report.
.google.ads.admanager.v1.Report.DateRange date_range = 6 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the dateRange field is set. |
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
public ReportDefinition.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
ReportDefinition.Builder |
|
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ReportDefinition.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
ReportDefinition.Builder |
|
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Parameter | |
|---|---|
| Name | Description |
unused |
UnusedPrivateParameter |
| Returns | |
|---|---|
| Type | Description |
Object |
|
toBuilder()
public ReportDefinition.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
ReportDefinition.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|