Provides methods for creating, updating, and retrieving ForecastAdjustment s and TrafficForecastSegment s.
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/v202508/AdjustmentService?wsdl
- Namespace
-
https://www.google.com/apis/ads/publisher/v202508
- 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
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
Enumerations
-
UPDATE_TO_NEWER_VERSION
- Indicates that the operation is not allowed in the version the request was made in.
-
UNKNOWN
- The value returned if the actual value is not exposed by the requested API version.
Enumerations
-
AMBIGUOUS_SOAP_REQUEST_HEADER
- The SOAP message contains a request header with an ambiguous definition of the authentication
header fields. This means either the
authToken
andoAuthToken
fields were both null or both were specified. Exactly one value should be specified with each request. -
INVALID_EMAIL
- The login provided is invalid.
-
AUTHENTICATION_FAILED
- Tried to authenticate with provided information, but failed.
-
INVALID_OAUTH_SIGNATURE
- The OAuth provided is invalid.
-
INVALID_SERVICE
- The specified service to use was not recognized.
-
MISSING_SOAP_REQUEST_HEADER
- The SOAP message is missing a request header with an
authToken
and optionalnetworkCode
. -
MISSING_AUTHENTICATION_HTTP_HEADER
- The HTTP request is missing a request header with an
authToken
-
MISSING_AUTHENTICATION
- The request is missing an
authToken
-
NETWORK_API_ACCESS_DISABLED
- The network does not have API access enabled.
-
NO_NETWORKS_TO_ACCESS
- The user is not associated with any network.
-
NETWORK_NOT_FOUND
- No network for the given
networkCode
was found. -
NETWORK_CODE_REQUIRED
- The user has access to more than one network, but did not provide a
networkCode
. -
CONNECTION_ERROR
- An error happened on the server side during connection to authentication service.
-
GOOGLE_ACCOUNT_ALREADY_ASSOCIATED_WITH_NETWORK
- The user tried to create a test network using an account that already is associated with a network.
-
UNDER_INVESTIGATION
- The account is blocked and under investigation by the collections team. Please contact Google for more information.
-
UNKNOWN
- The value returned if the actual value is not exposed by the requested API version.
Enumerations
-
TOO_LARGE
-
UNKNOWN
- The value returned if the actual value is not exposed by the requested API version.
Enumerations
-
NOT_FOUND
- Indicates that an attempt was made to retrieve an entity that does not exist.
-
ALREADY_EXISTS
- Indicates that an attempt was made to create an entity that already exists.
-
NOT_APPLICABLE
- Indicates that a value is not applicable for given use case.
-
DUPLICATE_OBJECT
- Indicates that two elements in the collection were identical.
-
CANNOT_UPDATE
- Indicates that an attempt was made to change an immutable field.
-
UNSUPPORTED_OPERATION
- Indicates that the requested operation is not supported.
-
CONCURRENT_MODIFICATION
- Indicates that another request attempted to update the same data in the same network at about the same time. Please wait and try the request again.
-
UNKNOWN
- The value returned if the actual value is not exposed by the requested API version.
Enumerations
-
KEY_NOT_FOUND
- Requested CustomTargetingKey is not found.
-
KEY_COUNT_TOO_LARGE
- Number of CustomTargetingKey objects created exceeds the limit allowed for the network.
-
KEY_NAME_DUPLICATE
- CustomTargetingKey with the same CustomTargetingKey.name already exists.
-
KEY_NAME_EMPTY
- CustomTargetingKey.name is empty.
-
KEY_NAME_INVALID_LENGTH
- CustomTargetingKey.name is too long.
-
KEY_NAME_INVALID_CHARS
- CustomTargetingKey.name contains unsupported or reserved characters.
-
KEY_NAME_RESERVED
- CustomTargetingKey.name matches one of the reserved custom targeting key names.
-
KEY_DISPLAY_NAME_INVALID_LENGTH
- CustomTargetingKey.displayName is too long.
-
KEY_STATUS_NOT_ACTIVE
- Key is not active.
-
VALUE_NOT_FOUND
- Requested CustomTargetingValue is not found.
-
GET_VALUES_BY_STATEMENT_MUST_CONTAIN_KEY_ID
- The
WHERE
clause in the Statement.query must always contain CustomTargetingValue.customTargetingKeyId as one of its columns in a way that it is AND'ed with the rest of the query. -
VALUE_COUNT_FOR_KEY_TOO_LARGE
- The number of CustomTargetingValue
objects associated with a CustomTargetingKey
exceeds the network limit. This is only
applicable for keys of type
CustomTargetingKey.Type#PREDEFINED
. -
VALUE_NAME_DUPLICATE
- CustomTargetingValue with the same CustomTargetingValue.name already exists.
-
VALUE_NAME_EMPTY
- CustomTargetingValue.name is empty.
-
VALUE_NAME_INVALID_LENGTH
- CustomTargetingValue.name is too long.
-
VALUE_NAME_INVALID_CHARS
- CustomTargetingValue.name contains unsupported or reserved characters.
-
VALUE_DISPLAY_NAME_INVALID_LENGTH
- CustomTargetingValue.displayName is too long.
-
VALUE_MATCH_TYPE_NOT_ALLOWED
- Only Ad Manager 360 networks can have CustomTargetingValue.matchType other than CustomTargetingValue.MatchType.EXACT .
-
VALUE_MATCH_TYPE_NOT_EXACT_FOR_PREDEFINED_KEY
- You can only create CustomTargetingValue objects with match type CustomTargetingValue.MatchType.EXACT when associating with CustomTargetingKey objects of type CustomTargetingKey.Type.PREDEFINED
-
SUFFIX_MATCH_TYPE_NOT_ALLOWED
- CustomTargetingValue object cannot have match type of CustomTargetingValue.MatchType.SUFFIX when adding a CustomTargetingValue to a line item.
-
CONTAINS_MATCH_TYPE_NOT_ALLOWED
- CustomTargetingValue object cannot have match type of CustomTargetingValue.MatchType.CONTAINS when adding a CustomTargetingValue to targeting expression of a line item.
-
VALUE_STATUS_NOT_ACTIVE
- Value is not active.
-
KEY_WITH_MISSING_VALUES
- The CustomTargetingKey does not have any CustomTargetingValue associated with it.
-
INVALID_VALUE_FOR_KEY
- The CustomTargetingKey has a CustomTargetingValue specified for which the value is not a valid child.
-
CANNOT_OR_DIFFERENT_KEYS
- CustomCriteriaSet.LogicalOperator.OR operation cannot be applied to values with different keys.
-
INVALID_TARGETING_EXPRESSION
- Targeting expression is invalid. This can happen if the sequence of operators is wrong, or a node contains invalid number of children.
-
DELETED_KEY_CANNOT_BE_USED_FOR_TARGETING
- The key has been deleted. CustomCriteria cannot have deleted keys.
-
DELETED_VALUE_CANNOT_BE_USED_FOR_TARGETING
- The value has been deleted. CustomCriteria cannot have deleted values.
-
VIDEO_BROWSE_BY_KEY_CANNOT_BE_USED_FOR_CUSTOM_TARGETING
- The key is set as the video browse-by key, which cannot be used for custom targeting.
-
CANNOT_DELETE_CUSTOM_KEY_USED_IN_PARTNER_ASSIGNMENT_TARGETING
- Cannot delete a custom criteria key that is targeted by an active partner assignment.
-
CANNOT_DELETE_CUSTOM_VALUE_USED_IN_PARTNER_ASSIGNMENT_TARGETING
- Cannot delete a custom criteria value that is targeted by an active partner assignment.
-
CANNOT_TARGET_AUDIENCE_SEGMENT
- AudienceSegment object cannot be targeted.
-
CANNOT_TARGET_THIRD_PARTY_AUDIENCE_SEGMENT
- Third party AudienceSegment cannot be targeted.
-
CANNOT_TARGET_INACTIVE_AUDIENCE_SEGMENT
- Inactive AudienceSegment object cannot be targeted.
-
INVALID_AUDIENCE_SEGMENTS
- Targeted AudienceSegment object is not valid.
-
CANNOT_TARGET_MAPPED_METADATA
- Mapped metadata key-values are deprecated and cannot be targeted.
-
ONLY_APPROVED_AUDIENCE_SEGMENTS_CAN_BE_TARGETED
- Targeted AudienceSegment objects have not been approved.
-
UNKNOWN
- The value returned if the actual value is not exposed by the requested API version.
Enumerations
-
DATE_IN_PAST
-
START_DATE_AFTER_END_DATE
-
END_DATE_BEFORE_START_DATE
-
NOT_CERTAIN_DAY_OF_MONTH
-
INVALID_DATES
-
UNKNOWN
- The value returned if the actual value is not exposed by the requested API version.
Enumerations
-
EMPTY_RANGES
- No targeted ranges exists.
-
NOT_SPONSORSHIP_LINEITEM
- Type of lineitem is not sponsorship.
-
NOT_SPONSORSHIP_OR_STANDARD_LINEITEM
- Type of lineitem is not sponsorship or standard.
-
UNSUPPORTED_LINEITEM_RESERVATION_TYPE
- Line item must have a reservation type of sponsorship, standard or preferred deal to use date time range targeting.
-
PAST_RANGES_CHANGED
- Past ranges are changed.
-
RANGES_OVERLAP
- Targeted date time ranges overlap.
-
FIRST_DATE_TIME_DOES_NOT_MATCH_START_TIME
- First date time does not match line item's start time.
-
LAST_DATE_TIME_DOES_NOT_MATCH_END_TIME
- Last date time does not match line item's end time.
-
RANGES_OUT_OF_LINEITEM_ACTIVE_PERIOD
- Targeted date time ranges fall out the active period of lineitem.
-
START_TIME_IS_NOT_START_OF_DAY
- Start time of range (except the earliest range) is not at start of day. Start of day is 00:00:00.
-
END_TIME_IS_NOT_END_OF_DAY
- End time of range (except the latest range) is not at end of day. End of day is 23:59:59.
-
START_DATE_TIME_IS_IN_PAST
- Start date time of earliest targeted ranges is in past.
-
MODIFY_START_DATE_TIME_TO_PAST
- Cannot modify the start date time for date time targeting to the past.
-
RANGE_END_TIME_BEFORE_START_TIME
- The end time of range is before the start time. Could happen when start type is IMMEDIATE or ONE_HOUR_LATER.
-
END_DATE_TIME_IS_TOO_LATE
- End date time of latest targeted ranges is too late.
-
LIMITED_RANGES_IN_UNLIMITED_LINEITEM
-
BLACKOUT_DURATION_TOO_SHORT
- Blackout ranges do not adhere to the minimum blackout duration. There must be a minimum of 2
seconds between targeted
DateTime
s. -
UNKNOWN
- The value returned if the actual value is not exposed by the requested API version.
Enumerations
-
INVALID_HOUR
- Hour of day must be between 0 and 24, inclusive.
-
INVALID_MINUTE
- Minute of hour must be one of 0, 15,30, 45.
-
END_TIME_NOT_AFTER_START_TIME
- The DayPart.endTime cannot be after DayPart.startTime .
-
TIME_PERIODS_OVERLAP
- Cannot create day-parts that overlap.
-
UNKNOWN
- The value returned if the actual value is not exposed by the requested API version.
Enumerations
-
CUSTOM_TARGETING_VALUES_LIMIT_REACHED
- The number of custom targeting values exceeds the max number allowed in the network.
-
AD_EXCLUSION_RULES_LIMIT_REACHED
- The number of ad exclusion rules exceeds the max number allowed in the network.
-
FIRST_PARTY_AUDIENCE_SEGMENTS_LIMIT_REACHED
- The number of first party audience segments exceeds the max number allowed in the network.
-
PLACEMENTS_LIMIT_REACHED
- The number of active placements exceeds the max number allowed in the network.
-
LINE_ITEMS_LIMIT_REACHED
- The number of line items excceeds the max number allowed in the network.
-
ACTIVE_LINE_ITEMS_LIMIT_REACHED
- The number of active line items exceeds the max number allowed in the network.
-
DAI_ENCODING_PROFILES_LIMIT_REACHED
- The number of not-archived encoding profiles exceeds the max number allowed in the network.
-
TRAFFIC_FORECAST_SEGMENTS_LIMIT_REACHED
- The number of traffic forecast segments exceeds the max number allowed in the network.
-
FORECAST_ADJUSTMENTS_LIMIT_REACHED
- The number of forecast adjustments exceeds the max number allowed in the network.
-
ACTIVE_EXPERIMENTS_LIMIT_REACHED
- The number of active experiments exceeds the max number allowed in the network.
-
SITES_LIMIT_REACHED
- The number of sites exceeds the max number allowed in the network.
-
USER_TEAMS_LIMIT_REACHED
- The number of teams on the user exceeds the max number allowed.
-
ACTIVE_TARGETING_PRESETS_LIMIT_REACHED
- The count of active targeting presets exceeds the limit.
-
UNKNOWN
- The value returned if the actual value is not exposed by the requested API version.
Enumerations
-
MISSING_FEATURE
- A feature is being used that is not enabled on the current network.
-
UNKNOWN
- The value returned if the actual value is not exposed by the requested API version.
Enumerations
-
AD_REQUEST_SOURCE_PLATFORMS_MUST_MATCH_SEGMENT_PLATFORMS
- The adjustment has ad request source settings with a targeting expression that contains request platform targeting that is not equal to the request platform targeting of the targeting expression of the parent traffic forecast segment.
-
AD_REQUEST_HISTORICAL_BASIS_DATE_RANGE_TOO_SHORT_RELATIVE_TO_ADJUSTMENT
- The adjustment has ad request historical basis settings with a source time duration that is too short given the adjustment date range.
-
ADJUSTED_VALUE_ABOVE_RECOMMENDED_RELATIVE_LIMIT
- The adjustment contains at least one daily value above the recommended limit relative to the current forecast. This error will only be thrown if adjusting the forecast above the recommended limit is disallowed in the current request.
-
ADJUSTED_VALUE_TOO_HIGH_RELATIVE_TO_FORECAST
- The adjustment contains at least one daily value above the allowed maximum percentage of the current forecast.
-
ADJUSTED_VALUE_TOO_LOW
- The adjustment contains at least one daily value below the allowed minimum.
-
ADJUSTED_VALUE_TOO_LOW_RELATIVE_TO_FORECAST
- The adjustment contains at least one daily value below the allowed minimum percentage of the current forecast.
-
ADJUSTS_CROSS_SELL_INVENTORY
- The adjustment is attempting to adjust cross-sell inventory.
-
DATE_RANGE_OVERLAPS_ANOTHER_ADJUSTMENT
- The date range of the adjustment overlaps the date range of another adjustment within the same traffic forecast segment.
-
END_DATE_AFTER_FURTHEST_AVAILABLE_FORECAST_DATE
- The adjustment's end date is after the furthest available date in the forecast.
-
END_DATE_NOT_ON_OR_AFTER_START_DATE
- A provided date range has an end date that is not on or after its start date.
-
HISTORICAL_BASIS_DATE_RANGE_TOO_SHORT
- A historical date range is shorter than the minimum allowed length.
-
HISTORICAL_END_DATE_NOT_IN_PAST
- A historical date range has an end date not in the past.
-
HISTORICAL_START_DATE_TOO_FAR_BEFORE_ADJUSTMENT_END_DATE
- A historical date range has a start date more than the allowed number of days before the adjustment end date.
-
NO_VOLUME_SETTINGS_PROVIDED
- No volume settings were provided.
-
NUMBER_OF_VALUES_DOES_NOT_MATCH_DATE_RANGE
- The values provided do not span the provided date range.
-
AD_REQUEST_ADJUSTMENT_MUST_USE_PARENT_SEGMENT_TARGETING
- A historical basis ad request source adjustment must set
useParentTrafficForecastSegmentTargeting
totrue
when the parent segment's targeting containsNOT
orOR
expressions. -
UNKNOWN
- The value returned if the actual value is not exposed by the requested API version.
Enumerations
-
SERVER_NOT_AVAILABLE
- The forecast could not be retrieved due to a server side connection problem. Please try again soon.
-
INTERNAL_ERROR
- There was an unexpected internal error.
-
NO_FORECAST_YET
- The forecast could not be retrieved because there is not enough forecasting data available yet. It may take up to one week before enough data is available.
-
NOT_ENOUGH_INVENTORY
- There's not enough inventory for the requested reservation.
-
SUCCESS
- No error from forecast.
-
ZERO_LENGTH_RESERVATION
- The requested reservation is of zero length. No forecast is returned.
-
EXCEEDED_QUOTA
- The number of requests made per second is too high and has exceeded the
allowable limit. The recommended approach to handle this error is to wait
about 5 seconds and then retry the request. Note that this does not
guarantee the request will succeed. If it fails again, try increasing the
wait time.
Another way to mitigate this error is to limit requests to 2 per second. Once again this does not guarantee that every request will succeed, but may help reduce the number of times you receive this error.
-
OUTSIDE_AVAILABLE_DATE_RANGE
- The request falls outside the date range of the available data.
-
UNKNOWN
- The value returned if the actual value is not exposed by the requested API version.
Enumerations
-
CONFLICTING_INCLUSION_OR_EXCLUSION_OF_SIBLINGS
- Both including and excluding sibling criteria is disallowed.
-
INCLUDING_DESCENDANTS_OF_EXCLUDED_CRITERIA
- Including descendants of excluded criteria is disallowed.
-
UNKNOWN
- The value returned if the actual value is not exposed by the requested API version.
Enumerations
-
TARGETED_LOCATIONS_NOT_EXCLUDABLE
- A location that is targeted cannot also be excluded.
-
EXCLUDED_LOCATIONS_CANNOT_HAVE_CHILDREN_TARGETED
- Excluded locations cannot have any of their children targeted.
-
POSTAL_CODES_CANNOT_BE_EXCLUDED
- Postal codes cannot be excluded.
-
UNTARGETABLE_LOCATION
- Indicates that location targeting is not allowed.
-
UNKNOWN
- The value returned if the actual value is not exposed by the requested API version.
InternalApiError
s
are generally not the result of an invalid request or message sent by the
client.Enumerations
-
UNEXPECTED_INTERNAL_API_ERROR
- API encountered an unexpected internal error.
-
TRANSIENT_ERROR
- A temporary error occurred during the request. Please retry.
-
UNKNOWN
- The cause of the error is not known or only defined in newer versions.
-
DOWNTIME
- The API is currently unavailable for a planned downtime.
-
ERROR_GENERATING_RESPONSE
- Mutate succeeded but server was unable to build response. Client should not retry mutate.
Enumerations
-
ILLEGAL_CHARACTERS
- The URL contains invalid characters.
-
INVALID_FORMAT
- The format of the URL is not allowed. This could occur for a number of reasons. For example, if an invalid scheme is specified (like "ftp://") or if a port is specified when not required, or if a query was specified when not required.
-
INSECURE_SCHEME
- URL contains insecure scheme.
-
NO_SCHEME
- The URL does not contain a scheme.
-
UNKNOWN
- The value returned if the actual value is not exposed by the requested API version.
Enumerations
-
AT_LEAST_ONE_PLACEMENT_OR_INVENTORY_UNIT_REQUIRED
- At least one placement or inventory unit is required
-
INVENTORY_CANNOT_BE_TARGETED_AND_EXCLUDED
- The same inventory unit or placement cannot be targeted and excluded at the same time
-
INVENTORY_UNIT_CANNOT_BE_TARGETED_IF_ANCESTOR_IS_TARGETED
- A child inventory unit cannot be targeted if its ancestor inventory unit is also targeted.
-
INVENTORY_UNIT_CANNOT_BE_TARGETED_IF_ANCESTOR_IS_EXCLUDED
- A child inventory unit cannot be targeted if its ancestor inventory unit is excluded.
-
INVENTORY_UNIT_CANNOT_BE_EXCLUDED_IF_ANCESTOR_IS_EXCLUDED
- A child inventory unit cannot be excluded if its ancestor inventory unit is also excluded.
-
EXPLICITLY_TARGETED_INVENTORY_UNIT_CANNOT_BE_TARGETED
- An explicitly targeted inventory unit cannot be targeted.
-
EXPLICITLY_TARGETED_INVENTORY_UNIT_CANNOT_BE_EXCLUDED
- An explicitly targeted inventory unit cannot be excluded.
-
SELF_ONLY_INVENTORY_UNIT_NOT_ALLOWED
- A landing page-only ad unit cannot be targeted.
-
SELF_ONLY_INVENTORY_UNIT_WITHOUT_DESCENDANTS
- A landing page-only ad unit cannot be targeted if it doesn't have any children.
-
YOUTUBE_AUDIENCE_SEGMENTS_CAN_ONLY_BE_TARGETED_WITH_YOUTUBE_SHARED_INVENTORY
- Audience segments shared from YouTube can only be targeted with inventory shared from YouTube for cross selling.
-
UNKNOWN
- The value returned if the actual value is not exposed by the requested API version.
Enumerations
-
EXPLICIT_TARGETING_NOT_ALLOWED
- AdUnit.explicitlyTargeted
can be set to
true
only in an Ad Manager 360 account. -
TARGET_PLATFORM_NOT_APPLICABLE
- The specified target platform is not applicable for the inventory unit.
-
ADSENSE_CANNOT_BE_ENABLED
- AdSense cannot be enabled on this inventory unit if it is disabled for the network.
-
ROOT_UNIT_CANNOT_BE_DEACTIVATED
- A root unit cannot be deactivated.
-
UNKNOWN
- The value returned if the actual value is not exposed by the requested API version.
Enumerations
-
INVALID_SIZES
- A size in the ad unit is too large or too small.
-
INVALID_SIZE_FOR_PLATFORM
- A size is an aspect ratio, but the ad unit is not a mobile ad unit.
-
VIDEO_FEATURE_MISSING
- A size is video, but the video feature is not enabled.
-
VIDEO_MOBILE_LINE_ITEM_FEATURE_MISSING
- A size is video in a mobile ad unit, but the mobile video feature is not enabled.
-
INVALID_SIZE_FOR_MASTER
- A size that has companions must have an environment of VIDEO_PLAYER.
-
INVALID_SIZE_FOR_COMPANION
- A size that is a companion must have an environment of BROWSER.
-
DUPLICATE_MASTER_SIZES
- Duplicate video master sizes are not allowed.
-
ASPECT_RATIO_NOT_SUPPORTED
- A size is an aspect ratio, but aspect ratio sizes are not enabled.
-
VIDEO_COMPANIONS_NOT_SUPPORTED
- A video size has companions, but companions are not allowed for the network
-
UNKNOWN
- The value returned if the actual value is not exposed by the requested API version.
Enumerations
-
ARG1_NULL
- Assuming that a method will not have more than 3 arguments, if it does, return NULL
-
ARG2_NULL
-
ARG3_NULL
-
NULL
-
UNKNOWN
- The value returned if the actual value is not exposed by the requested API version.
Enumerations
-
NULL_CONTENT
- Specified list/container must not contain any null elements
Enumerations
-
UNPARSABLE
- Indicates an error in parsing an attribute.
-
UNKNOWN
- The value returned if the actual value is not exposed by the requested API version.
Enumerations
-
PERMISSION_DENIED
- User does not have the required permission for the request.
-
UNKNOWN
- The value returned if the actual value is not exposed by the requested API version.
Enumerations
-
UNEXECUTABLE
- Indicates that there was an error executing the PQL.
-
UNKNOWN
- The value returned if the actual value is not exposed by the requested API version.
Enumerations
-
UNPARSABLE
- Indicates that there was a PQL syntax error.
-
UNKNOWN
- The value returned if the actual value is not exposed by the requested API version.
Enumerations
-
EXCEEDED_QUOTA
- The number of requests made per second is too high and has exceeded
the allowable limit. The recommended approach to handle this error
is to wait about 5 seconds and then retry the request. Note that
this does not guarantee the request will succeed. If it fails
again, try increasing the wait time.
Another way to mitigate this error is to limit requests to 8 per second for Ad Manager 360 accounts, or 2 per second for Ad Manager accounts. Once again this does not guarantee that every request will succeed, but may help reduce the number of times you receive this error.
-
UNKNOWN
- The value returned if the actual value is not exposed by the requested API version.
-
REPORT_JOB_LIMIT
- This user has exceeded the allowed number of new report requests
per hour (this includes both reports run via the UI and reports run
via ReportService.runReportJob
). The recommended approach to handle this error
is to wait about 10 minutes and then retry the request. Note that
this does not guarantee the request will succeed. If it fails
again, try increasing the wait time.
Another way to mitigate this error is to limit the number of new report requests to 250 per hour per user. Once again, this does not guarantee that every request will succeed, but may help reduce the number of times you receive this error.
-
SEGMENT_POPULATION_LIMIT
- This network has exceeded the allowed number of identifiers uploaded within a 24 hour period. The recommended approach to handle this error is to wait 30 minutes and then retry the request. Note that this does not guarantee the request will succeed. If it fails again, try increasing the wait time.
Enumerations
-
REQUIRED
- A required collection is missing.
-
TOO_LARGE
- Collection size is too large.
-
TOO_SMALL
- Collection size is too small.
-
UNKNOWN
- The value returned if the actual value is not exposed by the requested API version.
Enumerations
-
REQUIRED
- Missing required field.
Enumerations
-
SERVER_ERROR
- Indicates that an unexpected error occured.
-
SERVER_BUSY
- Indicates that the server is currently experiencing a high load. Please wait and try your request again.
-
UNKNOWN
- The value returned if the actual value is not exposed by the requested API version.
Enumerations
-
VARIABLE_NOT_BOUND_TO_VALUE
- A bind variable has not been bound to a value.
-
UNKNOWN
- The value returned if the actual value is not exposed by the requested API version.
Enumerations
-
UNKNOWN
-
ILLEGAL_CHARS
- The input string value contains disallowed characters.
-
INVALID_FORMAT
- The input string value is invalid for the associated field.
Enumerations
-
TOO_LONG
-
TOO_SHORT
-
UNKNOWN
- The value returned if the actual value is not exposed by the requested API version.
Enumerations
-
MOBILE_LINE_ITEM_CONTAINS_WEB_TECH_CRITERIA
- Mobile line item cannot target web-only targeting criteria.
-
WEB_LINE_ITEM_CONTAINS_MOBILE_TECH_CRITERIA
- Web line item cannot target mobile-only targeting criteria.
-
MOBILE_CARRIER_TARGETING_FEATURE_NOT_ENABLED
- The mobile carrier targeting feature is not enabled.
-
DEVICE_CAPABILITY_TARGETING_FEATURE_NOT_ENABLED
- The device capability targeting feature is not enabled.
-
UNKNOWN
- The value returned if the actual value is not exposed by the requested API version.
Enumerations
-
CANNOT_UPDATE_TARGETING_AFTER_CREATION
- Segment targeting cannot be changed after segment creation.
-
TARGETING_NOT_UNIQUE
- The targeting expression that defines the segment is not unique
within the given network's segments.
The ID of the colliding segment will be provided in the ApiError.trigger .
-
UNKNOWN
- The value returned if the actual value is not exposed by the requested API version.
Enumerations
-
INVALID_DOMAIN_NAMES
- Invalid domain names. Domain names must be at most 67 characters long. And must contain only alphanumeric characters and hyphens.
-
UNKNOWN
- The value returned if the actual value is not exposed by the requested API version.