BiddingDataExclusion
Stay organized with collections
Save and categorize content based on your preferences.
Fields |
resource_name
|
string
Immutable. The resource name of the data exclusion. Data exclusion resource names have the form: customers/{customer_id}/biddingDataExclusions/{data_exclusion_id}
|
data_exclusion_id
|
int64
Output only. The ID of the data exclusion.
|
scope
|
SeasonalityEventScope
The scope of the data exclusion.
|
status
|
SeasonalityEventStatus
Output only. The status of the data exclusion.
|
start_date_time
|
string
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.
|
end_date_time
|
string
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].
|
name
|
string
The name of the data exclusion. The name can be at most 255 characters.
|
description
|
string
The description of the data exclusion. The description can be at most 2048 characters.
|
devices[]
|
Device
If not specified, all devices will be included in this exclusion. Otherwise, only the specified targeted devices will be included in this exclusion.
|
campaigns[]
|
string
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.
|
advertising_channel_types[]
|
AdvertisingChannelType
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.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-07 UTC.
[null,null,["Last updated 2025-08-07 UTC."],[],[],null,["# BiddingDataExclusion\n\nRepresents a bidding data exclusion. Bidding data exclusions can be set in client accounts only, and cannot be used in manager accounts.\n\nSee \"About data exclusions\" at \u003chttps://support.google.com/google-ads/answer/10370710\u003e.\n\n| Fields ||\n|-----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ### `resource_name` | `string` Immutable. The resource name of the data exclusion. Data exclusion resource names have the form: `customers/{customer_id}/biddingDataExclusions/{data_exclusion_id}` |\n| ### `data_exclusion_id` | `int64` Output only. The ID of the data exclusion. |\n| ### `scope` | [SeasonalityEventScope](/google-ads/api/reference/rpc/v20/SeasonalityEventScopeEnum.SeasonalityEventScope) The scope of the data exclusion. |\n| ### `status` | [SeasonalityEventStatus](/google-ads/api/reference/rpc/v20/SeasonalityEventStatusEnum.SeasonalityEventStatus) Output only. The status of the data exclusion. |\n| ### `start_date_time` | `string` 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. |\n| ### `end_date_time` | `string` 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\\]. |\n| ### `name` | `string` The name of the data exclusion. The name can be at most 255 characters. |\n| ### `description` | `string` The description of the data exclusion. The description can be at most 2048 characters. |\n| ### `devices[]` | [Device](/google-ads/api/reference/rpc/v20/DeviceEnum.Device) If not specified, all devices will be included in this exclusion. Otherwise, only the specified targeted devices will be included in this exclusion. |\n| ### `campaigns[]` | `string` 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. |\n| ### `advertising_channel_types[]` | [AdvertisingChannelType](/google-ads/api/reference/rpc/v20/AdvertisingChannelTypeEnum.AdvertisingChannelType) 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. |"]]