Partager via

Opération du service GetLinkedAccountsAndCustomersInfo - Gestion des clients

  • Article

Obtient la hiérarchie du client et du compte sous le client spécifié.

Éléments de demande

L’objet GetLinkedAccountsAndCustomersInfoRequest 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
CustomerId Identificateur du client dont vous souhaitez obtenir la hiérarchie. long
OnlyParentAccounts Détermine s’il faut retourner uniquement les comptes d’annonceur qui appartiennent au client ou retourner également les clients liés et les comptes d’annonceur liés sous d’autres clients.

Pour limiter les résultats aux comptes d’annonceur directement sous le client spécifié, définissez cet élément sur true, sinon laissez-le vide ou définissez la propriété sur false. La valeur par défaut est false.		 boolean

É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
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 GetLinkedAccountsAndCustomersInfoResponse 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
AccountsInfo Liste des informations sur les comptes d’annonceur qui correspondent aux critères de la demande.

Notez qu’il peut y avoir un délai allant jusqu’à cinq minutes entre le moment où vous créez un compte et que les informations de compte sont incluses dans la réponse.		 Tableau AccountInfo
CustomersInfo Liste des informations sur les clients qui correspondent aux critères de la demande. Tableau CustomerInfo

É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/Customer/v13">
    <Action mustUnderstand="1">GetLinkedAccountsAndCustomersInfo</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <GetLinkedAccountsAndCustomersInfoRequest xmlns="https://bingads.microsoft.com/Customer/v13">
      <CustomerId i:nil="false">ValueHere</CustomerId>
      <OnlyParentAccounts>ValueHere</OnlyParentAccounts>
    </GetLinkedAccountsAndCustomersInfoRequest>
  </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/Customer/v13">
    <TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
  </s:Header>
  <s:Body>
    <GetLinkedAccountsAndCustomersInfoResponse xmlns="https://bingads.microsoft.com/Customer/v13">
      <AccountsInfo xmlns:e503="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e503:AccountInfo>
          <e503:Id>ValueHere</e503:Id>
          <e503:Name d4p1:nil="false">ValueHere</e503:Name>
          <e503:Number d4p1:nil="false">ValueHere</e503:Number>
          <e503:AccountLifeCycleStatus>ValueHere</e503:AccountLifeCycleStatus>
          <e503:PauseReason d4p1:nil="false">ValueHere</e503:PauseReason>
        </e503:AccountInfo>
      </AccountsInfo>
      <CustomersInfo xmlns:e504="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e504:CustomerInfo>
          <e504:Id d4p1:nil="false">ValueHere</e504:Id>
          <e504:Name d4p1:nil="false">ValueHere</e504:Name>
        </e504:CustomerInfo>
      </CustomersInfo>
    </GetLinkedAccountsAndCustomersInfoResponse>
  </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<GetLinkedAccountsAndCustomersInfoResponse> GetLinkedAccountsAndCustomersInfoAsync(
	long? customerId,
	bool onlyParentAccounts)
{
	var request = new GetLinkedAccountsAndCustomersInfoRequest
	{
		CustomerId = customerId,
		OnlyParentAccounts = onlyParentAccounts
	};

	return (await CustomerManagementService.CallAsync((s, r) => s.GetLinkedAccountsAndCustomersInfoAsync(r), request));
}

static GetLinkedAccountsAndCustomersInfoResponse getLinkedAccountsAndCustomersInfo(
	java.lang.Long customerId,
	boolean onlyParentAccounts) throws RemoteException, Exception
{
	GetLinkedAccountsAndCustomersInfoRequest request = new GetLinkedAccountsAndCustomersInfoRequest();

	request.setCustomerId(customerId);
	request.setOnlyParentAccounts(onlyParentAccounts);

	return CustomerManagementService.getService().getLinkedAccountsAndCustomersInfo(request);
}

