Package com.google.ads.googleads.v18.common

Class HistoricalMetricsOptions

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.ads.googleads.v18.common.HistoricalMetricsOptions
All Implemented Interfaces:
HistoricalMetricsOptionsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class HistoricalMetricsOptions extends com.google.protobuf.GeneratedMessageV3 implements HistoricalMetricsOptionsOrBuilder
 Historical metrics options.
Protobuf type google.ads.googleads.v18.common.HistoricalMetricsOptions
See Also:

  • Field Details

    • YEAR_MONTH_RANGE_FIELD_NUMBER

      public static final int YEAR_MONTH_RANGE_FIELD_NUMBER
      See Also:

    • INCLUDE_AVERAGE_CPC_FIELD_NUMBER

      public static final int INCLUDE_AVERAGE_CPC_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • hasYearMonthRange

      public boolean hasYearMonthRange()
       The year month range for historical metrics. If not specified, metrics
 for the past 12 months are returned.
 Search metrics are available for the past 4 years. If the search volume is
 not available for the entire year_month_range provided, the subset of the
 year month range for which search volume is available are returned.
      optional .google.ads.googleads.v18.common.YearMonthRange year_month_range = 1;
      Specified by:
      hasYearMonthRange in interface HistoricalMetricsOptionsOrBuilder
      Returns:
      Whether the yearMonthRange field is set.

    • getYearMonthRange

      public YearMonthRange getYearMonthRange()
       The year month range for historical metrics. If not specified, metrics
 for the past 12 months are returned.
 Search metrics are available for the past 4 years. If the search volume is
 not available for the entire year_month_range provided, the subset of the
 year month range for which search volume is available are returned.
      optional .google.ads.googleads.v18.common.YearMonthRange year_month_range = 1;
      Specified by:
      getYearMonthRange in interface HistoricalMetricsOptionsOrBuilder
      Returns:
      The yearMonthRange.

    • getYearMonthRangeOrBuilder

      public YearMonthRangeOrBuilder getYearMonthRangeOrBuilder()
       The year month range for historical metrics. If not specified, metrics
 for the past 12 months are returned.
 Search metrics are available for the past 4 years. If the search volume is
 not available for the entire year_month_range provided, the subset of the
 year month range for which search volume is available are returned.
      optional .google.ads.googleads.v18.common.YearMonthRange year_month_range = 1;
      Specified by:
      getYearMonthRangeOrBuilder in interface HistoricalMetricsOptionsOrBuilder

    • getIncludeAverageCpc

      public boolean getIncludeAverageCpc()
       Indicates whether to include average cost per click value.
 Average CPC is provided only for legacy support.
      bool include_average_cpc = 2;
      Specified by:
      getIncludeAverageCpc in interface HistoricalMetricsOptionsOrBuilder
      Returns:
      The includeAverageCpc.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static HistoricalMetricsOptions parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static HistoricalMetricsOptions parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static HistoricalMetricsOptions parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static HistoricalMetricsOptions parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static HistoricalMetricsOptions parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static HistoricalMetricsOptions parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static HistoricalMetricsOptions parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static HistoricalMetricsOptions parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static HistoricalMetricsOptions parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static HistoricalMetricsOptions parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static HistoricalMetricsOptions parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static HistoricalMetricsOptions parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public HistoricalMetricsOptions.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static HistoricalMetricsOptions.Builder newBuilder()

    • newBuilder

      public static HistoricalMetricsOptions.Builder newBuilder(HistoricalMetricsOptions prototype)

    • toBuilder

      public HistoricalMetricsOptions.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected HistoricalMetricsOptions.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static HistoricalMetricsOptions getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<HistoricalMetricsOptions> parser()

    • getParserForType

      public com.google.protobuf.Parser<HistoricalMetricsOptions> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

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