PlacementService (v202411)

AI-generated Key Takeaways

• The Placement Service in Google Ad Manager allows for the creation, retrieval, updating, and execution of actions on Placement objects, which group ad units for targeted advertising.

• Placements can be used to organize ad inventory based on specific criteria, such as targeting or discounts.

• A variety of potential errors can occur when using the Placement Service, including authentication issues, permission errors, and data validation problems.

• Each error type has specific reasons associated with it, providing more details on the cause of the failure, enabling troubleshooting and resolution.

• Developers should familiarize themselves with these error types and their reasons to effectively handle potential issues when interacting with the Placement Service.

Provides methods for creating, updating and retrieving Placement objects.

You can use a placement to group ad units. For example, you might have a placement that focuses on sports sites, which may be spread across different branches of your inventory. You might also have a "fire sale" placement that includes ad units that have not been selling and are consequently priced very attractively.

---

Production WSDL

https://ads.google.com/apis/ads/publisher/v202411/PlacementService?wsdl

Namespace

https://www.google.com/apis/ads/publisher/v202411

Operations

• createPlacements
• getPlacementsByStatement
• performPlacementAction
• updatePlacements

Errors

• ApiVersionError
• AuthenticationError
• CollectionSizeError
• CommonError
• EntityChildrenLimitReachedError
• EntityLimitReachedError
• FeatureError
• InternalApiError
• NotNullError
• NullError
• ParseError
• PermissionError
• PlacementError
• PublisherQueryLanguageContextError
• PublisherQueryLanguageSyntaxError
• QuotaError
• RangeError
• RegExError
• RequiredCollectionError
• RequiredError
• ServerError
• StatementError
• StringFormatError
• StringLengthError
• TypeError
• UniqueError

createPlacements

Creates new Placement objects.

Parameters

Field	Type	Description
placements	Placement[]

Response

Field	Type	Description
rval	Placement[]

getPlacementsByStatement

Gets a PlacementPage of Placement objects that satisfy the given Statement.query. The following fields are supported for filtering:

PQL Property	Object Property
description	Placement.description
id	Placement.id
name	Placement.name
placementCode	Placement.placementCode
status	Placement.status
lastModifiedDateTime	Placement.lastModifiedDateTime

Parameters

Field	Type	Description
filterStatement	Statement

Response

Field	Type	Description
rval	PlacementPage

performPlacementAction

Performs actions on Placement objects that match the given Statement.query.

Parameters

Field	Type	Description
placementAction	PlacementAction ActivatePlacements ArchivePlacements DeactivatePlacements
filterStatement	Statement

Response

Field	Type	Description
rval	UpdateResult

updatePlacements

Updates the specified Placement objects.

Parameters

Field	Type	Description
placements	Placement[]

Response

Field	Type	Description
rval	Placement[]

Errors

