Package com.google.ads.googleads.v15.resources

Class Campaign.ShoppingSetting

  • All Implemented Interfaces:
    Campaign.ShoppingSettingOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    Enclosing class:
    Campaign
    public static final class Campaign.ShoppingSetting
extends com.google.protobuf.GeneratedMessageV3
implements Campaign.ShoppingSettingOrBuilder
     The setting for Shopping campaigns. Defines the universe of products that
 can be advertised by the campaign, and how this campaign interacts with
 other Shopping campaigns.
    Protobuf type google.ads.googleads.v15.resources.Campaign.ShoppingSetting
    See Also:
    Serialized Form

    • Field Detail

      • MERCHANT_ID_FIELD_NUMBER

        public static final int MERCHANT_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • FEED_LABEL_FIELD_NUMBER

        public static final int FEED_LABEL_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CAMPAIGN_PRIORITY_FIELD_NUMBER

        public static final int CAMPAIGN_PRIORITY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ENABLE_LOCAL_FIELD_NUMBER

        public static final int ENABLE_LOCAL_FIELD_NUMBER
        See Also:
        Constant Field Values

      • USE_VEHICLE_INVENTORY_FIELD_NUMBER

        public static final int USE_VEHICLE_INVENTORY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ADVERTISING_PARTNER_IDS_FIELD_NUMBER

        public static final int ADVERTISING_PARTNER_IDS_FIELD_NUMBER
        See Also:
        Constant Field Values

    • 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

      • hasMerchantId

        public boolean hasMerchantId()
         Immutable. 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 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        hasMerchantId in interface Campaign.ShoppingSettingOrBuilder
        Returns:
        Whether the merchantId field is set.

      • getMerchantId

        public long getMerchantId()
         Immutable. 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 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getMerchantId in interface Campaign.ShoppingSettingOrBuilder
        Returns:
        The merchantId.

      • getFeedLabel

        public java.lang.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;
        Specified by:
        getFeedLabel in interface Campaign.ShoppingSettingOrBuilder
        Returns:
        The feedLabel.

      • getFeedLabelBytes

        public 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;
        Specified by:
        getFeedLabelBytes in interface Campaign.ShoppingSettingOrBuilder
        Returns:
        The bytes for feedLabel.

      • hasCampaignPriority

        public 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;
        Specified by:
        hasCampaignPriority in interface Campaign.ShoppingSettingOrBuilder
        Returns:
        Whether the campaignPriority field is set.

      • getCampaignPriority

        public 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;
        Specified by:
        getCampaignPriority in interface Campaign.ShoppingSettingOrBuilder
        Returns:
        The campaignPriority.

      • hasEnableLocal

        public boolean hasEnableLocal()
         Whether to include local products.
        optional bool enable_local = 8;
        Specified by:
        hasEnableLocal in interface Campaign.ShoppingSettingOrBuilder
        Returns:
        Whether the enableLocal field is set.

      • getUseVehicleInventory

        public 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];
        Specified by:
        getUseVehicleInventory in interface Campaign.ShoppingSettingOrBuilder
        Returns:
        The useVehicleInventory.

      • getAdvertisingPartnerIdsList

        public java.util.List<java.lang.Long> getAdvertisingPartnerIdsList()
         Immutable. The ads account IDs of advertising partners cooperating within
 the campaign.
        repeated int64 advertising_partner_ids = 11 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getAdvertisingPartnerIdsList in interface Campaign.ShoppingSettingOrBuilder
        Returns:
        A list containing the advertisingPartnerIds.

      • getAdvertisingPartnerIdsCount

        public int getAdvertisingPartnerIdsCount()
         Immutable. The ads account IDs of advertising partners cooperating within
 the campaign.
        repeated int64 advertising_partner_ids = 11 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getAdvertisingPartnerIdsCount in interface Campaign.ShoppingSettingOrBuilder
        Returns:
        The count of advertisingPartnerIds.

      • getAdvertisingPartnerIds

        public long getAdvertisingPartnerIds​(int index)
         Immutable. The ads account IDs of advertising partners cooperating within
 the campaign.
        repeated int64 advertising_partner_ids = 11 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getAdvertisingPartnerIds in interface Campaign.ShoppingSettingOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The advertisingPartnerIds 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 Campaign.ShoppingSetting parseFrom​(java.nio.ByteBuffer data)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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