Class AssetGroup

  • All Implemented Interfaces:
    AssetGroupOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable

    public final class AssetGroup
    extends com.google.protobuf.GeneratedMessageV3
    implements AssetGroupOrBuilder
     An asset group.
     AssetGroupAsset is used to link an asset to the asset group.
     AssetGroupSignal is used to associate a signal to an asset group.
     
    Protobuf type google.ads.googleads.v14.resources.AssetGroup
    See Also:
    Serialized Form
    • Method Detail

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • getResourceName

        public 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) = { ... }
        Specified by:
        getResourceName in interface AssetGroupOrBuilder
        Returns:
        The resourceName.
      • getResourceNameBytes

        public 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) = { ... }
        Specified by:
        getResourceNameBytes in interface AssetGroupOrBuilder
        Returns:
        The bytes for resourceName.
      • getId

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

        public 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) = { ... }
        Specified by:
        getCampaign in interface AssetGroupOrBuilder
        Returns:
        The campaign.
      • getCampaignBytes

        public 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) = { ... }
        Specified by:
        getCampaignBytes in interface AssetGroupOrBuilder
        Returns:
        The bytes for campaign.
      • getName

        public 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];
        Specified by:
        getName in interface AssetGroupOrBuilder
        Returns:
        The name.
      • getNameBytes

        public 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];
        Specified by:
        getNameBytes in interface AssetGroupOrBuilder
        Returns:
        The bytes for name.
      • getFinalUrlsList

        public com.google.protobuf.ProtocolStringList 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;
        Specified by:
        getFinalUrlsList in interface AssetGroupOrBuilder
        Returns:
        A list containing the finalUrls.
      • getFinalUrlsCount

        public 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;
        Specified by:
        getFinalUrlsCount in interface AssetGroupOrBuilder
        Returns:
        The count of finalUrls.
      • getFinalUrls

        public 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;
        Specified by:
        getFinalUrls in interface AssetGroupOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The finalUrls at the given index.
      • getFinalUrlsBytes

        public 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;
        Specified by:
        getFinalUrlsBytes in interface AssetGroupOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the finalUrls at the given index.
      • getFinalMobileUrlsList

        public com.google.protobuf.ProtocolStringList 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;
        Specified by:
        getFinalMobileUrlsList in interface AssetGroupOrBuilder
        Returns:
        A list containing the finalMobileUrls.
      • getFinalMobileUrlsCount

        public 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;
        Specified by:
        getFinalMobileUrlsCount in interface AssetGroupOrBuilder
        Returns:
        The count of finalMobileUrls.
      • getFinalMobileUrls

        public 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;
        Specified by:
        getFinalMobileUrls in interface AssetGroupOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The finalMobileUrls at the given index.
      • getFinalMobileUrlsBytes

        public 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;
        Specified by:
        getFinalMobileUrlsBytes in interface AssetGroupOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the finalMobileUrls at the given index.
      • getStatusValue

        public int getStatusValue()
         The status of the asset group.
         
        .google.ads.googleads.v14.enums.AssetGroupStatusEnum.AssetGroupStatus status = 6;
        Specified by:
        getStatusValue in interface AssetGroupOrBuilder
        Returns:
        The enum numeric value on the wire for status.
      • getPrimaryStatusValue

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

        public AssetGroupPrimaryStatusEnum.AssetGroupPrimaryStatus 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.v14.enums.AssetGroupPrimaryStatusEnum.AssetGroupPrimaryStatus primary_status = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getPrimaryStatus in interface AssetGroupOrBuilder
        Returns:
        The primaryStatus.
      • getPrimaryStatusReasonsList

        public java.util.List<AssetGroupPrimaryStatusReasonEnum.AssetGroupPrimaryStatusReason> 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.v14.enums.AssetGroupPrimaryStatusReasonEnum.AssetGroupPrimaryStatusReason primary_status_reasons = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getPrimaryStatusReasonsList in interface AssetGroupOrBuilder
        Returns:
        A list containing the primaryStatusReasons.
      • getPrimaryStatusReasonsCount

        public 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.v14.enums.AssetGroupPrimaryStatusReasonEnum.AssetGroupPrimaryStatusReason primary_status_reasons = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getPrimaryStatusReasonsCount in interface AssetGroupOrBuilder
        Returns:
        The count of primaryStatusReasons.
      • getPrimaryStatusReasons

        public 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.v14.enums.AssetGroupPrimaryStatusReasonEnum.AssetGroupPrimaryStatusReason primary_status_reasons = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getPrimaryStatusReasons in interface AssetGroupOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The primaryStatusReasons at the given index.
      • getPrimaryStatusReasonsValueList

        public java.util.List<java.lang.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.v14.enums.AssetGroupPrimaryStatusReasonEnum.AssetGroupPrimaryStatusReason primary_status_reasons = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getPrimaryStatusReasonsValueList in interface AssetGroupOrBuilder
        Returns:
        A list containing the enum numeric values on the wire for primaryStatusReasons.
      • getPrimaryStatusReasonsValue

        public 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.v14.enums.AssetGroupPrimaryStatusReasonEnum.AssetGroupPrimaryStatusReason primary_status_reasons = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getPrimaryStatusReasonsValue in interface AssetGroupOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The enum numeric value on the wire of primaryStatusReasons at the given index.
      • getPath1

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

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

        public 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;
        Specified by:
        getPath2 in interface AssetGroupOrBuilder
        Returns:
        The path2.
      • getPath2Bytes

        public 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;
        Specified by:
        getPath2Bytes in interface AssetGroupOrBuilder
        Returns:
        The bytes for path2.
      • getAdStrengthValue

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

        public AdStrengthEnum.AdStrength getAdStrength()
         Output only. Overall ad strength of this asset group.
         
        .google.ads.googleads.v14.enums.AdStrengthEnum.AdStrength ad_strength = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getAdStrength in interface AssetGroupOrBuilder
        Returns:
        The adStrength.
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • equals

        public boolean equals​(java.lang.Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage
      • parseFrom

        public static AssetGroup parseFrom​(java.nio.ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static AssetGroup parseFrom​(java.nio.ByteBuffer data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static AssetGroup parseFrom​(com.google.protobuf.ByteString data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static AssetGroup parseFrom​(com.google.protobuf.ByteString data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static AssetGroup parseFrom​(byte[] data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static AssetGroup parseFrom​(byte[] data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static AssetGroup parseFrom​(java.io.InputStream input)
                                    throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static AssetGroup parseFrom​(java.io.InputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

        public static AssetGroup parseDelimitedFrom​(java.io.InputStream input)
                                             throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

        public static AssetGroup parseDelimitedFrom​(java.io.InputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static AssetGroup parseFrom​(com.google.protobuf.CodedInputStream input)
                                    throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static AssetGroup parseFrom​(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws java.io.IOException
        Throws:
        java.io.IOException
      • newBuilderForType

        public AssetGroup.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public AssetGroup.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected AssetGroup.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstance

        public static AssetGroup getDefaultInstance()
      • parser

        public static com.google.protobuf.Parser<AssetGroup> parser()
      • getParserForType

        public com.google.protobuf.Parser<AssetGroup> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstanceForType

        public AssetGroup getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder