Package com.google.ads.googleads.v21.resources

Interface Campaign.ShoppingSettingOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Campaign.ShoppingSetting, Campaign.ShoppingSetting.Builder
Enclosing class:
Campaign
public static interface Campaign.ShoppingSettingOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    getAdvertisingPartnerIds(int index)
    The list of Google Ads accounts IDs of advertising partners cooperating within the campaign.
    int
    getAdvertisingPartnerIdsCount()
    The list of Google Ads accounts IDs of advertising partners cooperating within the campaign.
    List<Long>
    getAdvertisingPartnerIdsList()
    The list of Google Ads accounts IDs of advertising partners cooperating within the campaign.
    int
    getCampaignPriority()
    Priority of the campaign.
    boolean
    getDisableProductFeed()
    Disable the optional product feed.
    boolean
    getEnableLocal()
    Whether to include local products.
    String
    getFeedLabel()
    Feed label of products to include in the campaign.
    com.google.protobuf.ByteString
    getFeedLabelBytes()
    Feed label of products to include in the campaign.
    long
    getMerchantId()
    ID of the Merchant Center account.
    boolean
    getUseVehicleInventory()
    Immutable.
    boolean
    hasCampaignPriority()
    Priority of the campaign.
    boolean
    hasDisableProductFeed()
    Disable the optional product feed.
    boolean
    hasEnableLocal()
    Whether to include local products.
    boolean
    hasMerchantId()
    ID of the Merchant Center account.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • hasMerchantId

      boolean hasMerchantId()
       ID of the Merchant Center account.
 This field is required for create operations. This field is immutable for
 Shopping campaigns.
      optional int64 merchant_id = 5;
      Returns:
      Whether the merchantId field is set.

    • getMerchantId

      long getMerchantId()
       ID of the Merchant Center account.
 This field is required for create operations. This field is immutable for
 Shopping campaigns.
      optional int64 merchant_id = 5;
      Returns:
      The merchantId.

    • getFeedLabel

      String getFeedLabel()
       Feed label of products to include in the campaign.
 Only one of feed_label or sales_country can be set.
 If used instead of sales_country, the feed_label field accepts country
 codes in the same format for example: 'XX'.
 Otherwise can be any string used for feed label in Google Merchant
 Center.
      string feed_label = 10;
      Returns:
      The feedLabel.

    • getFeedLabelBytes

      com.google.protobuf.ByteString getFeedLabelBytes()
       Feed label of products to include in the campaign.
 Only one of feed_label or sales_country can be set.
 If used instead of sales_country, the feed_label field accepts country
 codes in the same format for example: 'XX'.
 Otherwise can be any string used for feed label in Google Merchant
 Center.
      string feed_label = 10;
      Returns:
      The bytes for feedLabel.

    • hasCampaignPriority

      boolean hasCampaignPriority()
       Priority of the campaign. Campaigns with numerically higher priorities
 take precedence over those with lower priorities.
 This field is required for Shopping campaigns, with values between 0 and
 2, inclusive.
 This field is optional for Smart Shopping campaigns, but must be equal to
 3 if set.
      optional int32 campaign_priority = 7;
      Returns:
      Whether the campaignPriority field is set.

    • getCampaignPriority

      int getCampaignPriority()
       Priority of the campaign. Campaigns with numerically higher priorities
 take precedence over those with lower priorities.
 This field is required for Shopping campaigns, with values between 0 and
 2, inclusive.
 This field is optional for Smart Shopping campaigns, but must be equal to
 3 if set.
      optional int32 campaign_priority = 7;
      Returns:
      The campaignPriority.

    • hasEnableLocal

      boolean hasEnableLocal()
       Whether to include local products.
      optional bool enable_local = 8;
      Returns:
      Whether the enableLocal field is set.

    • getEnableLocal

      boolean getEnableLocal()
       Whether to include local products.
      optional bool enable_local = 8;
      Returns:
      The enableLocal.

    • getUseVehicleInventory

      boolean getUseVehicleInventory()
       Immutable. Whether to target Vehicle Listing inventory. This field is
 supported only in Smart Shopping Campaigns. For setting Vehicle Listing
 inventory in Performance Max campaigns, use `listing_type` instead.
      bool use_vehicle_inventory = 9 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The useVehicleInventory.

    • getAdvertisingPartnerIdsList

      List<Long> getAdvertisingPartnerIdsList()
       The list of Google Ads accounts IDs of advertising partners cooperating
 within the campaign.
 This feature is currently available only for accounts having an
 advertising partner link. Once set, the field is immutable.
 This feature is currently supported only for Performance Max, Shopping,
 Search and Demand Gen campaign types.
      repeated int64 advertising_partner_ids = 11;
      Returns:
      A list containing the advertisingPartnerIds.

    • getAdvertisingPartnerIdsCount

      int getAdvertisingPartnerIdsCount()
       The list of Google Ads accounts IDs of advertising partners cooperating
 within the campaign.
 This feature is currently available only for accounts having an
 advertising partner link. Once set, the field is immutable.
 This feature is currently supported only for Performance Max, Shopping,
 Search and Demand Gen campaign types.
      repeated int64 advertising_partner_ids = 11;
      Returns:
      The count of advertisingPartnerIds.

    • getAdvertisingPartnerIds

      long getAdvertisingPartnerIds(int index)
       The list of Google Ads accounts IDs of advertising partners cooperating
 within the campaign.
 This feature is currently available only for accounts having an
 advertising partner link. Once set, the field is immutable.
 This feature is currently supported only for Performance Max, Shopping,
 Search and Demand Gen campaign types.
      repeated int64 advertising_partner_ids = 11;
      Parameters:
      index - The index of the element to return.
      Returns:
      The advertisingPartnerIds at the given index.

    • hasDisableProductFeed

      boolean hasDisableProductFeed()
       Disable the optional product feed. This field is currently supported
 only for Demand Gen campaigns. See
 https://support.google.com/google-ads/answer/13721750 to learn more about
 this feature.
      optional bool disable_product_feed = 12;
      Returns:
      Whether the disableProductFeed field is set.

    • getDisableProductFeed

      boolean getDisableProductFeed()
       Disable the optional product feed. This field is currently supported
 only for Demand Gen campaigns. See
 https://support.google.com/google-ads/answer/13721750 to learn more about
 this feature.
      optional bool disable_product_feed = 12;
      Returns:
      The disableProductFeed.