Interface AssetGroupOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
AssetGroup, AssetGroup.Builder

public interface AssetGroupOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Details

    • getResourceName

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

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

      long getId()
       Output only. The ID of the asset group.
       
      int64 id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The id.
    • getCampaign

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

      com.google.protobuf.ByteString getCampaignBytes()
       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) = { ... }
      Returns:
      The bytes for campaign.
    • getName

      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];
      Returns:
      The name.
    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       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];
      Returns:
      The bytes for name.
    • getFinalUrlsList

      List<String> 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;
      Returns:
      A list containing the finalUrls.
    • getFinalUrlsCount

      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;
      Returns:
      The count of finalUrls.
    • getFinalUrls

      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;
      Parameters:
      index - The index of the element to return.
      Returns:
      The finalUrls at the given index.
    • getFinalUrlsBytes

      com.google.protobuf.ByteString getFinalUrlsBytes(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;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the finalUrls at the given index.
    • getFinalMobileUrlsList

      List<String> 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;
      Returns:
      A list containing the finalMobileUrls.
    • getFinalMobileUrlsCount

      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;
      Returns:
      The count of finalMobileUrls.
    • getFinalMobileUrls

      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;
      Parameters:
      index - The index of the element to return.
      Returns:
      The finalMobileUrls at the given index.
    • getFinalMobileUrlsBytes

      com.google.protobuf.ByteString getFinalMobileUrlsBytes(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;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the finalMobileUrls at the given index.
    • getStatusValue

      int getStatusValue()
       The status of the asset group.
       
      .google.ads.googleads.v18.enums.AssetGroupStatusEnum.AssetGroupStatus status = 6;
      Returns:
      The enum numeric value on the wire for status.
    • getStatus

       The status of the asset group.
       
      .google.ads.googleads.v18.enums.AssetGroupStatusEnum.AssetGroupStatus status = 6;
      Returns:
      The status.
    • getPrimaryStatusValue

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

       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.v18.enums.AssetGroupPrimaryStatusEnum.AssetGroupPrimaryStatus primary_status = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The primaryStatus.
    • 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.v18.enums.AssetGroupPrimaryStatusReasonEnum.AssetGroupPrimaryStatusReason primary_status_reasons = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      A list containing the primaryStatusReasons.
    • getPrimaryStatusReasonsCount

      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.v18.enums.AssetGroupPrimaryStatusReasonEnum.AssetGroupPrimaryStatusReason primary_status_reasons = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The count of primaryStatusReasons.
    • getPrimaryStatusReasons

       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.v18.enums.AssetGroupPrimaryStatusReasonEnum.AssetGroupPrimaryStatusReason primary_status_reasons = 12 [(.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 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.v18.enums.AssetGroupPrimaryStatusReasonEnum.AssetGroupPrimaryStatusReason primary_status_reasons = 12 [(.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 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.v18.enums.AssetGroupPrimaryStatusReasonEnum.AssetGroupPrimaryStatusReason primary_status_reasons = 12 [(.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.
    • getPath1

      String getPath1()
       First part of text that may appear appended to the url displayed in
       the ad.
       
      string path1 = 7;
      Returns:
      The path1.
    • getPath1Bytes

      com.google.protobuf.ByteString getPath1Bytes()
       First part of text that may appear appended to the url displayed in
       the ad.
       
      string path1 = 7;
      Returns:
      The bytes for path1.
    • getPath2

      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;
      Returns:
      The path2.
    • getPath2Bytes

      com.google.protobuf.ByteString getPath2Bytes()
       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;
      Returns:
      The bytes for path2.
    • getAdStrengthValue

      int getAdStrengthValue()
       Output only. Overall ad strength of this asset group.
       
      .google.ads.googleads.v18.enums.AdStrengthEnum.AdStrength ad_strength = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for adStrength.
    • getAdStrength

      AdStrengthEnum.AdStrength getAdStrength()
       Output only. Overall ad strength of this asset group.
       
      .google.ads.googleads.v18.enums.AdStrengthEnum.AdStrength ad_strength = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The adStrength.