Package com.google.ads.googleads.v21.resources

Class CampaignSearchTermInsight

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableMessage<com.google.protobuf.GeneratedMessageV3>
com.google.protobuf.GeneratedMessageV3
com.google.ads.googleads.v21.resources.CampaignSearchTermInsight
All Implemented Interfaces:
CampaignSearchTermInsightOrBuilder, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class CampaignSearchTermInsight extends com.google.protobuf.GeneratedMessageV3 implements CampaignSearchTermInsightOrBuilder
 This report provides a high-level view of search demand at the campaign
 level by grouping similar search terms into categories and showing their
 search volume.
 Historical data is available starting March 2023.
Protobuf type google.ads.googleads.v21.resources.CampaignSearchTermInsight
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    CampaignSearchTermInsight.Builder
    This report provides a high-level view of search demand at the campaign level by grouping similar search terms into categories and showing their search volume.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage.ExtendableMessage

    com.google.protobuf.GeneratedMessage.ExtendableMessage.ExtensionSerializer, com.google.protobuf.GeneratedMessage.ExtendableMessage.ExtensionWriter, com.google.protobuf.GeneratedMessage.ExtendableMessage.FieldEntry

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    CAMPAIGN_ID_FIELD_NUMBER
     
    static final int
    CATEGORY_LABEL_FIELD_NUMBER
     
    static final int
    ID_FIELD_NUMBER
     
    static final int
    RESOURCE_NAME_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    long
    getCampaignId()
    Output only.
    String
    getCategoryLabel()
    Output only.
    com.google.protobuf.ByteString
    getCategoryLabelBytes()
    Output only.
    static CampaignSearchTermInsight
    getDefaultInstance()
     
    CampaignSearchTermInsight
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    long
    getId()
    Output only.
    com.google.protobuf.Parser<CampaignSearchTermInsight>
    getParserForType()
     
    String
    getResourceName()
    Output only.
    com.google.protobuf.ByteString
    getResourceNameBytes()
    Output only.
    int
    getSerializedSize()
     
    boolean
    hasCampaignId()
    Output only.
    boolean
    hasCategoryLabel()
    Output only.
    int
    hashCode()
     
    boolean
    hasId()
    Output only.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static CampaignSearchTermInsight.Builder
    newBuilder()
     
    static CampaignSearchTermInsight.Builder
    newBuilder(CampaignSearchTermInsight prototype)
     
    CampaignSearchTermInsight.Builder
    newBuilderForType()
     
    protected CampaignSearchTermInsight.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static CampaignSearchTermInsight
    parseDelimitedFrom(InputStream input)
     
    static CampaignSearchTermInsight
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CampaignSearchTermInsight
    parseFrom(byte[] data)
     
    static CampaignSearchTermInsight
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CampaignSearchTermInsight
    parseFrom(com.google.protobuf.ByteString data)
     
    static CampaignSearchTermInsight
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CampaignSearchTermInsight
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static CampaignSearchTermInsight
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CampaignSearchTermInsight
    parseFrom(InputStream input)
     
    static CampaignSearchTermInsight
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CampaignSearchTermInsight
    parseFrom(ByteBuffer data)
     
    static CampaignSearchTermInsight
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<CampaignSearchTermInsight>
    parser()
     
    CampaignSearchTermInsight.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList

    Methods inherited from class com.google.protobuf.GeneratedMessage.ExtendableMessage

    extensionsAreInitialized, extensionsIterator, extensionsSerializedSize, extensionsSerializedSizeAsMessageSet, getAllFields, getAllFieldsRaw, getExtension, getExtension, getExtensionCount, getExtensionFields, getField, getRepeatedField, getRepeatedFieldCount, hasExtension, hasField, makeExtensionsImmutable, newExtensionSerializer, newExtensionWriter, newMessageSetExtensionSerializer, newMessageSetExtensionWriter

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getDescriptorForType, getOneofFieldDescriptor, getUnknownFields, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder

    getExtension, getExtension, getExtension, getExtension, getExtensionCount, getExtensionCount, hasExtension, hasExtension

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • RESOURCE_NAME_FIELD_NUMBER

      public static final int RESOURCE_NAME_FIELD_NUMBER
      See Also:

    • CATEGORY_LABEL_FIELD_NUMBER

      public static final int CATEGORY_LABEL_FIELD_NUMBER
      See Also:

    • ID_FIELD_NUMBER

      public static final int ID_FIELD_NUMBER
      See Also:

    • CAMPAIGN_ID_FIELD_NUMBER

      public static final int CAMPAIGN_ID_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()
      Overrides:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getResourceName

      public String getResourceName()
       Output only. The resource name of the campaign level search term insight.
 Campaign level search term insight resource names have the form:

 `customers/{customer_id}/campaignSearchTermInsights/{campaign_id}~{category_id}`
      string resource_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getResourceName in interface CampaignSearchTermInsightOrBuilder
      Returns:
      The resourceName.

    • getResourceNameBytes

      public com.google.protobuf.ByteString getResourceNameBytes()
       Output only. The resource name of the campaign level search term insight.
 Campaign level search term insight resource names have the form:

 `customers/{customer_id}/campaignSearchTermInsights/{campaign_id}~{category_id}`
      string resource_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getResourceNameBytes in interface CampaignSearchTermInsightOrBuilder
      Returns:
      The bytes for resourceName.

    • hasCategoryLabel

      public boolean hasCategoryLabel()
       Output only. The label for the search category. An empty string denotes the
 catch-all category for search terms that didn't fit into another category.
      optional string category_label = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCategoryLabel in interface CampaignSearchTermInsightOrBuilder
      Returns:
      Whether the categoryLabel field is set.

    • getCategoryLabel

      public String getCategoryLabel()
       Output only. The label for the search category. An empty string denotes the
 catch-all category for search terms that didn't fit into another category.
      optional string category_label = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCategoryLabel in interface CampaignSearchTermInsightOrBuilder
      Returns:
      The categoryLabel.

    • getCategoryLabelBytes

      public com.google.protobuf.ByteString getCategoryLabelBytes()
       Output only. The label for the search category. An empty string denotes the
 catch-all category for search terms that didn't fit into another category.
      optional string category_label = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCategoryLabelBytes in interface CampaignSearchTermInsightOrBuilder
      Returns:
      The bytes for categoryLabel.

    • hasId

      public boolean hasId()
       Output only. The ID of the insight.
      optional int64 id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasId in interface CampaignSearchTermInsightOrBuilder
      Returns:
      Whether the id field is set.

    • getId

      public long getId()
       Output only. The ID of the insight.
      optional int64 id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getId in interface CampaignSearchTermInsightOrBuilder
      Returns:
      The id.

    • hasCampaignId

      public boolean hasCampaignId()
       Output only. The ID of the campaign.
      optional int64 campaign_id = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCampaignId in interface CampaignSearchTermInsightOrBuilder
      Returns:
      Whether the campaignId field is set.

    • getCampaignId

      public long getCampaignId()
       Output only. The ID of the campaign.
      optional int64 campaign_id = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCampaignId in interface CampaignSearchTermInsightOrBuilder
      Returns:
      The campaignId.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.ExtendableMessage<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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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 CampaignSearchTermInsight parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static CampaignSearchTermInsight.Builder newBuilder()

    • newBuilder

      public static CampaignSearchTermInsight.Builder newBuilder(CampaignSearchTermInsight prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static CampaignSearchTermInsight getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<CampaignSearchTermInsight> 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.GeneratedMessage

    • getDefaultInstanceForType

      public CampaignSearchTermInsight getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder