MediaService (v201809)

Use this service to manage media.


Production WSDL
https://adwords.google.com/api/adwords/cm/v201809/MediaService?wsdl
Namespace
https://adwords.google.com/api/adwords/cm/v201809
Operations
Errors

get

Returns a list of media that meet the criteria specified by the selector.

Note: MediaService will not return any ImageAd image files.

Parameters

Field Type Description
serviceSelector Selector Selects which media objects to return.

Response

Field Type Description
rval MediaPage A list of Media objects.

query

Returns the list of Media objects that match the query.

Parameters

Field Type Description
query xsd:string The SQL-like AWQL query string

Response

Field Type Description
rval MediaPage

upload

Uploads new media. Currently, you can upload Image files and MediaBundles.

Parameters

Field Type Description
media
  1. Media[]
    1. Audio
    2. Image
    3. MediaBundle
    4. Video
A list of Media objects, each containing the data to be uploaded.

Response

Field Type Description
rval
  1. Media[]
    1. Audio
    2. Image
    3. MediaBundle
    4. Video
A list of uploaded media in the same order as the argument list.

Errors

Error Reasons
AudioError Error class for errors associated with parsing audio data.
Enumerations
INVALID_AUDIO
PROBLEM_READING_AUDIO_FILE
ERROR_STORING_AUDIO
FILE_TOO_LARGE
UNSUPPORTED_AUDIO
ERROR_GENERATING_STREAMING_URL
AuthenticationError Errors returned when Authentication failed.
Enumerations
AUTHENTICATION_FAILED
Authentication of the request failed.
CLIENT_CUSTOMER_ID_IS_REQUIRED
Client Customer Id is required if CustomerIdMode is set to CLIENT_EXTERNAL_CUSTOMER_ID. Starting version V201409 ClientCustomerId will be required for all requests except for CustomerService.get
CLIENT_EMAIL_REQUIRED
Client Email is required if CustomerIdMode is set to CLIENT_EXTERNAL_EMAIL_FIELD.
CLIENT_CUSTOMER_ID_INVALID
Client customer Id is not a number.
CLIENT_EMAIL_INVALID
Client customer Id is not a number.
CLIENT_EMAIL_FAILED_TO_AUTHENTICATE
Client email is not a valid customer email.
CUSTOMER_NOT_FOUND
No customer found for the customer id provided in the header.
GOOGLE_ACCOUNT_DELETED
Client's Google Account is deleted.
GOOGLE_ACCOUNT_COOKIE_INVALID
Google account login token in the cookie is invalid.
FAILED_TO_AUTHENTICATE_GOOGLE_ACCOUNT
problem occurred during Google account authentication.
GOOGLE_ACCOUNT_USER_AND_ADS_USER_MISMATCH
The user in the google account login token does not match the UserId in the cookie.
LOGIN_COOKIE_REQUIRED
Login cookie is required for authentication.
NOT_ADS_USER
User in the cookie is not a valid Ads user.
OAUTH_TOKEN_INVALID
Oauth token in the header is not valid.
OAUTH_TOKEN_EXPIRED
Oauth token in the header has expired.
OAUTH_TOKEN_DISABLED
Oauth token in the header has been disabled.
OAUTH_TOKEN_REVOKED
Oauth token in the header has been revoked.
OAUTH_TOKEN_HEADER_INVALID
Oauth token HTTP header is malformed.
LOGIN_COOKIE_INVALID
Login cookie is not valid.
FAILED_TO_RETRIEVE_LOGIN_COOKIE
Failed to decrypt the login cookie.
USER_ID_INVALID
User Id in the header is not a valid id.
AuthorizationError Errors encountered when trying to authorize a user.
Enumerations
UNABLE_TO_AUTHORIZE
Could not complete authorization due to an internal problem.
NO_ADWORDS_ACCOUNT_FOR_CUSTOMER
Customer has no AdWords account.
USER_PERMISSION_DENIED
User doesn't have permission to access customer.
EFFECTIVE_USER_PERMISSION_DENIED
Effective user doesn't have permission to access this customer.
CUSTOMER_NOT_ACTIVE
Access denied since the customer is not active.
USER_HAS_READONLY_PERMISSION
User has read-only permission cannot mutate.
NO_CUSTOMER_FOUND
No customer found.
SERVICE_ACCESS_DENIED
Developer doesn't have permission to access service.
TWO_STEP_VERIFICATION_NOT_ENROLLED
The customer has a policy to enforce 2-Step Verification, but the user is not enrolled.
ADVANCED_PROTECTION_NOT_ENROLLED
The customer has a policy to enforce enrollment in the Advanced Protection Program, but the user is not enrolled.
ClientTermsError Error due to user not accepting the AdWords terms of service.
Enumerations
INCOMPLETE_SIGNUP_CURRENT_ADWORDS_TNC_NOT_AGREED
Customer has not agreed to the latest AdWords Terms & Conditions
DatabaseError Errors that are thrown due to a database access problem.
Enumerations
CONCURRENT_MODIFICATION
A concurrency problem occurred as two threads were attempting to modify same object.
PERMISSION_DENIED
The permission was denied to access an object.
ACCESS_PROHIBITED
The user's access to an object has been prohibited.
CAMPAIGN_PRODUCT_NOT_SUPPORTED
Requested campaign belongs to a product that is not supported by the api.
DUPLICATE_KEY
a duplicate key was detected upon insertion
DATABASE_ERROR
a database error has occurred
UNKNOWN
an unknown error has occurred
DistinctError Errors related to distinct ids or content.
Enumerations
DUPLICATE_ELEMENT
DUPLICATE_TYPE
EntityNotFound An id did not correspond to an entity, or it referred to an entity which does not belong to the customer.
Enumerations
INVALID_ID
The specified id refered to an entity which either doesn't exist or is not accessible to the customer. e.g. campaign belongs to another customer.
IdError Errors associated with the ids.
Enumerations
NOT_FOUND
Id not found
ImageError Error class for errors associated with parsing image data.
Enumerations
INVALID_IMAGE
The image is not valid.
STORAGE_ERROR
The image could not be stored.
BAD_REQUEST
There was a problem with the request.
UNEXPECTED_SIZE
The image is not of legal dimensions.
ANIMATED_NOT_ALLOWED
Animated image are not permitted.
ANIMATION_TOO_LONG
Animation is too long.
SERVER_ERROR
There was an error on the server.
CMYK_JPEG_NOT_ALLOWED
Image cannot be in CMYK color format.
FLASH_NOT_ALLOWED
Flash images are not permitted.
FLASH_WITHOUT_CLICKTAG
Flash images must support clickTag.
FLASH_ERROR_AFTER_FIXING_CLICK_TAG
A flash error has occurred after fixing the click tag.
ANIMATED_VISUAL_EFFECT
Unacceptable visual effects.
FLASH_ERROR
There was a problem with the flash image.
LAYOUT_PROBLEM
Incorrect image layout.
PROBLEM_READING_IMAGE_FILE
There was a problem reading the image file.
ERROR_STORING_IMAGE
There was an error storing the image.
ASPECT_RATIO_NOT_ALLOWED
The aspect ratio of the image is not allowed.
FLASH_HAS_NETWORK_OBJECTS
Flash cannot have network objects.
FLASH_HAS_NETWORK_METHODS
Flash cannot have network methods.
FLASH_HAS_URL
Flash cannot have a Url.
FLASH_HAS_MOUSE_TRACKING
Flash cannot use mouse tracking.
FLASH_HAS_RANDOM_NUM
Flash cannot have a random number.
FLASH_SELF_TARGETS
Ad click target cannot be '_self'.
FLASH_BAD_GETURL_TARGET
GetUrl method should only use '_blank'.
FLASH_VERSION_NOT_SUPPORTED
Flash version is not supported.
FLASH_WITHOUT_HARD_CODED_CLICK_URL
Flash movies need to have hard coded click URL or clickTAG
INVALID_FLASH_FILE
Uploaded flash file is corrupted.
FAILED_TO_FIX_CLICK_TAG_IN_FLASH
Uploaded flash file can be parsed, but the click tag can not be fixed properly.
FLASH_ACCESSES_NETWORK_RESOURCES
Flash movie accesses network resources
FLASH_EXTERNAL_JS_CALL
Flash movie attempts to call external javascript code
FLASH_EXTERNAL_FS_CALL
Flash movie attempts to call flash system commands
FILE_TOO_LARGE
Image file is too large.
IMAGE_DATA_TOO_LARGE
Image data is too large.
IMAGE_PROCESSING_ERROR
Error while processing the image.
IMAGE_TOO_SMALL
Image is too small.
INVALID_INPUT
Input was invalid.
PROBLEM_READING_FILE
There was a problem reading the image file.
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.
MediaBundleError Error class for errors associated with parsing media bundle data.
Enumerations
ENTRY_POINT_CANNOT_BE_SET_USING_MEDIA_SERVICE
The entryPoint field cannot be set using the MediaService.
BAD_REQUEST
There was a problem with the request.
DOUBLECLICK_BUNDLE_NOT_ALLOWED
HTML5 ads using DoubleClick Studio created ZIP files are not supported.
EXTERNAL_URL_NOT_ALLOWED
Cannot reference URL external to the media bundle.
FILE_TOO_LARGE
Media bundle file is too large.
GOOGLE_WEB_DESIGNER_ZIP_FILE_NOT_PUBLISHED
ZIP file from Google Web Designer is not published.
INVALID_INPUT
Input was invalid.
INVALID_MEDIA_BUNDLE
There was a problem with the media bundle.
INVALID_MEDIA_BUNDLE_ENTRY
There was a problem with one or more of the media bundle entries.
INVALID_MIME_TYPE
The media bundle contains a file with an unknown mime type
INVALID_PATH
The media bundle contain an invalid asset path.
INVALID_URL_REFERENCE
HTML5 ad is trying to reference an asset not in .ZIP file
MEDIA_DATA_TOO_LARGE
Media data is too large.
MISSING_PRIMARY_MEDIA_BUNDLE_ENTRY
The media bundle contains no primary entry.
SERVER_ERROR
There was an error on the server.
STORAGE_ERROR
The image could not be stored.
SWIFFY_BUNDLE_NOT_ALLOWED
Media bundle created with the Swiffy tool is not allowed.
TOO_MANY_FILES
The media bundle contains too many files.
UNEXPECTED_SIZE
The media bundle is not of legal dimensions.
UNSUPPORTED_GOOGLE_WEB_DESIGNER_ENVIRONMENT
Google Web Designer not created for "AdWords" environment.
UNSUPPORTED_HTML5_FEATURE
Unsupported HTML5 feature in HTML5 asset.
URL_IN_MEDIA_BUNDLE_NOT_SSL_COMPLIANT
URL in HTML5 entry is not ssl compliant.
CUSTOM_EXIT_NOT_ALLOWED
Custom exits not allowed in HTML5 entry.
MediaError Error class for media related errors.
Enumerations
CANNOT_ADD_STANDARD_ICON
Cannot add a standard icon type
CANNOT_SELECT_STANDARD_ICON_WITH_OTHER_TYPES
May only select Standard Icons alone
CANNOT_SPECIFY_MEDIA_ID_AND_DATA
Image contains both a media ID and media data.
DUPLICATE_MEDIA
A media with given type and reference id already exists
EMPTY_FIELD
A required field was not specified or is an empty string.
ENTITY_REFERENCED_IN_MULTIPLE_OPS
A media may only be modified once per call
FIELD_NOT_SUPPORTED_FOR_MEDIA_SUB_TYPE
Field is not supported for the media sub type.
INVALID_MEDIA_ID
The media id is invalid
INVALID_MEDIA_SUB_TYPE
The media subtype is invalid
INVALID_MEDIA_TYPE
The media type is invalid
INVALID_MIME_TYPE
The mimetype is invalid
INVALID_REFERENCE_ID
The media reference id is invalid
INVALID_YOU_TUBE_ID
The YouTube video id is invalid
MEDIA_FAILED_TRANSCODING
Media has failed transcoding
MEDIA_NOT_TRANSCODED
Media has not been transcoded
MEDIA_TYPE_DOES_NOT_MATCH_OBJECT_TYPE
The MediaType does not match the actual media object's type
NO_FIELDS_SPECIFIED
None of the fields have been specified.
NULL_REFERENCE_ID_AND_MEDIA_ID
One of reference Id or media Id must be specified
TOO_LONG
The string has too many characters.
UNSUPPORTED_OPERATION
The specified operation is not supported. Only ADD, SET, and REMOVE are supported
UNSUPPORTED_TYPE
The specified type is not supported.
YOU_TUBE_SERVICE_UNAVAILABLE
YouTube is unavailable for requesting video data.
YOU_TUBE_VIDEO_HAS_NON_POSITIVE_DURATION
The YouTube video has a non positive duration.
YOU_TUBE_VIDEO_NOT_FOUND
The YouTube video id is syntactically valid but the video was not found.
NewEntityCreationError Error associated with creation of new entities.
Enumerations
CANNOT_SET_ID_FOR_ADD
Do not set the id field while creating new entities.
DUPLICATE_TEMP_IDS
Creating more than one entity with the same temp ID is not allowed.
TEMP_ID_ENTITY_HAD_ERRORS
Parent object with specified temp id failed validation, so no deep validation will be done for this child entity.
NotEmptyError Errors corresponding with violation of a NOT EMPTY check.
Enumerations
EMPTY_LIST
NullError Errors associated with violation of a NOT NULL check.
Enumerations
NULL_CONTENT
Specified list/container must not contain any null elements
OperationAccessDenied Operation not permitted due to the invoked service's access policy.
Enumerations
ACTION_NOT_PERMITTED
Unauthorized invocation of a service's method (get, mutate, etc.)
ADD_OPERATION_NOT_PERMITTED
Unauthorized ADD operation in invoking a service's mutate method.
REMOVE_OPERATION_NOT_PERMITTED
Unauthorized REMOVE operation in invoking a service's mutate method.
SET_OPERATION_NOT_PERMITTED
Unauthorized SET operation in invoking a service's mutate method.
MUTATE_ACTION_NOT_PERMITTED_FOR_CLIENT
A mutate action is not allowed on this campaign, from this client.
OPERATION_NOT_PERMITTED_FOR_CAMPAIGN_TYPE
This operation is not permitted on this campaign type
ADD_AS_REMOVED_NOT_PERMITTED
An ADD operation may not set status to REMOVED.
OPERATION_NOT_PERMITTED_FOR_REMOVED_ENTITY
This operation is not allowed because the campaign or adgroup is removed.
OPERATION_NOT_PERMITTED_FOR_AD_GROUP_TYPE
This operation is not permitted on this ad group type.
UNKNOWN
The reason the invoked method or operation is prohibited is not known (the client may be of an older version than the server).
OperatorError Errors due to the use of unsupported operations.
Enumerations
OPERATOR_NOT_SUPPORTED
QueryError A QueryError represents possible errors for query parsing and execution.
Enumerations
PARSING_FAILED
Exception that happens when trying to parse a query that doesn't match the AWQL grammar.
MISSING_QUERY
The provided query is an empty string.
MISSING_SELECT_CLAUSE
The query does not contain the required SELECT clause or it is not in the correct location.
MISSING_FROM_CLAUSE
The query does not contain the required FROM clause or it is not in the correct location.
INVALID_SELECT_CLAUSE
The SELECT clause could not be parsed.
INVALID_FROM_CLAUSE
The FROM clause could not be parsed.
INVALID_WHERE_CLAUSE
The WHERE clause could not be parsed.
INVALID_ORDER_BY_CLAUSE
The ORDER BY clause could not be parsed.
INVALID_LIMIT_CLAUSE
The LIMIT clause could not be parsed.
INVALID_START_INDEX_IN_LIMIT_CLAUSE
The startIndex in the LIMIT clause does not contain a valid integer.
INVALID_PAGE_SIZE_IN_LIMIT_CLAUSE
The pageSize in the LIMIT clause does not contain a valid integer.
INVALID_DURING_CLAUSE
The DURING clause could not be parsed.
INVALID_MIN_DATE_IN_DURING_CLAUSE
The minimum date in the DURING clause is not a valid date in YYYYMMDD format.
INVALID_MAX_DATE_IN_DURING_CLAUSE
The maximum date in the DURING clause is not a valid date in YYYYMMDD format.
MAX_LESS_THAN_MIN_IN_DURING_CLAUSE
The minimum date in the DURING is after the maximum date.
VALIDATION_FAILED
The query matched the grammar, but is invalid in some way such as using a service that isn't supported.
QuotaCheckError Encapsulates the errors thrown during developer quota checks.
Enumerations
INVALID_TOKEN_HEADER
Customer passed in an invalid token in the header.
ACCOUNT_DELINQUENT
Customer is marked delinquent.
ACCOUNT_INACCESSIBLE
Customer is a fraudulent.
ACCOUNT_INACTIVE
Inactive Account.
INCOMPLETE_SIGNUP
Signup not complete
DEVELOPER_TOKEN_NOT_APPROVED
Developer token is not approved for production access, and the customer is attempting to access a production account.
TERMS_AND_CONDITIONS_NOT_SIGNED
Terms and conditions are not signed.
MONTHLY_BUDGET_REACHED
Monthly budget quota reached.
QUOTA_EXCEEDED
Monthly budget quota exceeded.
RangeError A list of all errors associated with the Range constraint.
Enumerations
TOO_LOW
TOO_HIGH
RateExceededError Signals that a call failed because a measured rate exceeded.
Enumerations
RATE_EXCEEDED
Rate exceeded.
ReadOnlyError Errors from attempting to write to read-only fields.
Enumerations
READ_ONLY
RejectedError Indicates that a field was rejected due to compatibility issues.
Enumerations
UNKNOWN_VALUE
Unknown value encountered
RequestError Encapsulates the generic errors thrown when there's an error with user request.
Enumerations
UNKNOWN
Error reason is unknown.
INVALID_INPUT
Invalid input.
UNSUPPORTED_VERSION
The api version in the request has been discontinued. Please update to the new AdWords API version.
RequiredError Errors due to missing required field.
Enumerations
REQUIRED
Missing required field.
SelectorError Represents possible error codes for Selector.
Enumerations
INVALID_FIELD_NAME
The field name is not valid.
MISSING_FIELDS
The list of fields is null or empty.
MISSING_PREDICATES
The list of predicates is null or empty.
OPERATOR_DOES_NOT_SUPPORT_MULTIPLE_VALUES
Predicate operator does not support multiple values. Multiple values are supported only for Predicate.Operator.IN and Predicate.Operator.NOT_IN.
INVALID_PREDICATE_ENUM_VALUE
The predicate enum value is not valid.
MISSING_PREDICATE_OPERATOR
The predicate operator is empty.
MISSING_PREDICATE_VALUES
The predicate values are empty.
INVALID_PREDICATE_FIELD_NAME
The predicate field name is not valid.
INVALID_PREDICATE_OPERATOR
The predicate operator is not valid.
INVALID_FIELD_SELECTION
Invalid selection of fields.
INVALID_PREDICATE_VALUE
The predicate value is not valid.
INVALID_SORT_FIELD_NAME
The sort field name is not valid or the field is not sortable.
SELECTOR_ERROR
Standard error.
FILTER_BY_DATE_RANGE_NOT_SUPPORTED
Filtering by date range is not supported.
START_INDEX_IS_TOO_HIGH
Selector paging start index is too high.
TOO_MANY_PREDICATE_VALUES
The values list in a predicate was too long.
UNKNOWN_ERROR
SizeLimitError Indicates that the number of entries in the request or response exceeds the system limit.
Enumerations
REQUEST_SIZE_LIMIT_EXCEEDED
The number of entries in the request exceeds the system limit.
RESPONSE_SIZE_LIMIT_EXCEEDED
The number of entries in the response exceeds the system limit.
INTERNAL_STORAGE_ERROR
The account is too large to load.
UNKNOWN
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 associated with the length of the given string being out of bounds.
Enumerations
TOO_SHORT
TOO_LONG
VideoError Error class for errors associated with parsing video data.
Enumerations
INVALID_VIDEO
Invalid video.
STORAGE_ERROR
Storage error.
BAD_REQUEST
Bad request.
ERROR_GENERATING_STREAMING_URL
Server error.
UNEXPECTED_SIZE
Unexpected size.
SERVER_ERROR
Server error.
FILE_TOO_LARGE
File too large.
VIDEO_PROCESSING_ERROR
Video processing error.
INVALID_INPUT
Invalid input.
PROBLEM_READING_FILE
Problem reading file.
INVALID_ISCI
Invalid ISCI.
INVALID_AD_ID
Invalid AD-ID.

Send feedback about...

AdWords API
AdWords API
Need help? Visit our support page.