Provides methods for creating, updating and retrieving AdExclusionRule objects.
An AdExclusionRule provides a way to block specified ads from showing on portions of your site. Each rule specifies the inventory on which the rule is in effect, and the labels to block on that inventory.
- Production WSDL
-
https://ads.google.com/apis/ads/publisher/v202111/AdExclusionRuleService?wsdl
- Namespace
-
https://www.google.com/apis/ads/publisher/v202111
- Operations
- Errors
-
- AdExclusionRuleError
- ApiVersionError
- AuthenticationError
- CollectionSizeError
- CommonError
- EntityChildrenLimitReachedError
- EntityLimitReachedError
- FeatureError
- InternalApiError
- NotNullError
- ParseError
- PermissionError
- PublisherQueryLanguageContextError
- PublisherQueryLanguageSyntaxError
- QuotaError
- RequiredCollectionError
- RequiredError
- ServerError
- StatementError
- StringFormatError
- StringLengthError
- UniqueError
createAdExclusionRules
Creates new AdExclusionRule objects.
Parameters
Field | Type | Description |
---|---|---|
adExclusionRules
|
|
the ad exclusion rules to create |
Response
Field | Type | Description |
---|---|---|
rval
|
|
the created rules with their IDs filled in |
getAdExclusionRulesByStatement
Gets a AdExclusionRulePage of AdExclusionRule objects that satisfy the given Statement.query. The following fields are supported for filtering:
PQL Property | Object Property |
---|---|
id
|
AdExclusionRule.id |
name
|
AdExclusionRule.name |
status
|
AdExclusionRule.status |
Parameters
Field | Type | Description |
---|---|---|
filterStatement
|
|
a Publisher Query Language statement used to filter a set of rules |
Response
Field | Type | Description |
---|---|---|
rval
|
|
the rules that match the given filter |
performAdExclusionRuleAction
Performs action on AdExclusionRule objects that satisfy the given Statement.query.
Parameters
Field | Type | Description |
---|---|---|
adExclusionRuleAction
|
|
the action to perform |
filterStatement
|
|
a Publisher Query Language statement used to filter a set of ad exclusion rules |
Response
Field | Type | Description |
---|---|---|
rval
|
|
the result of the action performed |
updateAdExclusionRules
Updates the specified AdExclusionRule objects.
Parameters
Field | Type | Description |
---|---|---|
adExclusionRules
|
|
the ad exclusion rules to update |
Response
Field | Type | Description |
---|---|---|
rval
|
|
the updated rules |
Errors
Error | Reasons |
---|---|
AdExclusionRuleError
|
Ad exclusion rule specific errors.
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
|
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
|
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
|
NotNullError
|
Caused by supplying a null value for an attribute that cannot be null.
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
|
UniqueError
|
An error for a field which must satisfy a uniqueness constraint |