Provides methods for creating, updating, and retrieving ForecastAdjustments and TrafficForecastSegments.
Forecast adjustments allow editing the volume and traffic composition of forecasted inventory. Traffic forecast segments divide forecasted inventory into segments to which forecast adjustments can be applied.
- Production WSDL
-
https://ads.google.com/apis/ads/publisher/v202308/AdjustmentService?wsdl
- Namespace
-
https://www.google.com/apis/ads/publisher/v202308
- Operations
- Errors
-
- ApiVersionError
- AuthenticationError
- CollectionSizeError
- CommonError
- CustomTargetingError
- DateError
- DateTimeRangeTargetingError
- DayPartTargetingError
- EntityLimitReachedError
- FeatureError
- ForecastAdjustmentError
- ForecastError
- GenericTargetingError
- GeoTargetingError
- InternalApiError
- InvalidUrlError
- InventoryTargetingError
- InventoryUnitError
- InventoryUnitSizesError
- NotNullError
- NullError
- ParseError
- PermissionError
- PublisherQueryLanguageContextError
- PublisherQueryLanguageSyntaxError
- QuotaError
- RequiredCollectionError
- RequiredError
- ServerError
- StatementError
- StringFormatError
- StringLengthError
- TechnologyTargetingError
- TrafficForecastSegmentError
- TypeError
- UniqueError
- UserDomainTargetingError
calculateDailyAdOpportunityCounts
Takes a prospective forecast adjustment and calculates the daily ad opportunity counts corresponding to its provided volume settings.
Parameters
Field | Type | Description |
---|---|---|
forecastAdjustment
|
|
Response
Field | Type | Description |
---|---|---|
rval
|
|
createForecastAdjustments
Creates new ForecastAdjustment objects.
Parameters
Field | Type | Description |
---|---|---|
forecastAdjustments
|
|
Response
Field | Type | Description |
---|---|---|
rval
|
|
createTrafficForecastSegments
Creates new TrafficForecastSegment objects.
Parameters
Field | Type | Description |
---|---|---|
trafficForecastSegments
|
|
Response
Field | Type | Description |
---|---|---|
rval
|
|
getForecastAdjustmentsByStatement
Gets a ForecastAdjustmentPage of ForecastAdjustment objects that satisfy the given Statement.query.
The following fields are supported for filtering:
PQL Property | Object Property |
---|---|
id
|
ForecastAdjustment.id |
trafficForecastSegmentId
|
ForecastAdjustment.trafficForecastSegmentId |
name
|
ForecastAdjustment.name |
startDate
|
ForecastAdjustment.startDate |
endDate
|
ForecastAdjustment.endDate |
status
|
ForecastAdjustment.status |
Parameters
Field | Type | Description |
---|---|---|
filterStatement
|
|
Response
Field | Type | Description |
---|---|---|
rval
|
|
getTrafficForecastSegmentsByStatement
Gets a TrafficForecastSegmentPage of TrafficForecastSegment objects that satisfy the given Statement.query.
The following fields are supported for filtering:
PQL Property | Object Property |
---|---|
id
|
TrafficForecastSegment.id |
name
|
TrafficForecastSegment.name |
creationTime
|
TrafficForecastSegment.creationTime |
Parameters
Field | Type | Description |
---|---|---|
filterStatement
|
|
Response
Field | Type | Description |
---|---|---|
rval
|
|
performForecastAdjustmentAction
Performs actions on ForecastAdjustment objects that match the given Statement.query.
Parameters
Field | Type | Description |
---|---|---|
forecastAdjustmentAction
|
|
|
filterStatement
|
|
Response
Field | Type | Description |
---|---|---|
rval
|
|
updateForecastAdjustments
Updates the specified ForecastAdjustment objects.
Parameters
Field | Type | Description |
---|---|---|
forecastAdjustments
|
|
Response
Field | Type | Description |
---|---|---|
rval
|
|
updateTrafficForecastSegments
Updates the specified TrafficForecastSegment objects.
Parameters
Field | Type | Description |
---|---|---|
trafficForecastSegments
|
|
Response
Field | Type | Description |
---|---|---|
rval
|
|
Errors
Error | Reasons |
---|---|
ApiVersionError
|
Errors related to the usage of API versions.
Enumerations
|
AuthenticationError
|
An error for an exception that occurred when authenticating.
Enumerations
|
CollectionSizeError
|
Error for the size of the collection being too large
Enumerations
|
CommonError
|
A place for common errors that can be used across services.
Enumerations
|
CustomTargetingError
|
Lists all errors related to CustomTargetingKey and
CustomTargetingValue objects.
Enumerations
|
DateError
|
A list of all errors associated with the dates.
Enumerations
|
DateTimeRangeTargetingError
|
Lists all date time range errors caused by associating a line item with a targeting
expression.
Enumerations
|
DayPartTargetingError
|
Lists all errors associated with day-part targeting for a line item.
Enumerations
|
EntityLimitReachedError
|
An error that occurs when creating an entity if the limit on the number of allowed entities for
a network has already been reached.
Enumerations
|
FeatureError
|
Errors related to feature management. If you attempt using a feature that is not available to
the current network you'll receive a FeatureError with the missing feature as the trigger.
Enumerations
|
ForecastAdjustmentError
|
Lists all errors associated with forecast adjustments.
Enumerations
|
ForecastError
|
Errors that can result from a forecast request.
Enumerations
|
GenericTargetingError
|
Targeting validation errors that can be used by different targeting types.
Enumerations
|
GeoTargetingError
|
Lists all errors associated with geographical targeting for a
LineItem.
Enumerations
|
InternalApiError
|
Indicates that a server-side error has occured. InternalApiError s
are generally not the result of an invalid request or message sent by the
client.
Enumerations
|
InvalidUrlError
|
Lists all errors associated with URLs.
Enumerations
|
InventoryTargetingError
|
Lists all inventory errors caused by associating a line item with a targeting
expression.
Enumerations
|
InventoryUnitError
|
Lists the generic errors associated with AdUnit objects.
Enumerations
|
InventoryUnitSizesError
|
An error specifically for InventoryUnitSizes.
Enumerations
|
NotNullError
|
Caused by supplying a null value for an attribute that cannot be null.
Enumerations
|
NullError
|
Errors associated with violation of a NOT NULL check.
Enumerations
|
ParseError
|
Lists errors related to parsing.
Enumerations
|
PermissionError
|
Errors related to incorrect permission.
Enumerations
|
PublisherQueryLanguageContextError
|
An error that occurs while executing a PQL query contained in
a Statement object.
Enumerations
|
PublisherQueryLanguageSyntaxError
|
An error that occurs while parsing a PQL query contained in a
Statement object.
Enumerations
|
QuotaError
|
Describes a client-side error on which a user is attempting
to perform an action to which they have no quota remaining.
Enumerations
|
RequiredCollectionError
|
A list of all errors to be used for validating sizes of collections.
Enumerations
|
RequiredError
|
Errors due to missing required field.
Enumerations
|
ServerError
|
Errors related to the server.
Enumerations
|
StatementError
|
An error that occurs while parsing Statement objects.
Enumerations
|
StringFormatError
|
A list of error code for reporting invalid content of input strings.
Enumerations
|
StringLengthError
|
Errors for Strings which do not meet given length constraints.
Enumerations
|
TechnologyTargetingError
|
Technology targeting validation errors.
Enumerations
|
TrafficForecastSegmentError
|
Lists all errors associated with traffic forecast segments.
Enumerations
|
TypeError
|
An error for a field which is an invalid type. |
UniqueError
|
An error for a field which must satisfy a uniqueness constraint |
UserDomainTargetingError
|
Lists all errors related to user domain targeting for a line item.
Enumerations
|