Compartir a través de

Operación de servicio GetCampaignsByAccountId: Administración de campañas

  • Artículo

Obtiene las campañas dentro de una cuenta.

Elementos Request

El objeto GetCampaignsByAccountIdRequest 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
AccountId Identificador de la cuenta que contiene las campañas que se van a obtener. Largo
CampaignType Tipo de campaña que se va a obtener, por ejemplo, Search, Shopping o DynamicSearchAds.

Este elemento request es opcional. Si no establece ningún tipo de campaña, el valor predeterminado es Buscar , es decir, solo se devolverán las campañas de búsqueda.

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, <CampaignType>Search Shopping</CampaignType>.		 CampaignType
ReturnAdditionalFields Lista de propiedades adicionales que quieres incluir en cada campaña devuelta. Los valores de campo adicionales le permiten obtener las características más recientes mediante la versión actual de Campaign Management API y, en la siguiente versión, los elementos correspondientes se incluirán de forma predeterminada.

Este elemento request es opcional.		 CampaignAdditionalField

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 GetCampaignsByAccountIdResponse 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
Campañas Lista de campañas recuperadas. Si no existen campañas, se devuelve una matriz vacía. Matriz de campañas

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">GetCampaignsByAccountId</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>
    <GetCampaignsByAccountIdRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <AccountId>ValueHere</AccountId>
      <CampaignType>ValueHere</CampaignType>
      <ReturnAdditionalFields i:nil="false">ValueHere</ReturnAdditionalFields>
    </GetCampaignsByAccountIdRequest>
  </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>
    <GetCampaignsByAccountIdResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <Campaigns d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <Campaign>
          <AudienceAdsBidAdjustment d4p1:nil="false">ValueHere</AudienceAdsBidAdjustment>
          <BiddingScheme d4p1:nil="false" d4p1:type="-- derived type specified here with the appropriate prefix --">
            <Type d4p1:nil="false">ValueHere</Type>
            <!--This field is applicable if the derived type attribute is set to MaxClicksBiddingScheme-->
            <MaxCpc d4p1:nil="false">
              <Amount d4p1:nil="false">ValueHere</Amount>
            </MaxCpc>
            <!--These fields are applicable if the derived type attribute is set to MaxConversionsBiddingScheme-->
            <MaxCpc d4p1:nil="false">
              <Amount d4p1:nil="false">ValueHere</Amount>
            </MaxCpc>
            <TargetCpa d4p1:nil="false">ValueHere</TargetCpa>
            <!--These fields are applicable if the derived type attribute is set to TargetCpaBiddingScheme-->
            <MaxCpc d4p1:nil="false">
              <Amount d4p1:nil="false">ValueHere</Amount>
            </MaxCpc>
            <TargetCpa d4p1:nil="false">ValueHere</TargetCpa>
            <!--No additional fields are applicable if the derived type attribute is set to ManualCpcBiddingScheme-->
            <!--No additional fields are applicable if the derived type attribute is set to EnhancedCpcBiddingScheme-->
            <!--No additional fields are applicable if the derived type attribute is set to ManualCpvBiddingScheme-->
            <!--No additional fields are applicable if the derived type attribute is set to ManualCpmBiddingScheme-->
            <!--This field is applicable if the derived type attribute is set to InheritFromParentBiddingScheme-->
            <InheritedBidStrategyType d4p1:nil="false">ValueHere</InheritedBidStrategyType>
            <!--These fields are applicable if the derived type attribute is set to TargetRoasBiddingScheme-->
            <MaxCpc d4p1:nil="false">
              <Amount d4p1:nil="false">ValueHere</Amount>
            </MaxCpc>
            <TargetRoas d4p1:nil="false">ValueHere</TargetRoas>
            <!--This field is applicable if the derived type attribute is set to MaxRoasBiddingScheme-->
            <MaxCpc d4p1:nil="false">
              <Amount d4p1:nil="false">ValueHere</Amount>
            </MaxCpc>
            <!--This field is applicable if the derived type attribute is set to MaxConversionValueBiddingScheme-->
            <TargetRoas d4p1:nil="false">ValueHere</TargetRoas>
            <!--These fields are applicable if the derived type attribute is set to TargetImpressionShareBiddingScheme-->
            <MaxCpc d4p1:nil="false">
              <Amount d4p1:nil="false">ValueHere</Amount>
            </MaxCpc>
            <TargetAdPosition d4p1:nil="false">ValueHere</TargetAdPosition>
            <TargetImpressionShare d4p1:nil="false">ValueHere</TargetImpressionShare>
            <!--This field is applicable if the derived type attribute is set to PercentCpcBiddingScheme-->
            <MaxPercentCpc d4p1:nil="false">ValueHere</MaxPercentCpc>
            <!--This field is applicable if the derived type attribute is set to CommissionBiddingScheme-->
            <CommissionRate d4p1:nil="false">ValueHere</CommissionRate>
            <!--No additional fields are applicable if the derived type attribute is set to ManualCpaBiddingScheme-->
            <!--This field is applicable if the derived type attribute is set to CostPerSaleBiddingScheme-->
            <TargetCostPerSale d4p1:nil="false">ValueHere</TargetCostPerSale>
          </BiddingScheme>
          <BudgetType d4p1:nil="false">ValueHere</BudgetType>
          <DailyBudget d4p1:nil="false">ValueHere</DailyBudget>
          <DealIds d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <a1:long>ValueHere</a1:long>
          </DealIds>
          <ExperimentId d4p1:nil="false">ValueHere</ExperimentId>
          <FinalUrlSuffix d4p1:nil="false">ValueHere</FinalUrlSuffix>
          <ForwardCompatibilityMap xmlns:e134="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e134:KeyValuePairOfstringstring>
              <e134:key d4p1:nil="false">ValueHere</e134:key>
              <e134:value d4p1:nil="false">ValueHere</e134:value>
            </e134:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
          <GoalIds d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <a1:long>ValueHere</a1:long>
          </GoalIds>
          <Id d4p1:nil="false">ValueHere</Id>
          <MultimediaAdsBidAdjustment d4p1:nil="false">ValueHere</MultimediaAdsBidAdjustment>
          <Name d4p1:nil="false">ValueHere</Name>
          <Status d4p1:nil="false">ValueHere</Status>
          <SubType d4p1:nil="false">ValueHere</SubType>
          <TimeZone d4p1:nil="false">ValueHere</TimeZone>
          <TrackingUrlTemplate d4p1:nil="false">ValueHere</TrackingUrlTemplate>
          <UrlCustomParameters d4p1:nil="false">
            <Parameters d4p1:nil="false">
              <CustomParameter>
                <Key d4p1:nil="false">ValueHere</Key>
                <Value d4p1:nil="false">ValueHere</Value>
              </CustomParameter>
            </Parameters>
          </UrlCustomParameters>
          <CampaignType d4p1:nil="false">ValueHere</CampaignType>
          <Settings d4p1:nil="false">
            <Setting d4p1:type="-- derived type specified here with the appropriate prefix --">
              <Type d4p1:nil="false">ValueHere</Type>
              <!--This field is applicable if the derived type attribute is set to VerifiedTrackingSetting-->
              <Details xmlns:e135="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
                <e135:ArrayOfKeyValuePairOfstringstring>
                  <e135:KeyValuePairOfstringstring>
                    <e135:key d4p1:nil="false">ValueHere</e135:key>
                    <e135:value d4p1:nil="false">ValueHere</e135:value>
                  </e135:KeyValuePairOfstringstring>
                </e135:ArrayOfKeyValuePairOfstringstring>
              </Details>
              <!--These fields are applicable if the derived type attribute is set to ShoppingSetting-->
              <FeedLabel d4p1:nil="false">ValueHere</FeedLabel>
              <LocalInventoryAdsEnabled d4p1:nil="false">ValueHere</LocalInventoryAdsEnabled>
              <Priority d4p1:nil="false">ValueHere</Priority>
              <SalesCountryCode d4p1:nil="false">ValueHere</SalesCountryCode>
              <ShoppableAdsEnabled d4p1:nil="false">ValueHere</ShoppableAdsEnabled>
              <StoreId d4p1:nil="false">ValueHere</StoreId>
              <!--This field is applicable if the derived type attribute is set to DynamicFeedSetting-->
              <FeedId d4p1:nil="false">ValueHere</FeedId>
              <!--These fields are applicable if the derived type attribute is set to DynamicSearchAdsSetting-->
              <DomainName d4p1:nil="false">ValueHere</DomainName>
              <DynamicDescriptionEnabled d4p1:nil="false">ValueHere</DynamicDescriptionEnabled>
              <Language d4p1:nil="false">ValueHere</Language>
              <PageFeedIds d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <a1:long>ValueHere</a1:long>
              </PageFeedIds>
              <Source d4p1:nil="false">ValueHere</Source>
              <!--This field is applicable if the derived type attribute is set to TargetSetting-->
              <Details d4p1:nil="false">
                <TargetSettingDetail>
                  <CriterionTypeGroup>ValueHere</CriterionTypeGroup>
                  <TargetAndBid>ValueHere</TargetAndBid>
                </TargetSettingDetail>
              </Details>
              <!--These fields are applicable if the derived type attribute is set to CoOpSetting-->
              <BidBoostValue d4p1:nil="false">ValueHere</BidBoostValue>
              <BidMaxValue d4p1:nil="false">ValueHere</BidMaxValue>
              <BidOption d4p1:nil="false">ValueHere</BidOption>
              <!--This field is applicable if the derived type attribute is set to DisclaimerSetting-->
              <DisclaimerAdsEnabled>ValueHere</DisclaimerAdsEnabled>
              <!--This field is applicable if the derived type attribute is set to HotelSetting-->
              <HotelAdGroupType>ValueHere</HotelAdGroupType>
              <!--This field is applicable if the derived type attribute is set to ResponsiveSearchAdsSetting-->
              <AutoGeneratedAssetsEnabled d4p1:nil="false">ValueHere</AutoGeneratedAssetsEnabled>
              <!--These fields are applicable if the derived type attribute is set to PerformanceMaxSetting-->
              <AutoGeneratedImageOptOut d4p1:nil="false">ValueHere</AutoGeneratedImageOptOut>
              <AutoGeneratedTextOptOut d4p1:nil="false">ValueHere</AutoGeneratedTextOptOut>
              <FinalUrlExpansionOptOut>ValueHere</FinalUrlExpansionOptOut>
              <PageFeedIds d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <a1:long>ValueHere</a1:long>
              </PageFeedIds>
              <!--This field is applicable if the derived type attribute is set to CallToActionSetting-->
              <AutomatedCallToActionOptOut d4p1:nil="false">ValueHere</AutomatedCallToActionOptOut>
            </Setting>
          </Settings>
          <BudgetId d4p1:nil="false">ValueHere</BudgetId>
          <Languages d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <a1:string>ValueHere</a1:string>
          </Languages>
          <AdScheduleUseSearcherTimeZone d4p1:nil="false">ValueHere</AdScheduleUseSearcherTimeZone>
          <BidStrategyId d4p1:nil="false">ValueHere</BidStrategyId>
        </Campaign>
      </Campaigns>
    </GetCampaignsByAccountIdResponse>
  </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<GetCampaignsByAccountIdResponse> GetCampaignsByAccountIdAsync(
	long accountId,
	CampaignType campaignType,
	CampaignAdditionalField? returnAdditionalFields)
{
	var request = new GetCampaignsByAccountIdRequest
	{
		AccountId = accountId,
		CampaignType = campaignType,
		ReturnAdditionalFields = returnAdditionalFields
	};

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

static GetCampaignsByAccountIdResponse getCampaignsByAccountId(
	java.lang.Long accountId,
	ArrayList<CampaignType> campaignType,
	ArrayList<CampaignAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
	GetCampaignsByAccountIdRequest request = new GetCampaignsByAccountIdRequest();

	request.setAccountId(accountId);
	request.setCampaignType(campaignType);
	request.setReturnAdditionalFields(returnAdditionalFields);

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

static function GetCampaignsByAccountId(
	$accountId,
	$campaignType,
	$returnAdditionalFields)
{

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

	$request = new GetCampaignsByAccountIdRequest();

	$request->AccountId = $accountId;
	$request->CampaignType = $campaignType;
	$request->ReturnAdditionalFields = $returnAdditionalFields;

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

response=campaignmanagement_service.GetCampaignsByAccountId(
	AccountId=AccountId,
	CampaignType=CampaignType,
	ReturnAdditionalFields=ReturnAdditionalFields)

Requisitos

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