Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

REST Resource: customers.biddingDataExclusions

Resource: BiddingDataExclusion

Represents a bidding data exclusion.

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

JSON representation
{
  "resourceName": string,
  "dataExclusionId": string,
  "scope": enum (SeasonalityEventScope),
  "status": enum (SeasonalityEventStatus),
  "startDateTime": string,
  "endDateTime": string,
  "name": string,
  "description": string,
  "devices": [
    enum (Device)
  ],
  "campaigns": [
    string
  ],
  "advertisingChannelTypes": [
    enum (AdvertisingChannelType)
  ]
}
Fields
resourceName

string

Immutable. The resource name of the data exclusion. Data exclusion resource names have the form:

customers/{customerId}/biddingDataExclusions/{dataExclusionId}

dataExclusionId

string (int64 format)

Output only. The ID of the data exclusion.

scope

enum (SeasonalityEventScope)

The scope of the data exclusion.

status

enum (SeasonalityEventStatus)

Output only. The status of the data exclusion.

startDateTime

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.

endDateTime

string

Required. The exclusive end time of the data exclusion in yyyy-MM-dd HH:mm:ss format.

The length of [startDateTime, endDateTime) 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[]

enum (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 advertisingChannelTypes and campaign_ids is not supported.

advertisingChannelTypes[]

enum (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 advertisingChannelTypes and campaign_ids is not supported.

Methods

get

Returns the requested data exclusion in full detail.

mutate

Creates, updates, or removes data exclusions.