Compartir a través de


Operación del servicio GetVideosByIds: administración de campañas

Obtiene vídeos por identificadores de vídeo.

Nota:

Todavía no todos tienen esta característica. Si no lo haces, no te preocupes, ¡estará disponible pronto!

Elementos Request

El objeto GetVideosByIdsRequest define los elementos body y header de la solicitud de operación de servicio. Los elementos deben estar en el mismo orden que se muestra en la solicitud SOAP.

Nota:

A menos que se indique lo contrario a continuación, se requieren todos los elementos de solicitud.

Elementos del cuerpo de la solicitud

Elemento Descripción Tipo de datos
PageInfo Determina el índice y el tamaño de los resultados de vídeo por página.

Este elemento request es opcional. Si no se especifica este elemento, la página defaut Index es 0 y el valor predeterminado Size es 1000.
Paginación
VideoIds Identificadores de los vídeos que se van a obtener.

El tamaño máximo de la lista es de 1000 elementos por solicitud de servicio. Si no se especifica este elemento, la operación devolverá todos los vídeos activos de la cuenta (1000 resultados por página).
matriz larga

Elementos de encabezado de solicitud

Elemento Descripción Tipo de datos
AuthenticationToken Token de acceso de OAuth que representa las credenciales de un usuario que tiene permisos para cuentas de Microsoft Advertising.

Para obtener más información, consulte Autenticación con OAuth.
string
CustomerAccountId Identificador de la cuenta de anuncio que posee o está asociada a las entidades de la solicitud. Este elemento de encabezado debe tener el mismo valor que el elemento de cuerpo AccountId cuando ambos son necesarios. Este elemento es necesario para la mayoría de las operaciones de servicio y, como procedimiento recomendado, siempre debe establecerlo.

Para obtener más información, consulte Obtención de su cuenta e identificadores de cliente.
string
Customerid Identificador de la cuenta de administrador (cliente) desde la que el usuario accede o funciona. Un usuario puede tener acceso a varias cuentas de administrador. Este elemento es necesario para la mayoría de las operaciones de servicio y, como procedimiento recomendado, siempre debe establecerlo.

Para obtener más información, consulte Obtención de su cuenta e identificadores de cliente.
string
DeveloperToken Token de desarrollador que se usa para acceder a Bing Ads API.

Para obtener más información, consulte Obtención de un token de desarrollador.
string
Password Este elemento está reservado para uso interno y se quitará de una versión futura de la API. Debe usar el elemento AuthenticationToken para establecer las credenciales de usuario. string
UserName Este elemento está reservado para uso interno y se quitará de una versión futura de la API. Debe usar el elemento AuthenticationToken para establecer las credenciales de usuario. string

Elementos de respuesta

El objeto GetVideosByIdsResponse define los elementos body y header de la respuesta de la operación de servicio. Los elementos se devuelven en el mismo orden que se muestra en soap de respuesta.

Elementos del cuerpo de la respuesta

Elemento Descripción Tipo de datos
PartialErrors Matriz de objetos BatchError que contienen detalles de los elementos de solicitud que no se han realizado correctamente.

La lista de errores no se corresponde directamente con la lista de elementos de la solicitud. La lista puede estar vacía si no hay errores o puede incluir uno o varios objetos de error correspondientes a cada elemento de lista incorrecto en la solicitud.
Matriz BatchError
Videos Matriz de objetos Video que corresponde directamente a los identificadores de vídeo especificados en la solicitud. Los elementos de la lista se pueden devolver como null. Para cada índice de lista en el que no se recuperó un vídeo, el elemento correspondiente será null. Matriz de vídeo

Elementos de encabezado de respuesta

Elemento Descripción Tipo de datos
Seguimiento del Id. Identificador de la entrada de registro que contiene los detalles de la llamada API. string

Solicitud de SOAP

Esta plantilla se generó mediante una herramienta para mostrar el orden del cuerpo y los elementos de encabezado de la solicitud SOAP. Para ver los tipos admitidos que puede usar con esta operación de servicio, consulte la referencia de elementos de cuerpo de solicitud anterior.

<s:Envelope xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
    <Action mustUnderstand="1">GetVideosByIds</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <CustomerAccountId i:nil="false">ValueHere</CustomerAccountId>
    <CustomerId i:nil="false">ValueHere</CustomerId>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <GetVideosByIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <VideoIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long>ValueHere</a1:long>
      </VideoIds>
      <PageInfo i:nil="false">
        <Index>ValueHere</Index>
        <Size>ValueHere</Size>
      </PageInfo>
    </GetVideosByIdsRequest>
  </s:Body>
