Package com.google.ads.googleads.v10.resources

Class AdGroupAd

  • All Implemented Interfaces:
    AdGroupAdOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    public final class AdGroupAd
extends com.google.protobuf.GeneratedMessageV3
implements AdGroupAdOrBuilder
     An ad group ad.
    Protobuf type google.ads.googleads.v10.resources.AdGroupAd
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  AdGroupAd.Builder
      An ad group ad.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Detail

      • newInstance

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

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields 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 ad.
 Ad group ad resource names have the form:
 `customers/{customer_id}/adGroupAds/{ad_group_id}~{ad_id}`
        string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getResourceName in interface AdGroupAdOrBuilder
        Returns:
        The resourceName.

      • getResourceNameBytes

        public com.google.protobuf.ByteString getResourceNameBytes()
         Immutable. The resource name of the ad.
 Ad group ad resource names have the form:
 `customers/{customer_id}/adGroupAds/{ad_group_id}~{ad_id}`
        string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getResourceNameBytes in interface AdGroupAdOrBuilder
        Returns:
        The bytes for resourceName.

      • getStatusValue

        public int getStatusValue()
         The status of the ad.
        .google.ads.googleads.v10.enums.AdGroupAdStatusEnum.AdGroupAdStatus status = 3;
        Specified by:
        getStatusValue in interface AdGroupAdOrBuilder
        Returns:
        The enum numeric value on the wire for status.

      • hasAdGroup

        public boolean hasAdGroup()
         Immutable. The ad group to which the ad belongs.
        optional string ad_group = 9 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        hasAdGroup in interface AdGroupAdOrBuilder
        Returns:
        Whether the adGroup field is set.

      • getAdGroup

        public java.lang.String getAdGroup()
         Immutable. The ad group to which the ad belongs.
        optional string ad_group = 9 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getAdGroup in interface AdGroupAdOrBuilder
        Returns:
        The adGroup.

      • getAdGroupBytes

        public com.google.protobuf.ByteString getAdGroupBytes()
         Immutable. The ad group to which the ad belongs.
        optional string ad_group = 9 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getAdGroupBytes in interface AdGroupAdOrBuilder
        Returns:
        The bytes for adGroup.

      • hasAd

        public boolean hasAd()
         Immutable. The ad.
        .google.ads.googleads.v10.resources.Ad ad = 5 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        hasAd in interface AdGroupAdOrBuilder
        Returns:
        Whether the ad field is set.

      • getAd

        public Ad getAd()
         Immutable. The ad.
        .google.ads.googleads.v10.resources.Ad ad = 5 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getAd in interface AdGroupAdOrBuilder
        Returns:
        The ad.

      • getAdOrBuilder

        public AdOrBuilder getAdOrBuilder()
         Immutable. The ad.
        .google.ads.googleads.v10.resources.Ad ad = 5 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getAdOrBuilder in interface AdGroupAdOrBuilder

      • hasPolicySummary

        public boolean hasPolicySummary()
         Output only. Policy information for the ad.
        .google.ads.googleads.v10.resources.AdGroupAdPolicySummary policy_summary = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasPolicySummary in interface AdGroupAdOrBuilder
        Returns:
        Whether the policySummary field is set.

      • getPolicySummary

        public AdGroupAdPolicySummary getPolicySummary()
         Output only. Policy information for the ad.
        .google.ads.googleads.v10.resources.AdGroupAdPolicySummary policy_summary = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getPolicySummary in interface AdGroupAdOrBuilder
        Returns:
        The policySummary.

      • getAdStrengthValue

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

      • getAdStrength

        public AdStrengthEnum.AdStrength getAdStrength()
         Output only. Overall ad strength for this ad group ad.
        .google.ads.googleads.v10.enums.AdStrengthEnum.AdStrength ad_strength = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getAdStrength in interface AdGroupAdOrBuilder
        Returns:
        The adStrength.

      • getActionItemsList

        public com.google.protobuf.ProtocolStringList getActionItemsList()
         Output only. A list of recommendations to improve the ad strength. For example, a
 recommendation could be "Your headlines are a little too similar.
 Try adding more distinct headlines.".
        repeated string action_items = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getActionItemsList in interface AdGroupAdOrBuilder
        Returns:
        A list containing the actionItems.

      • getActionItemsCount

        public int getActionItemsCount()
         Output only. A list of recommendations to improve the ad strength. For example, a
 recommendation could be "Your headlines are a little too similar.
 Try adding more distinct headlines.".
        repeated string action_items = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getActionItemsCount in interface AdGroupAdOrBuilder
        Returns:
        The count of actionItems.

      • getActionItems

        public java.lang.String getActionItems​(int index)
         Output only. A list of recommendations to improve the ad strength. For example, a
 recommendation could be "Your headlines are a little too similar.
 Try adding more distinct headlines.".
        repeated string action_items = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getActionItems in interface AdGroupAdOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The actionItems at the given index.

      • getActionItemsBytes

        public com.google.protobuf.ByteString getActionItemsBytes​(int index)
         Output only. A list of recommendations to improve the ad strength. For example, a
 recommendation could be "Your headlines are a little too similar.
 Try adding more distinct headlines.".
        repeated string action_items = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getActionItemsBytes in interface AdGroupAdOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the actionItems at the given index.

      • getLabelsList

        public com.google.protobuf.ProtocolStringList getLabelsList()
         Output only. The resource names of labels attached to this ad group ad.
        repeated string labels = 10 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getLabelsList in interface AdGroupAdOrBuilder
        Returns:
        A list containing the labels.

      • getLabelsCount

        public int getLabelsCount()
         Output only. The resource names of labels attached to this ad group ad.
        repeated string labels = 10 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getLabelsCount in interface AdGroupAdOrBuilder
        Returns:
        The count of labels.

      • getLabels

        public java.lang.String getLabels​(int index)
         Output only. The resource names of labels attached to this ad group ad.
        repeated string labels = 10 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getLabels in interface AdGroupAdOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The labels at the given index.

      • getLabelsBytes

        public com.google.protobuf.ByteString getLabelsBytes​(int index)
         Output only. The resource names of labels attached to this ad group ad.
        repeated string labels = 10 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getLabelsBytes in interface AdGroupAdOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the labels at the given index.

      • 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 AdGroupAd parseFrom​(java.nio.ByteBuffer data)
                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static AdGroupAd getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<AdGroupAd> parser()

      • getParserForType

        public com.google.protobuf.Parser<AdGroupAd> 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 AdGroupAd getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder