com.google.ads.googleads.v17.resources.CustomInterestOrBuilder 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/custom_interest.proto

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

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

  /**
   *    * Immutable. The resource name of the custom interest.
   * Custom interest resource names have the form:
   *
   * `customers/{customer_id}/customInterests/{custom_interest_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 custom interest.
   * Custom interest resource names have the form:
   *
   * `customers/{customer_id}/customInterests/{custom_interest_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. Id of the custom interest.
   * 
   *
   * optional int64 id = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the id field is set.
   */
  boolean hasId();
  /**
   *    * Output only. Id of the custom interest.
   * 
   *
   * optional int64 id = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The id.
   */
  long getId();

  /**
   *    * Status of this custom interest. Indicates whether the custom interest is
   * enabled or removed.
   * 
   *
   * .google.ads.googleads.v17.enums.CustomInterestStatusEnum.CustomInterestStatus status = 3;
   * @return The enum numeric value on the wire for status.
   */
  int getStatusValue();
  /**
   *    * Status of this custom interest. Indicates whether the custom interest is
   * enabled or removed.
   * 
   *
   * .google.ads.googleads.v17.enums.CustomInterestStatusEnum.CustomInterestStatus status = 3;
   * @return The status.
   */
  com.google.ads.googleads.v17.enums.CustomInterestStatusEnum.CustomInterestStatus getStatus();

  /**
   *    * Name of the custom interest. It should be unique across the same custom
   * affinity audience.
   * This field is required for create operations.
   * 
   *
   * optional string name = 9;
   * @return Whether the name field is set.
   */
  boolean hasName();
  /**
   *    * Name of the custom interest. It should be unique across the same custom
   * affinity audience.
   * This field is required for create operations.
   * 
   *
   * optional string name = 9;
   * @return The name.
   */
  java.lang.String getName();
  /**
   *    * Name of the custom interest. It should be unique across the same custom
   * affinity audience.
   * This field is required for create operations.
   * 
   *
   * optional string name = 9;
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString
      getNameBytes();

  /**
   *    * Type of the custom interest, CUSTOM_AFFINITY or CUSTOM_INTENT.
   * By default the type is set to CUSTOM_AFFINITY.
   * 
   *
   * .google.ads.googleads.v17.enums.CustomInterestTypeEnum.CustomInterestType type = 5;
   * @return The enum numeric value on the wire for type.
   */
  int getTypeValue();
  /**
   *    * Type of the custom interest, CUSTOM_AFFINITY or CUSTOM_INTENT.
   * By default the type is set to CUSTOM_AFFINITY.
   * 
   *
   * .google.ads.googleads.v17.enums.CustomInterestTypeEnum.CustomInterestType type = 5;
   * @return The type.
   */
  com.google.ads.googleads.v17.enums.CustomInterestTypeEnum.CustomInterestType getType();

  /**
   *    * Description of this custom interest audience.
   * 
   *
   * optional string description = 10;
   * @return Whether the description field is set.
   */
  boolean hasDescription();
  /**
   *    * Description of this custom interest audience.
   * 
   *
   * optional string description = 10;
   * @return The description.
   */
  java.lang.String getDescription();
  /**
   *    * Description of this custom interest audience.
   * 
   *
   * optional string description = 10;
   * @return The bytes for description.
   */
  com.google.protobuf.ByteString
      getDescriptionBytes();

  /**
   *    * List of custom interest members that this custom interest is composed of.
   * Members can be added during CustomInterest creation. If members are
   * presented in UPDATE operation, existing members will be overridden.
   * 
   *
   * repeated .google.ads.googleads.v17.resources.CustomInterestMember members = 7;
   */
  java.util.List 
      getMembersList();
  /**
   *    * List of custom interest members that this custom interest is composed of.
   * Members can be added during CustomInterest creation. If members are
   * presented in UPDATE operation, existing members will be overridden.
   * 
   *
   * repeated .google.ads.googleads.v17.resources.CustomInterestMember members = 7;
   */
  com.google.ads.googleads.v17.resources.CustomInterestMember getMembers(int index);
  /**
   *    * List of custom interest members that this custom interest is composed of.
   * Members can be added during CustomInterest creation. If members are
   * presented in UPDATE operation, existing members will be overridden.
   * 
   *
   * repeated .google.ads.googleads.v17.resources.CustomInterestMember members = 7;
   */
  int getMembersCount();
  /**
   *    * List of custom interest members that this custom interest is composed of.
   * Members can be added during CustomInterest creation. If members are
   * presented in UPDATE operation, existing members will be overridden.
   * 
   *
   * repeated .google.ads.googleads.v17.resources.CustomInterestMember members = 7;
   */
  java.util.List 
      getMembersOrBuilderList();
  /**
   *    * List of custom interest members that this custom interest is composed of.
   * Members can be added during CustomInterest creation. If members are
   * presented in UPDATE operation, existing members will be overridden.
   * 
   *
   * repeated .google.ads.googleads.v17.resources.CustomInterestMember members = 7;
   */
  com.google.ads.googleads.v17.resources.CustomInterestMemberOrBuilder getMembersOrBuilder(
      int index);
}