Package com.google.ads.googleads.v18.services

Class InsightsAudienceDescription.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<InsightsAudienceDescription.Builder>
com.google.ads.googleads.v18.services.InsightsAudienceDescription.Builder
All Implemented Interfaces:
InsightsAudienceDescriptionOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
InsightsAudienceDescription
public static final class InsightsAudienceDescription.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<InsightsAudienceDescription.Builder> implements InsightsAudienceDescriptionOrBuilder
 A text description of the audience of interest for which insights are being
 requested in AudienceInsightsService.
Protobuf type google.ads.googleads.v18.services.InsightsAudienceDescription

  • Method Details

    • 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.Builder<InsightsAudienceDescription.Builder>

    • clear

      public InsightsAudienceDescription.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<InsightsAudienceDescription.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<InsightsAudienceDescription.Builder>

    • getDefaultInstanceForType

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

    • build

      public InsightsAudienceDescription build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public InsightsAudienceDescription buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • clone

      public InsightsAudienceDescription.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<InsightsAudienceDescription.Builder>

    • setField

      public InsightsAudienceDescription.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<InsightsAudienceDescription.Builder>

    • clearField

      public InsightsAudienceDescription.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<InsightsAudienceDescription.Builder>

    • clearOneof

      public InsightsAudienceDescription.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<InsightsAudienceDescription.Builder>

    • setRepeatedField

      public InsightsAudienceDescription.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<InsightsAudienceDescription.Builder>

    • addRepeatedField

      public InsightsAudienceDescription.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<InsightsAudienceDescription.Builder>

    • mergeFrom

      public InsightsAudienceDescription.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<InsightsAudienceDescription.Builder>

    • mergeFrom

      public InsightsAudienceDescription.Builder mergeFrom(InsightsAudienceDescription other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<InsightsAudienceDescription.Builder>

    • mergeFrom

      public InsightsAudienceDescription.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<InsightsAudienceDescription.Builder>
      Throws:
      IOException

    • getCountryLocationsList

      public List<LocationInfo> getCountryLocationsList()
       Required. The countries for the audience.
      repeated .google.ads.googleads.v18.common.LocationInfo country_locations = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getCountryLocationsList in interface InsightsAudienceDescriptionOrBuilder

    • getCountryLocationsCount

      public int getCountryLocationsCount()
       Required. The countries for the audience.
      repeated .google.ads.googleads.v18.common.LocationInfo country_locations = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getCountryLocationsCount in interface InsightsAudienceDescriptionOrBuilder

    • getCountryLocations

      public LocationInfo getCountryLocations(int index)
       Required. The countries for the audience.
      repeated .google.ads.googleads.v18.common.LocationInfo country_locations = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getCountryLocations in interface InsightsAudienceDescriptionOrBuilder

    • setCountryLocations

      public InsightsAudienceDescription.Builder setCountryLocations(int index, LocationInfo value)
       Required. The countries for the audience.
      repeated .google.ads.googleads.v18.common.LocationInfo country_locations = 1 [(.google.api.field_behavior) = REQUIRED];

    • setCountryLocations

      public InsightsAudienceDescription.Builder setCountryLocations(int index, LocationInfo.Builder builderForValue)
       Required. The countries for the audience.
      repeated .google.ads.googleads.v18.common.LocationInfo country_locations = 1 [(.google.api.field_behavior) = REQUIRED];

    • addCountryLocations

      public InsightsAudienceDescription.Builder addCountryLocations(LocationInfo value)
       Required. The countries for the audience.
      repeated .google.ads.googleads.v18.common.LocationInfo country_locations = 1 [(.google.api.field_behavior) = REQUIRED];

    • addCountryLocations

      public InsightsAudienceDescription.Builder addCountryLocations(int index, LocationInfo value)
       Required. The countries for the audience.
      repeated .google.ads.googleads.v18.common.LocationInfo country_locations = 1 [(.google.api.field_behavior) = REQUIRED];

    • addCountryLocations

      public InsightsAudienceDescription.Builder addCountryLocations(LocationInfo.Builder builderForValue)
       Required. The countries for the audience.
      repeated .google.ads.googleads.v18.common.LocationInfo country_locations = 1 [(.google.api.field_behavior) = REQUIRED];

    • addCountryLocations

      public InsightsAudienceDescription.Builder addCountryLocations(int index, LocationInfo.Builder builderForValue)
       Required. The countries for the audience.
      repeated .google.ads.googleads.v18.common.LocationInfo country_locations = 1 [(.google.api.field_behavior) = REQUIRED];

    • addAllCountryLocations

      public InsightsAudienceDescription.Builder addAllCountryLocations(Iterable<? extends LocationInfo> values)
       Required. The countries for the audience.
      repeated .google.ads.googleads.v18.common.LocationInfo country_locations = 1 [(.google.api.field_behavior) = REQUIRED];

    • clearCountryLocations

      public InsightsAudienceDescription.Builder clearCountryLocations()
       Required. The countries for the audience.
      repeated .google.ads.googleads.v18.common.LocationInfo country_locations = 1 [(.google.api.field_behavior) = REQUIRED];

    • removeCountryLocations

      public InsightsAudienceDescription.Builder removeCountryLocations(int index)
       Required. The countries for the audience.
      repeated .google.ads.googleads.v18.common.LocationInfo country_locations = 1 [(.google.api.field_behavior) = REQUIRED];

    • getCountryLocationsBuilder

      public LocationInfo.Builder getCountryLocationsBuilder(int index)
       Required. The countries for the audience.
      repeated .google.ads.googleads.v18.common.LocationInfo country_locations = 1 [(.google.api.field_behavior) = REQUIRED];

    • getCountryLocationsOrBuilder

      public LocationInfoOrBuilder getCountryLocationsOrBuilder(int index)
       Required. The countries for the audience.
      repeated .google.ads.googleads.v18.common.LocationInfo country_locations = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getCountryLocationsOrBuilder in interface InsightsAudienceDescriptionOrBuilder

    • getCountryLocationsOrBuilderList

      public List<? extends LocationInfoOrBuilder> getCountryLocationsOrBuilderList()
       Required. The countries for the audience.
      repeated .google.ads.googleads.v18.common.LocationInfo country_locations = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getCountryLocationsOrBuilderList in interface InsightsAudienceDescriptionOrBuilder

    • addCountryLocationsBuilder

      public LocationInfo.Builder addCountryLocationsBuilder()
       Required. The countries for the audience.
      repeated .google.ads.googleads.v18.common.LocationInfo country_locations = 1 [(.google.api.field_behavior) = REQUIRED];

    • addCountryLocationsBuilder

      public LocationInfo.Builder addCountryLocationsBuilder(int index)
       Required. The countries for the audience.
      repeated .google.ads.googleads.v18.common.LocationInfo country_locations = 1 [(.google.api.field_behavior) = REQUIRED];

    • getCountryLocationsBuilderList

      public List<LocationInfo.Builder> getCountryLocationsBuilderList()
       Required. The countries for the audience.
      repeated .google.ads.googleads.v18.common.LocationInfo country_locations = 1 [(.google.api.field_behavior) = REQUIRED];

    • getAudienceDescription

      public String getAudienceDescription()
       Required. An English language text description of an audience to get
 suggestions for. Maximum length is 2000 characters. For example, "Women in
 their 30s who love to travel".
      string audience_description = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getAudienceDescription in interface InsightsAudienceDescriptionOrBuilder
      Returns:
      The audienceDescription.

    • getAudienceDescriptionBytes

      public com.google.protobuf.ByteString getAudienceDescriptionBytes()
       Required. An English language text description of an audience to get
 suggestions for. Maximum length is 2000 characters. For example, "Women in
 their 30s who love to travel".
      string audience_description = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getAudienceDescriptionBytes in interface InsightsAudienceDescriptionOrBuilder
      Returns:
      The bytes for audienceDescription.

    • setAudienceDescription

      public InsightsAudienceDescription.Builder setAudienceDescription(String value)
       Required. An English language text description of an audience to get
 suggestions for. Maximum length is 2000 characters. For example, "Women in
 their 30s who love to travel".
      string audience_description = 2 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The audienceDescription to set.
      Returns:
      This builder for chaining.

    • clearAudienceDescription

      public InsightsAudienceDescription.Builder clearAudienceDescription()
       Required. An English language text description of an audience to get
 suggestions for. Maximum length is 2000 characters. For example, "Women in
 their 30s who love to travel".
      string audience_description = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.

    • setAudienceDescriptionBytes

      public InsightsAudienceDescription.Builder setAudienceDescriptionBytes(com.google.protobuf.ByteString value)
       Required. An English language text description of an audience to get
 suggestions for. Maximum length is 2000 characters. For example, "Women in
 their 30s who love to travel".
      string audience_description = 2 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The bytes for audienceDescription to set.
      Returns:
      This builder for chaining.

    • getMarketingObjectiveValue

      public int getMarketingObjectiveValue()
       Optional. An optional marketing objective which will influence the type of
 suggestions produced. AWARENESS will provide affinity audience segments,
 while CONSIDERATION will provide in-market audience segments. Leaving it
 unset will provide both.
      .google.ads.googleads.v18.enums.AudienceInsightsMarketingObjectiveEnum.AudienceInsightsMarketingObjective marketing_objective = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getMarketingObjectiveValue in interface InsightsAudienceDescriptionOrBuilder
      Returns:
      The enum numeric value on the wire for marketingObjective.

    • setMarketingObjectiveValue

      public InsightsAudienceDescription.Builder setMarketingObjectiveValue(int value)
       Optional. An optional marketing objective which will influence the type of
 suggestions produced. AWARENESS will provide affinity audience segments,
 while CONSIDERATION will provide in-market audience segments. Leaving it
 unset will provide both.
      .google.ads.googleads.v18.enums.AudienceInsightsMarketingObjectiveEnum.AudienceInsightsMarketingObjective marketing_objective = 3 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The enum numeric value on the wire for marketingObjective to set.
      Returns:
      This builder for chaining.

    • getMarketingObjective

      public AudienceInsightsMarketingObjectiveEnum.AudienceInsightsMarketingObjective getMarketingObjective()
       Optional. An optional marketing objective which will influence the type of
 suggestions produced. AWARENESS will provide affinity audience segments,
 while CONSIDERATION will provide in-market audience segments. Leaving it
 unset will provide both.
      .google.ads.googleads.v18.enums.AudienceInsightsMarketingObjectiveEnum.AudienceInsightsMarketingObjective marketing_objective = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getMarketingObjective in interface InsightsAudienceDescriptionOrBuilder
      Returns:
      The marketingObjective.

    • setMarketingObjective

      public InsightsAudienceDescription.Builder setMarketingObjective(AudienceInsightsMarketingObjectiveEnum.AudienceInsightsMarketingObjective value)
       Optional. An optional marketing objective which will influence the type of
 suggestions produced. AWARENESS will provide affinity audience segments,
 while CONSIDERATION will provide in-market audience segments. Leaving it
 unset will provide both.
      .google.ads.googleads.v18.enums.AudienceInsightsMarketingObjectiveEnum.AudienceInsightsMarketingObjective marketing_objective = 3 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The marketingObjective to set.
      Returns:
      This builder for chaining.

    • clearMarketingObjective

      public InsightsAudienceDescription.Builder clearMarketingObjective()
       Optional. An optional marketing objective which will influence the type of
 suggestions produced. AWARENESS will provide affinity audience segments,
 while CONSIDERATION will provide in-market audience segments. Leaving it
 unset will provide both.
      .google.ads.googleads.v18.enums.AudienceInsightsMarketingObjectiveEnum.AudienceInsightsMarketingObjective marketing_objective = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • setUnknownFields

      public final InsightsAudienceDescription.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<InsightsAudienceDescription.Builder>

    • mergeUnknownFields

      public final InsightsAudienceDescription.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<InsightsAudienceDescription.Builder>