DownloadCampaignsByCampaignIds Service Operation - Bulk

Artículo
11/14/2024

Descarga la configuración y los datos de rendimiento de las campañas especificadas. Puede solicitar todos los datos de la campaña o solo los datos que han cambiado desde la última vez que descargó la campaña.

Debe usar las mismas credenciales de usuario para la operación de solicitud de descarga ( DownloadCampaignsByAccountIds o DownloadCampaignsByCampaignIds) y la operación de sondeo GetBulkDownloadStatus .

Sugerencia

El esquema de archivos masivo proporciona detalles sobre los registros que puede descargar y cargar. Siga los procedimientos recomendados para garantizar un uso justo para usted y para todos los clientes de Microsoft Advertising. Para obtener más información, consulte Procedimientos recomendados de descarga masiva y procedimientos recomendados de carga masiva.

Elementos Request

El objeto DownloadCampaignsByCampaignIdsRequest 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
Campañas	Campañas que se van a descargar. Puede especificar un máximo de 1000 campañas. Las campañas que especifique deben pertenecer a la misma cuenta.	Matriz CampaignScope
CompressionType	Tipo de compresión del archivo de descarga. Para obtener los valores posibles, vea CompressionType. El tipo de compresión predeterminado es Zip.	CompressionType
DataScope	Puede incluir datos de puntuación de calidad, como la relevancia del anuncio, además de los datos de entidad, como la configuración de la campaña. El valor predeterminado es EntityData. Puede incluir varios valores como marcas. La forma de especificar varias marcas depende del lenguaje de programación que use. Por ejemplo, C# trata estos valores como valores de marca y Java los trata como una matriz de cadenas. SOAP debe incluir una cadena que contenga una lista delimitada por espacios de valores, por ejemplo, `<DataScope>EntityData QualityScoreData</DataScope>`. Si se incluyen BidSuggestionsData o QualityScoreData , debe solicitar una sincronización completa. Para realizar una sincronización completa, no establezca LastSyncTimeInUTC , es decir, déjela en un valor nulo.	DataScope
DownloadEntities	Entidades que se van a incluir en la descarga. Para obtener una lista de las entidades que puede descargar, consulte el conjunto de valores DownloadEntity . Debe especificar al menos una entidad de descarga y, en caso contrario, se producirá un error en la operación.	Matriz DownloadEntity
DownloadFileType	Formato del archivo de descarga. Para ver los valores posibles, consulte DownloadFileType. El valor predeterminado es CSV.	DownloadFileType
FormatVersion	Formato de los registros del archivo de descarga. Como procedimiento recomendado, siempre debe especificar la versión de formato más reciente. Actualmente, la única versión de formato compatible para Bing Ads API versión 13 es la 6.0. Debe administrar los registros según el esquema de archivo masivo para la versión de formato correspondiente.	string
LastSyncTimeInUTC	La última vez que solicitó una descarga. La fecha y hora se expresan en hora universal coordinada (UTC). Si especifica la hora de la última sincronización, solo se descargarán las entidades que han cambiado (agregadas, actualizadas o eliminadas) desde la fecha y hora especificadas. Si la campaña primaria o el grupo de anuncios se han eliminado desde la última hora de sincronización especificada, solo verá un registro eliminado para la campaña primaria o el grupo de anuncios eliminados. Por ejemplo, si se eliminó una campaña, el archivo masivo no contendrá registros eliminados de los grupos de anuncios, los criterios, los anuncios y las palabras clave que estaban en la campaña. El criterio de destino se trata ligeramente diferente de otras entidades y no se devuelven los registros eliminados. Si se han realizado cambios en el destino de una campaña o grupo de anuncios, se devuelven todos los registros de criterio de sub target activos actualmente. Normalmente, se solicita una descarga completa la primera vez que se llama a la operación estableciendo este elemento en null. En todas las llamadas posteriores, establece la hora de la última sincronización en la marca de tiempo de la descarga anterior. El archivo de descarga contiene la marca de tiempo de la descarga en la columna Hora de sincronización del registro Cuenta . Debe usar la hora de sincronización de la cuenta para establecer este elemento la próxima vez que solicite una descarga. Si establece una fecha y una hora que son más de 30 días antes, se devolverá un error.	dateTime

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 DownloadCampaignsByCampaignIdsResponse 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
DownloadRequestId	Identificador de la solicitud de descarga. Use el identificador para llamar a la operación GetBulkDownloadStatus para comprobar el estado de la descarga. El identificador es válido durante un máximo de dos días. Si no ha descargado correctamente el archivo dentro de este período, se quita del sitio de descarga y tendrá que obtener un nuevo identificador de solicitud de descarga. La cadena tiene una longitud de hasta 40 y puede contener cualquier carácter.	string

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">DownloadCampaignsByCampaignIds</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>
    <DownloadCampaignsByCampaignIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <Campaigns i:nil="false">
        <CampaignScope>
          <CampaignId>ValueHere</CampaignId>
          <ParentAccountId>ValueHere</ParentAccountId>
        </CampaignScope>
      </Campaigns>
      <CompressionType i:nil="false">ValueHere</CompressionType>
      <DataScope>ValueHere</DataScope>
      <DownloadEntities i:nil="false">
        <DownloadEntity>ValueHere</DownloadEntity>
      </DownloadEntities>
      <DownloadFileType i:nil="false">ValueHere</DownloadFileType>
      <FormatVersion i:nil="false">ValueHere</FormatVersion>
      <LastSyncTimeInUTC i:nil="false">ValueHere</LastSyncTimeInUTC>
    </DownloadCampaignsByCampaignIdsRequest>
  </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>
    <DownloadCampaignsByCampaignIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <DownloadRequestId d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</DownloadRequestId>
    </DownloadCampaignsByCampaignIdsResponse>
  </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<DownloadCampaignsByCampaignIdsResponse> DownloadCampaignsByCampaignIdsAsync(
	IList<CampaignScope> campaigns,
	CompressionType? compressionType,
	DataScope dataScope,
	IList<DownloadEntity> downloadEntities,
	DownloadFileType? downloadFileType,
	string formatVersion,
	DateTime? lastSyncTimeInUTC)
{
	var request = new DownloadCampaignsByCampaignIdsRequest
	{
		Campaigns = campaigns,
		CompressionType = compressionType,
		DataScope = dataScope,
		DownloadEntities = downloadEntities,
		DownloadFileType = downloadFileType,
		FormatVersion = formatVersion,
		LastSyncTimeInUTC = lastSyncTimeInUTC
	};

	return (await BulkService.CallAsync((s, r) => s.DownloadCampaignsByCampaignIdsAsync(r), request));
}

