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

Class ConversionCustomVariable.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<ConversionCustomVariable.Builder>
com.google.ads.googleads.v18.resources.ConversionCustomVariable.Builder
All Implemented Interfaces:
ConversionCustomVariableOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
ConversionCustomVariable
public static final class ConversionCustomVariable.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<ConversionCustomVariable.Builder> implements ConversionCustomVariableOrBuilder
 A conversion custom variable
 See "About custom variables for conversions" at
 https://support.google.com/google-ads/answer/9964350
Protobuf type google.ads.googleads.v18.resources.ConversionCustomVariable

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

    • clear

      public ConversionCustomVariable.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<ConversionCustomVariable.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<ConversionCustomVariable.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

      public ConversionCustomVariable.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<ConversionCustomVariable.Builder>

    • setField

      public ConversionCustomVariable.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<ConversionCustomVariable.Builder>

    • clearField

      public ConversionCustomVariable.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<ConversionCustomVariable.Builder>

    • clearOneof

      public ConversionCustomVariable.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<ConversionCustomVariable.Builder>

    • setRepeatedField

      public ConversionCustomVariable.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<ConversionCustomVariable.Builder>

    • addRepeatedField

      public ConversionCustomVariable.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<ConversionCustomVariable.Builder>

    • mergeFrom

      public ConversionCustomVariable.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<ConversionCustomVariable.Builder>

    • mergeFrom

      public ConversionCustomVariable.Builder mergeFrom(ConversionCustomVariable other)

    • isInitialized

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

    • mergeFrom

      public ConversionCustomVariable.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<ConversionCustomVariable.Builder>
      Throws:
      IOException

    • getResourceName

      public String getResourceName()
       Immutable. The resource name of the conversion custom variable.
 Conversion custom variable resource names have the form:

 `customers/{customer_id}/conversionCustomVariables/{conversion_custom_variable_id}`
      string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Specified by:
      getResourceName in interface ConversionCustomVariableOrBuilder
      Returns:
      The resourceName.

    • getResourceNameBytes

      public com.google.protobuf.ByteString getResourceNameBytes()
       Immutable. The resource name of the conversion custom variable.
 Conversion custom variable resource names have the form:

 `customers/{customer_id}/conversionCustomVariables/{conversion_custom_variable_id}`
      string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Specified by:
      getResourceNameBytes in interface ConversionCustomVariableOrBuilder
      Returns:
      The bytes for resourceName.

    • setResourceName

      public ConversionCustomVariable.Builder setResourceName(String value)
       Immutable. The resource name of the conversion custom variable.
 Conversion custom variable resource names have the form:

 `customers/{customer_id}/conversionCustomVariables/{conversion_custom_variable_id}`
      string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The resourceName to set.
      Returns:
      This builder for chaining.

    • clearResourceName

      public ConversionCustomVariable.Builder clearResourceName()
       Immutable. The resource name of the conversion custom variable.
 Conversion custom variable resource names have the form:

 `customers/{customer_id}/conversionCustomVariables/{conversion_custom_variable_id}`
      string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Returns:
      This builder for chaining.

    • setResourceNameBytes

      public ConversionCustomVariable.Builder setResourceNameBytes(com.google.protobuf.ByteString value)
       Immutable. The resource name of the conversion custom variable.
 Conversion custom variable resource names have the form:

 `customers/{customer_id}/conversionCustomVariables/{conversion_custom_variable_id}`
      string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The bytes for resourceName to set.
      Returns:
      This builder for chaining.

    • getId

      public long getId()
       Output only. The ID of the conversion custom variable.
      int64 id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getId in interface ConversionCustomVariableOrBuilder
      Returns:
      The id.

    • setId

      public ConversionCustomVariable.Builder setId(long value)
       Output only. The ID of the conversion custom variable.
      int64 id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The id to set.
      Returns:
      This builder for chaining.

    • clearId

      public ConversionCustomVariable.Builder clearId()
       Output only. The ID of the conversion custom variable.
      int64 id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.

    • getName

      public String getName()
       Required. The name of the conversion custom variable.
 Name should be unique. The maximum length of name is 100 characters.
 There should not be any extra spaces before and after.
      string name = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getName in interface ConversionCustomVariableOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Required. The name of the conversion custom variable.
 Name should be unique. The maximum length of name is 100 characters.
 There should not be any extra spaces before and after.
      string name = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getNameBytes in interface ConversionCustomVariableOrBuilder
      Returns:
      The bytes for name.

    • setName

      public ConversionCustomVariable.Builder setName(String value)
       Required. The name of the conversion custom variable.
 Name should be unique. The maximum length of name is 100 characters.
 There should not be any extra spaces before and after.
      string name = 3 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • clearName

      public ConversionCustomVariable.Builder clearName()
       Required. The name of the conversion custom variable.
 Name should be unique. The maximum length of name is 100 characters.
 There should not be any extra spaces before and after.
      string name = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.

    • setNameBytes

      public ConversionCustomVariable.Builder setNameBytes(com.google.protobuf.ByteString value)
       Required. The name of the conversion custom variable.
 Name should be unique. The maximum length of name is 100 characters.
 There should not be any extra spaces before and after.
      string name = 3 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

    • getTag

      public String getTag()
       Required. Immutable. The tag of the conversion custom variable. It is used
 in the event snippet and sent to Google Ads along with conversion pings.
 For conversion uploads in Google Ads API, the resource name of the
 conversion custom variable is used. Tag should be unique. The maximum size
 of tag is 100 bytes. There should not be any extra spaces before and after.
 Currently only lowercase letters, numbers and underscores are allowed in
 the tag.
      string tag = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getTag in interface ConversionCustomVariableOrBuilder
      Returns:
      The tag.

    • getTagBytes

      public com.google.protobuf.ByteString getTagBytes()
       Required. Immutable. The tag of the conversion custom variable. It is used
 in the event snippet and sent to Google Ads along with conversion pings.
 For conversion uploads in Google Ads API, the resource name of the
 conversion custom variable is used. Tag should be unique. The maximum size
 of tag is 100 bytes. There should not be any extra spaces before and after.
 Currently only lowercase letters, numbers and underscores are allowed in
 the tag.
      string tag = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getTagBytes in interface ConversionCustomVariableOrBuilder
      Returns:
      The bytes for tag.

    • setTag

      public ConversionCustomVariable.Builder setTag(String value)
       Required. Immutable. The tag of the conversion custom variable. It is used
 in the event snippet and sent to Google Ads along with conversion pings.
 For conversion uploads in Google Ads API, the resource name of the
 conversion custom variable is used. Tag should be unique. The maximum size
 of tag is 100 bytes. There should not be any extra spaces before and after.
 Currently only lowercase letters, numbers and underscores are allowed in
 the tag.
      string tag = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
      Parameters:
      value - The tag to set.
      Returns:
      This builder for chaining.

    • clearTag

      public ConversionCustomVariable.Builder clearTag()
       Required. Immutable. The tag of the conversion custom variable. It is used
 in the event snippet and sent to Google Ads along with conversion pings.
 For conversion uploads in Google Ads API, the resource name of the
 conversion custom variable is used. Tag should be unique. The maximum size
 of tag is 100 bytes. There should not be any extra spaces before and after.
 Currently only lowercase letters, numbers and underscores are allowed in
 the tag.
      string tag = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
      Returns:
      This builder for chaining.

    • setTagBytes

      public ConversionCustomVariable.Builder setTagBytes(com.google.protobuf.ByteString value)
       Required. Immutable. The tag of the conversion custom variable. It is used
 in the event snippet and sent to Google Ads along with conversion pings.
 For conversion uploads in Google Ads API, the resource name of the
 conversion custom variable is used. Tag should be unique. The maximum size
 of tag is 100 bytes. There should not be any extra spaces before and after.
 Currently only lowercase letters, numbers and underscores are allowed in
 the tag.
      string tag = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
      Parameters:
      value - The bytes for tag to set.
      Returns:
      This builder for chaining.

    • getStatusValue

      public int getStatusValue()
       The status of the conversion custom variable for conversion event accrual.
      .google.ads.googleads.v18.enums.ConversionCustomVariableStatusEnum.ConversionCustomVariableStatus status = 5;
      Specified by:
      getStatusValue in interface ConversionCustomVariableOrBuilder
      Returns:
      The enum numeric value on the wire for status.

    • setStatusValue

      public ConversionCustomVariable.Builder setStatusValue(int value)
       The status of the conversion custom variable for conversion event accrual.
      .google.ads.googleads.v18.enums.ConversionCustomVariableStatusEnum.ConversionCustomVariableStatus status = 5;
      Parameters:
      value - The enum numeric value on the wire for status to set.
      Returns:
      This builder for chaining.

    • getStatus

      public ConversionCustomVariableStatusEnum.ConversionCustomVariableStatus getStatus()
       The status of the conversion custom variable for conversion event accrual.
      .google.ads.googleads.v18.enums.ConversionCustomVariableStatusEnum.ConversionCustomVariableStatus status = 5;
      Specified by:
      getStatus in interface ConversionCustomVariableOrBuilder
      Returns:
      The status.

    • setStatus

      public ConversionCustomVariable.Builder setStatus(ConversionCustomVariableStatusEnum.ConversionCustomVariableStatus value)
       The status of the conversion custom variable for conversion event accrual.
      .google.ads.googleads.v18.enums.ConversionCustomVariableStatusEnum.ConversionCustomVariableStatus status = 5;
      Parameters:
      value - The status to set.
      Returns:
      This builder for chaining.

    • clearStatus

      public ConversionCustomVariable.Builder clearStatus()
       The status of the conversion custom variable for conversion event accrual.
      .google.ads.googleads.v18.enums.ConversionCustomVariableStatusEnum.ConversionCustomVariableStatus status = 5;
      Returns:
      This builder for chaining.

    • getOwnerCustomer

      public String getOwnerCustomer()
       Output only. The resource name of the customer that owns the conversion
 custom variable.
      string owner_customer = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getOwnerCustomer in interface ConversionCustomVariableOrBuilder
      Returns:
      The ownerCustomer.

    • getOwnerCustomerBytes

      public com.google.protobuf.ByteString getOwnerCustomerBytes()
       Output only. The resource name of the customer that owns the conversion
 custom variable.
      string owner_customer = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getOwnerCustomerBytes in interface ConversionCustomVariableOrBuilder
      Returns:
      The bytes for ownerCustomer.

    • setOwnerCustomer

      public ConversionCustomVariable.Builder setOwnerCustomer(String value)
       Output only. The resource name of the customer that owns the conversion
 custom variable.
      string owner_customer = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The ownerCustomer to set.
      Returns:
      This builder for chaining.

    • clearOwnerCustomer

      public ConversionCustomVariable.Builder clearOwnerCustomer()
       Output only. The resource name of the customer that owns the conversion
 custom variable.
      string owner_customer = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Returns:
      This builder for chaining.

    • setOwnerCustomerBytes

      public ConversionCustomVariable.Builder setOwnerCustomerBytes(com.google.protobuf.ByteString value)
       Output only. The resource name of the customer that owns the conversion
 custom variable.
      string owner_customer = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The bytes for ownerCustomer to set.
      Returns:
      This builder for chaining.

    • setUnknownFields

      public final ConversionCustomVariable.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<ConversionCustomVariable.Builder>

    • mergeUnknownFields

      public final ConversionCustomVariable.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<ConversionCustomVariable.Builder>