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

Interface BiddingSeasonalityAdjustmentOrBuilder

    • Method Detail

      • getResourceName

        java.lang.String getResourceName()
         Immutable. The resource name of the seasonality adjustment.
 Seasonality adjustment resource names have the form:
 `customers/{customer_id}/biddingSeasonalityAdjustments/{seasonality_adjustment_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 seasonality adjustment.
 Seasonality adjustment resource names have the form:
 `customers/{customer_id}/biddingSeasonalityAdjustments/{seasonality_adjustment_id}`
        string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Returns:
        The bytes for resourceName.

      • getSeasonalityAdjustmentId

        long getSeasonalityAdjustmentId()
         Output only. The ID of the seasonality adjustment.
        int64 seasonality_adjustment_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The seasonalityAdjustmentId.

      • getScopeValue

        int getScopeValue()
         The scope of the seasonality adjustment.
        .google.ads.googleads.v10.enums.SeasonalityEventScopeEnum.SeasonalityEventScope scope = 3;
        Returns:
        The enum numeric value on the wire for scope.

      • getStatusValue

        int getStatusValue()
         Output only. The status of the seasonality adjustment.
        .google.ads.googleads.v10.enums.SeasonalityEventStatusEnum.SeasonalityEventStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The enum numeric value on the wire for status.

      • getStatus

        SeasonalityEventStatusEnum.SeasonalityEventStatus getStatus()
         Output only. The status of the seasonality adjustment.
        .google.ads.googleads.v10.enums.SeasonalityEventStatusEnum.SeasonalityEventStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The status.

      • getStartDateTime

        java.lang.String getStartDateTime()
         Required. The inclusive start time of the seasonality adjustment in yyyy-MM-dd
 HH:mm:ss format.
 A seasonality adjustment is forward looking and should be used for events
 that start and end in the future.
        string start_date_time = 5 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The startDateTime.

      • getStartDateTimeBytes

        com.google.protobuf.ByteString getStartDateTimeBytes()
         Required. The inclusive start time of the seasonality adjustment in yyyy-MM-dd
 HH:mm:ss format.
 A seasonality adjustment is forward looking and should be used for events
 that start and end in the future.
        string start_date_time = 5 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The bytes for startDateTime.

      • getEndDateTime

        java.lang.String getEndDateTime()
         Required. The exclusive end time of the seasonality adjustment in yyyy-MM-dd HH:mm:ss
 format.
 The length of [start_date_time, end_date_time) interval must be
 within (0, 14 days].
        string end_date_time = 6 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The endDateTime.

      • getEndDateTimeBytes

        com.google.protobuf.ByteString getEndDateTimeBytes()
         Required. The exclusive end time of the seasonality adjustment in yyyy-MM-dd HH:mm:ss
 format.
 The length of [start_date_time, end_date_time) interval must be
 within (0, 14 days].
        string end_date_time = 6 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The bytes for endDateTime.

      • getName

        java.lang.String getName()
         The name of the seasonality adjustment. The name can be at most 255
 characters.
        string name = 7;
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         The name of the seasonality adjustment. The name can be at most 255
 characters.
        string name = 7;
        Returns:
        The bytes for name.

      • getDescription

        java.lang.String getDescription()
         The description of the seasonality adjustment. The description can be at
 most 2048 characters.
        string description = 8;
        Returns:
        The description.

      • getDescriptionBytes

        com.google.protobuf.ByteString getDescriptionBytes()
         The description of the seasonality adjustment. The description can be at
 most 2048 characters.
        string description = 8;
        Returns:
        The bytes for description.

      • getDevicesList

        java.util.List<DeviceEnum.Device> getDevicesList()
         If not specified, all devices will be included in this adjustment.
 Otherwise, only the specified targeted devices will be included in this
 adjustment.
        repeated .google.ads.googleads.v10.enums.DeviceEnum.Device devices = 9;
        Returns:
        A list containing the devices.

      • getDevicesCount

        int getDevicesCount()
         If not specified, all devices will be included in this adjustment.
 Otherwise, only the specified targeted devices will be included in this
 adjustment.
        repeated .google.ads.googleads.v10.enums.DeviceEnum.Device devices = 9;
        Returns:
        The count of devices.

      • getDevices

        DeviceEnum.Device getDevices​(int index)
         If not specified, all devices will be included in this adjustment.
 Otherwise, only the specified targeted devices will be included in this
 adjustment.
        repeated .google.ads.googleads.v10.enums.DeviceEnum.Device devices = 9;
        Parameters:
        index - The index of the element to return.
        Returns:
        The devices at the given index.

      • getDevicesValueList

        java.util.List<java.lang.Integer> getDevicesValueList()
         If not specified, all devices will be included in this adjustment.
 Otherwise, only the specified targeted devices will be included in this
 adjustment.
        repeated .google.ads.googleads.v10.enums.DeviceEnum.Device devices = 9;
        Returns:
        A list containing the enum numeric values on the wire for devices.

      • getDevicesValue

        int getDevicesValue​(int index)
         If not specified, all devices will be included in this adjustment.
 Otherwise, only the specified targeted devices will be included in this
 adjustment.
        repeated .google.ads.googleads.v10.enums.DeviceEnum.Device devices = 9;
        Parameters:
        index - The index of the value to return.
        Returns:
        The enum numeric value on the wire of devices at the given index.

      • getConversionRateModifier

        double getConversionRateModifier()
         Conversion rate modifier estimated based on expected conversion rate
 changes. When this field is unset or set to 1.0 no adjustment will be
 applied to traffic. The allowed range is 0.1 to 10.0.
        double conversion_rate_modifier = 10;
        Returns:
        The conversionRateModifier.

      • getCampaignsList

        java.util.List<java.lang.String> getCampaignsList()
         The seasonality adjustment will apply to the campaigns listed when the
 scope of this adjustment is CAMPAIGN. The maximum number of campaigns per
 event is 2000.
 Note: a seasonality adjustment with both advertising_channel_types and
 campaign_ids is not supported.
        repeated string campaigns = 11 [(.google.api.resource_reference) = { ... }
        Returns:
        A list containing the campaigns.

      • getCampaignsCount

        int getCampaignsCount()
         The seasonality adjustment will apply to the campaigns listed when the
 scope of this adjustment is CAMPAIGN. The maximum number of campaigns per
 event is 2000.
 Note: a seasonality adjustment with both advertising_channel_types and
 campaign_ids is not supported.
        repeated string campaigns = 11 [(.google.api.resource_reference) = { ... }
        Returns:
        The count of campaigns.

      • getCampaigns

        java.lang.String getCampaigns​(int index)
         The seasonality adjustment will apply to the campaigns listed when the
 scope of this adjustment is CAMPAIGN. The maximum number of campaigns per
 event is 2000.
 Note: a seasonality adjustment with both advertising_channel_types and
 campaign_ids is not supported.
        repeated string campaigns = 11 [(.google.api.resource_reference) = { ... }
        Parameters:
        index - The index of the element to return.
        Returns:
        The campaigns at the given index.

      • getCampaignsBytes

        com.google.protobuf.ByteString getCampaignsBytes​(int index)
         The seasonality adjustment will apply to the campaigns listed when the
 scope of this adjustment is CAMPAIGN. The maximum number of campaigns per
 event is 2000.
 Note: a seasonality adjustment with both advertising_channel_types and
 campaign_ids is not supported.
        repeated string campaigns = 11 [(.google.api.resource_reference) = { ... }
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the campaigns at the given index.

      • getAdvertisingChannelTypesList

        java.util.List<AdvertisingChannelTypeEnum.AdvertisingChannelType> getAdvertisingChannelTypesList()
         The seasonality adjustment will apply to all the campaigns under the listed
 channels retroactively as well as going forward when the scope of this
 adjustment is CHANNEL.
 The supported advertising channel types are DISPLAY, SEARCH and SHOPPING.
 Note: a seasonality adjustment with both advertising_channel_types and
 campaign_ids is not supported.
        repeated .google.ads.googleads.v10.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_types = 12;
        Returns:
        A list containing the advertisingChannelTypes.

      • getAdvertisingChannelTypesCount

        int getAdvertisingChannelTypesCount()
         The seasonality adjustment will apply to all the campaigns under the listed
 channels retroactively as well as going forward when the scope of this
 adjustment is CHANNEL.
 The supported advertising channel types are DISPLAY, SEARCH and SHOPPING.
 Note: a seasonality adjustment with both advertising_channel_types and
 campaign_ids is not supported.
        repeated .google.ads.googleads.v10.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_types = 12;
        Returns:
        The count of advertisingChannelTypes.

      • getAdvertisingChannelTypes

        AdvertisingChannelTypeEnum.AdvertisingChannelType getAdvertisingChannelTypes​(int index)
         The seasonality adjustment will apply to all the campaigns under the listed
 channels retroactively as well as going forward when the scope of this
 adjustment is CHANNEL.
 The supported advertising channel types are DISPLAY, SEARCH and SHOPPING.
 Note: a seasonality adjustment with both advertising_channel_types and
 campaign_ids is not supported.
        repeated .google.ads.googleads.v10.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_types = 12;
        Parameters:
        index - The index of the element to return.
        Returns:
        The advertisingChannelTypes at the given index.

      • getAdvertisingChannelTypesValueList

        java.util.List<java.lang.Integer> getAdvertisingChannelTypesValueList()
         The seasonality adjustment will apply to all the campaigns under the listed
 channels retroactively as well as going forward when the scope of this
 adjustment is CHANNEL.
 The supported advertising channel types are DISPLAY, SEARCH and SHOPPING.
 Note: a seasonality adjustment with both advertising_channel_types and
 campaign_ids is not supported.
        repeated .google.ads.googleads.v10.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_types = 12;
        Returns:
        A list containing the enum numeric values on the wire for advertisingChannelTypes.

      • getAdvertisingChannelTypesValue

        int getAdvertisingChannelTypesValue​(int index)
         The seasonality adjustment will apply to all the campaigns under the listed
 channels retroactively as well as going forward when the scope of this
 adjustment is CHANNEL.
 The supported advertising channel types are DISPLAY, SEARCH and SHOPPING.
 Note: a seasonality adjustment with both advertising_channel_types and
 campaign_ids is not supported.
        repeated .google.ads.googleads.v10.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_types = 12;
        Parameters:
        index - The index of the value to return.
        Returns:
        The enum numeric value on the wire of advertisingChannelTypes at the given index.