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

Interface AdGroupAdOrBuilder

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

  • Method Details

    • getResourceName

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

    • getResourceNameBytes

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

    • getStatusValue

      int getStatusValue()
       The status of the ad.
      .google.ads.googleads.v18.enums.AdGroupAdStatusEnum.AdGroupAdStatus status = 3;
      Returns:
      The enum numeric value on the wire for status.

    • getStatus

      AdGroupAdStatusEnum.AdGroupAdStatus getStatus()
       The status of the ad.
      .google.ads.googleads.v18.enums.AdGroupAdStatusEnum.AdGroupAdStatus status = 3;
      Returns:
      The status.

    • hasAdGroup

      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) = { ... }
      Returns:
      Whether the adGroup field is set.

    • getAdGroup

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

    • getAdGroupBytes

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

    • hasAd

      boolean hasAd()
       Immutable. The ad.
      .google.ads.googleads.v18.resources.Ad ad = 5 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      Whether the ad field is set.

    • getAd

      Ad getAd()
       Immutable. The ad.
      .google.ads.googleads.v18.resources.Ad ad = 5 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The ad.

    • getAdOrBuilder

      AdOrBuilder getAdOrBuilder()
       Immutable. The ad.
      .google.ads.googleads.v18.resources.Ad ad = 5 [(.google.api.field_behavior) = IMMUTABLE];

    • hasPolicySummary

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

    • getPolicySummary

      AdGroupAdPolicySummary getPolicySummary()
       Output only. Policy information for the ad.
      .google.ads.googleads.v18.resources.AdGroupAdPolicySummary policy_summary = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The policySummary.

    • getPolicySummaryOrBuilder

      AdGroupAdPolicySummaryOrBuilder getPolicySummaryOrBuilder()
       Output only. Policy information for the ad.
      .google.ads.googleads.v18.resources.AdGroupAdPolicySummary policy_summary = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getAdStrengthValue

      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];
      Returns:
      The enum numeric value on the wire for adStrength.

    • getAdStrength

      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];
      Returns:
      The adStrength.

    • getActionItemsList

      List<String> 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];
      Returns:
      A list containing the actionItems.

    • getActionItemsCount

      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];
      Returns:
      The count of actionItems.

    • getActionItems

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

    • getActionItemsBytes

      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];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the actionItems at the given index.

    • getLabelsList

      List<String> 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) = { ... }
      Returns:
      A list containing the labels.

    • getLabelsCount

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

    • getLabels

      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) = { ... }
      Parameters:
      index - The index of the element to return.
      Returns:
      The labels at the given index.

    • getLabelsBytes

      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) = { ... }
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the labels at the given index.

    • getPrimaryStatusValue

      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];
      Returns:
      The enum numeric value on the wire for primaryStatus.

    • getPrimaryStatus

      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];
      Returns:
      The primaryStatus.

    • getPrimaryStatusReasonsList

      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];
      Returns:
      A list containing the primaryStatusReasons.

    • getPrimaryStatusReasonsCount

      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];
      Returns:
      The count of primaryStatusReasons.

    • getPrimaryStatusReasons

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

    • getPrimaryStatusReasonsValueList

      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];
      Returns:
      A list containing the enum numeric values on the wire for primaryStatusReasons.

    • getPrimaryStatusReasonsValue

      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];
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of primaryStatusReasons at the given index.

    • getAdGroupAdAssetAutomationSettingsList

      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;

    • getAdGroupAdAssetAutomationSettings

      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;

    • getAdGroupAdAssetAutomationSettingsCount

      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;

    • getAdGroupAdAssetAutomationSettingsOrBuilderList

      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;

    • getAdGroupAdAssetAutomationSettingsOrBuilder

      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;