</s:Envelope>

SOAP de respuesta

Esta plantilla se generó mediante una herramienta para mostrar el orden de los elementos body y header para la respuesta SOAP.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
    <TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
  </s:Header>
  <s:Body>
    <GetVideosByIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <Videos d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <Video>
          <AspectRatio d4p1:nil="false">ValueHere</AspectRatio>
          <CreatedDateTimeInUTC d4p1:nil="false">ValueHere</CreatedDateTimeInUTC>
          <Description d4p1:nil="false">ValueHere</Description>
          <DurationInMilliseconds d4p1:nil="false">ValueHere</DurationInMilliseconds>
          <FailureCode d4p1:nil="false">ValueHere</FailureCode>
          <Id d4p1:nil="false">ValueHere</Id>
          <ModifiedDateTimeInUTC d4p1:nil="false">ValueHere</ModifiedDateTimeInUTC>
          <SourceUrl d4p1:nil="false">ValueHere</SourceUrl>
          <Status d4p1:nil="false">ValueHere</Status>
          <ThumbnailUrl d4p1:nil="false">ValueHere</ThumbnailUrl>
          <Url d4p1:nil="false">ValueHere</Url>
        </Video>
      </Videos>
      <PartialErrors d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <BatchError d4p1:type="-- derived type specified here with the appropriate prefix --">
          <Code>ValueHere</Code>
          <Details d4p1:nil="false">ValueHere</Details>
          <ErrorCode d4p1:nil="false">ValueHere</ErrorCode>
          <FieldPath d4p1:nil="false">ValueHere</FieldPath>
          <ForwardCompatibilityMap xmlns:e171="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e171:KeyValuePairOfstringstring>
              <e171:key d4p1:nil="false">ValueHere</e171:key>
              <e171:value d4p1:nil="false">ValueHere</e171:value>
            </e171:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
          <Index>ValueHere</Index>
          <Message d4p1:nil="false">ValueHere</Message>
          <Type d4p1:nil="false">ValueHere</Type>
          <!--These fields are applicable if the derived type attribute is set to EditorialError-->
          <Appealable d4p1:nil="false">ValueHere</Appealable>
          <DisapprovedText d4p1:nil="false">ValueHere</DisapprovedText>
          <Location d4p1:nil="false">ValueHere</Location>
          <PublisherCountry d4p1:nil="false">ValueHere</PublisherCountry>
          <ReasonCode>ValueHere</ReasonCode>
        </BatchError>
      </PartialErrors>
    </GetVideosByIdsResponse>
  </s:Body>
</s:Envelope>

Sintaxis de código

La sintaxis de ejemplo se puede usar con los SDK de Bing Ads. Consulte Ejemplos de código de API de Bing Ads para obtener más ejemplos.

public async Task<GetVideosByIdsResponse> GetVideosByIdsAsync(
	IList<long> videoIds,
	Paging pageInfo)
{
	var request = new GetVideosByIdsRequest
	{
		VideoIds = videoIds,
		PageInfo = pageInfo
	};

	return (await CampaignManagementService.CallAsync((s, r) => s.GetVideosByIdsAsync(r), request));
}
static GetVideosByIdsResponse getVideosByIds(
	ArrayOflong videoIds,
	Paging pageInfo) throws RemoteException, Exception
{
	GetVideosByIdsRequest request = new GetVideosByIdsRequest();

	request.setVideoIds(videoIds);
	request.setPageInfo(pageInfo);

	return CampaignManagementService.getService().getVideosByIds(request);
}
static function GetVideosByIds(
	$videoIds,
	$pageInfo)
{

	$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];

	$request = new GetVideosByIdsRequest();

	$request->VideoIds = $videoIds;
	$request->PageInfo = $pageInfo;

	return $GLOBALS['CampaignManagementProxy']->GetService()->GetVideosByIds($request);
}
response=campaignmanagement_service.GetVideosByIds(
	VideoIds=VideoIds,
	PageInfo=PageInfo)

Requisitos

Servicio: CampaignManagementService.svc v13
Nombres: https://bingads.microsoft.com/CampaignManagement/v13