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

Class AdGroupAd

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.ads.googleads.v18.resources.AdGroupAd
All Implemented Interfaces:
AdGroupAdOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class AdGroupAd extends com.google.protobuf.GeneratedMessageV3 implements AdGroupAdOrBuilder
 An ad group ad.
Protobuf type google.ads.googleads.v18.resources.AdGroupAd
See Also:

  • Field Details

    • RESOURCE_NAME_FIELD_NUMBER

      public static final int RESOURCE_NAME_FIELD_NUMBER
      See Also:

    • STATUS_FIELD_NUMBER

      public static final int STATUS_FIELD_NUMBER
      See Also:

    • AD_GROUP_FIELD_NUMBER

      public static final int AD_GROUP_FIELD_NUMBER
      See Also:

    • AD_FIELD_NUMBER

      public static final int AD_FIELD_NUMBER
      See Also:

    • POLICY_SUMMARY_FIELD_NUMBER

      public static final int POLICY_SUMMARY_FIELD_NUMBER
      See Also:

    • AD_STRENGTH_FIELD_NUMBER

      public static final int AD_STRENGTH_FIELD_NUMBER
      See Also:

    • ACTION_ITEMS_FIELD_NUMBER

      public static final int ACTION_ITEMS_FIELD_NUMBER
      See Also:

    • LABELS_FIELD_NUMBER

      public static final int LABELS_FIELD_NUMBER
      See Also:

    • PRIMARY_STATUS_FIELD_NUMBER

      public static final int PRIMARY_STATUS_FIELD_NUMBER
      See Also:

    • PRIMARY_STATUS_REASONS_FIELD_NUMBER

      public static final int PRIMARY_STATUS_REASONS_FIELD_NUMBER
      See Also:

    • AD_GROUP_AD_ASSET_AUTOMATION_SETTINGS_FIELD_NUMBER

      public static final int AD_GROUP_AD_ASSET_AUTOMATION_SETTINGS_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected 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 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.v18.enums.AdGroupAdStatusEnum.AdGroupAdStatus status = 3;
      Specified by:
      getStatusValue in interface AdGroupAdOrBuilder
      Returns:
      The enum numeric value on the wire for status.

    • getStatus

      public AdGroupAdStatusEnum.AdGroupAdStatus getStatus()
       The status of the ad.
      .google.ads.googleads.v18.enums.AdGroupAdStatusEnum.AdGroupAdStatus status = 3;
      Specified by:
      getStatus in interface AdGroupAdOrBuilder
      Returns:
      The 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 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.v18.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.v18.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.v18.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.v18.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.v18.resources.AdGroupAdPolicySummary policy_summary = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getPolicySummary in interface AdGroupAdOrBuilder
      Returns:
      The policySummary.

    • getPolicySummaryOrBuilder

      public AdGroupAdPolicySummaryOrBuilder getPolicySummaryOrBuilder()
       Output only. Policy information for the ad.
      .google.ads.googleads.v18.resources.AdGroupAdPolicySummary policy_summary = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getPolicySummaryOrBuilder in interface AdGroupAdOrBuilder

    • getAdStrengthValue

      public int getAdStrengthValue()
       Output only. Overall ad strength for this ad group ad.
      .google.ads.googleads.v18.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.v18.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 "Try adding a few more unique headlines
 or unpinning some assets.".
      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 "Try adding a few more unique headlines
 or unpinning some assets.".
      repeated string action_items = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getActionItemsCount in interface AdGroupAdOrBuilder
      Returns:
      The count of actionItems.

    • getActionItems

      public String getActionItems(int index)
       Output only. A list of recommendations to improve the ad strength. For
 example, a recommendation could be "Try adding a few more unique headlines
 or unpinning some assets.".
      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 "Try adding a few more unique headlines
 or unpinning some assets.".
      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 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.

    • getPrimaryStatusValue

      public int getPrimaryStatusValue()
       Output only. Provides aggregated view into why an ad group ad is not
 serving or not serving optimally.
      .google.ads.googleads.v18.enums.AdGroupAdPrimaryStatusEnum.AdGroupAdPrimaryStatus primary_status = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getPrimaryStatusValue in interface AdGroupAdOrBuilder
      Returns:
      The enum numeric value on the wire for primaryStatus.

    • getPrimaryStatus

      public AdGroupAdPrimaryStatusEnum.AdGroupAdPrimaryStatus getPrimaryStatus()
       Output only. Provides aggregated view into why an ad group ad is not
 serving or not serving optimally.
      .google.ads.googleads.v18.enums.AdGroupAdPrimaryStatusEnum.AdGroupAdPrimaryStatus primary_status = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getPrimaryStatus in interface AdGroupAdOrBuilder
      Returns:
      The primaryStatus.

    • getPrimaryStatusReasonsList

      public List<AdGroupAdPrimaryStatusReasonEnum.AdGroupAdPrimaryStatusReason> getPrimaryStatusReasonsList()
       Output only. Provides reasons for why an ad group ad is not serving or not
 serving optimally.
      repeated .google.ads.googleads.v18.enums.AdGroupAdPrimaryStatusReasonEnum.AdGroupAdPrimaryStatusReason primary_status_reasons = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getPrimaryStatusReasonsList in interface AdGroupAdOrBuilder
      Returns:
      A list containing the primaryStatusReasons.

    • getPrimaryStatusReasonsCount

      public int getPrimaryStatusReasonsCount()
       Output only. Provides reasons for why an ad group ad is not serving or not
 serving optimally.
      repeated .google.ads.googleads.v18.enums.AdGroupAdPrimaryStatusReasonEnum.AdGroupAdPrimaryStatusReason primary_status_reasons = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getPrimaryStatusReasonsCount in interface AdGroupAdOrBuilder
      Returns:
      The count of primaryStatusReasons.

    • getPrimaryStatusReasons

      public AdGroupAdPrimaryStatusReasonEnum.AdGroupAdPrimaryStatusReason getPrimaryStatusReasons(int index)
       Output only. Provides reasons for why an ad group ad is not serving or not
 serving optimally.
      repeated .google.ads.googleads.v18.enums.AdGroupAdPrimaryStatusReasonEnum.AdGroupAdPrimaryStatusReason primary_status_reasons = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getPrimaryStatusReasons in interface AdGroupAdOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The primaryStatusReasons at the given index.

    • getPrimaryStatusReasonsValueList

      public List<Integer> getPrimaryStatusReasonsValueList()
       Output only. Provides reasons for why an ad group ad is not serving or not
 serving optimally.
      repeated .google.ads.googleads.v18.enums.AdGroupAdPrimaryStatusReasonEnum.AdGroupAdPrimaryStatusReason primary_status_reasons = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getPrimaryStatusReasonsValueList in interface AdGroupAdOrBuilder
      Returns:
      A list containing the enum numeric values on the wire for primaryStatusReasons.

    • getPrimaryStatusReasonsValue

      public int getPrimaryStatusReasonsValue(int index)
       Output only. Provides reasons for why an ad group ad is not serving or not
 serving optimally.
      repeated .google.ads.googleads.v18.enums.AdGroupAdPrimaryStatusReasonEnum.AdGroupAdPrimaryStatusReason primary_status_reasons = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getPrimaryStatusReasonsValue in interface AdGroupAdOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of primaryStatusReasons at the given index.

    • getAdGroupAdAssetAutomationSettingsList

      public List<AdGroupAdAssetAutomationSetting> getAdGroupAdAssetAutomationSettingsList()
       Settings that control the types of asset automation. See the
 AssetAutomationTypeEnum documentation for the default opt in/out behavior
 of each type.
      repeated .google.ads.googleads.v18.resources.AdGroupAdAssetAutomationSetting ad_group_ad_asset_automation_settings = 18;
      Specified by:
      getAdGroupAdAssetAutomationSettingsList in interface AdGroupAdOrBuilder

    • getAdGroupAdAssetAutomationSettingsOrBuilderList

      public List<? extends AdGroupAdAssetAutomationSettingOrBuilder> getAdGroupAdAssetAutomationSettingsOrBuilderList()
       Settings that control the types of asset automation. See the
 AssetAutomationTypeEnum documentation for the default opt in/out behavior
 of each type.
      repeated .google.ads.googleads.v18.resources.AdGroupAdAssetAutomationSetting ad_group_ad_asset_automation_settings = 18;
      Specified by:
      getAdGroupAdAssetAutomationSettingsOrBuilderList in interface AdGroupAdOrBuilder

    • getAdGroupAdAssetAutomationSettingsCount

      public int getAdGroupAdAssetAutomationSettingsCount()
       Settings that control the types of asset automation. See the
 AssetAutomationTypeEnum documentation for the default opt in/out behavior
 of each type.
      repeated .google.ads.googleads.v18.resources.AdGroupAdAssetAutomationSetting ad_group_ad_asset_automation_settings = 18;
      Specified by:
      getAdGroupAdAssetAutomationSettingsCount in interface AdGroupAdOrBuilder

    • getAdGroupAdAssetAutomationSettings

      public AdGroupAdAssetAutomationSetting getAdGroupAdAssetAutomationSettings(int index)
       Settings that control the types of asset automation. See the
 AssetAutomationTypeEnum documentation for the default opt in/out behavior
 of each type.
      repeated .google.ads.googleads.v18.resources.AdGroupAdAssetAutomationSetting ad_group_ad_asset_automation_settings = 18;
      Specified by:
      getAdGroupAdAssetAutomationSettings in interface AdGroupAdOrBuilder

    • getAdGroupAdAssetAutomationSettingsOrBuilder

      public AdGroupAdAssetAutomationSettingOrBuilder getAdGroupAdAssetAutomationSettingsOrBuilder(int index)
       Settings that control the types of asset automation. See the
 AssetAutomationTypeEnum documentation for the default opt in/out behavior
 of each type.
      repeated .google.ads.googleads.v18.resources.AdGroupAdAssetAutomationSetting ad_group_ad_asset_automation_settings = 18;
      Specified by:
      getAdGroupAdAssetAutomationSettingsOrBuilder in interface AdGroupAdOrBuilder

    • 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 IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      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(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(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AdGroupAd parseFrom(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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static AdGroupAd parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static AdGroupAd.Builder newBuilder()

    • newBuilder

      public static AdGroupAd.Builder newBuilder(AdGroupAd prototype)

    • 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