Edit

GetAccountMigrationStatuses Service Operation - Campaign Management

  • Article

Gets the migration status info for the specified accounts.

Currently there are no applicable migrations in progress and this operation is reserved for future use.

Request Elements

The GetAccountMigrationStatusesRequest object defines the body and header elements of the service operation request. The elements must be in the same order as shown in the Request SOAP.

Note

Unless otherwise noted below, all request elements are required.

Request Body Elements

Element Description Data Type
AccountIds The identifiers of each account to request migration status. long array
MigrationType Filters the returned migration status by migration type.

Currently there are no applicable migrations in progress and this element is reserved for future use.		 string

Request Header Elements

Element Description Data Type
AuthenticationToken The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts.

For more information see Authentication with OAuth.		 string
CustomerAccountId The identifier of the ad account that owns or is associated with the entities in the request. This header element must have the same value as the AccountId body element when both are required. This element is required for most service operations, and as a best practice you should always set it.

For more information see Get Your Account and Customer IDs.		 string
CustomerId The identifier of the manager account (customer) the user is accessing or operating from. A user can have access to multiple manager accounts. This element is required for most service operations, and as a best practice you should always set it.

For more information see Get Your Account and Customer IDs.		 string
DeveloperToken The developer token used to access the Bing Ads API.

For more information see Get a Developer Token.		 string
Password This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. string
UserName This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. string

Response Elements

The GetAccountMigrationStatusesResponse object defines the body and header elements of the service operation response. The elements are returned in the same order as shown in the Response SOAP.

Response Body Elements

Element Description Data Type
MigrationStatuses An array of account migration statuses.

For each account identifier specified in the request, an AccountMigrationStatusesInfo object is returned.		 AccountMigrationStatusesInfo array

Response Header Elements

Element Description Data Type
TrackingId The identifier of the log entry that contains the details of the API call. string

Request SOAP

This template was generated by a tool to show the order of the body and header elements for the SOAP request. For supported types that you can use with this service operation, see the Request Body Elements reference above.

<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">GetAccountMigrationStatuses</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>
    <GetAccountMigrationStatusesRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <AccountIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long>ValueHere</a1:long>
      </AccountIds>
      <MigrationType i:nil="false">ValueHere</MigrationType>
    </GetAccountMigrationStatusesRequest>
  </s:Body>
</s:Envelope>

Response SOAP

This template was generated by a tool to show the order of the body and header elements for the SOAP response.

<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>
    <GetAccountMigrationStatusesResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <MigrationStatuses d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <AccountMigrationStatusesInfo>
          <AccountId>ValueHere</AccountId>
          <MigrationStatusInfos d4p1:nil="false">
            <MigrationStatusInfo>
              <MigrationType d4p1:nil="false">ValueHere</MigrationType>
              <StartTimeInUtc d4p1:nil="false">ValueHere</StartTimeInUtc>
              <Status>ValueHere</Status>
            </MigrationStatusInfo>
          </MigrationStatusInfos>
        </AccountMigrationStatusesInfo>
      </MigrationStatuses>
    </GetAccountMigrationStatusesResponse>
  </s:Body>
</s:Envelope>

Code Syntax

The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.

public async Task<GetAccountMigrationStatusesResponse> GetAccountMigrationStatusesAsync(
	IList<long> accountIds,
	string migrationType)
{
	var request = new GetAccountMigrationStatusesRequest
	{
		AccountIds = accountIds,
		MigrationType = migrationType
	};

	return (await CampaignManagementService.CallAsync((s, r) => s.GetAccountMigrationStatusesAsync(r), request));
}

static GetAccountMigrationStatusesResponse getAccountMigrationStatuses(
	ArrayOflong accountIds,
	java.lang.String migrationType) throws RemoteException, Exception
{
	GetAccountMigrationStatusesRequest request = new GetAccountMigrationStatusesRequest();

	request.setAccountIds(accountIds);
	request.setMigrationType(migrationType);

	return CampaignManagementService.getService().getAccountMigrationStatuses(request);
}

static function GetAccountMigrationStatuses(
	$accountIds,
	$migrationType)
{

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

	$request = new GetAccountMigrationStatusesRequest();

	$request->AccountIds = $accountIds;
	$request->MigrationType = $migrationType;

	return $GLOBALS['CampaignManagementProxy']->GetService()->GetAccountMigrationStatuses($request);
}

response=campaignmanagement_service.GetAccountMigrationStatuses(
	AccountIds=AccountIds,
	MigrationType=MigrationType)

Requirements

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