Package com.google.ads.googleads.v18.resources

Class CampaignSearchTermInsight

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.ads.googleads.v18.resources.CampaignSearchTermInsight
All Implemented Interfaces:
CampaignSearchTermInsightOrBuilder, 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
 A Campaign search term view.
 Historical data is available starting March 2023.
Protobuf type google.ads.googleads.v18.resources.CampaignSearchTermInsight
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:

    • 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()
      Specified by:
      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.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 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.GeneratedMessageV3

    • getDefaultInstanceForType

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