Package com.google.ads.googleads.v10.common

Class KeywordPlanHistoricalMetrics

  • All Implemented Interfaces:
    KeywordPlanHistoricalMetricsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    public final class KeywordPlanHistoricalMetrics
extends com.google.protobuf.GeneratedMessageV3
implements KeywordPlanHistoricalMetricsOrBuilder
     Historical metrics specific to the targeting options selected.
 Targeting options include geographies, network, etc.
 Refer to https://support.google.com/google-ads/answer/3022575 for more
 details.
    Protobuf type google.ads.googleads.v10.common.KeywordPlanHistoricalMetrics
    See Also:
    Serialized Form

    • Field Detail

      • AVG_MONTHLY_SEARCHES_FIELD_NUMBER

        public static final int AVG_MONTHLY_SEARCHES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MONTHLY_SEARCH_VOLUMES_FIELD_NUMBER

        public static final int MONTHLY_SEARCH_VOLUMES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • COMPETITION_FIELD_NUMBER

        public static final int COMPETITION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • COMPETITION_INDEX_FIELD_NUMBER

        public static final int COMPETITION_INDEX_FIELD_NUMBER
        See Also:
        Constant Field Values

      • LOW_TOP_OF_PAGE_BID_MICROS_FIELD_NUMBER

        public static final int LOW_TOP_OF_PAGE_BID_MICROS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • HIGH_TOP_OF_PAGE_BID_MICROS_FIELD_NUMBER

        public static final int HIGH_TOP_OF_PAGE_BID_MICROS_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

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

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields 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

      • hasAvgMonthlySearches

        public boolean hasAvgMonthlySearches()
         Approximate number of monthly searches on this query averaged
 for the past 12 months.
        optional int64 avg_monthly_searches = 7;
        Specified by:
        hasAvgMonthlySearches in interface KeywordPlanHistoricalMetricsOrBuilder
        Returns:
        Whether the avgMonthlySearches field is set.

      • getAvgMonthlySearches

        public long getAvgMonthlySearches()
         Approximate number of monthly searches on this query averaged
 for the past 12 months.
        optional int64 avg_monthly_searches = 7;
        Specified by:
        getAvgMonthlySearches in interface KeywordPlanHistoricalMetricsOrBuilder
        Returns:
        The avgMonthlySearches.

      • getMonthlySearchVolumesCount

        public int getMonthlySearchVolumesCount()
         Approximate number of searches on this query for the past twelve months.
        repeated .google.ads.googleads.v10.common.MonthlySearchVolume monthly_search_volumes = 6;
        Specified by:
        getMonthlySearchVolumesCount in interface KeywordPlanHistoricalMetricsOrBuilder

      • getCompetitionValue

        public int getCompetitionValue()
         The competition level for the query.
        .google.ads.googleads.v10.enums.KeywordPlanCompetitionLevelEnum.KeywordPlanCompetitionLevel competition = 2;
        Specified by:
        getCompetitionValue in interface KeywordPlanHistoricalMetricsOrBuilder
        Returns:
        The enum numeric value on the wire for competition.

      • hasCompetitionIndex

        public boolean hasCompetitionIndex()
         The competition index for the query in the range [0, 100].
 Shows how competitive ad placement is for a keyword.
 The level of competition from 0-100 is determined by the number of ad slots
 filled divided by the total number of ad slots available. If not enough
 data is available, null is returned.
        optional int64 competition_index = 8;
        Specified by:
        hasCompetitionIndex in interface KeywordPlanHistoricalMetricsOrBuilder
        Returns:
        Whether the competitionIndex field is set.

      • getCompetitionIndex

        public long getCompetitionIndex()
         The competition index for the query in the range [0, 100].
 Shows how competitive ad placement is for a keyword.
 The level of competition from 0-100 is determined by the number of ad slots
 filled divided by the total number of ad slots available. If not enough
 data is available, null is returned.
        optional int64 competition_index = 8;
        Specified by:
        getCompetitionIndex in interface KeywordPlanHistoricalMetricsOrBuilder
        Returns:
        The competitionIndex.

      • hasLowTopOfPageBidMicros

        public boolean hasLowTopOfPageBidMicros()
         Top of page bid low range (20th percentile) in micros for the keyword.
        optional int64 low_top_of_page_bid_micros = 9;
        Specified by:
        hasLowTopOfPageBidMicros in interface KeywordPlanHistoricalMetricsOrBuilder
        Returns:
        Whether the lowTopOfPageBidMicros field is set.

      • getLowTopOfPageBidMicros

        public long getLowTopOfPageBidMicros()
         Top of page bid low range (20th percentile) in micros for the keyword.
        optional int64 low_top_of_page_bid_micros = 9;
        Specified by:
        getLowTopOfPageBidMicros in interface KeywordPlanHistoricalMetricsOrBuilder
        Returns:
        The lowTopOfPageBidMicros.

      • hasHighTopOfPageBidMicros

        public boolean hasHighTopOfPageBidMicros()
         Top of page bid high range (80th percentile) in micros for the keyword.
        optional int64 high_top_of_page_bid_micros = 10;
        Specified by:
        hasHighTopOfPageBidMicros in interface KeywordPlanHistoricalMetricsOrBuilder
        Returns:
        Whether the highTopOfPageBidMicros field is set.

      • getHighTopOfPageBidMicros

        public long getHighTopOfPageBidMicros()
         Top of page bid high range (80th percentile) in micros for the keyword.
        optional int64 high_top_of_page_bid_micros = 10;
        Specified by:
        getHighTopOfPageBidMicros in interface KeywordPlanHistoricalMetricsOrBuilder
        Returns:
        The highTopOfPageBidMicros.

      • 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 java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.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​(java.lang.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 KeywordPlanHistoricalMetrics parseFrom​(java.nio.ByteBuffer data)
                                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static KeywordPlanHistoricalMetrics parseFrom​(java.nio.ByteBuffer data,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static KeywordPlanHistoricalMetrics parseFrom​(java.io.InputStream input)
                                              throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static KeywordPlanHistoricalMetrics parseFrom​(java.io.InputStream input,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static KeywordPlanHistoricalMetrics parseDelimitedFrom​(java.io.InputStream input)
                                                       throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static KeywordPlanHistoricalMetrics parseDelimitedFrom​(java.io.InputStream input,
                                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                       throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static KeywordPlanHistoricalMetrics parseFrom​(com.google.protobuf.CodedInputStream input)
                                              throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static KeywordPlanHistoricalMetrics parseFrom​(com.google.protobuf.CodedInputStream input,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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