Compartir a través de

Operación del servicio AddAudiences: administración de campañas

  • Artículo

Agrega una o más audiencias.

Elementos Request

El objeto AddAudiencesRequest 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
Audiencias Lista de audiencias que se van a agregar.

El tamaño máximo de la lista es 100.

No se pueden agregar objetos CustomAudience, InMarketAudience o SimilarRemarketingList .		 Matriz de audiencias

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 AddAudiencesResponse 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
AudienceIds Lista de identificadores únicos del sistema correspondientes a las audiencias que se agregaron.

La lista de identificadores corresponde directamente a la lista de audiencias de la solicitud. Los elementos de la lista se pueden devolver como null. Para cada índice de lista en el que no se agregó una audiencia, el elemento correspondiente será null.		 matriz larga
PartialErrors Matriz de objetos BatchError que contienen detalles de los elementos de solicitud que no se han realizado correctamente.

La lista de errores no se corresponde directamente con la lista de elementos de la solicitud. La lista puede estar vacía si no hay errores o puede incluir uno o varios objetos de error correspondientes a cada elemento de lista incorrecto en la solicitud.		 Matriz BatchError

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">AddAudiences</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>
    <AddAudiencesRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <Audiences i:nil="false">
        <Audience i:type="-- derived type specified here with the appropriate prefix --">
          <AudienceNetworkSize i:nil="false">ValueHere</AudienceNetworkSize>
          <CustomerShare i:nil="false">
            <CustomerAccountShares i:nil="false">
              <CustomerAccountShare>
                <AccountId i:nil="false">ValueHere</AccountId>
                <Associations i:nil="false">
                  <CustomerAccountShareAssociation>
                    <AssociationCount i:nil="false">ValueHere</AssociationCount>
                    <UsageType i:nil="false">ValueHere</UsageType>
                  </CustomerAccountShareAssociation>
                </Associations>
                <CustomerId i:nil="false">ValueHere</CustomerId>
              </CustomerAccountShare>
            </CustomerAccountShares>
            <OwnerCustomerId i:nil="false">ValueHere</OwnerCustomerId>
          </CustomerShare>
          <Description i:nil="false">ValueHere</Description>
          <ForwardCompatibilityMap xmlns:e33="http://schemas.datacontract.org/2004/07/System.Collections.Generic" i:nil="false">
            <e33:KeyValuePairOfstringstring>
              <e33:key i:nil="false">ValueHere</e33:key>
              <e33:value i:nil="false">ValueHere</e33:value>
            </e33:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
          <Id i:nil="false">ValueHere</Id>
          <MembershipDuration i:nil="false">ValueHere</MembershipDuration>
          <Name i:nil="false">ValueHere</Name>
          <ParentId i:nil="false">ValueHere</ParentId>
          <Scope i:nil="false">ValueHere</Scope>
          <SearchSize i:nil="false">ValueHere</SearchSize>
          <SupportedCampaignTypes i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <a1:string>ValueHere</a1:string>
          </SupportedCampaignTypes>
          <Type>ValueHere</Type>
          <!--These fields are applicable if the derived type attribute is set to RemarketingList-->
          <Rule i:nil="false" i:type="-- derived type specified here with the appropriate prefix --">
            <Type i:nil="false">ValueHere</Type>
            <!--These fields are applicable if the derived type attribute is set to PageVisitorsRule-->
            <NormalForm i:nil="false">ValueHere</NormalForm>
            <RuleItemGroups i:nil="false">
              <RuleItemGroup>
                <Items i:nil="false">
                  <RuleItem i:type="-- derived type specified here with the appropriate prefix --">
                    <Type i:nil="false">ValueHere</Type>
                    <!--These fields are applicable if the derived type attribute is set to StringRuleItem-->
                    <Operand i:nil="false">ValueHere</Operand>
                    <Operator>ValueHere</Operator>
                    <Value i:nil="false">ValueHere</Value>
                    <!--These fields are applicable if the derived type attribute is set to NumberRuleItem-->
                    <Operand i:nil="false">ValueHere</Operand>
                    <Operator>ValueHere</Operator>
                    <Value i:nil="false">ValueHere</Value>
                  </RuleItem>
                </Items>
              </RuleItemGroup>
            </RuleItemGroups>
            <!--These fields are applicable if the derived type attribute is set to PageVisitorsWhoVisitedAnotherPageRule-->
            <AnotherRuleItemGroups i:nil="false">
              <RuleItemGroup>
                <Items i:nil="false">
                  <RuleItem i:type="-- derived type specified here with the appropriate prefix --">
                    <Type i:nil="false">ValueHere</Type>
                    <!--These fields are applicable if the derived type attribute is set to StringRuleItem-->
                    <Operand i:nil="false">ValueHere</Operand>
                    <Operator>ValueHere</Operator>
                    <Value i:nil="false">ValueHere</Value>
                    <!--These fields are applicable if the derived type attribute is set to NumberRuleItem-->
                    <Operand i:nil="false">ValueHere</Operand>
                    <Operator>ValueHere</Operator>
                    <Value i:nil="false">ValueHere</Value>
                  </RuleItem>
                </Items>
              </RuleItemGroup>
            </AnotherRuleItemGroups>
            <RuleItemGroups i:nil="false">
              <RuleItemGroup>
                <Items i:nil="false">
                  <RuleItem i:type="-- derived type specified here with the appropriate prefix --">
                    <Type i:nil="false">ValueHere</Type>
                    <!--These fields are applicable if the derived type attribute is set to StringRuleItem-->
                    <Operand i:nil="false">ValueHere</Operand>
                    <Operator>ValueHere</Operator>
                    <Value i:nil="false">ValueHere</Value>
                    <!--These fields are applicable if the derived type attribute is set to NumberRuleItem-->
                    <Operand i:nil="false">ValueHere</Operand>
                    <Operator>ValueHere</Operator>
                    <Value i:nil="false">ValueHere</Value>
                  </RuleItem>
                </Items>
              </RuleItemGroup>
            </RuleItemGroups>
            <!--These fields are applicable if the derived type attribute is set to PageVisitorsWhoDidNotVisitAnotherPageRule-->
            <ExcludeRuleItemGroups i:nil="false">
              <RuleItemGroup>
                <Items i:nil="false">
                  <RuleItem i:type="-- derived type specified here with the appropriate prefix --">
                    <Type i:nil="false">ValueHere</Type>
                    <!--These fields are applicable if the derived type attribute is set to StringRuleItem-->
                    <Operand i:nil="false">ValueHere</Operand>
                    <Operator>ValueHere</Operator>
                    <Value i:nil="false">ValueHere</Value>
                    <!--These fields are applicable if the derived type attribute is set to NumberRuleItem-->
                    <Operand i:nil="false">ValueHere</Operand>
                    <Operator>ValueHere</Operator>
                    <Value i:nil="false">ValueHere</Value>
                  </RuleItem>
                </Items>
              </RuleItemGroup>
            </ExcludeRuleItemGroups>
            <IncludeRuleItemGroups i:nil="false">
              <RuleItemGroup>
                <Items i:nil="false">
                  <RuleItem i:type="-- derived type specified here with the appropriate prefix --">
                    <Type i:nil="false">ValueHere</Type>
                    <!--These fields are applicable if the derived type attribute is set to StringRuleItem-->
                    <Operand i:nil="false">ValueHere</Operand>
                    <Operator>ValueHere</Operator>
                    <Value i:nil="false">ValueHere</Value>
                    <!--These fields are applicable if the derived type attribute is set to NumberRuleItem-->
                    <Operand i:nil="false">ValueHere</Operand>
                    <Operator>ValueHere</Operator>
                    <Value i:nil="false">ValueHere</Value>
                  </RuleItem>
                </Items>
              </RuleItemGroup>
            </IncludeRuleItemGroups>
            <!--These fields are applicable if the derived type attribute is set to CustomEventsRule-->
            <Action i:nil="false">ValueHere</Action>
            <ActionOperator>ValueHere</ActionOperator>
            <Category i:nil="false">ValueHere</Category>
            <CategoryOperator>ValueHere</CategoryOperator>
            <Label i:nil="false">ValueHere</Label>
            <LabelOperator>ValueHere</LabelOperator>
            <Value i:nil="false">ValueHere</Value>
            <ValueOperator>ValueHere</ValueOperator>
          </Rule>
          <TagId i:nil="false">ValueHere</TagId>
          <!--No additional fields are applicable if the derived type attribute is set to CustomAudience-->
          <!--No additional fields are applicable if the derived type attribute is set to InMarketAudience-->
          <!--These fields are applicable if the derived type attribute is set to ProductAudience-->
          <ProductAudienceType i:nil="false">ValueHere</ProductAudienceType>
          <TagId i:nil="false">ValueHere</TagId>
          <!--This field is applicable if the derived type attribute is set to SimilarRemarketingList-->
          <SourceId>ValueHere</SourceId>
          <!--This field is applicable if the derived type attribute is set to CombinedList-->
          <CombinationRules i:nil="false">
            <CombinationRule>
              <AudienceIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <a1:long>ValueHere</a1:long>
              </AudienceIds>
              <Operator>ValueHere</Operator>
            </CombinationRule>
          </CombinationRules>
          <!--No additional fields are applicable if the derived type attribute is set to CustomerList-->
          <!--These fields are applicable if the derived type attribute is set to ImpressionBasedRemarketingList-->
          <AdGroupId i:nil="false">ValueHere</AdGroupId>
          <CampaignId i:nil="false">ValueHere</CampaignId>
          <EntityType>ValueHere</EntityType>
        </Audience>
      </Audiences>
    </AddAudiencesRequest>
  </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>
    <AddAudiencesResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <AudienceIds d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <a1:long>ValueHere</a1:long>
      </AudienceIds>
      <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:e34="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e34:KeyValuePairOfstringstring>
              <e34:key d4p1:nil="false">ValueHere</e34:key>
              <e34:value d4p1:nil="false">ValueHere</e34:value>
            </e34: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>
    </AddAudiencesResponse>
  </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<AddAudiencesResponse> AddAudiencesAsync(
	IList<Audience> audiences)
{
	var request = new AddAudiencesRequest
	{
		Audiences = audiences
	};

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

static AddAudiencesResponse addAudiences(
	ArrayOfAudience audiences) throws RemoteException, Exception
{
	AddAudiencesRequest request = new AddAudiencesRequest();

	request.setAudiences(audiences);

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

static function AddAudiences(
	$audiences)
{

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

	$request = new AddAudiencesRequest();

	$request->Audiences = $audiences;

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

response=campaignmanagement_service.AddAudiences(
	Audiences=Audiences)

Requisitos

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