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.biddingSeasonalityAdjustments

Resource: BiddingSeasonalityAdjustment

Represents a bidding seasonality adjustment.

See "About seasonality adjustments" at https://support.google.com/google-ads/answer/10369906.

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

string

Immutable. The resource name of the seasonality adjustment. Seasonality adjustment resource names have the form:

customers/{customerId}/biddingSeasonalityAdjustments/{seasonalityAdjustmentId}

seasonalityAdjustmentId

string (int64 format)

Output only. The ID of the seasonality adjustment.

scope

enum (SeasonalityEventScope)

The scope of the seasonality adjustment.

status

enum (SeasonalityEventStatus)

Output only. The status of the seasonality adjustment.

startDateTime

string

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.

endDateTime

string

Required. The exclusive end time of the seasonality adjustment 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 seasonality adjustment. The name can be at most 255 characters.

description

string

The description of the seasonality adjustment. The description can be at most 2048 characters.

devices[]

enum (Device)

If not specified, all devices will be included in this adjustment. Otherwise, only the specified targeted devices will be included in this adjustment.

conversionRateModifier

number

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.

campaigns[]

string

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

advertisingChannelTypes[]

enum (AdvertisingChannelType)

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

Methods

get

Returns the requested seasonality adjustment in full detail.

mutate

Creates, updates, or removes seasonality adjustments.