static DownloadCampaignsByCampaignIdsResponse downloadCampaignsByCampaignIds(
	ArrayOfCampaignScope campaigns,
	CompressionType compressionType,
	ArrayList<DataScope> dataScope,
	ArrayOfDownloadEntity downloadEntities,
	DownloadFileType downloadFileType,
	java.lang.String formatVersion,
	Calendar lastSyncTimeInUTC) throws RemoteException, Exception
{
	DownloadCampaignsByCampaignIdsRequest request = new DownloadCampaignsByCampaignIdsRequest();

	request.setCampaigns(campaigns);
	request.setCompressionType(compressionType);
	request.setDataScope(dataScope);
	request.setDownloadEntities(downloadEntities);
	request.setDownloadFileType(downloadFileType);
	request.setFormatVersion(formatVersion);
	request.setLastSyncTimeInUTC(lastSyncTimeInUTC);

	return BulkService.getService().downloadCampaignsByCampaignIds(request);
}

static function DownloadCampaignsByCampaignIds(
	$campaigns,
	$compressionType,
	$dataScope,
	$downloadEntities,
	$downloadFileType,
	$formatVersion,
	$lastSyncTimeInUTC)
{

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

	$request = new DownloadCampaignsByCampaignIdsRequest();

	$request->Campaigns = $campaigns;
	$request->CompressionType = $compressionType;
	$request->DataScope = $dataScope;
	$request->DownloadEntities = $downloadEntities;
	$request->DownloadFileType = $downloadFileType;
	$request->FormatVersion = $formatVersion;
	$request->LastSyncTimeInUTC = $lastSyncTimeInUTC;

	return $GLOBALS['BulkProxy']->GetService()->DownloadCampaignsByCampaignIds($request);
}

response=bulk_service.DownloadCampaignsByCampaignIds(
	Campaigns=Campaigns,
	CompressionType=CompressionType,
	DataScope=DataScope,
	DownloadEntities=DownloadEntities,
	DownloadFileType=DownloadFileType,
	FormatVersion=FormatVersion,
	LastSyncTimeInUTC=LastSyncTimeInUTC)

Requisitos

Servicio: BulkService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13

