Partager via

Opération de service GetVideosByIds - Gestion des campagnes

  • Article

Obtient des vidéos par identificateurs de vidéo.

Remarque

Tout le monde n’a pas encore cette fonctionnalité. Si ce n’est pas le cas, ne vous inquiétez pas, il sera bientôt disponible !

Éléments de demande

L’objet GetVideosByIdsRequest définit les éléments body et header de la demande d’opération de service. Les éléments doivent être dans le même ordre que celui indiqué dans la requête SOAP.

Remarque

Sauf indication contraire ci-dessous, tous les éléments de requête sont requis.

Éléments du corps de la requête

Élément Description Type de données
PageInfo Détermine l’index et la taille des résultats vidéo par page.

Cet élément de requête est facultatif. Si cet élément n’est pas spécifié, l’index de la page defaut est 0 et la valeur par défaut Size est 1 000.		 Pagination
VideoIds Identificateurs des vidéos à obtenir.

La taille maximale de la liste est de 1 000 éléments par demande de service. Si cet élément n’est pas spécifié, l’opération retourne toutes les vidéos actives dans le compte (1 000 résultats par page).		 tableau long

Éléments d’en-tête de requête

Élément Description Type de données
AuthenticationToken Jeton d’accès OAuth qui représente les informations d’identification d’un utilisateur disposant d’autorisations sur les comptes Microsoft Advertising.

Pour plus d’informations, consultez Authentification avec OAuth.		 chaîne
CustomerAccountId Identificateur du compte publicitaire qui possède ou est associé aux entités dans la demande. Cet élément d’en-tête doit avoir la même valeur que l’élément de corps AccountId lorsque les deux sont nécessaires. Cet élément est requis pour la plupart des opérations de service et, à titre de bonne pratique, vous devez toujours le définir.

Pour plus d’informations, consultez Obtenir votre compte et ID de client.		 chaîne
CustomerId Identificateur du compte de responsable (client) auquel l’utilisateur accède ou à partir duquel il opère. Un utilisateur peut avoir accès à plusieurs comptes de gestionnaire. Cet élément est requis pour la plupart des opérations de service et, à titre de bonne pratique, vous devez toujours le définir.

Pour plus d’informations, consultez Obtenir votre compte et ID de client.		 chaîne
DeveloperToken Jeton de développeur utilisé pour accéder à l’API Bing Ads.

Pour plus d’informations, consultez Obtenir un jeton de développeur.		 chaîne
Mot de passe Cet élément est réservé à un usage interne et sera supprimé d’une version ultérieure de l’API. Vous devez utiliser l’élément AuthenticationToken pour définir les informations d’identification de l’utilisateur. chaîne
UserName Cet élément est réservé à un usage interne et sera supprimé d’une version ultérieure de l’API. Vous devez utiliser l’élément AuthenticationToken pour définir les informations d’identification de l’utilisateur. chaîne

Éléments Response

L’objet GetVideosByIdsResponse définit les éléments body et header de la réponse de l’opération de service. Les éléments sont retournés dans le même ordre que celui indiqué dans la réponse SOAP.

Response Body, éléments

Élément Description Type de données
PartialErrors Tableau d’objets BatchError qui contiennent des détails pour tous les éléments de demande qui n’ont pas réussi.

La liste des erreurs ne correspond pas directement à la liste des éléments de la demande. La liste peut être vide s’il n’y a pas d’erreur, ou peut inclure un ou plusieurs objets d’erreur correspondant à chaque élément de liste ayant échoué dans la demande.		 Tableau BatchError
Vidéos Tableau d’objets Video qui correspond directement aux identificateurs vidéo que vous avez spécifiés dans la requête. Les éléments de la liste peuvent être retournés comme null. Pour chaque index de liste où une vidéo n’a pas été récupérée, l’élément correspondant est null. Tableau de vidéos

Éléments d’en-tête de réponse

Élément Description Type de données
TrackingId Identificateur de l’entrée de journal qui contient les détails de l’appel d’API. chaîne

Requête SOAP

Ce modèle a été généré par un outil pour afficher l’ordre des éléments body et header pour la requête SOAP. Pour connaître les types pris en charge que vous pouvez utiliser avec cette opération de service, consultez la référence Éléments du corps de la demande ci-dessus.

<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 réponse

Ce modèle a été généré par un outil pour afficher l’ordre des éléments de corps et d’en-tête pour la réponse 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:e361="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e361:KeyValuePairOfstringstring>
              <e361:key d4p1:nil="false">ValueHere</e361:key>
              <e361:value d4p1:nil="false">ValueHere</e361:value>
            </e361: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>

Syntaxe du code

L’exemple de syntaxe peut être utilisé avec les Kits de développement logiciel (SDK) Bing Ads. Pour plus d’exemples, consultez Exemples de code de l’API Bing Ads .

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)

Configuration requise

Service : CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13

URL de la demande

https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/Videos/QueryByIds

Éléments de demande

L’objet GetVideosByIdsRequest définit les éléments body et header de la demande d’opération de service.

Remarque

Sauf indication contraire ci-dessous, tous les éléments de requête sont requis.

Éléments du corps de la requête

Élément Description Type de données
PageInfo Détermine l’index et la taille des résultats vidéo par page.

Cet élément de requête est facultatif. Si cet élément n’est pas spécifié, l’index de la page defaut est 0 et la valeur par défaut Size est 1 000.		 Pagination
VideoIds Identificateurs des vidéos à obtenir.