static function GetLinkedAccountsAndCustomersInfo(
	$customerId,
	$onlyParentAccounts)
{

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

	$request = new GetLinkedAccountsAndCustomersInfoRequest();

	$request->CustomerId = $customerId;
	$request->OnlyParentAccounts = $onlyParentAccounts;

	return $GLOBALS['CustomerManagementProxy']->GetService()->GetLinkedAccountsAndCustomersInfo($request);
}

response=customermanagement_service.GetLinkedAccountsAndCustomersInfo(
	CustomerId=CustomerId,
	OnlyParentAccounts=OnlyParentAccounts)

Configuration requise

Service : CustomerManagementService.svc v13
Namespace: https://bingads.microsoft.com/Customer/v13

URL de la demande

https://clientcenter.api.bingads.microsoft.com/CustomerManagement/v13/LinkedAccountsAndCustomersInfo/Query

Éléments de demande

L’objet GetLinkedAccountsAndCustomersInfoRequest 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
CustomerId Identificateur du client dont vous souhaitez obtenir la hiérarchie. long
OnlyParentAccounts Détermine s’il faut retourner uniquement les comptes d’annonceur qui appartiennent au client ou retourner également les clients liés et les comptes d’annonceur liés sous d’autres clients.

Pour limiter les résultats aux comptes d’annonceur directement sous le client spécifié, définissez cet élément sur true, sinon laissez-le vide ou définissez la propriété sur false. La valeur par défaut est false.		 boolean

É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
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 GetLinkedAccountsAndCustomersInfoResponse 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
AccountsInfo Liste des informations sur les comptes d’annonceur qui correspondent aux critères de la demande.

Notez qu’il peut y avoir un délai allant jusqu’à cinq minutes entre le moment où vous créez un compte et que les informations de compte sont incluses dans la réponse.		 Tableau AccountInfo
CustomersInfo Liste des informations sur les clients qui correspondent aux critères de la demande. Tableau CustomerInfo

É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.

{
  "CustomerId": "LongValueHere",
  "OnlyParentAccounts": "ValueHere"
}

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.

{
  "AccountsInfo": [
    {
      "AccountLifeCycleStatus": "ValueHere",
      "Id": "LongValueHere",
      "Name": "ValueHere",
      "Number": "ValueHere",
      "PauseReason": "ValueHere"
    }
  ],
  "CustomersInfo": [
    {
      "Id": "LongValueHere",
      "Name": "ValueHere"
    }
  ]
}

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<GetLinkedAccountsAndCustomersInfoResponse> GetLinkedAccountsAndCustomersInfoAsync(
	long? customerId,
	bool onlyParentAccounts)
{
	var request = new GetLinkedAccountsAndCustomersInfoRequest
	{
		CustomerId = customerId,
		OnlyParentAccounts = onlyParentAccounts
	};

	return (await CustomerManagementService.CallAsync((s, r) => s.GetLinkedAccountsAndCustomersInfoAsync(r), request));
}

static GetLinkedAccountsAndCustomersInfoResponse getLinkedAccountsAndCustomersInfo(
	java.lang.Long customerId,
	boolean onlyParentAccounts) throws RemoteException, Exception
{
	GetLinkedAccountsAndCustomersInfoRequest request = new GetLinkedAccountsAndCustomersInfoRequest();

	request.setCustomerId(customerId);
	request.setOnlyParentAccounts(onlyParentAccounts);

	return CustomerManagementService.getService().getLinkedAccountsAndCustomersInfo(request);
}

static function GetLinkedAccountsAndCustomersInfo(
	$customerId,
	$onlyParentAccounts)
{

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

	$request = new GetLinkedAccountsAndCustomersInfoRequest();

	$request->CustomerId = $customerId;
	$request->OnlyParentAccounts = $onlyParentAccounts;

	return $GLOBALS['CustomerManagementProxy']->GetService()->GetLinkedAccountsAndCustomersInfo($request);
}

response=customermanagement_service.GetLinkedAccountsAndCustomersInfo(
	CustomerId=CustomerId,
	OnlyParentAccounts=OnlyParentAccounts)