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

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

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

  /**
   *    * Immutable. The resource name of the ad.
   * Ad group ad resource names have the form:
   *
   * `customers/{customer_id}/adGroupAds/{ad_group_id}~{ad_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 ad.
   * Ad group ad resource names have the form:
   *
   * `customers/{customer_id}/adGroupAds/{ad_group_id}~{ad_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 status of the ad.
   * 
   *
   * .google.ads.googleads.v17.enums.AdGroupAdStatusEnum.AdGroupAdStatus status = 3;
   * @return The enum numeric value on the wire for status.
   */
  int getStatusValue();
  /**
   *    * The status of the ad.
   * 
   *
   * .google.ads.googleads.v17.enums.AdGroupAdStatusEnum.AdGroupAdStatus status = 3;
   * @return The status.
   */
  com.google.ads.googleads.v17.enums.AdGroupAdStatusEnum.AdGroupAdStatus getStatus();

  /**
   *    * Immutable. The ad group to which the ad belongs.
   * 
   *
   * optional string ad_group = 9 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
   * @return Whether the adGroup field is set.
   */
  boolean hasAdGroup();
  /**
   *    * Immutable. The ad group to which the ad belongs.
   * 
   *
   * optional string ad_group = 9 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
   * @return The adGroup.
   */
  java.lang.String getAdGroup();
  /**
   *    * Immutable. The ad group to which the ad belongs.
   * 
   *
   * optional string ad_group = 9 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
   * @return The bytes for adGroup.
   */
  com.google.protobuf.ByteString
      getAdGroupBytes();

  /**
   *    * Immutable. The ad.
   * 
   *
   * .google.ads.googleads.v17.resources.Ad ad = 5 [(.google.api.field_behavior) = IMMUTABLE];
   * @return Whether the ad field is set.
   */
  boolean hasAd();
  /**
   *    * Immutable. The ad.
   * 
   *
   * .google.ads.googleads.v17.resources.Ad ad = 5 [(.google.api.field_behavior) = IMMUTABLE];
   * @return The ad.
   */
  com.google.ads.googleads.v17.resources.Ad getAd();
  /**
   *    * Immutable. The ad.
   * 
   *
   * .google.ads.googleads.v17.resources.Ad ad = 5 [(.google.api.field_behavior) = IMMUTABLE];
   */
  com.google.ads.googleads.v17.resources.AdOrBuilder getAdOrBuilder();

  /**
   *    * Output only. Policy information for the ad.
   * 
   *
   * .google.ads.googleads.v17.resources.AdGroupAdPolicySummary policy_summary = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the policySummary field is set.
   */
  boolean hasPolicySummary();
  /**
   *    * Output only. Policy information for the ad.
   * 
   *
   * .google.ads.googleads.v17.resources.AdGroupAdPolicySummary policy_summary = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The policySummary.
   */
  com.google.ads.googleads.v17.resources.AdGroupAdPolicySummary getPolicySummary();
  /**
   *    * Output only. Policy information for the ad.
   * 
   *
   * .google.ads.googleads.v17.resources.AdGroupAdPolicySummary policy_summary = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
   */
  com.google.ads.googleads.v17.resources.AdGroupAdPolicySummaryOrBuilder getPolicySummaryOrBuilder();

  /**
   *    * Output only. Overall ad strength for this ad group ad.
   * 
   *
   * .google.ads.googleads.v17.enums.AdStrengthEnum.AdStrength ad_strength = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The enum numeric value on the wire for adStrength.
   */
  int getAdStrengthValue();
  /**
   *    * Output only. Overall ad strength for this ad group ad.
   * 
   *
   * .google.ads.googleads.v17.enums.AdStrengthEnum.AdStrength ad_strength = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The adStrength.
   */
  com.google.ads.googleads.v17.enums.AdStrengthEnum.AdStrength getAdStrength();

  /**
   *    * Output only. A list of recommendations to improve the ad strength. For
   * example, a recommendation could be "Try adding a few more unique headlines
   * or unpinning some assets.".
   * 
   *
   * repeated string action_items = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return A list containing the actionItems.
   */
  java.util.List
      getActionItemsList();
  /**
   *    * Output only. A list of recommendations to improve the ad strength. For
   * example, a recommendation could be "Try adding a few more unique headlines
   * or unpinning some assets.".
   * 
   *
   * repeated string action_items = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The count of actionItems.
   */
  int getActionItemsCount();
  /**
   *    * Output only. A list of recommendations to improve the ad strength. For
   * example, a recommendation could be "Try adding a few more unique headlines
   * or unpinning some assets.".
   * 
   *
   * repeated string action_items = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @param index The index of the element to return.
   * @return The actionItems at the given index.
   */
  java.lang.String getActionItems(int index);
  /**
   *    * Output only. A list of recommendations to improve the ad strength. For
   * example, a recommendation could be "Try adding a few more unique headlines
   * or unpinning some assets.".
   * 
   *
   * repeated string action_items = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @param index The index of the value to return.
   * @return The bytes of the actionItems at the given index.
   */
  com.google.protobuf.ByteString
      getActionItemsBytes(int index);

  /**
   *    * Output only. The resource names of labels attached to this ad group ad.
   * 
   *
   * repeated string labels = 10 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
   * @return A list containing the labels.
   */
  java.util.List
      getLabelsList();
  /**
   *    * Output only. The resource names of labels attached to this ad group ad.
   * 
   *
   * repeated string labels = 10 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
   * @return The count of labels.
   */
  int getLabelsCount();
  /**
   *    * Output only. The resource names of labels attached to this ad group ad.
   * 
   *
   * repeated string labels = 10 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
   * @param index The index of the element to return.
   * @return The labels at the given index.
   */
  java.lang.String getLabels(int index);
  /**
   *    * Output only. The resource names of labels attached to this ad group ad.
   * 
   *
   * repeated string labels = 10 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
   * @param index The index of the value to return.
   * @return The bytes of the labels at the given index.
   */
  com.google.protobuf.ByteString
      getLabelsBytes(int index);

  /**
   *    * Output only. Provides aggregated view into why an ad group ad is not
   * serving or not serving optimally.
   * 
   *
   * .google.ads.googleads.v17.enums.AdGroupAdPrimaryStatusEnum.AdGroupAdPrimaryStatus primary_status = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The enum numeric value on the wire for primaryStatus.
   */
  int getPrimaryStatusValue();
  /**
   *    * Output only. Provides aggregated view into why an ad group ad is not
   * serving or not serving optimally.
   * 
   *
   * .google.ads.googleads.v17.enums.AdGroupAdPrimaryStatusEnum.AdGroupAdPrimaryStatus primary_status = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The primaryStatus.
   */
  com.google.ads.googleads.v17.enums.AdGroupAdPrimaryStatusEnum.AdGroupAdPrimaryStatus getPrimaryStatus();

  /**
   *    * Output only. Provides reasons for why an ad group ad is not serving or not
   * serving optimally.
   * 
   *
   * repeated .google.ads.googleads.v17.enums.AdGroupAdPrimaryStatusReasonEnum.AdGroupAdPrimaryStatusReason primary_status_reasons = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return A list containing the primaryStatusReasons.
   */
  java.util.List getPrimaryStatusReasonsList();
  /**
   *    * Output only. Provides reasons for why an ad group ad is not serving or not
   * serving optimally.
   * 
   *
   * repeated .google.ads.googleads.v17.enums.AdGroupAdPrimaryStatusReasonEnum.AdGroupAdPrimaryStatusReason primary_status_reasons = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The count of primaryStatusReasons.
   */
  int getPrimaryStatusReasonsCount();
  /**
   *    * Output only. Provides reasons for why an ad group ad is not serving or not
   * serving optimally.
   * 
   *
   * repeated .google.ads.googleads.v17.enums.AdGroupAdPrimaryStatusReasonEnum.AdGroupAdPrimaryStatusReason primary_status_reasons = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @param index The index of the element to return.
   * @return The primaryStatusReasons at the given index.
   */
  com.google.ads.googleads.v17.enums.AdGroupAdPrimaryStatusReasonEnum.AdGroupAdPrimaryStatusReason getPrimaryStatusReasons(int index);
  /**
   *    * Output only. Provides reasons for why an ad group ad is not serving or not
   * serving optimally.
   * 
   *
   * repeated .google.ads.googleads.v17.enums.AdGroupAdPrimaryStatusReasonEnum.AdGroupAdPrimaryStatusReason primary_status_reasons = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return A list containing the enum numeric values on the wire for primaryStatusReasons.
   */
  java.util.List
  getPrimaryStatusReasonsValueList();
  /**
   *    * Output only. Provides reasons for why an ad group ad is not serving or not
   * serving optimally.
   * 
   *
   * repeated .google.ads.googleads.v17.enums.AdGroupAdPrimaryStatusReasonEnum.AdGroupAdPrimaryStatusReason primary_status_reasons = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @param index The index of the value to return.
   * @return The enum numeric value on the wire of primaryStatusReasons at the given index.
   */
  int getPrimaryStatusReasonsValue(int index);
}