Web Service: ContentService

Port type ContentServiceInterfaceSource code

1. getContentByStatement
   Source code
   Description:
   Gets a {@link ContentPage} of {@link Content} objects that satisfy the given {@link Statement#query}. The following fields are supported for filtering:

   PQL Property	Object Property
   {@code id}	{@link Content#id}
   {@code status}	{@link Content#status}
   {@code name}	{@link Content#name}
   {@code lastModifiedDateTime}	{@link Content#lastModifiedDateTime}
   {@code lastDaiIngestDateTime}	{@link Content#lastDaiIngestDateTime}
   {@code daiIngestStatus}	{@link Content#daiIngestStatus}

   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   getContentByStatementRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type getContentByStatement

   Gets a {@link ContentPage} of {@link Content} objects that satisfy the given {@link Statement#query}. The following fields are supported for filtering:

   PQL Property	Object Property
   {@code id}	{@link Content#id}
   {@code status}	{@link Content#status}
   {@code name}	{@link Content#name}
   {@code lastModifiedDateTime}	{@link Content#lastModifiedDateTime}
   {@code lastDaiIngestDateTime}	{@link Content#lastDaiIngestDateTime}
   {@code daiIngestStatus}	{@link Content#daiIngestStatus}

   • statement - optional; type Statement
     Captures the {@code WHERE}, {@code ORDER BY} and {@code LIMIT} clauses of a PQL query. Statements are typically used to retrieve objects of a predefined domain type, which makes SELECT clause unnecessary.

     An example query text might be {@code "WHERE status = 'ACTIVE' ORDER BY id LIMIT 30"}.

     Statements support bind variables. These are substitutes for literals and can be thought of as input parameters to a PQL query.

     An example of such a query might be {@code "WHERE id = :idValue"}.

     Statements also support use of the LIKE keyword. This provides wildcard string matching.

     An example of such a query might be {@code "WHERE name LIKE '%searchString%'"}.

     The value for the variable idValue must then be set with an object of type {@link Value}, e.g., {@link NumberValue}, {@link TextValue} or {@link BooleanValue}.
     • query - optional; type string
       Holds the query in PQL syntax. The syntax is:
       [WHERE {[AND | OR] ...}]
[ORDER BY [ASC | DESC]]
[LIMIT {[,] } | { OFFSET }]
       

       
            := {< | <= | > | >= | = | != }

     := {< | <= | > | >= | = | != }
:= IN
:= IS NULL
:= LIKE
:= :
       

     • values - optional, unbounded; type String_ValueMapEntry
       Holds keys and values for bind variables and their values. The key is the name of the bind variable. The value is the literal value of the variable.

       In the example {@code "WHERE status = :bindStatus ORDER BY id LIMIT 30"}, the bind variable, represented by {@code :bindStatus} is named {@code bindStatus}, which would also be the parameter map key. The bind variable's value would be represented by a parameter map value of type {@link TextValue}. The final result, for example, would be an entry of {@code "bindStatus" => StringParam("ACTIVE")}.

       This represents an entry in a map with a key of type String and value of type Value.
       • key - optional; type string
       • value - optional; type Value
         {@code Value} represents a value.
   Output:
   getContentByStatementResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type getContentByStatementResponse

   • rval - optional; type ContentPage
     Captures a page of {@code Content} objects.
     • totalResultSetSize - optional; type int
       The size of the total result set to which this page belongs.
     • startIndex - optional; type int
       The absolute index in the total result set on which this page begins.
     • results - optional, unbounded; type Content
       A {@code Content} represents video metadata from a publisher's Content Management System (CMS) that has been synced to Ad Manager.

       Video line items can be targeted to {@code Content} to indicate what ads should match when the {@code Content} is being played.

       • id - optional; type long
         Uniquely identifies the {@code Content}. This attribute is read-only and is assigned by Google when the content is created.
       • name - optional; type string
         The name of the {@code Content}. This attribute is read-only.
       • status - optional; type ContentStatus - type string with restriction - enum { 'ACTIVE', 'INACTIVE', 'ARCHIVED', 'UNKNOWN' }
         The status of this {@code Content}. This attribute is read-only.
       • statusDefinedBy - optional; type ContentStatusDefinedBy - type string with restriction - enum { 'CMS', 'USER' }
         Whether the content status was defined by the user, or by the source CMS from which the content was ingested. This attribute is read-only.
       • hlsIngestStatus - optional; type DaiIngestStatus - type string with restriction - enum { 'SUCCESS', 'WARNING', 'INGESTED', 'INGESTED_WITH_WARNINGS', 'CONDITIONED', 'CONDITIONED_WITH_WARNINGS', 'FAILURE', 'UNKNOWN' }
         The current DAI ingest status of the HLS media for the {@code content}. This attribute is read-only and is null if the content is not eligible for dynamic ad insertion or if the content does not have HLS media.
       • hlsIngestErrors - optional, unbounded; type DaiIngestError
         The list of any errors that occurred during the most recent DAI ingestion process of the HLS media. This attribute is read-only and will be null if the {@link #hlsIngestStatus} is {@link DaiIngestStatus#STATUS_SUCCESS} or if the content is not eligible for dynamic ad insertion or if the content does not have HLS media.
         Represents an error associated with a DAI content's status.
         • reason - optional; type DaiIngestErrorReason - type string with restriction - enum { 'INVALID_INGEST_URL', 'INVALID_CLOSED_CAPTION_URL', 'MISSING_CLOSED_CAPTION_URL', 'COULD_NOT_FETCH_HLS', 'COULD_NOT_FETCH_SUBTITLES', 'MISSING_SUBTITLE_LANGUAGE', 'COULD_NOT_FETCH_MEDIA', 'MALFORMED_MEDIA_BYTES', 'CHAPTER_TIME_OUT_OF_BOUNDS', 'INTERNAL_ERROR', 'CONTENT_HAS_CHAPTER_TIMES_BUT_NO_MIDROLL_SETTINGS', 'MALFORMED_MEDIA_PLAYLIST', 'MIXED_AD_BREAK_TAGS', 'AD_BREAK_TAGS_INCONSISTENT_ACROSS_VARIANTS', 'MALFORMED_SUBTITLES', 'SUBTITLES_TOO_LARGE', 'PLAYLIST_ITEM_URL_DOES_NOT_MATCH_INGEST_COMMON_PATH', 'COULD_NOT_UPLOAD_SPLIT_MEDIA_AUTHENTICATION_FAILED', 'COULD_NOT_UPLOAD_SPLIT_MEDIA_CONNECTION_FAILED', 'COULD_NOT_UPLOAD_SPLIT_MEDIA_WRITE_FAILED', 'PLAYLISTS_HAVE_DIFFERENT_NUMBER_OF_DISCONTINUITIES', 'PLAYIST_HAS_NO_STARTING_PTS_VALUE', 'PLAYLIST_DISCONTINUITY_PTS_VALUES_DIFFER_TOO_MUCH', 'SEGMENT_HAS_NO_PTS', 'SUBTITLE_LANGUAGE_DOES_NOT_MATCH_LANGUAGE_IN_FEED', 'CANNOT_DETERMINE_CORRECT_SUBTITLES_FOR_LANGUAGE', 'NO_CDN_CONFIGURATION_FOUND', 'CONTENT_HAS_MIDROLLS_BUT_NO_SPLIT_CONTENT_CONFIG', 'CONTENT_HAS_MIDROLLS_BUT_SOURCE_HAS_MIDROLLS_DISABLED', 'ADTS_PARSE_ERROR', 'AAC_SPLIT_ERROR', 'AAC_PARSE_ERROR', 'TS_PARSE_ERROR', 'TS_SPLIT_ERROR', 'UNSUPPORTED_CONTAINER_FORMAT', 'MULTIPLE_ELEMENTARY_STREAMS_OF_SAME_MEDIA_TYPE_IN_TS', 'UNSUPPORTED_TS_MEDIA_FORMAT', 'NO_IFRAMES_NEAR_CUE_POINT', 'AC3_SPLIT_ERROR', 'AC3_PARSE_ERROR', 'EAC3_SPLIT_ERROR', 'INVALID_ENCRYPTION_KEY', 'EAC3_PARSE_ERROR', 'CUE_POINT_COUNT_DOES_NOT_MATCH_PTS_COUNT', 'DASH_CUE_POINT_EVENT_MISMATCH', 'DASH_MANIFEST_CONDITIONING_FAILED', 'DASH_MANIFEST_CONDITIONING_SEGMENT_BOUNDARY_ERROR', 'CLOSED_CAPTION_LANGUAGE_VALUE_INVALID', 'CLOSED_CAPTION_NAME_VALUE_INVALID', 'CLOSED_CAPTION_CHARACTERISTICS_VALUE_UNEXPECTED', 'CLOSED_CAPTIONS_WITH_DUPLICATE_KEYS', 'SUBTITLES_PRESENT_IN_FEED_AND_MANIFEST', 'INVALID_MEDIA_PROFILE', 'UNKNOWN' }
           The error associated with the content.
         • trigger - optional; type string
           The field, if any, that triggered the error.
       • lastHlsIngestDateTime - optional; type DateTime
         The date and time at which this content's HLS media was last ingested for DAI. This attribute is read-only and will be null if the content is not eligible for dynamic ad insertion or if the content does not have HLS media.
         Represents a date combined with the time of day.
         • date - optional; type Date
           Represents a date.
           • year - optional; type int
             Year (e.g., 2009)
           • month - optional; type int
             Month (1..12)
           • day - optional; type int
             Day (1..31)
         • hour - optional; type int
         • minute - optional; type int
         • second - optional; type int
         • timeZoneId - optional; type string
       • dashIngestStatus - optional; type DaiIngestStatus - type string with restriction - enum { 'SUCCESS', 'WARNING', 'INGESTED', 'INGESTED_WITH_WARNINGS', 'CONDITIONED', 'CONDITIONED_WITH_WARNINGS', 'FAILURE', 'UNKNOWN' }
         The current DAI ingest status of the DASH media for the {@code content}. This attribute is read-only and is null if the content is not eligible for dynamic ad insertion or if the content does not have DASH media.
       • dashIngestErrors - optional, unbounded; type DaiIngestError
         The list of any errors that occurred during the most recent DAI ingestion process of the DASH media. This attribute is read-only and will be null if the {@link #hlsIngestStatus} is {@link DaiIngestStatus#STATUS_SUCCESS} or if the content is not eligible for dynamic ad insertion or if the content does not have DASH media.
         Represents an error associated with a DAI content's status.
         • reason - optional; type DaiIngestErrorReason - type string with restriction - enum { 'INVALID_INGEST_URL', 'INVALID_CLOSED_CAPTION_URL', 'MISSING_CLOSED_CAPTION_URL', 'COULD_NOT_FETCH_HLS', 'COULD_NOT_FETCH_SUBTITLES', 'MISSING_SUBTITLE_LANGUAGE', 'COULD_NOT_FETCH_MEDIA', 'MALFORMED_MEDIA_BYTES', 'CHAPTER_TIME_OUT_OF_BOUNDS', 'INTERNAL_ERROR', 'CONTENT_HAS_CHAPTER_TIMES_BUT_NO_MIDROLL_SETTINGS', 'MALFORMED_MEDIA_PLAYLIST', 'MIXED_AD_BREAK_TAGS', 'AD_BREAK_TAGS_INCONSISTENT_ACROSS_VARIANTS', 'MALFORMED_SUBTITLES', 'SUBTITLES_TOO_LARGE', 'PLAYLIST_ITEM_URL_DOES_NOT_MATCH_INGEST_COMMON_PATH', 'COULD_NOT_UPLOAD_SPLIT_MEDIA_AUTHENTICATION_FAILED', 'COULD_NOT_UPLOAD_SPLIT_MEDIA_CONNECTION_FAILED', 'COULD_NOT_UPLOAD_SPLIT_MEDIA_WRITE_FAILED', 'PLAYLISTS_HAVE_DIFFERENT_NUMBER_OF_DISCONTINUITIES', 'PLAYIST_HAS_NO_STARTING_PTS_VALUE', 'PLAYLIST_DISCONTINUITY_PTS_VALUES_DIFFER_TOO_MUCH', 'SEGMENT_HAS_NO_PTS', 'SUBTITLE_LANGUAGE_DOES_NOT_MATCH_LANGUAGE_IN_FEED', 'CANNOT_DETERMINE_CORRECT_SUBTITLES_FOR_LANGUAGE', 'NO_CDN_CONFIGURATION_FOUND', 'CONTENT_HAS_MIDROLLS_BUT_NO_SPLIT_CONTENT_CONFIG', 'CONTENT_HAS_MIDROLLS_BUT_SOURCE_HAS_MIDROLLS_DISABLED', 'ADTS_PARSE_ERROR', 'AAC_SPLIT_ERROR', 'AAC_PARSE_ERROR', 'TS_PARSE_ERROR', 'TS_SPLIT_ERROR', 'UNSUPPORTED_CONTAINER_FORMAT', 'MULTIPLE_ELEMENTARY_STREAMS_OF_SAME_MEDIA_TYPE_IN_TS', 'UNSUPPORTED_TS_MEDIA_FORMAT', 'NO_IFRAMES_NEAR_CUE_POINT', 'AC3_SPLIT_ERROR', 'AC3_PARSE_ERROR', 'EAC3_SPLIT_ERROR', 'INVALID_ENCRYPTION_KEY', 'EAC3_PARSE_ERROR', 'CUE_POINT_COUNT_DOES_NOT_MATCH_PTS_COUNT', 'DASH_CUE_POINT_EVENT_MISMATCH', 'DASH_MANIFEST_CONDITIONING_FAILED', 'DASH_MANIFEST_CONDITIONING_SEGMENT_BOUNDARY_ERROR', 'CLOSED_CAPTION_LANGUAGE_VALUE_INVALID', 'CLOSED_CAPTION_NAME_VALUE_INVALID', 'CLOSED_CAPTION_CHARACTERISTICS_VALUE_UNEXPECTED', 'CLOSED_CAPTIONS_WITH_DUPLICATE_KEYS', 'SUBTITLES_PRESENT_IN_FEED_AND_MANIFEST', 'INVALID_MEDIA_PROFILE', 'UNKNOWN' }
           The error associated with the content.
         • trigger - optional; type string
           The field, if any, that triggered the error.
       • lastDashIngestDateTime - optional; type DateTime
         The date and time at which this content's DASH media was last ingested for DAI. This attribute is read-only and will be null if the content is not eligible for dynamic ad insertion or if the content does not have DASH media.
         Represents a date combined with the time of day.
         • date - optional; type Date
           Represents a date.
           • year - optional; type int
             Year (e.g., 2009)
           • month - optional; type int
             Month (1..12)
           • day - optional; type int
             Day (1..31)
         • hour - optional; type int
         • minute - optional; type int
         • second - optional; type int
         • timeZoneId - optional; type string
       • importDateTime - optional; type DateTime
         The date and time at which this content was published. This attribute is read-only.
         Represents a date combined with the time of day.
         • date - optional; type Date
           Represents a date.
           • year - optional; type int
             Year (e.g., 2009)
           • month - optional; type int
             Month (1..12)
           • day - optional; type int
             Day (1..31)
         • hour - optional; type int
         • minute - optional; type int
         • second - optional; type int
         • timeZoneId - optional; type string
       • lastModifiedDateTime - optional; type DateTime
         The date and time at which this content was last modified. The last modified date time will always be updated when a {@link ContentBundle} association is changed, but will not always be updated when a {@link CmsMetadataValue} value is changed. This attribute is read-only.
         Represents a date combined with the time of day.
         • date - optional; type Date
           Represents a date.
           • year - optional; type int
             Year (e.g., 2009)
           • month - optional; type int
             Month (1..12)
           • day - optional; type int
             Day (1..31)
         • hour - optional; type int
         • minute - optional; type int
         • second - optional; type int
         • timeZoneId - optional; type string
       • cmsSources - optional, unbounded; type CmsContent
         Contains information about {@link Content} from the CMS it was ingested from.
         • id - optional; type long
           The ID of the Content Source associated with the CMS in Ad Manager. This attribute is read-only.
         • displayName - optional; type string
           The display name of the CMS this content is in. This attribute is read-only.
         • cmsContentId - optional; type string
           The ID of the {@link Content} in the CMS. This ID will be a 3rd party ID, usually the ID of the content in a CMS (Content Management System). This attribute is read-only.
         Information about the content from the CMS it was ingested from. This attribute is read-only.
       • contentBundleIds - optional, unbounded; type long
         IDs of the {@link ContentBundle} of which this content is a member. This attribute is read-only.
       • cmsMetadataValueIds - optional, unbounded; type long
         A collection of {@link CmsMetadataValue} IDs that are associated with this content. This attribute is read-only.
       • duration - optional; type long
         The duration of the content in milliseconds. This attribute is read-only.
       The collection of content contained within this page.
   Fault:
   ApiException (wsdlsoap:fault, use = literal)Source code
   ApiException type ApiExceptionFault

   Exception class for holding a list of service errors.

   Base class for exceptions.

   • message - optional; type string
     Error message.

   • errors - optional, unbounded; type ApiError
     The API error base class that provides details about an error that occurred while processing a service request.

     The OGNL field path is provided for parsers to identify the request data element that may have caused the error.

     • fieldPath - optional; type string
       The OGNL field path to identify cause of error.
     • fieldPathElements - optional, unbounded; type FieldPathElement
       A parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.
       A segment of a field path. Each dot in a field path defines a new segment.
       • field - optional; type string
         The name of a field in lower camelcase. (e.g. "biddingStrategy")
       • index - optional; type int
         For list fields, this is a 0-indexed position in the list. Null for non-list fields.
     • trigger - optional; type string
       The data that caused the error.
     • errorString - optional; type string
       A simple string representation of the error and reason.
     List of errors.

   A fault element of type ApiException.