Error	Reasons
ApiVersionError	Errors related to the usage of API versions. 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.
AuthenticationError	An error for an exception that occurred when authenticating. 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 and oAuthToken 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 optional networkCode. 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.
CollectionSizeError	Error for the size of the collection being too large Enumerations TOO_LARGE UNKNOWN The value returned if the actual value is not exposed by the requested API version.
CommonError	A place for common errors that can be used across services. 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.
EntityChildrenLimitReachedError	Lists errors relating to having too many children on an entity. Enumerations LINE_ITEM_LIMIT_FOR_ORDER_REACHED The number of line items on the order exceeds the max number of line items allowed per order in the network. CREATIVE_ASSOCIATION_LIMIT_FOR_LINE_ITEM_REACHED The number of creatives associated with the line item exceeds the max number of creatives allowed to be associated with a line item in the network. AD_UNIT_LIMIT_FOR_PLACEMENT_REACHED The number of ad units on the placement exceeds the max number of ad units allowed per placement in the network. TARGETING_EXPRESSION_LIMIT_FOR_LINE_ITEM_REACHED The number of targeting expressions on the line item exceeds the max number of targeting expressions allowed per line item in the network. TARGETING_EXPRESSION_SIZE_LIMIT_REACHED The size of a single targeting expression tree exceeds the max size allowed by the network. CUSTOM_TARGETING_VALUES_FOR_KEY_LIMIT_REACHED The number of custom targeting values for the free-form or predefined custom targeting key exceeds the max number allowed. TARGETING_EXPRESSION_LIMIT_FOR_CREATIVES_ON_LINE_ITEM_REACHED The total number of targeting expressions on the creatives for the line item exceeds the max number allowed per line item in the network. ATTACHMENT_LIMIT_FOR_PROPOSAL_REACHED The number of attachments added to the proposal exceeds the max number allowed per proposal in the network. PROPOSAL_LINE_ITEM_LIMIT_FOR_PROPOSAL_REACHED The number of proposal line items on the proposal exceeds the max number allowed per proposal in the network. PRODUCT_LIMIT_FOR_PRODUCT_PACKAGE_REACHED The number of product package items on the product package exceeds the max number allowed per product package in the network. PRODUCT_TEMPLATE_AND_PRODUCT_BASE_RATE_LIMIT_FOR_RATE_CARD_REACHED The number of product template and product base rates on the rate card (including excluded product base rates) exceeds the max number allowed per rate card in the network. PRODUCT_PACKAGE_ITEM_BASE_RATE_LIMIT_FOR_RATE_CARD_REACHED The number of product package item base rates on the rate card exceeds the max number allowed per rate card in the network. PREMIUM_LIMIT_FOR_RATE_CARD_REACHED The number of premiums of the rate card exceeds the max number allowed per rate card in the network. AD_UNIT_LIMIT_FOR_AD_EXCLUSION_RULE_TARGETING_REACHED The number of ad units on AdExclusionRule.inventoryTargeting exceeds the max number of ad units allowed per ad exclusion rule inventory targeting in the network. NATIVE_STYLE_LIMIT_FOR_NATIVE_AD_FORMAT_REACHED The number of native styles under the native creative template exceeds the max number of native styles allowed per native creative template in the network. TARGETING_EXPRESSION_LIMIT_FOR_PRESENTATION_ASSIGNMENT_REACHED The number of targeting expressions on the native style exceeds the max number of targeting expressions allowed per native style in the network. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
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 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. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
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 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.
InternalApiError	Indicates that a server-side error has occured. InternalApiErrors 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.
NotNullError	Caused by supplying a null value for an attribute that cannot be null. 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.
NullError	Errors associated with violation of a NOT NULL check. Enumerations NULL_CONTENT Specified list/container must not contain any null elements
ParseError	Lists errors related to parsing. 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.
PermissionError	Errors related to incorrect permission. 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.
PlacementError	Class defining all validation errors for a placement. Enumerations INVALID_ENTITY_TYPE Entity type is something other than inventory or content. SHARED_INVENTORY_ASSIGNED Shared inventory cannot be assigned to a placement. PLACEMENTS_CANNOT_INCLUDE_INVENTORY_FROM_MULTIPLE_DISTRIBUTOR_NETWORKS Shared inventory from one distributor network cannot be in the same placement with inventory from another distributor. PLACEMENTS_CANNOT_INCLUDE_BOTH_LOCAL_AND_SHARED_INVENTORY Shared inventory and local inventory cannot be in the same placement. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
PublisherQueryLanguageContextError	An error that occurs while executing a PQL query contained in a Statement object. 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.
PublisherQueryLanguageSyntaxError	An error that occurs while parsing a PQL query contained in a Statement object. 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.
QuotaError	Describes a client-side error on which a user is attempting to perform an action to which they have no quota remaining. 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.
RangeError	A list of all errors associated with the Range constraint. Enumerations TOO_HIGH TOO_LOW UNKNOWN The value returned if the actual value is not exposed by the requested API version.
RegExError	Caused by supplying a value for an object attribute that does not conform to a documented valid regular expression. Enumerations INVALID Invalid value found. NULL Null value found. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
RequiredCollectionError	A list of all errors to be used for validating sizes of collections. 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.
RequiredError	Errors due to missing required field. Enumerations REQUIRED Missing required field.
ServerError	Errors related to the server. 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.
StatementError	An error that occurs while parsing Statement objects. 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.
StringFormatError	A list of error code for reporting invalid content of input strings. Enumerations UNKNOWN ILLEGAL_CHARS The input string value contains disallowed characters. INVALID_FORMAT The input string value is invalid for the associated field.
StringLengthError	Errors for Strings which do not meet given length constraints. Enumerations TOO_LONG TOO_SHORT UNKNOWN The value returned if the actual value is not exposed by the requested API version.
TypeError	An error for a field which is an invalid type.
UniqueError	An error for a field which must satisfy a uniqueness constraint