Package com.google.ads.googleads.v25.services

Class CustomerMetrics.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<CustomerMetrics.Builder>
com.google.ads.googleads.v25.services.CustomerMetrics.Builder
All Implemented Interfaces:
CustomerMetricsOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
CustomerMetrics
public static final class CustomerMetrics.Builder extends com.google.protobuf.GeneratedMessage.Builder<CustomerMetrics.Builder> implements CustomerMetricsOrBuilder
 Metrics representing the customer’s Ad performance.
Protobuf type google.ads.googleads.v25.services.CustomerMetrics

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<CustomerMetrics.Builder>

    • clear

      public CustomerMetrics.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<CustomerMetrics.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<CustomerMetrics.Builder>

    • getDefaultInstanceForType

      public CustomerMetrics getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public CustomerMetrics build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public CustomerMetrics buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public CustomerMetrics.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<CustomerMetrics.Builder>

    • mergeFrom

      public CustomerMetrics.Builder mergeFrom(CustomerMetrics other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<CustomerMetrics.Builder>

    • mergeFrom

      public CustomerMetrics.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<CustomerMetrics.Builder>
      Throws:
      IOException

    • hasAverageRateMetrics

      public boolean hasAverageRateMetrics()
       Average rate metrics calculated by dividing one metric by another.
      .google.ads.googleads.v25.services.RateMetrics average_rate_metrics = 1;
      Specified by:
      hasAverageRateMetrics in interface CustomerMetricsOrBuilder
      Returns:
      Whether the averageRateMetrics field is set.

    • getAverageRateMetrics

      public RateMetrics getAverageRateMetrics()
       Average rate metrics calculated by dividing one metric by another.
      .google.ads.googleads.v25.services.RateMetrics average_rate_metrics = 1;
      Specified by:
      getAverageRateMetrics in interface CustomerMetricsOrBuilder
      Returns:
      The averageRateMetrics.

    • setAverageRateMetrics

      public CustomerMetrics.Builder setAverageRateMetrics(RateMetrics value)
       Average rate metrics calculated by dividing one metric by another.
      .google.ads.googleads.v25.services.RateMetrics average_rate_metrics = 1;

    • setAverageRateMetrics

      public CustomerMetrics.Builder setAverageRateMetrics(RateMetrics.Builder builderForValue)
       Average rate metrics calculated by dividing one metric by another.
      .google.ads.googleads.v25.services.RateMetrics average_rate_metrics = 1;

    • mergeAverageRateMetrics

      public CustomerMetrics.Builder mergeAverageRateMetrics(RateMetrics value)
       Average rate metrics calculated by dividing one metric by another.
      .google.ads.googleads.v25.services.RateMetrics average_rate_metrics = 1;

    • clearAverageRateMetrics

      public CustomerMetrics.Builder clearAverageRateMetrics()
       Average rate metrics calculated by dividing one metric by another.
      .google.ads.googleads.v25.services.RateMetrics average_rate_metrics = 1;

    • getAverageRateMetricsBuilder

      public RateMetrics.Builder getAverageRateMetricsBuilder()
       Average rate metrics calculated by dividing one metric by another.
      .google.ads.googleads.v25.services.RateMetrics average_rate_metrics = 1;

    • getAverageRateMetricsOrBuilder

      public RateMetricsOrBuilder getAverageRateMetricsOrBuilder()
       Average rate metrics calculated by dividing one metric by another.
      .google.ads.googleads.v25.services.RateMetrics average_rate_metrics = 1;
      Specified by:
      getAverageRateMetricsOrBuilder in interface CustomerMetricsOrBuilder

    • hasShareMetrics

      public boolean hasShareMetrics()
       Metrics calculated by dividing the metric of the customer by that of the
 selected benchmarks source. These metrics are only returned when:

 1. `all_advertisers` is used as the `benchmarks_source`. Note that the
 request `category_filter` must be set when using `all_advertisers`.
      .google.ads.googleads.v25.services.ShareMetrics share_metrics = 2;
      Specified by:
      hasShareMetrics in interface CustomerMetricsOrBuilder
      Returns:
      Whether the shareMetrics field is set.

    • getShareMetrics

      public ShareMetrics getShareMetrics()
       Metrics calculated by dividing the metric of the customer by that of the
 selected benchmarks source. These metrics are only returned when:

 1. `all_advertisers` is used as the `benchmarks_source`. Note that the
 request `category_filter` must be set when using `all_advertisers`.
      .google.ads.googleads.v25.services.ShareMetrics share_metrics = 2;
      Specified by:
      getShareMetrics in interface CustomerMetricsOrBuilder
      Returns:
      The shareMetrics.

    • setShareMetrics

      public CustomerMetrics.Builder setShareMetrics(ShareMetrics value)
       Metrics calculated by dividing the metric of the customer by that of the
 selected benchmarks source. These metrics are only returned when:

 1. `all_advertisers` is used as the `benchmarks_source`. Note that the
 request `category_filter` must be set when using `all_advertisers`.
      .google.ads.googleads.v25.services.ShareMetrics share_metrics = 2;

    • setShareMetrics

      public CustomerMetrics.Builder setShareMetrics(ShareMetrics.Builder builderForValue)
       Metrics calculated by dividing the metric of the customer by that of the
 selected benchmarks source. These metrics are only returned when:

 1. `all_advertisers` is used as the `benchmarks_source`. Note that the
 request `category_filter` must be set when using `all_advertisers`.
      .google.ads.googleads.v25.services.ShareMetrics share_metrics = 2;

    • mergeShareMetrics

      public CustomerMetrics.Builder mergeShareMetrics(ShareMetrics value)
       Metrics calculated by dividing the metric of the customer by that of the
 selected benchmarks source. These metrics are only returned when:

 1. `all_advertisers` is used as the `benchmarks_source`. Note that the
 request `category_filter` must be set when using `all_advertisers`.
      .google.ads.googleads.v25.services.ShareMetrics share_metrics = 2;

    • clearShareMetrics

      public CustomerMetrics.Builder clearShareMetrics()
       Metrics calculated by dividing the metric of the customer by that of the
 selected benchmarks source. These metrics are only returned when:

 1. `all_advertisers` is used as the `benchmarks_source`. Note that the
 request `category_filter` must be set when using `all_advertisers`.
      .google.ads.googleads.v25.services.ShareMetrics share_metrics = 2;

    • getShareMetricsBuilder

      public ShareMetrics.Builder getShareMetricsBuilder()
       Metrics calculated by dividing the metric of the customer by that of the
 selected benchmarks source. These metrics are only returned when:

 1. `all_advertisers` is used as the `benchmarks_source`. Note that the
 request `category_filter` must be set when using `all_advertisers`.
      .google.ads.googleads.v25.services.ShareMetrics share_metrics = 2;

    • getShareMetricsOrBuilder

      public ShareMetricsOrBuilder getShareMetricsOrBuilder()
       Metrics calculated by dividing the metric of the customer by that of the
 selected benchmarks source. These metrics are only returned when:

 1. `all_advertisers` is used as the `benchmarks_source`. Note that the
 request `category_filter` must be set when using `all_advertisers`.
      .google.ads.googleads.v25.services.ShareMetrics share_metrics = 2;
      Specified by:
      getShareMetricsOrBuilder in interface CustomerMetricsOrBuilder

    • hasAggregateMetrics

      public boolean hasAggregateMetrics()
       Metrics calculated by aggregating values of a single metric for the
 customer.
      .google.ads.googleads.v25.services.AggregateMetrics aggregate_metrics = 3;
      Specified by:
      hasAggregateMetrics in interface CustomerMetricsOrBuilder
      Returns:
      Whether the aggregateMetrics field is set.

    • getAggregateMetrics

      public AggregateMetrics getAggregateMetrics()
       Metrics calculated by aggregating values of a single metric for the
 customer.
      .google.ads.googleads.v25.services.AggregateMetrics aggregate_metrics = 3;
      Specified by:
      getAggregateMetrics in interface CustomerMetricsOrBuilder
      Returns:
      The aggregateMetrics.

    • setAggregateMetrics

      public CustomerMetrics.Builder setAggregateMetrics(AggregateMetrics value)
       Metrics calculated by aggregating values of a single metric for the
 customer.
      .google.ads.googleads.v25.services.AggregateMetrics aggregate_metrics = 3;

    • setAggregateMetrics

      public CustomerMetrics.Builder setAggregateMetrics(AggregateMetrics.Builder builderForValue)
       Metrics calculated by aggregating values of a single metric for the
 customer.
      .google.ads.googleads.v25.services.AggregateMetrics aggregate_metrics = 3;

    • mergeAggregateMetrics

      public CustomerMetrics.Builder mergeAggregateMetrics(AggregateMetrics value)
       Metrics calculated by aggregating values of a single metric for the
 customer.
      .google.ads.googleads.v25.services.AggregateMetrics aggregate_metrics = 3;

    • clearAggregateMetrics

      public CustomerMetrics.Builder clearAggregateMetrics()
       Metrics calculated by aggregating values of a single metric for the
 customer.
      .google.ads.googleads.v25.services.AggregateMetrics aggregate_metrics = 3;

    • getAggregateMetricsBuilder

      public AggregateMetrics.Builder getAggregateMetricsBuilder()
       Metrics calculated by aggregating values of a single metric for the
 customer.
      .google.ads.googleads.v25.services.AggregateMetrics aggregate_metrics = 3;

    • getAggregateMetricsOrBuilder

      public AggregateMetricsOrBuilder getAggregateMetricsOrBuilder()
       Metrics calculated by aggregating values of a single metric for the
 customer.
      .google.ads.googleads.v25.services.AggregateMetrics aggregate_metrics = 3;
      Specified by:
      getAggregateMetricsOrBuilder in interface CustomerMetricsOrBuilder