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

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

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

  /**
   *    * Immutable. The resource name of the campaign asset.
   * CampaignAsset resource names have the form:
   *
   * `customers/{customer_id}/campaignAssets/{campaign_id}~{asset_id}~{field_type}`
   * 
   *
   * 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 campaign asset.
   * CampaignAsset resource names have the form:
   *
   * `customers/{customer_id}/campaignAssets/{campaign_id}~{asset_id}~{field_type}`
   * 
   *
   * string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
   * @return The bytes for resourceName.
   */
  com.google.protobuf.ByteString
      getResourceNameBytes();

  /**
   *    * Immutable. The campaign to which the asset is linked.
   * 
   *
   * optional string campaign = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
   * @return Whether the campaign field is set.
   */
  boolean hasCampaign();
  /**
   *    * Immutable. The campaign to which the asset is linked.
   * 
   *
   * optional string campaign = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
   * @return The campaign.
   */
  java.lang.String getCampaign();
  /**
   *    * Immutable. The campaign to which the asset is linked.
   * 
   *
   * optional string campaign = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
   * @return The bytes for campaign.
   */
  com.google.protobuf.ByteString
      getCampaignBytes();

  /**
   *    * Immutable. The asset which is linked to the campaign.
   * 
   *
   * optional string asset = 7 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
   * @return Whether the asset field is set.
   */
  boolean hasAsset();
  /**
   *    * Immutable. The asset which is linked to the campaign.
   * 
   *
   * optional string asset = 7 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
   * @return The asset.
   */
  java.lang.String getAsset();
  /**
   *    * Immutable. The asset which is linked to the campaign.
   * 
   *
   * optional string asset = 7 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
   * @return The bytes for asset.
   */
  com.google.protobuf.ByteString
      getAssetBytes();

  /**
   *    * Immutable. Role that the asset takes under the linked campaign.
   * Required.
   * 
   *
   * .google.ads.googleads.v17.enums.AssetFieldTypeEnum.AssetFieldType field_type = 4 [(.google.api.field_behavior) = IMMUTABLE];
   * @return The enum numeric value on the wire for fieldType.
   */
  int getFieldTypeValue();
  /**
   *    * Immutable. Role that the asset takes under the linked campaign.
   * Required.
   * 
   *
   * .google.ads.googleads.v17.enums.AssetFieldTypeEnum.AssetFieldType field_type = 4 [(.google.api.field_behavior) = IMMUTABLE];
   * @return The fieldType.
   */
  com.google.ads.googleads.v17.enums.AssetFieldTypeEnum.AssetFieldType getFieldType();

  /**
   *    * Output only. Source of the campaign asset link.
   * 
   *
   * .google.ads.googleads.v17.enums.AssetSourceEnum.AssetSource source = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The enum numeric value on the wire for source.
   */
  int getSourceValue();
  /**
   *    * Output only. Source of the campaign asset link.
   * 
   *
   * .google.ads.googleads.v17.enums.AssetSourceEnum.AssetSource source = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The source.
   */
  com.google.ads.googleads.v17.enums.AssetSourceEnum.AssetSource getSource();

  /**
   *    * Status of the campaign asset.
   * 
   *
   * .google.ads.googleads.v17.enums.AssetLinkStatusEnum.AssetLinkStatus status = 5;
   * @return The enum numeric value on the wire for status.
   */
  int getStatusValue();
  /**
   *    * Status of the campaign asset.
   * 
   *
   * .google.ads.googleads.v17.enums.AssetLinkStatusEnum.AssetLinkStatus status = 5;
   * @return The status.
   */
  com.google.ads.googleads.v17.enums.AssetLinkStatusEnum.AssetLinkStatus getStatus();

  /**
   *    * Output only. Provides the PrimaryStatus of this asset link.
   * Primary status is meant essentially to differentiate between the plain
   * "status" field, which has advertiser set values of enabled, paused, or
   * removed.  The primary status takes into account other signals (for assets
   * its mainly policy and quality approvals) to come up with a more
   * comprehensive status to indicate its serving state.
   * 
   *
   * .google.ads.googleads.v17.enums.AssetLinkPrimaryStatusEnum.AssetLinkPrimaryStatus primary_status = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The enum numeric value on the wire for primaryStatus.
   */
  int getPrimaryStatusValue();
  /**
   *    * Output only. Provides the PrimaryStatus of this asset link.
   * Primary status is meant essentially to differentiate between the plain
   * "status" field, which has advertiser set values of enabled, paused, or
   * removed.  The primary status takes into account other signals (for assets
   * its mainly policy and quality approvals) to come up with a more
   * comprehensive status to indicate its serving state.
   * 
   *
   * .google.ads.googleads.v17.enums.AssetLinkPrimaryStatusEnum.AssetLinkPrimaryStatus primary_status = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The primaryStatus.
   */
  com.google.ads.googleads.v17.enums.AssetLinkPrimaryStatusEnum.AssetLinkPrimaryStatus getPrimaryStatus();

  /**
   *    * Output only. Provides the details of the primary status and its associated
   * reasons.
   * 
   *
   * repeated .google.ads.googleads.v17.common.AssetLinkPrimaryStatusDetails primary_status_details = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
   */
  java.util.List 
      getPrimaryStatusDetailsList();
  /**
   *    * Output only. Provides the details of the primary status and its associated
   * reasons.
   * 
   *
   * repeated .google.ads.googleads.v17.common.AssetLinkPrimaryStatusDetails primary_status_details = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
   */
  com.google.ads.googleads.v17.common.AssetLinkPrimaryStatusDetails getPrimaryStatusDetails(int index);
  /**
   *    * Output only. Provides the details of the primary status and its associated
   * reasons.
   * 
   *
   * repeated .google.ads.googleads.v17.common.AssetLinkPrimaryStatusDetails primary_status_details = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
   */
  int getPrimaryStatusDetailsCount();
  /**
   *    * Output only. Provides the details of the primary status and its associated
   * reasons.
   * 
   *
   * repeated .google.ads.googleads.v17.common.AssetLinkPrimaryStatusDetails primary_status_details = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
   */
  java.util.List 
      getPrimaryStatusDetailsOrBuilderList();
  /**
   *    * Output only. Provides the details of the primary status and its associated
   * reasons.
   * 
   *
   * repeated .google.ads.googleads.v17.common.AssetLinkPrimaryStatusDetails primary_status_details = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
   */
  com.google.ads.googleads.v17.common.AssetLinkPrimaryStatusDetailsOrBuilder getPrimaryStatusDetailsOrBuilder(
      int index);

  /**
   *    * Output only. Provides a list of reasons for why an asset is not serving or
   * not serving at full capacity.
   * 
   *
   * repeated .google.ads.googleads.v17.enums.AssetLinkPrimaryStatusReasonEnum.AssetLinkPrimaryStatusReason primary_status_reasons = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return A list containing the primaryStatusReasons.
   */
  java.util.List getPrimaryStatusReasonsList();
  /**
   *    * Output only. Provides a list of reasons for why an asset is not serving or
   * not serving at full capacity.
   * 
   *
   * repeated .google.ads.googleads.v17.enums.AssetLinkPrimaryStatusReasonEnum.AssetLinkPrimaryStatusReason primary_status_reasons = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The count of primaryStatusReasons.
   */
  int getPrimaryStatusReasonsCount();
  /**
   *    * Output only. Provides a list of reasons for why an asset is not serving or
   * not serving at full capacity.
   * 
   *
   * repeated .google.ads.googleads.v17.enums.AssetLinkPrimaryStatusReasonEnum.AssetLinkPrimaryStatusReason primary_status_reasons = 11 [(.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.AssetLinkPrimaryStatusReasonEnum.AssetLinkPrimaryStatusReason getPrimaryStatusReasons(int index);
  /**
   *    * Output only. Provides a list of reasons for why an asset is not serving or
   * not serving at full capacity.
   * 
   *
   * repeated .google.ads.googleads.v17.enums.AssetLinkPrimaryStatusReasonEnum.AssetLinkPrimaryStatusReason primary_status_reasons = 11 [(.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 a list of reasons for why an asset is not serving or
   * not serving at full capacity.
   * 
   *
   * repeated .google.ads.googleads.v17.enums.AssetLinkPrimaryStatusReasonEnum.AssetLinkPrimaryStatusReason primary_status_reasons = 11 [(.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);
}