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

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

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

  /**
   *    * Immutable. The resource name of the Keyword Plan campaign.
   * KeywordPlanCampaign resource names have the form:
   *
   * `customers/{customer_id}/keywordPlanCampaigns/{kp_campaign_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 Keyword Plan campaign.
   * KeywordPlanCampaign resource names have the form:
   *
   * `customers/{customer_id}/keywordPlanCampaigns/{kp_campaign_id}`
   * 
   *
   * string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
   * @return The bytes for resourceName.
   */
  com.google.protobuf.ByteString
      getResourceNameBytes();

  /**
   *    * The keyword plan this campaign belongs to.
   * 
   *
   * optional string keyword_plan = 9 [(.google.api.resource_reference) = { ... }
   * @return Whether the keywordPlan field is set.
   */
  boolean hasKeywordPlan();
  /**
   *    * The keyword plan this campaign belongs to.
   * 
   *
   * optional string keyword_plan = 9 [(.google.api.resource_reference) = { ... }
   * @return The keywordPlan.
   */
  java.lang.String getKeywordPlan();
  /**
   *    * The keyword plan this campaign belongs to.
   * 
   *
   * optional string keyword_plan = 9 [(.google.api.resource_reference) = { ... }
   * @return The bytes for keywordPlan.
   */
  com.google.protobuf.ByteString
      getKeywordPlanBytes();

  /**
   *    * Output only. The ID of the Keyword Plan campaign.
   * 
   *
   * optional int64 id = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the id field is set.
   */
  boolean hasId();
  /**
   *    * Output only. The ID of the Keyword Plan campaign.
   * 
   *
   * optional int64 id = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The id.
   */
  long getId();

  /**
   *    * The name of the Keyword Plan campaign.
   *
   * This field is required and should not be empty when creating Keyword Plan
   * campaigns.
   * 
   *
   * optional string name = 11;
   * @return Whether the name field is set.
   */
  boolean hasName();
  /**
   *    * The name of the Keyword Plan campaign.
   *
   * This field is required and should not be empty when creating Keyword Plan
   * campaigns.
   * 
   *
   * optional string name = 11;
   * @return The name.
   */
  java.lang.String getName();
  /**
   *    * The name of the Keyword Plan campaign.
   *
   * This field is required and should not be empty when creating Keyword Plan
   * campaigns.
   * 
   *
   * optional string name = 11;
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString
      getNameBytes();

  /**
   *    * The languages targeted for the Keyword Plan campaign.
   * Max allowed: 1.
   * 
   *
   * repeated string language_constants = 12 [(.google.api.resource_reference) = { ... }
   * @return A list containing the languageConstants.
   */
  java.util.List
      getLanguageConstantsList();
  /**
   *    * The languages targeted for the Keyword Plan campaign.
   * Max allowed: 1.
   * 
   *
   * repeated string language_constants = 12 [(.google.api.resource_reference) = { ... }
   * @return The count of languageConstants.
   */
  int getLanguageConstantsCount();
  /**
   *    * The languages targeted for the Keyword Plan campaign.
   * Max allowed: 1.
   * 
   *
   * repeated string language_constants = 12 [(.google.api.resource_reference) = { ... }
   * @param index The index of the element to return.
   * @return The languageConstants at the given index.
   */
  java.lang.String getLanguageConstants(int index);
  /**
   *    * The languages targeted for the Keyword Plan campaign.
   * Max allowed: 1.
   * 
   *
   * repeated string language_constants = 12 [(.google.api.resource_reference) = { ... }
   * @param index The index of the value to return.
   * @return The bytes of the languageConstants at the given index.
   */
  com.google.protobuf.ByteString
      getLanguageConstantsBytes(int index);

  /**
   *    * Targeting network.
   *
   * This field is required and should not be empty when creating Keyword Plan
   * campaigns.
   * 
   *
   * .google.ads.googleads.v17.enums.KeywordPlanNetworkEnum.KeywordPlanNetwork keyword_plan_network = 6;
   * @return The enum numeric value on the wire for keywordPlanNetwork.
   */
  int getKeywordPlanNetworkValue();
  /**
   *    * Targeting network.
   *
   * This field is required and should not be empty when creating Keyword Plan
   * campaigns.
   * 
   *
   * .google.ads.googleads.v17.enums.KeywordPlanNetworkEnum.KeywordPlanNetwork keyword_plan_network = 6;
   * @return The keywordPlanNetwork.
   */
  com.google.ads.googleads.v17.enums.KeywordPlanNetworkEnum.KeywordPlanNetwork getKeywordPlanNetwork();

  /**
   *    * A default max cpc bid in micros, and in the account currency, for all ad
   * groups under the campaign.
   *
   * This field is required and should not be empty when creating Keyword Plan
   * campaigns.
   * 
   *
   * optional int64 cpc_bid_micros = 13;
   * @return Whether the cpcBidMicros field is set.
   */
  boolean hasCpcBidMicros();
  /**
   *    * A default max cpc bid in micros, and in the account currency, for all ad
   * groups under the campaign.
   *
   * This field is required and should not be empty when creating Keyword Plan
   * campaigns.
   * 
   *
   * optional int64 cpc_bid_micros = 13;
   * @return The cpcBidMicros.
   */
  long getCpcBidMicros();

  /**
   *    * The geo targets.
   * Max number allowed: 20.
   * 
   *
   * repeated .google.ads.googleads.v17.resources.KeywordPlanGeoTarget geo_targets = 8;
   */
  java.util.List 
      getGeoTargetsList();
  /**
   *    * The geo targets.
   * Max number allowed: 20.
   * 
   *
   * repeated .google.ads.googleads.v17.resources.KeywordPlanGeoTarget geo_targets = 8;
   */
  com.google.ads.googleads.v17.resources.KeywordPlanGeoTarget getGeoTargets(int index);
  /**
   *    * The geo targets.
   * Max number allowed: 20.
   * 
   *
   * repeated .google.ads.googleads.v17.resources.KeywordPlanGeoTarget geo_targets = 8;
   */
  int getGeoTargetsCount();
  /**
   *    * The geo targets.
   * Max number allowed: 20.
   * 
   *
   * repeated .google.ads.googleads.v17.resources.KeywordPlanGeoTarget geo_targets = 8;
   */
  java.util.List 
      getGeoTargetsOrBuilderList();
  /**
   *    * The geo targets.
   * Max number allowed: 20.
   * 
   *
   * repeated .google.ads.googleads.v17.resources.KeywordPlanGeoTarget geo_targets = 8;
   */
  com.google.ads.googleads.v17.resources.KeywordPlanGeoTargetOrBuilder getGeoTargetsOrBuilder(
      int index);
}