Provides operations for creating, updating and retrieving AdUnit objects.
Line items connect a creative with its associated ad unit through targeting.
An ad unit represents a piece of inventory within a publisher. It contains all the settings that need to be associated with the inventory in order to serve ads. For example, the ad unit contains creative size restrictions and AdSense settings.
- Production WSDL
-
https://ads.google.com/apis/ads/publisher/v202311/InventoryService?wsdl
- Namespace
-
https://www.google.com/apis/ads/publisher/v202311
- Operations
- Errors
-
- AdSenseAccountError
- AdUnitCodeError
- AdUnitHierarchyError
- ApiVersionError
- AuthenticationError
- CollectionSizeError
- CommonError
- CompanyError
- CreativeWrapperError
- CrossSellError
- EntityChildrenLimitReachedError
- EntityLimitReachedError
- FeatureError
- FrequencyCapError
- InternalApiError
- InvalidColorError
- InvalidUrlError
- InventoryUnitError
- InventoryUnitRefreshRateError
- InventoryUnitSizesError
- LabelEntityAssociationError
- NotNullError
- NullError
- ParseError
- PermissionError
- PublisherQueryLanguageContextError
- PublisherQueryLanguageSyntaxError
- QuotaError
- RangeError
- RegExError
- RequiredCollectionError
- RequiredError
- RequiredNumberError
- ServerError
- StatementError
- StringFormatError
- StringLengthError
- TeamError
- TypeError
- UniqueError
createAdUnits
Creates new AdUnit objects.
Parameters
Field | Type | Description |
---|---|---|
adUnits
|
|
Response
Field | Type | Description |
---|---|---|
rval
|
|
getAdUnitSizesByStatement
Returns a set of all relevant AdUnitSize objects.
The given Statement is currently ignored but may be honored in future versions.
Parameters
Field | Type | Description |
---|---|---|
filterStatement
|
|
Response
Field | Type | Description |
---|---|---|
rval
|
|
getAdUnitsByStatement
Gets a AdUnitPage of AdUnit objects that satisfy the given Statement.query. The following fields are supported for filtering:
PQL Property | Object Property |
---|---|
adUnitCode
|
AdUnit.adUnitCode |
id
|
AdUnit.id |
name
|
AdUnit.name |
parentId
|
AdUnit.parentId |
status
|
AdUnit.status |
lastModifiedDateTime
|
AdUnit.lastModifiedDateTime |
Parameters
Field | Type | Description |
---|---|---|
filterStatement
|
|
Response
Field | Type | Description |
---|---|---|
rval
|
|
performAdUnitAction
Performs actions on AdUnit objects that match the given Statement.query.
Parameters
Field | Type | Description |
---|---|---|
adUnitAction
|
|
|
filterStatement
|
|
Response
Field | Type | Description |
---|---|---|
rval
|
|
updateAdUnits
Updates the specified AdUnit objects.
Parameters
Field | Type | Description |
---|---|---|
adUnits
|
|
Response
Field | Type | Description |
---|---|---|
rval
|
|
Errors
Error | Reasons |
---|---|
AdSenseAccountError
|
Error for AdSense related API calls.
Enumerations
|
AdUnitCodeError
|
Lists the generic errors associated with AdUnit.adUnitCode.
Enumerations
|
AdUnitHierarchyError
|
Caused by creating an AdUnit object with an invalid hierarchy.
Enumerations
|
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
|
CompanyError
|
A list of all errors associated with companies.
Enumerations
|
CreativeWrapperError
|
Errors specific to creative wrappers.
Enumerations
|
CrossSellError
|
Lists all errors associated with cross selling.
Enumerations
|
EntityChildrenLimitReachedError
|
Lists errors relating to having too many children on an entity.
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
|
FrequencyCapError
|
Lists all errors associated with frequency caps.
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
|
InvalidColorError
|
A list of all errors associated with a color attribute.
Enumerations
|
InvalidUrlError
|
Lists all errors associated with URLs.
Enumerations
|
InventoryUnitError
|
Lists the generic errors associated with AdUnit objects.
Enumerations
|
InventoryUnitRefreshRateError
|
Lists errors relating to AdUnit.refreshRate.
Enumerations
|
InventoryUnitSizesError
|
An error specifically for InventoryUnitSizes.
Enumerations
|
LabelEntityAssociationError
|
Errors specific to creating label entity associations.
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
|
RangeError
|
A list of all errors associated with the Range constraint.
Enumerations
|
RegExError
|
Caused by supplying a value for an object attribute that does not conform
to a documented valid regular expression.
Enumerations
|
RequiredCollectionError
|
A list of all errors to be used for validating sizes of collections.
Enumerations
|
RequiredError
|
Errors due to missing required field.
Enumerations
|
RequiredNumberError
|
A list of all errors to be used in conjunction with required number
validators.
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
|
TeamError
|
Errors related to a Team.
Enumerations
|
TypeError
|
An error for a field which is an invalid type. |
UniqueError
|
An error for a field which must satisfy a uniqueness constraint |