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

Interface ConversionCustomVariableOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ConversionCustomVariable, ConversionCustomVariable.Builder
public interface ConversionCustomVariableOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    getId()
    Output only.
    String
    getName()
    Required.
    com.google.protobuf.ByteString
    getNameBytes()
    Required.
    String
    getOwnerCustomer()
    Output only.
    com.google.protobuf.ByteString
    getOwnerCustomerBytes()
    Output only.
    String
    getResourceName()
    Immutable.
    com.google.protobuf.ByteString
    getResourceNameBytes()
    Immutable.
    ConversionCustomVariableStatusEnum.ConversionCustomVariableStatus
    getStatus()
    The status of the conversion custom variable for conversion event accrual.
    int
    getStatusValue()
    The status of the conversion custom variable for conversion event accrual.
    String
    getTag()
    Required.
    com.google.protobuf.ByteString
    getTagBytes()
    Required.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getResourceName

      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) = { ... }
      Returns:
      The resourceName.

    • getResourceNameBytes

      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) = { ... }
      Returns:
      The bytes for resourceName.

    • getId

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

    • getName

      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];
      Returns:
      The name.

    • getNameBytes

      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];
      Returns:
      The bytes for name.

    • getTag

      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];
      Returns:
      The tag.

    • getTagBytes

      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];
      Returns:
      The bytes for tag.

    • getStatusValue

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

    • getStatus

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

    • getOwnerCustomer

      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) = { ... }
      Returns:
      The ownerCustomer.

    • getOwnerCustomerBytes

      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) = { ... }
      Returns:
      The bytes for ownerCustomer.