BiddingDataExclusion

  • Bidding data exclusions represent excluded bidding data and can only be set in client accounts.

  • Data exclusions include fields such as resource name, ID, scope, status, start and end dates, name, description, devices, campaigns, and advertising channel types.

  • Data exclusions are backward-looking events with a start time in the past and an end time within a 14-day interval of the start time.

  • The scope of the data exclusion determines whether it applies to campaigns or advertising channel types, but not both simultaneously.

Represents a bidding data exclusion. Bidding data exclusions can be set in client accounts only, and cannot be used in manager accounts.

See "About data exclusions" at https://support.google.com/google-ads/answer/10370710.

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.