Package com.google.ads.googleads.v22.resources

Class CustomerSearchTermInsight

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.ads.googleads.v22.resources.CustomerSearchTermInsight
All Implemented Interfaces:
CustomerSearchTermInsightOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class CustomerSearchTermInsight extends com.google.protobuf.GeneratedMessage implements CustomerSearchTermInsightOrBuilder
 This report provides a high-level view of search demand at the customer
 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.v22.resources.CustomerSearchTermInsight
See Also:

  • 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:

  • 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

    • getResourceName

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

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

    • getResourceNameBytes

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

 `customers/{customer_id}/customerSearchTermInsights/{category_id}`
      string resource_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getResourceNameBytes in interface CustomerSearchTermInsightOrBuilder
      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 CustomerSearchTermInsightOrBuilder
      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 CustomerSearchTermInsightOrBuilder
      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 CustomerSearchTermInsightOrBuilder
      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 CustomerSearchTermInsightOrBuilder
      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 CustomerSearchTermInsightOrBuilder
      Returns:
      The id.

    • isInitialized

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

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static CustomerSearchTermInsight.Builder newBuilder()

    • newBuilder

      public static CustomerSearchTermInsight.Builder newBuilder(CustomerSearchTermInsight prototype)

    • toBuilder

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

    • newBuilderForType

      protected CustomerSearchTermInsight.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static CustomerSearchTermInsight getDefaultInstance()

    • parser

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

    • getParserForType

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