Class KeywordForecastMetrics

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.ads.googleads.v18.services.KeywordForecastMetrics
All Implemented Interfaces:
KeywordForecastMetricsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class KeywordForecastMetrics extends com.google.protobuf.GeneratedMessageV3 implements KeywordForecastMetricsOrBuilder
 The forecast metrics for the planless keyword campaign.
 
Protobuf type google.ads.googleads.v18.services.KeywordForecastMetrics
See Also:
  • Field Details

    • IMPRESSIONS_FIELD_NUMBER

      public static final int IMPRESSIONS_FIELD_NUMBER
      See Also:
    • CLICK_THROUGH_RATE_FIELD_NUMBER

      public static final int CLICK_THROUGH_RATE_FIELD_NUMBER
      See Also:
    • AVERAGE_CPC_MICROS_FIELD_NUMBER

      public static final int AVERAGE_CPC_MICROS_FIELD_NUMBER
      See Also:
    • CLICKS_FIELD_NUMBER

      public static final int CLICKS_FIELD_NUMBER
      See Also:
    • COST_MICROS_FIELD_NUMBER

      public static final int COST_MICROS_FIELD_NUMBER
      See Also:
    • CONVERSIONS_FIELD_NUMBER

      public static final int CONVERSIONS_FIELD_NUMBER
      See Also:
    • CONVERSION_RATE_FIELD_NUMBER

      public static final int CONVERSION_RATE_FIELD_NUMBER
      See Also:
    • AVERAGE_CPA_MICROS_FIELD_NUMBER

      public static final int AVERAGE_CPA_MICROS_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
    • hasImpressions

      public boolean hasImpressions()
       The total number of impressions.
       
      optional double impressions = 1;
      Specified by:
      hasImpressions in interface KeywordForecastMetricsOrBuilder
      Returns:
      Whether the impressions field is set.
    • getImpressions

      public double getImpressions()
       The total number of impressions.
       
      optional double impressions = 1;
      Specified by:
      getImpressions in interface KeywordForecastMetricsOrBuilder
      Returns:
      The impressions.
    • hasClickThroughRate

      public boolean hasClickThroughRate()
       The average click through rate. Available only if impressions > 0.
       
      optional double click_through_rate = 2;
      Specified by:
      hasClickThroughRate in interface KeywordForecastMetricsOrBuilder
      Returns:
      Whether the clickThroughRate field is set.
    • getClickThroughRate

      public double getClickThroughRate()
       The average click through rate. Available only if impressions > 0.
       
      optional double click_through_rate = 2;
      Specified by:
      getClickThroughRate in interface KeywordForecastMetricsOrBuilder
      Returns:
      The clickThroughRate.
    • hasAverageCpcMicros

      public boolean hasAverageCpcMicros()
       The average cpc. Available only if clicks > 0.
       
      optional int64 average_cpc_micros = 3;
      Specified by:
      hasAverageCpcMicros in interface KeywordForecastMetricsOrBuilder
      Returns:
      Whether the averageCpcMicros field is set.
    • getAverageCpcMicros

      public long getAverageCpcMicros()
       The average cpc. Available only if clicks > 0.
       
      optional int64 average_cpc_micros = 3;
      Specified by:
      getAverageCpcMicros in interface KeywordForecastMetricsOrBuilder
      Returns:
      The averageCpcMicros.
    • hasClicks

      public boolean hasClicks()
       The total number of clicks.
       
      optional double clicks = 4;
      Specified by:
      hasClicks in interface KeywordForecastMetricsOrBuilder
      Returns:
      Whether the clicks field is set.
    • getClicks

      public double getClicks()
       The total number of clicks.
       
      optional double clicks = 4;
      Specified by:
      getClicks in interface KeywordForecastMetricsOrBuilder
      Returns:
      The clicks.
    • hasCostMicros

      public boolean hasCostMicros()
       The total cost.
       
      optional int64 cost_micros = 5;
      Specified by:
      hasCostMicros in interface KeywordForecastMetricsOrBuilder
      Returns:
      Whether the costMicros field is set.
    • getCostMicros

      public long getCostMicros()
       The total cost.
       
      optional int64 cost_micros = 5;
      Specified by:
      getCostMicros in interface KeywordForecastMetricsOrBuilder
      Returns:
      The costMicros.
    • hasConversions

      public boolean hasConversions()
       Forecasted number of conversions: clicks * conversion_rate.
       
      optional double conversions = 6;
      Specified by:
      hasConversions in interface KeywordForecastMetricsOrBuilder
      Returns:
      Whether the conversions field is set.
    • getConversions

      public double getConversions()
       Forecasted number of conversions: clicks * conversion_rate.
       
      optional double conversions = 6;
      Specified by:
      getConversions in interface KeywordForecastMetricsOrBuilder
      Returns:
      The conversions.
    • hasConversionRate

      public boolean hasConversionRate()
       Forecasted conversion rate.
       
      optional double conversion_rate = 7;
      Specified by:
      hasConversionRate in interface KeywordForecastMetricsOrBuilder
      Returns:
      Whether the conversionRate field is set.
    • getConversionRate

      public double getConversionRate()
       Forecasted conversion rate.
       
      optional double conversion_rate = 7;
      Specified by:
      getConversionRate in interface KeywordForecastMetricsOrBuilder
      Returns:
      The conversionRate.
    • hasAverageCpaMicros

      public boolean hasAverageCpaMicros()
       Average cost per acquisition calculated as cost_micros / conversions.
       
      optional int64 average_cpa_micros = 8;
      Specified by:
      hasAverageCpaMicros in interface KeywordForecastMetricsOrBuilder
      Returns:
      Whether the averageCpaMicros field is set.
    • getAverageCpaMicros

      public long getAverageCpaMicros()
       Average cost per acquisition calculated as cost_micros / conversions.
       
      optional int64 average_cpa_micros = 8;
      Specified by:
      getAverageCpaMicros in interface KeywordForecastMetricsOrBuilder
      Returns:
      The averageCpaMicros.
    • 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 KeywordForecastMetrics parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

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

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

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

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

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

      public static KeywordForecastMetrics parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

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

      public static KeywordForecastMetrics parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

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

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

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

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

      public static KeywordForecastMetrics.Builder newBuilder()
    • newBuilder

      public static KeywordForecastMetrics.Builder newBuilder(KeywordForecastMetrics prototype)
    • toBuilder

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

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

      public static KeywordForecastMetrics getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<KeywordForecastMetrics> parser()
    • getParserForType

      public com.google.protobuf.Parser<KeywordForecastMetrics> 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 KeywordForecastMetrics getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder