Package com.google.ads.googleads.v18.resources

Interface CampaignAssetOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
CampaignAsset, CampaignAsset.Builder
public interface CampaignAssetOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getResourceName

      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) = { ... }
      Returns:
      The resourceName.

    • getResourceNameBytes

      com.google.protobuf.ByteString getResourceNameBytes()
       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) = { ... }
      Returns:
      The bytes for resourceName.

    • hasCampaign

      boolean hasCampaign()
       Immutable. The campaign to which the asset is linked.
      optional string campaign = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Returns:
      Whether the campaign field is set.

    • getCampaign

      String getCampaign()
       Immutable. The campaign to which the asset is linked.
      optional string campaign = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Returns:
      The campaign.

    • getCampaignBytes

      com.google.protobuf.ByteString getCampaignBytes()
       Immutable. The campaign to which the asset is linked.
      optional string campaign = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for campaign.

    • hasAsset

      boolean hasAsset()
       Immutable. The asset which is linked to the campaign.
      optional string asset = 7 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Returns:
      Whether the asset field is set.

    • getAsset

      String getAsset()
       Immutable. The asset which is linked to the campaign.
      optional string asset = 7 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Returns:
      The asset.

    • getAssetBytes

      com.google.protobuf.ByteString getAssetBytes()
       Immutable. The asset which is linked to the campaign.
      optional string asset = 7 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for asset.

    • getFieldTypeValue

      int getFieldTypeValue()
       Immutable. Role that the asset takes under the linked campaign.
 Required.
      .google.ads.googleads.v18.enums.AssetFieldTypeEnum.AssetFieldType field_type = 4 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The enum numeric value on the wire for fieldType.

    • getFieldType

      AssetFieldTypeEnum.AssetFieldType getFieldType()
       Immutable. Role that the asset takes under the linked campaign.
 Required.
      .google.ads.googleads.v18.enums.AssetFieldTypeEnum.AssetFieldType field_type = 4 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The fieldType.

    • getSourceValue

      int getSourceValue()
       Output only. Source of the campaign asset link.
      .google.ads.googleads.v18.enums.AssetSourceEnum.AssetSource source = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for source.

    • getSource

      AssetSourceEnum.AssetSource getSource()
       Output only. Source of the campaign asset link.
      .google.ads.googleads.v18.enums.AssetSourceEnum.AssetSource source = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The source.

    • getStatusValue

      int getStatusValue()
       Status of the campaign asset.
      .google.ads.googleads.v18.enums.AssetLinkStatusEnum.AssetLinkStatus status = 5;
      Returns:
      The enum numeric value on the wire for status.

    • getStatus

      AssetLinkStatusEnum.AssetLinkStatus getStatus()
       Status of the campaign asset.
      .google.ads.googleads.v18.enums.AssetLinkStatusEnum.AssetLinkStatus status = 5;
      Returns:
      The status.

    • getPrimaryStatusValue

      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.v18.enums.AssetLinkPrimaryStatusEnum.AssetLinkPrimaryStatus primary_status = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for primaryStatus.

    • getPrimaryStatus

      AssetLinkPrimaryStatusEnum.AssetLinkPrimaryStatus getPrimaryStatus()
       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.v18.enums.AssetLinkPrimaryStatusEnum.AssetLinkPrimaryStatus primary_status = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The primaryStatus.

    • getPrimaryStatusDetailsList

      List<AssetLinkPrimaryStatusDetails> getPrimaryStatusDetailsList()
       Output only. Provides the details of the primary status and its associated
 reasons.
      repeated .google.ads.googleads.v18.common.AssetLinkPrimaryStatusDetails primary_status_details = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getPrimaryStatusDetails

      AssetLinkPrimaryStatusDetails getPrimaryStatusDetails(int index)
       Output only. Provides the details of the primary status and its associated
 reasons.
      repeated .google.ads.googleads.v18.common.AssetLinkPrimaryStatusDetails primary_status_details = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getPrimaryStatusDetailsCount

      int getPrimaryStatusDetailsCount()
       Output only. Provides the details of the primary status and its associated
 reasons.
      repeated .google.ads.googleads.v18.common.AssetLinkPrimaryStatusDetails primary_status_details = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getPrimaryStatusDetailsOrBuilderList

      List<? extends AssetLinkPrimaryStatusDetailsOrBuilder> getPrimaryStatusDetailsOrBuilderList()
       Output only. Provides the details of the primary status and its associated
 reasons.
      repeated .google.ads.googleads.v18.common.AssetLinkPrimaryStatusDetails primary_status_details = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getPrimaryStatusDetailsOrBuilder

      AssetLinkPrimaryStatusDetailsOrBuilder getPrimaryStatusDetailsOrBuilder(int index)
       Output only. Provides the details of the primary status and its associated
 reasons.
      repeated .google.ads.googleads.v18.common.AssetLinkPrimaryStatusDetails primary_status_details = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getPrimaryStatusReasonsList

      List<AssetLinkPrimaryStatusReasonEnum.AssetLinkPrimaryStatusReason> 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.v18.enums.AssetLinkPrimaryStatusReasonEnum.AssetLinkPrimaryStatusReason primary_status_reasons = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      A list containing the primaryStatusReasons.

    • getPrimaryStatusReasonsCount

      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.v18.enums.AssetLinkPrimaryStatusReasonEnum.AssetLinkPrimaryStatusReason primary_status_reasons = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The count of primaryStatusReasons.

    • getPrimaryStatusReasons

      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.v18.enums.AssetLinkPrimaryStatusReasonEnum.AssetLinkPrimaryStatusReason primary_status_reasons = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      index - The index of the element to return.
      Returns:
      The primaryStatusReasons at the given index.

    • getPrimaryStatusReasonsValueList

      List<Integer> 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.v18.enums.AssetLinkPrimaryStatusReasonEnum.AssetLinkPrimaryStatusReason primary_status_reasons = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      A list containing the enum numeric values on the wire for primaryStatusReasons.

    • getPrimaryStatusReasonsValue

      int getPrimaryStatusReasonsValue(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.v18.enums.AssetLinkPrimaryStatusReasonEnum.AssetLinkPrimaryStatusReason primary_status_reasons = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of primaryStatusReasons at the given index.