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

Interface BiddingDataExclusionOrBuilder

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

  • Method Details

    • getResourceName

      String getResourceName()
       Immutable. The resource name of the data exclusion.
 Data exclusion resource names have the form:

 `customers/{customer_id}/biddingDataExclusions/{data_exclusion_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 data exclusion.
 Data exclusion resource names have the form:

 `customers/{customer_id}/biddingDataExclusions/{data_exclusion_id}`
      string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for resourceName.

    • getDataExclusionId

      long getDataExclusionId()
       Output only. The ID of the data exclusion.
      int64 data_exclusion_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The dataExclusionId.

    • getScopeValue

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

    • getScope

      SeasonalityEventScopeEnum.SeasonalityEventScope getScope()
       The scope of the data exclusion.
      .google.ads.googleads.v18.enums.SeasonalityEventScopeEnum.SeasonalityEventScope scope = 3;
      Returns:
      The scope.

    • getStatusValue

      int getStatusValue()
       Output only. The status of the data exclusion.
      .google.ads.googleads.v18.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 data exclusion.
      .google.ads.googleads.v18.enums.SeasonalityEventStatusEnum.SeasonalityEventStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The status.

    • getStartDateTime

      String getStartDateTime()
       Required. The inclusive start time of the data exclusion in yyyy-MM-dd
 HH:mm:ss format.

 A data exclusion is backward looking and should be used for events that
 start in the past and end either in the past or 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 data exclusion in yyyy-MM-dd
 HH:mm:ss format.

 A data exclusion is backward looking and should be used for events that
 start in the past and end either in the past or future.
      string start_date_time = 5 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for startDateTime.

    • getEndDateTime

      String getEndDateTime()
       Required. The exclusive end time of the data exclusion 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 data exclusion 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

      String getName()
       The name of the data exclusion. The name can be at most 255
 characters.
      string name = 7;
      Returns:
      The name.

    • getNameBytes

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

    • getDescription

      String getDescription()
       The description of the data exclusion. The description can be at
 most 2048 characters.
      string description = 8;
      Returns:
      The description.

    • getDescriptionBytes

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

    • getDevicesList

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

    • getDevicesCount

      int getDevicesCount()
       If not specified, all devices will be included in this exclusion.
 Otherwise, only the specified targeted devices will be included in this
 exclusion.
      repeated .google.ads.googleads.v18.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 exclusion.
 Otherwise, only the specified targeted devices will be included in this
 exclusion.
      repeated .google.ads.googleads.v18.enums.DeviceEnum.Device devices = 9;
      Parameters:
      index - The index of the element to return.
      Returns:
      The devices at the given index.

    • getDevicesValueList

      List<Integer> getDevicesValueList()
       If not specified, all devices will be included in this exclusion.
 Otherwise, only the specified targeted devices will be included in this
 exclusion.
      repeated .google.ads.googleads.v18.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 exclusion.
 Otherwise, only the specified targeted devices will be included in this
 exclusion.
      repeated .google.ads.googleads.v18.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.

    • getCampaignsList

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

    • getCampaignsCount

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

    • getCampaigns

      String getCampaigns(int index)
       The data exclusion will apply to the campaigns listed when the scope of
 this exclusion is CAMPAIGN. The maximum number of campaigns per event is
 2000.
 Note: a data exclusion with both advertising_channel_types and
 campaign_ids is not supported.
      repeated string campaigns = 10 [(.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 data exclusion will apply to the campaigns listed when the scope of
 this exclusion is CAMPAIGN. The maximum number of campaigns per event is
 2000.
 Note: a data exclusion with both advertising_channel_types and
 campaign_ids is not supported.
      repeated string campaigns = 10 [(.google.api.resource_reference) = { ... }
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the campaigns at the given index.

    • getAdvertisingChannelTypesList

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

    • getAdvertisingChannelTypesCount

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

    • getAdvertisingChannelTypes

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

    • getAdvertisingChannelTypesValueList

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

    • getAdvertisingChannelTypesValue

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