CmsMetadataService (v202508)

Provides methods for querying CMS metadata keys and values.

A CMS metadata value corresponds to one key value pair ingested from a publisher's CMS and is used to target all the content with which it is associated in the CMS.

---

Production WSDL

https://ads.google.com/apis/ads/publisher/v202508/CmsMetadataService?wsdl

Namespace

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

Operations

• getCmsMetadataKeysByStatement
• getCmsMetadataValuesByStatement
• performCmsMetadataKeyAction
• performCmsMetadataValueAction

Errors

• ApiVersionError
• AuthenticationError
• CollectionSizeError
• CommonError
• FeatureError
• InternalApiError
• MetadataMergeSpecError
• NotNullError
• ParseError
• PermissionError
• PublisherQueryLanguageContextError
• PublisherQueryLanguageSyntaxError
• QuotaError
• RangeError
• RequiredCollectionError
• RequiredError
• ServerError
• StatementError
• StringFormatError
• StringLengthError
• UniqueError

getCmsMetadataKeysByStatement

Returns a page of CmsMetadataKeys matching the specified Statement. The following fields are supported for filtering:

PQL Property	Object Property
id	CmsMetadataKey.cmsMetadataKeyId
cmsKey	CmsMetadataKey.keyName
status	CmsMetadataKey.status

Parameters

Field	Type	Description
statement	Statement

Response

Field	Type	Description
rval	CmsMetadataKeyPage

getCmsMetadataValuesByStatement

Returns a page of CmsMetadataValues matching the specified Statement. The following fields are supported for filtering:

PQL Property	Object Property
id	CmsMetadataValue.cmsMetadataValueId
cmsValue	CmsMetadataValue.valueName
cmsKey	CmsMetadataValue.key
cmsKeyId	CmsMetadataValue.key
status	CmsMetadataValue.status

Parameters

Field	Type	Description
statement	Statement

Response

Field	Type	Description
rval	CmsMetadataValuePage

performCmsMetadataKeyAction

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

Parameters

Field	Type	Description
keyAction	CmsMetadataKeyAction ActivateCmsMetadataKeys DeactivateCmsMetadataKeys
filterStatement	Statement

Response

Field	Type	Description
rval	UpdateResult

performCmsMetadataValueAction

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

Parameters

Field	Type	Description
valueAction	CmsMetadataValueAction ActivateCmsMetadataValues DeactivateCmsMetadataValues
filterStatement	Statement

Response

Field	Type	Description
rval	UpdateResult

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. REQUEST_TOO_LARGE Indicates that the request is too large to be processed. This error is thrown when internal system limits are exceeded due to the number of affected entities implied by the input parameters. Clients should reduce the number of affected entities and try again. 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.
MetadataMergeSpecError	Errors associated with metadata merge specs. Enumerations INPUT_ID_ALREADY_USED The merge rule has an input id that is already used by another merge rule. BOUND_SPECIFIED_WITHOUT_VALUE The merge rule has an bucket where a bound type was specified without a min/max. VALUE_SPECIFIED_WITHOUT_BOUND The merge rule has an bucket where a min/max was specified without a bound type. MIN_EXCEEDS_MAX The merge rule has an bucket range where the min exceeds the max. MORE_THAN_ONE_INPUT_KEY_HAS_VALUE_RULES Tried to merge two or more rules which have value rules. VALUE_SPECIFIED_DOES_NOT_MATCH_OUTPUT_KEY Tried to set a rule for a value that does not match rule output namespace. CANNOT_MERGE_VALUES_WHERE_VALUE_BUCKET_EXISTS Tried to merge values on an existing rule that has value bucketing. CANNOT_MODIFY_RESERVED_KEY Tried to create a rule that depends on a reserved key. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
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.
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.
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.
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.
UniqueError	An error for a field which must satisfy a uniqueness constraint