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

Class ConversionCustomVariable

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.ads.googleads.v18.resources.ConversionCustomVariable
All Implemented Interfaces:
ConversionCustomVariableOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class ConversionCustomVariable extends com.google.protobuf.GeneratedMessageV3 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
See Also:

  • Field Details

  • 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()
       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.

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

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

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

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

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

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

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static ConversionCustomVariable.Builder newBuilder()

    • newBuilder

      public static ConversionCustomVariable.Builder newBuilder(ConversionCustomVariable prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static ConversionCustomVariable getDefaultInstance()

    • parser

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

    • getParserForType

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