La taille maximale de la liste est de 1 000 éléments par demande de service. Si cet élément n’est pas spécifié, l’opération retourne toutes les vidéos actives dans le compte (1 000 résultats par page).		 tableau long

Éléments d’en-tête de requête

Élément Description Type de données
Autorisation Jeton d’accès OAuth qui représente les informations d’identification d’un utilisateur disposant d’autorisations sur les comptes Microsoft Advertising. Vérifiez que le jeton est précédé de « Porteur », ce qui est nécessaire pour une authentification appropriée.

Pour plus d’informations, consultez Authentification avec OAuth.		 chaîne
CustomerAccountId Identificateur du compte publicitaire qui possède ou est associé aux entités dans la demande. Cet élément d’en-tête doit avoir la même valeur que l’élément de corps AccountId lorsque les deux sont nécessaires. Cet élément est requis pour la plupart des opérations de service et, à titre de bonne pratique, vous devez toujours le définir.

Pour plus d’informations, consultez Obtenir votre compte et ID de client.		 chaîne
CustomerId Identificateur du compte de responsable (client) auquel l’utilisateur accède ou à partir duquel il opère. Un utilisateur peut avoir accès à plusieurs comptes de gestionnaire. Cet élément est requis pour la plupart des opérations de service et, à titre de bonne pratique, vous devez toujours le définir.

Pour plus d’informations, consultez Obtenir votre compte et ID de client.		 chaîne
DeveloperToken Jeton de développeur utilisé pour accéder à l’API Bing Ads.

Pour plus d’informations, consultez Obtenir un jeton de développeur.		 chaîne
Mot de passe Cet élément est réservé à un usage interne et sera supprimé d’une version ultérieure de l’API. Vous devez utiliser l’élément AuthenticationToken pour définir les informations d’identification de l’utilisateur. chaîne
UserName Cet élément est réservé à un usage interne et sera supprimé d’une version ultérieure de l’API. Vous devez utiliser l’élément AuthenticationToken pour définir les informations d’identification de l’utilisateur. chaîne

Éléments Response

L’objet GetVideosByIdsResponse définit les éléments body et header de la réponse de l’opération de service. Les éléments sont retournés dans le même ordre que celui indiqué dans le json de réponse.

Response Body, éléments

Élément Description Type de données
PartialErrors Tableau d’objets BatchError qui contiennent des détails pour tous les éléments de demande qui n’ont pas réussi.

La liste des erreurs ne correspond pas directement à la liste des éléments de la demande. La liste peut être vide s’il n’y a pas d’erreur, ou peut inclure un ou plusieurs objets d’erreur correspondant à chaque élément de liste ayant échoué dans la demande.		 Tableau BatchError
Vidéos Tableau d’objets Video qui correspond directement aux identificateurs vidéo que vous avez spécifiés dans la requête. Les éléments de la liste peuvent être retournés comme null. Pour chaque index de liste où une vidéo n’a pas été récupérée, l’élément correspondant est null. Tableau de vidéos

Éléments d’en-tête de réponse

Élément Description Type de données
TrackingId Identificateur de l’entrée de journal qui contient les détails de l’appel d’API. chaîne

Requête JSON

Ce modèle a été généré par un outil pour afficher le corps et les éléments d’en-tête de la requête JSON. Pour connaître les types pris en charge que vous pouvez utiliser avec cette opération de service, consultez la référence Éléments du corps de la demande ci-dessus.

{
  "VideoIds": [
    "LongValueHere"
  ],
  "PageInfo": {
    "Index": IntValueHere,
    "Size": IntValueHere
  }
}

JSON de réponse

Ce modèle a été généré par un outil pour afficher le corps et les éléments d’en-tête de la réponse JSON.

Voici un exemple qui s’applique si le type de BatchError est EditorialError.

{
  "Videos": [
    {
      "AspectRatio": "ValueHere",
      "CreatedDateTimeInUTC": "ValueHere",
      "Description": "ValueHere",
      "DurationInMilliseconds": IntValueHere,
      "FailureCode": "ValueHere",
      "Id": "LongValueHere",
      "ModifiedDateTimeInUTC": "ValueHere",
      "SourceUrl": "ValueHere",
      "Status": "ValueHere",
      "ThumbnailUrl": "ValueHere",
      "Url": "ValueHere"
    }
  ],
  "PartialErrors": [
    {
      "Code": IntValueHere,
      "Details": "ValueHere",
      "ErrorCode": "ValueHere",
      "FieldPath": "ValueHere",
      "ForwardCompatibilityMap": [
        {
          "key": "ValueHere",
          "value": "ValueHere"
        }
      ],
      "Index": IntValueHere,
      "Message": "ValueHere",
      "Type": "EditorialError",
      "Appealable": "ValueHere",
      "DisapprovedText": "ValueHere",
      "Location": "ValueHere",
      "PublisherCountry": "ValueHere",
      "ReasonCode": IntValueHere
    }
  ]
}

Syntaxe du code

Pour appeler l’API REST via des kits SDK, vous devez mettre à niveau le KIT de développement logiciel (SDK) vers une certaine version et configurer les paramètres système. L’exemple de syntaxe peut être utilisé avec les Kits de développement logiciel (SDK) Bing Ads. Pour plus d’exemples, consultez Exemples de code de l’API Bing Ads .

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)