com.google.ads.googleads.v17.resources.CustomAudienceOrBuilder 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_audience.proto

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

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

  /**
   *    * Immutable. The resource name of the custom audience.
   * Custom audience resource names have the form:
   *
   * `customers/{customer_id}/customAudiences/{custom_audience_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 audience.
   * Custom audience resource names have the form:
   *
   * `customers/{customer_id}/customAudiences/{custom_audience_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 audience.
   * 
   *
   * int64 id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The id.
   */
  long getId();

  /**
   *    * Output only. Status of this custom audience. Indicates whether the custom
   * audience is enabled or removed.
   * 
   *
   * .google.ads.googleads.v17.enums.CustomAudienceStatusEnum.CustomAudienceStatus status = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The enum numeric value on the wire for status.
   */
  int getStatusValue();
  /**
   *    * Output only. Status of this custom audience. Indicates whether the custom
   * audience is enabled or removed.
   * 
   *
   * .google.ads.googleads.v17.enums.CustomAudienceStatusEnum.CustomAudienceStatus status = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The status.
   */
  com.google.ads.googleads.v17.enums.CustomAudienceStatusEnum.CustomAudienceStatus getStatus();

  /**
   *    * Name of the custom audience. It should be unique for all custom audiences
   * created by a customer.
   * This field is required for creating operations.
   * 
   *
   * string name = 4;
   * @return The name.
   */
  java.lang.String getName();
  /**
   *    * Name of the custom audience. It should be unique for all custom audiences
   * created by a customer.
   * This field is required for creating operations.
   * 
   *
   * string name = 4;
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString
      getNameBytes();

  /**
   *    * Type of the custom audience.
   * ("INTEREST" OR "PURCHASE_INTENT" is not allowed for newly created custom
   * audience but kept for existing audiences)
   * 
   *
   * .google.ads.googleads.v17.enums.CustomAudienceTypeEnum.CustomAudienceType type = 5;
   * @return The enum numeric value on the wire for type.
   */
  int getTypeValue();
  /**
   *    * Type of the custom audience.
   * ("INTEREST" OR "PURCHASE_INTENT" is not allowed for newly created custom
   * audience but kept for existing audiences)
   * 
   *
   * .google.ads.googleads.v17.enums.CustomAudienceTypeEnum.CustomAudienceType type = 5;
   * @return The type.
   */
  com.google.ads.googleads.v17.enums.CustomAudienceTypeEnum.CustomAudienceType getType();

  /**
   *    * Description of this custom audience.
   * 
   *
   * string description = 6;
   * @return The description.
   */
  java.lang.String getDescription();
  /**
   *    * Description of this custom audience.
   * 
   *
   * string description = 6;
   * @return The bytes for description.
   */
  com.google.protobuf.ByteString
      getDescriptionBytes();

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