https://bulk.api.bingads.microsoft.com/Bulk/v13/Campaigns/DownloadByCampaignIds

https://bulk.api.sandbox.bingads.microsoft.com/Bulk/v13/Campaigns/DownloadByCampaignIds

Elementos Request

El objeto DownloadCampaignsByCampaignIdsRequest define los elementos body y header de la solicitud de operación de servicio.

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
Campañas	Campañas que se van a descargar. Puede especificar un máximo de 1000 campañas. Las campañas que especifique deben pertenecer a la misma cuenta.	Matriz CampaignScope
CompressionType	Tipo de compresión del archivo de descarga. Para obtener los valores posibles, vea CompressionType. El tipo de compresión predeterminado es Zip.	CompressionType
DataScope	Puede incluir datos de puntuación de calidad, como la relevancia del anuncio, además de los datos de entidad, como la configuración de la campaña. El valor predeterminado es EntityData. Puede incluir varios valores como marcas. La forma de especificar varias marcas depende del lenguaje de programación que use. Por ejemplo, C# trata estos valores como valores de marca y Java los trata como una matriz de cadenas. SOAP debe incluir una cadena que contenga una lista delimitada por espacios de valores, por ejemplo, `<DataScope>EntityData QualityScoreData</DataScope>`. Si se incluyen BidSuggestionsData o QualityScoreData , debe solicitar una sincronización completa. Para realizar una sincronización completa, no establezca LastSyncTimeInUTC , es decir, déjela en un valor nulo.	DataScope
DownloadEntities	Entidades que se van a incluir en la descarga. Para obtener una lista de las entidades que puede descargar, consulte el conjunto de valores DownloadEntity . Debe especificar al menos una entidad de descarga y, en caso contrario, se producirá un error en la operación.	Matriz DownloadEntity
DownloadFileType	Formato del archivo de descarga. Para ver los valores posibles, consulte DownloadFileType. El valor predeterminado es CSV.	DownloadFileType
FormatVersion	Formato de los registros del archivo de descarga. Como procedimiento recomendado, siempre debe especificar la versión de formato más reciente. Actualmente, la única versión de formato compatible para Bing Ads API versión 13 es la 6.0. Debe administrar los registros según el esquema de archivo masivo para la versión de formato correspondiente.	string
LastSyncTimeInUTC	La última vez que solicitó una descarga. La fecha y hora se expresan en hora universal coordinada (UTC). Si especifica la hora de la última sincronización, solo se descargarán las entidades que han cambiado (agregadas, actualizadas o eliminadas) desde la fecha y hora especificadas. Si la campaña primaria o el grupo de anuncios se han eliminado desde la última hora de sincronización especificada, solo verá un registro eliminado para la campaña primaria o el grupo de anuncios eliminados. Por ejemplo, si se eliminó una campaña, el archivo masivo no contendrá registros eliminados de los grupos de anuncios, los criterios, los anuncios y las palabras clave que estaban en la campaña. El criterio de destino se trata ligeramente diferente de otras entidades y no se devuelven los registros eliminados. Si se han realizado cambios en el destino de una campaña o grupo de anuncios, se devuelven todos los registros de criterio de sub target activos actualmente. Normalmente, se solicita una descarga completa la primera vez que se llama a la operación estableciendo este elemento en null. En todas las llamadas posteriores, establece la hora de la última sincronización en la marca de tiempo de la descarga anterior. El archivo de descarga contiene la marca de tiempo de la descarga en la columna Hora de sincronización del registro Cuenta . Debe usar la hora de sincronización de la cuenta para establecer este elemento la próxima vez que solicite una descarga. Si establece una fecha y una hora que son más de 30 días antes, se devolverá un error.	dateTime

Elementos de encabezado de solicitud

Elemento	Descripción	Tipo de datos
Autorización	Token de acceso de OAuth que representa las credenciales de un usuario que tiene permisos para cuentas de Microsoft Advertising. Asegúrese de que el token tiene el prefijo "Portador", esto es necesario para la autenticación adecuada. 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

Elementos del cuerpo de la respuesta

Elemento	Descripción	Tipo de datos
DownloadRequestId	Identificador de la solicitud de descarga. Use el identificador para llamar a la operación GetBulkDownloadStatus para comprobar el estado de la descarga. El identificador es válido durante un máximo de dos días. Si no ha descargado correctamente el archivo dentro de este período, se quita del sitio de descarga y tendrá que obtener un nuevo identificador de solicitud de descarga. La cadena tiene una longitud de hasta 40 y puede contener cualquier carácter.	string

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 JSON

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

