com.google.ads.googleads.v17.resources.ConversionCustomVariableOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-ads-stubs-v17 Show documentation
Stubs for GAAPI version google-ads-stubs-v17
The newest version!
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/ads/googleads/v17/resources/conversion_custom_variable.proto

// Protobuf Java Version: 3.25.3
package com.google.ads.googleads.v17.resources;

public interface ConversionCustomVariableOrBuilder extends
    // @@protoc_insertion_point(interface_extends:google.ads.googleads.v17.resources.ConversionCustomVariable)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * 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) = { ... }
   * @return The resourceName.
   */
  java.lang.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) = { ... }
   * @return The bytes for resourceName.
   */
  com.google.protobuf.ByteString
      getResourceNameBytes();

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

  /**
   *    * 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];
   * @return The name.
   */
  java.lang.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];
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString
      getNameBytes();

  /**
   *    * 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];
   * @return The tag.
   */
  java.lang.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];
   * @return The bytes for tag.
   */
  com.google.protobuf.ByteString
      getTagBytes();

  /**
   *    * The status of the conversion custom variable for conversion event accrual.
   * 
   *
   * .google.ads.googleads.v17.enums.ConversionCustomVariableStatusEnum.ConversionCustomVariableStatus status = 5;
   * @return The enum numeric value on the wire for status.
   */
  int getStatusValue();
  /**
   *    * The status of the conversion custom variable for conversion event accrual.
   * 
   *
   * .google.ads.googleads.v17.enums.ConversionCustomVariableStatusEnum.ConversionCustomVariableStatus status = 5;
   * @return The status.
   */
  com.google.ads.googleads.v17.enums.ConversionCustomVariableStatusEnum.ConversionCustomVariableStatus getStatus();

  /**
   *    * 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) = { ... }
   * @return The ownerCustomer.
   */
  java.lang.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) = { ... }
   * @return The bytes for ownerCustomer.
   */
  com.google.protobuf.ByteString
      getOwnerCustomerBytes();
}