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

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

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

  /**
   *    * Immutable. The resource name of the asset group.
   * Asset group resource names have the form:
   *
   * `customers/{customer_id}/assetGroups/{asset_group_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 asset group.
   * Asset group resource names have the form:
   *
   * `customers/{customer_id}/assetGroups/{asset_group_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 asset group.
   * 
   *
   * int64 id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The id.
   */
  long getId();

  /**
   *    * Immutable. The campaign with which this asset group is associated.
   * The asset which is linked to the asset group.
   * 
   *
   * string campaign = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
   * @return The campaign.
   */
  java.lang.String getCampaign();
  /**
   *    * Immutable. The campaign with which this asset group is associated.
   * The asset which is linked to the asset group.
   * 
   *
   * string campaign = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
   * @return The bytes for campaign.
   */
  com.google.protobuf.ByteString
      getCampaignBytes();

  /**
   *    * Required. Name of the asset group. Required. It must have a minimum length
   * of 1 and maximum length of 128. It must be unique under a campaign.
   * 
   *
   * string name = 3 [(.google.api.field_behavior) = REQUIRED];
   * @return The name.
   */
  java.lang.String getName();
  /**
   *    * Required. Name of the asset group. Required. It must have a minimum length
   * of 1 and maximum length of 128. It must be unique under a campaign.
   * 
   *
   * string name = 3 [(.google.api.field_behavior) = REQUIRED];
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString
      getNameBytes();

  /**
   *    * A list of final URLs after all cross domain redirects. In performance max,
   * by default, the urls are eligible for expansion unless opted out.
   * 
   *
   * repeated string final_urls = 4;
   * @return A list containing the finalUrls.
   */
  java.util.List
      getFinalUrlsList();
  /**
   *    * A list of final URLs after all cross domain redirects. In performance max,
   * by default, the urls are eligible for expansion unless opted out.
   * 
   *
   * repeated string final_urls = 4;
   * @return The count of finalUrls.
   */
  int getFinalUrlsCount();
  /**
   *    * A list of final URLs after all cross domain redirects. In performance max,
   * by default, the urls are eligible for expansion unless opted out.
   * 
   *
   * repeated string final_urls = 4;
   * @param index The index of the element to return.
   * @return The finalUrls at the given index.
   */
  java.lang.String getFinalUrls(int index);
  /**
   *    * A list of final URLs after all cross domain redirects. In performance max,
   * by default, the urls are eligible for expansion unless opted out.
   * 
   *
   * repeated string final_urls = 4;
   * @param index The index of the value to return.
   * @return The bytes of the finalUrls at the given index.
   */
  com.google.protobuf.ByteString
      getFinalUrlsBytes(int index);

  /**
   *    * A list of final mobile URLs after all cross domain redirects. In
   * performance max, by default, the urls are eligible for expansion
   * unless opted out.
   * 
   *
   * repeated string final_mobile_urls = 5;
   * @return A list containing the finalMobileUrls.
   */
  java.util.List
      getFinalMobileUrlsList();
  /**
   *    * A list of final mobile URLs after all cross domain redirects. In
   * performance max, by default, the urls are eligible for expansion
   * unless opted out.
   * 
   *
   * repeated string final_mobile_urls = 5;
   * @return The count of finalMobileUrls.
   */
  int getFinalMobileUrlsCount();
  /**
   *    * A list of final mobile URLs after all cross domain redirects. In
   * performance max, by default, the urls are eligible for expansion
   * unless opted out.
   * 
   *
   * repeated string final_mobile_urls = 5;
   * @param index The index of the element to return.
   * @return The finalMobileUrls at the given index.
   */
  java.lang.String getFinalMobileUrls(int index);
  /**
   *    * A list of final mobile URLs after all cross domain redirects. In
   * performance max, by default, the urls are eligible for expansion
   * unless opted out.
   * 
   *
   * repeated string final_mobile_urls = 5;
   * @param index The index of the value to return.
   * @return The bytes of the finalMobileUrls at the given index.
   */
  com.google.protobuf.ByteString
      getFinalMobileUrlsBytes(int index);

  /**
   *    * The status of the asset group.
   * 
   *
   * .google.ads.googleads.v17.enums.AssetGroupStatusEnum.AssetGroupStatus status = 6;
   * @return The enum numeric value on the wire for status.
   */
  int getStatusValue();
  /**
   *    * The status of the asset group.
   * 
   *
   * .google.ads.googleads.v17.enums.AssetGroupStatusEnum.AssetGroupStatus status = 6;
   * @return The status.
   */
  com.google.ads.googleads.v17.enums.AssetGroupStatusEnum.AssetGroupStatus getStatus();

  /**
   *    * Output only. The primary status of the asset group. Provides insights into
   * why an asset group is not serving or not serving optimally.
   * 
   *
   * .google.ads.googleads.v17.enums.AssetGroupPrimaryStatusEnum.AssetGroupPrimaryStatus primary_status = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The enum numeric value on the wire for primaryStatus.
   */
  int getPrimaryStatusValue();
  /**
   *    * Output only. The primary status of the asset group. Provides insights into
   * why an asset group is not serving or not serving optimally.
   * 
   *
   * .google.ads.googleads.v17.enums.AssetGroupPrimaryStatusEnum.AssetGroupPrimaryStatus primary_status = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The primaryStatus.
   */
  com.google.ads.googleads.v17.enums.AssetGroupPrimaryStatusEnum.AssetGroupPrimaryStatus getPrimaryStatus();

  /**
   *    * Output only. Provides reasons into why an asset group is not serving or not
   * serving optimally. It will be empty when the asset group is serving without
   * issues.
   * 
   *
   * repeated .google.ads.googleads.v17.enums.AssetGroupPrimaryStatusReasonEnum.AssetGroupPrimaryStatusReason primary_status_reasons = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return A list containing the primaryStatusReasons.
   */
  java.util.List getPrimaryStatusReasonsList();
  /**
   *    * Output only. Provides reasons into why an asset group is not serving or not
   * serving optimally. It will be empty when the asset group is serving without
   * issues.
   * 
   *
   * repeated .google.ads.googleads.v17.enums.AssetGroupPrimaryStatusReasonEnum.AssetGroupPrimaryStatusReason primary_status_reasons = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The count of primaryStatusReasons.
   */
  int getPrimaryStatusReasonsCount();
  /**
   *    * Output only. Provides reasons into why an asset group is not serving or not
   * serving optimally. It will be empty when the asset group is serving without
   * issues.
   * 
   *
   * repeated .google.ads.googleads.v17.enums.AssetGroupPrimaryStatusReasonEnum.AssetGroupPrimaryStatusReason primary_status_reasons = 12 [(.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.AssetGroupPrimaryStatusReasonEnum.AssetGroupPrimaryStatusReason getPrimaryStatusReasons(int index);
  /**
   *    * Output only. Provides reasons into why an asset group is not serving or not
   * serving optimally. It will be empty when the asset group is serving without
   * issues.
   * 
   *
   * repeated .google.ads.googleads.v17.enums.AssetGroupPrimaryStatusReasonEnum.AssetGroupPrimaryStatusReason primary_status_reasons = 12 [(.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 into why an asset group is not serving or not
   * serving optimally. It will be empty when the asset group is serving without
   * issues.
   * 
   *
   * repeated .google.ads.googleads.v17.enums.AssetGroupPrimaryStatusReasonEnum.AssetGroupPrimaryStatusReason primary_status_reasons = 12 [(.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);

  /**
   *    * First part of text that may appear appended to the url displayed in
   * the ad.
   * 
   *
   * string path1 = 7;
   * @return The path1.
   */
  java.lang.String getPath1();
  /**
   *    * First part of text that may appear appended to the url displayed in
   * the ad.
   * 
   *
   * string path1 = 7;
   * @return The bytes for path1.
   */
  com.google.protobuf.ByteString
      getPath1Bytes();

  /**
   *    * Second part of text that may appear appended to the url displayed in
   * the ad. This field can only be set when path1 is set.
   * 
   *
   * string path2 = 8;
   * @return The path2.
   */
  java.lang.String getPath2();
  /**
   *    * Second part of text that may appear appended to the url displayed in
   * the ad. This field can only be set when path1 is set.
   * 
   *
   * string path2 = 8;
   * @return The bytes for path2.
   */
  com.google.protobuf.ByteString
      getPath2Bytes();

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