{
  "Campaigns": [
    {
      "CampaignId": "LongValueHere",
      "ParentAccountId": "LongValueHere"
    }
  ],
  "CompressionType": "ValueHere",
  "DataScope": "ValueHere",
  "DownloadEntities": [
    "ValueHere"
  ],
  "DownloadFileType": "ValueHere",
  "FormatVersion": "ValueHere",
  "LastSyncTimeInUTC": "ValueHere"
}

JSON de respuesta

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

{
  "DownloadRequestId": "ValueHere"
}

Sintaxis de código

Para llamar a la API REST a través de SDK, debe actualizar el SDK a una versión determinada y configurar los parámetros del sistema. 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<DownloadCampaignsByCampaignIdsResponse> DownloadCampaignsByCampaignIdsAsync(
	IList<CampaignScope> campaigns,
	CompressionType? compressionType,
	DataScope dataScope,
	IList<DownloadEntity> downloadEntities,
	DownloadFileType? downloadFileType,
	string formatVersion,
	DateTime? lastSyncTimeInUTC)
{
	var request = new DownloadCampaignsByCampaignIdsRequest
	{
		Campaigns = campaigns,
		CompressionType = compressionType,
		DataScope = dataScope,
		DownloadEntities = downloadEntities,
		DownloadFileType = downloadFileType,
		FormatVersion = formatVersion,
		LastSyncTimeInUTC = lastSyncTimeInUTC
	};

	return (await BulkService.CallAsync((s, r) => s.DownloadCampaignsByCampaignIdsAsync(r), request));
}

static DownloadCampaignsByCampaignIdsResponse downloadCampaignsByCampaignIds(
	ArrayOfCampaignScope campaigns,
	CompressionType compressionType,
	ArrayList<DataScope> dataScope,
	ArrayOfDownloadEntity downloadEntities,
	DownloadFileType downloadFileType,
	java.lang.String formatVersion,
	Calendar lastSyncTimeInUTC) throws RemoteException, Exception
{
	DownloadCampaignsByCampaignIdsRequest request = new DownloadCampaignsByCampaignIdsRequest();

	request.setCampaigns(campaigns);
	request.setCompressionType(compressionType);
	request.setDataScope(dataScope);
	request.setDownloadEntities(downloadEntities);
	request.setDownloadFileType(downloadFileType);
	request.setFormatVersion(formatVersion);
	request.setLastSyncTimeInUTC(lastSyncTimeInUTC);

	return BulkService.getService().downloadCampaignsByCampaignIds(request);
}

static function DownloadCampaignsByCampaignIds(
	$campaigns,
	$compressionType,
	$dataScope,
	$downloadEntities,
	$downloadFileType,
	$formatVersion,
	$lastSyncTimeInUTC)
{

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

	$request = new DownloadCampaignsByCampaignIdsRequest();

	$request->Campaigns = $campaigns;
	$request->CompressionType = $compressionType;
	$request->DataScope = $dataScope;
	$request->DownloadEntities = $downloadEntities;
	$request->DownloadFileType = $downloadFileType;
	$request->FormatVersion = $formatVersion;
	$request->LastSyncTimeInUTC = $lastSyncTimeInUTC;

	return $GLOBALS['BulkProxy']->GetService()->DownloadCampaignsByCampaignIds($request);
}

response=bulk_service.DownloadCampaignsByCampaignIds(
	Campaigns=Campaigns,
	CompressionType=CompressionType,
	DataScope=DataScope,
	DownloadEntities=DownloadEntities,
	DownloadFileType=DownloadFileType,
	FormatVersion=FormatVersion,
	LastSyncTimeInUTC=LastSyncTimeInUTC)

Compartir a través de

DownloadCampaignsByCampaignIds Service Operation - Bulk

Elementos Request

Elementos del cuerpo de la solicitud

Elementos de encabezado de solicitud

Elementos de respuesta

Elementos del cuerpo de la respuesta

Elementos de encabezado de respuesta

Solicitud de SOAP

SOAP de respuesta

Sintaxis de código

Requisitos

Dirección URL de solicitud

Elementos Request

Elementos del cuerpo de la solicitud

Elementos de encabezado de solicitud

Elementos de respuesta

Elementos del cuerpo de la respuesta

Elementos de encabezado de respuesta

Solicitud de JSON

JSON de respuesta

Sintaxis de código

Comentarios

Recursos adicionales