Freigeben über

AddSharedEntity Service Operation – Kampagnenverwaltung

  • Artikel

Fügt der Anzeigenkontobibliothek eine negative Schlüsselwort (keyword) Liste hinzu oder fügt der Bibliothek des Vorgesetztenkontos (Kunde) eine Websiteausschlussliste hinzu.

Tipp

Eine Übersicht finden Sie in den technischen Leitfäden zu negativen Schlüsselwörtern und negativen Websites .

Wichtig

Nur die Benutzer des Vorgesetztenkontos (Kunde), das eine Website-Ausschlussliste (PlacementExclusionList) besitzt, können die Liste aktualisieren oder löschen, Listenelemente hinzufügen oder löschen und die Liste Anzeigenkonten zuordnen. Wenn Ihr Anzeigenkonto einer Websiteausschlussliste zugeordnet ist, die Sie nicht besitzen, können Sie die Zuordnung der Liste zu Ihrem Konto aufheben, aber die Listen- und Listenelemente sind schreibgeschützt. Der Besitzer der Liste wird durch das SharedEntityCustomerId-Element der Zuordnung bestimmt.

Wenn Sie Zugriff auf mehrere Managerkonten in einer Kontohierarchie haben, können die Ergebnisse des Vorgangs je nach festgelegtem CustomerId-Anforderungsheaderelement variieren.

Anfordern von Elementen

Das AddSharedEntityRequest-Objekt definiert den Text und die Headerelemente der Dienstvorgangsanforderung. Die Elemente müssen in der gleichen Reihenfolge wie im Anforderungs-SOAP dargestellt sein.

Hinweis

Sofern unten nicht anders angegeben, sind alle Anforderungselemente erforderlich.

Anforderungstextelemente

Element Beschreibung Datentyp
ListItems Die negativen Schlüsselwörter (maximal 5.000), die in die neue negative Schlüsselwort (keyword) Liste aufgenommen werden sollen, oder negative Websites (maximal 10.000), die in die neue Ausschlussliste der Website aufgenommen werden sollen.

Die Liste kann maximal 5.000 Elemente pro Serviceaufruf enthalten. Um weitere Listenelemente hinzuzufügen, rufen Sie den Vorgang AddListItemsToSharedList auf.		 SharedListItem-Array
SharedEntity Die negative Schlüsselwort (keyword) Liste oder Websiteausschlussliste.

Wenn SharedEntityScope entweder leer oder auf Account festgelegt ist und SharedEntity eine NegativeKeywordList ist, müssen listItems negative Schlüsselwort (keyword) (NegativeKeyword)-Objekte sein.

Wenn SharedEntityScope auf Customer festgelegt ist und SharedEntity eine PlacementExclusionList ist, müssen die ListItems negative Websiteobjekte (NegativeSite) sein.		 SharedEntity
SharedEntityScope Gibt an, ob die freigegebene Entität auf Der Ebene des Anzeigenkontos (Kontos) oder des Vorgesetztenkontos (Kunde) verfügbar ist.

Dieses Element ist optional und wird standardmäßig auf Kontobereich festgelegt. Der Anzeigenkontobereich gilt nur für negative Schlüsselwort (keyword) Listen.

Legen Sie dieses Element auf Customer fest, um eine Websiteausschlussliste in Der freigegebenen Bibliothek ihres Vorgesetztenkontos (Kunde) hinzuzufügen.		 EntityScope

Anforderungsheaderelemente

Element Beschreibung Datentyp
AuthenticationToken Das OAuth-Zugriffstoken, das die Anmeldeinformationen eines Benutzers darstellt, der über Berechtigungen für Microsoft Advertising-Konten verfügt.

Weitere Informationen finden Sie unter Authentifizierung mit OAuth.		 Zeichenfolge
CustomerAccountId Der Bezeichner des Anzeigenkontos, das die Entitäten in der Anforderung besitzt oder zugeordnet ist. Dieses Headerelement muss denselben Wert wie das AccountId-Body-Element aufweisen, wenn beides erforderlich ist. Dieses Element ist für die meisten Dienstvorgänge erforderlich, und als bewährte Methode sollten Sie es immer festlegen.

Weitere Informationen finden Sie unter Abrufen Von Konto- und Kunden-IDs.		 Zeichenfolge
CustomerId Der Bezeichner des Vorgesetztenkontos (Kunde), auf das der Benutzer zugreift oder von dort aus arbeitet. Ein Benutzer kann Zugriff auf mehrere Managerkonten haben. Dieses Element ist für die meisten Dienstvorgänge erforderlich, und als bewährte Methode sollten Sie es immer festlegen.

Weitere Informationen finden Sie unter Abrufen Von Konto- und Kunden-IDs.		 Zeichenfolge
DeveloperToken Das Entwicklertoken, das für den Zugriff auf die Bing Ads-API verwendet wird.

Weitere Informationen finden Sie unter Abrufen eines Entwicklertokens.		 Zeichenfolge
Kennwort Dieses Element ist für die interne Verwendung reserviert und wird aus einer zukünftigen Version der API entfernt. Sie müssen das AuthenticationToken-Element verwenden, um Benutzeranmeldeinformationen festzulegen. Zeichenfolge
UserName Dieses Element ist für die interne Verwendung reserviert und wird aus einer zukünftigen Version der API entfernt. Sie müssen das AuthenticationToken-Element verwenden, um Benutzeranmeldeinformationen festzulegen. Zeichenfolge

Antwortelemente

Das AddSharedEntityResponse-Objekt definiert den Text und die Headerelemente der Dienstvorgangsantwort. Die Elemente werden in der gleichen Reihenfolge zurückgegeben, in der die Antwort-SOAP gezeigt wird.

Antworttextelemente

Element Beschreibung Datentyp
ListItemIds Eine Liste langer Werte , die die Bezeichner für die hinzugefügten Listenelemente darstellt.

Elemente der Liste können als NULL zurückgegeben werden. Für jeden Listenindex, bei dem kein Listenelement hinzugefügt wurde, ist das entsprechende Element NULL.		 langes Array
PartialErrors Ein Array von BatchError-Objekten , die Details für alle Anforderungselemente enthalten, die nicht erfolgreich waren.

Die Liste der Fehler entspricht nicht direkt der Liste der Elemente in der Anforderung. Die Liste kann leer sein, wenn keine Fehler aufgetreten sind, oder ein oder mehrere Fehlerobjekte enthalten, die jedem nicht erfolgreichen Listenelement in der Anforderung entsprechen.		 BatchError-Array
SharedEntityId Der Bezeichner für die freigegebene Entität, die hinzugefügt wurde. lang

Antwortheaderelemente

Element Beschreibung Datentyp
TrackingId Der Bezeichner des Protokolleintrags, der die Details des API-Aufrufs enthält. Zeichenfolge

SOAP anfordern

Diese Vorlage wurde von einem Tool generiert, um die Reihenfolge der Text- und Headerelemente für die SOAP-Anforderung anzuzeigen. Informationen zu unterstützten Typen, die Sie mit diesem Dienstvorgang verwenden können, finden Sie oben in der Referenz zu Anforderungstextelementen .

<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">AddSharedEntity</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>
    <AddSharedEntityRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <SharedEntity i:nil="false" i:type="-- derived type specified here with the appropriate prefix --">
        <AssociationCount i:nil="false">ValueHere</AssociationCount>
        <ForwardCompatibilityMap xmlns:e269="http://schemas.datacontract.org/2004/07/System.Collections.Generic" i:nil="false">
          <e269:KeyValuePairOfstringstring>
            <e269:key i:nil="false">ValueHere</e269:key>
            <e269:value i:nil="false">ValueHere</e269:value>
          </e269:KeyValuePairOfstringstring>
        </ForwardCompatibilityMap>
        <Id i:nil="false">ValueHere</Id>
        <Name i:nil="false">ValueHere</Name>
        <Type i:nil="false">ValueHere</Type>
        <!--This field is applicable if the derived type attribute is set to SharedList-->
        <ItemCount i:nil="false">ValueHere</ItemCount>
      </SharedEntity>
      <ListItems i:nil="false">
        <SharedListItem i:type="-- derived type specified here with the appropriate prefix --">
          <ForwardCompatibilityMap xmlns:e270="http://schemas.datacontract.org/2004/07/System.Collections.Generic" i:nil="false">
            <e270:KeyValuePairOfstringstring>
              <e270:key i:nil="false">ValueHere</e270:key>
              <e270:value i:nil="false">ValueHere</e270:value>
            </e270:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
          <Type i:nil="false">ValueHere</Type>
          <!--These fields are applicable if the derived type attribute is set to NegativeKeyword-->
          <Id i:nil="false">ValueHere</Id>
          <MatchType i:nil="false">ValueHere</MatchType>
          <Text i:nil="false">ValueHere</Text>
          <!--These fields are applicable if the derived type attribute is set to NegativeSite-->
          <Id i:nil="false">ValueHere</Id>
          <Url i:nil="false">ValueHere</Url>
          <!--This field is applicable if the derived type attribute is set to BrandItem-->
          <BrandId>ValueHere</BrandId>
          <!--These fields are applicable if the derived type attribute is set to Site-->
          <Id i:nil="false">ValueHere</Id>
          <Url i:nil="false">ValueHere</Url>
        </SharedListItem>
      </ListItems>
      <SharedEntityScope i:nil="false">ValueHere</SharedEntityScope>
    </AddSharedEntityRequest>
  </s:Body>
</s:Envelope>

Antwort-SOAP

Diese Vorlage wurde von einem Tool generiert, um die Reihenfolge der Text- und Headerelemente für die SOAP-Antwort anzuzeigen.

<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>
    <AddSharedEntityResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <ListItemIds 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>
      </ListItemIds>
      <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:e271="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e271:KeyValuePairOfstringstring>
              <e271:key d4p1:nil="false">ValueHere</e271:key>
              <e271:value d4p1:nil="false">ValueHere</e271:value>
            </e271: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>
      <SharedEntityId>ValueHere</SharedEntityId>
    </AddSharedEntityResponse>
  </s:Body>
</s:Envelope>

Codesyntax

Die Beispielsyntax kann mit Bing Ads SDKs verwendet werden. Weitere Beispiele finden Sie unter Codebeispiele für die Bing Ads-API .

public async Task<AddSharedEntityResponse> AddSharedEntityAsync(
	SharedEntity sharedEntity,
	IList<SharedListItem> listItems,
	EntityScope? sharedEntityScope)
{
	var request = new AddSharedEntityRequest
	{
		SharedEntity = sharedEntity,
		ListItems = listItems,
		SharedEntityScope = sharedEntityScope
	};

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

static AddSharedEntityResponse addSharedEntity(
	SharedEntity sharedEntity,
	ArrayOfSharedListItem listItems,
	EntityScope sharedEntityScope) throws RemoteException, Exception
{
	AddSharedEntityRequest request = new AddSharedEntityRequest();

	request.setSharedEntity(sharedEntity);
	request.setListItems(listItems);
	request.setSharedEntityScope(sharedEntityScope);

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

static function AddSharedEntity(
	$sharedEntity,
	$listItems,
	$sharedEntityScope)
{

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

	$request = new AddSharedEntityRequest();

	$request->SharedEntity = $sharedEntity;
	$request->ListItems = $listItems;
	$request->SharedEntityScope = $sharedEntityScope;

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

response=campaignmanagement_service.AddSharedEntity(
	SharedEntity=SharedEntity,
	ListItems=ListItems,
	SharedEntityScope=SharedEntityScope)

Anforderungen

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

Anforderungs-URL

https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/SharedEntity

Anfordern von Elementen

Das AddSharedEntityRequest-Objekt definiert den Text und die Headerelemente der Dienstvorgangsanforderung.

Hinweis

Sofern unten nicht anders angegeben, sind alle Anforderungselemente erforderlich.

Anforderungstextelemente

Element Beschreibung Datentyp
ListItems Die negativen Schlüsselwörter (maximal 5.000), die in die neue negative Schlüsselwort (keyword) Liste aufgenommen werden sollen, oder negative Websites (maximal 10.000), die in die neue Ausschlussliste der Website aufgenommen werden sollen.

Die Liste kann maximal 5.000 Elemente pro Serviceaufruf enthalten. Um weitere Listenelemente hinzuzufügen, rufen Sie den Vorgang AddListItemsToSharedList auf.		 SharedListItem-Array
SharedEntity Die negative Schlüsselwort (keyword) Liste oder Websiteausschlussliste.

Wenn SharedEntityScope entweder leer oder auf Account festgelegt ist und SharedEntity eine NegativeKeywordList ist, müssen listItems negative Schlüsselwort (keyword) (NegativeKeyword)-Objekte sein.

Wenn SharedEntityScope auf Customer festgelegt ist und SharedEntity eine PlacementExclusionList ist, müssen die ListItems negative Websiteobjekte (NegativeSite) sein.		 SharedEntity
SharedEntityScope Gibt an, ob die freigegebene Entität auf Der Ebene des Anzeigenkontos (Kontos) oder des Vorgesetztenkontos (Kunde) verfügbar ist.

Dieses Element ist optional und wird standardmäßig auf Kontobereich festgelegt. Der Anzeigenkontobereich gilt nur für negative Schlüsselwort (keyword) Listen.

Legen Sie dieses Element auf Customer fest, um eine Websiteausschlussliste in Der freigegebenen Bibliothek ihres Vorgesetztenkontos (Kunde) hinzuzufügen.		 EntityScope

Anforderungsheaderelemente

Element Beschreibung Datentyp
Authorization Das OAuth-Zugriffstoken, das die Anmeldeinformationen eines Benutzers darstellt, der über Berechtigungen für Microsoft Advertising-Konten verfügt. Stellen Sie sicher, dass dem Token das Präfix "Bearer" vorangestellt ist. Dies ist für die ordnungsgemäße Authentifizierung erforderlich.

Weitere Informationen finden Sie unter Authentifizierung mit OAuth.		 Zeichenfolge
CustomerAccountId Der Bezeichner des Anzeigenkontos, das die Entitäten in der Anforderung besitzt oder zugeordnet ist. Dieses Headerelement muss denselben Wert wie das AccountId-Body-Element aufweisen, wenn beides erforderlich ist. Dieses Element ist für die meisten Dienstvorgänge erforderlich, und als bewährte Methode sollten Sie es immer festlegen.

Weitere Informationen finden Sie unter Abrufen Von Konto- und Kunden-IDs.		 Zeichenfolge
CustomerId Der Bezeichner des Vorgesetztenkontos (Kunde), auf das der Benutzer zugreift oder von dort aus arbeitet. Ein Benutzer kann Zugriff auf mehrere Managerkonten haben. Dieses Element ist für die meisten Dienstvorgänge erforderlich, und als bewährte Methode sollten Sie es immer festlegen.

Weitere Informationen finden Sie unter Abrufen Von Konto- und Kunden-IDs.		 Zeichenfolge
DeveloperToken Das Entwicklertoken, das für den Zugriff auf die Bing Ads-API verwendet wird.

Weitere Informationen finden Sie unter Abrufen eines Entwicklertokens.		 Zeichenfolge
Kennwort Dieses Element ist für die interne Verwendung reserviert und wird aus einer zukünftigen Version der API entfernt. Sie müssen das AuthenticationToken-Element verwenden, um Benutzeranmeldeinformationen festzulegen. Zeichenfolge
UserName Dieses Element ist für die interne Verwendung reserviert und wird aus einer zukünftigen Version der API entfernt. Sie müssen das AuthenticationToken-Element verwenden, um Benutzeranmeldeinformationen festzulegen. Zeichenfolge

Antwortelemente

Das AddSharedEntityResponse-Objekt definiert den Text und die Headerelemente der Dienstvorgangsantwort. Die Elemente werden in der gleichen Reihenfolge zurückgegeben wie im Antwort-JSON-Code gezeigt.

Antworttextelemente

Element Beschreibung Datentyp
ListItemIds Eine Liste langer Werte , die die Bezeichner für die hinzugefügten Listenelemente darstellt.

Elemente der Liste können als NULL zurückgegeben werden. Für jeden Listenindex, bei dem kein Listenelement hinzugefügt wurde, ist das entsprechende Element NULL.		 langes Array
PartialErrors Ein Array von BatchError-Objekten , die Details für alle Anforderungselemente enthalten, die nicht erfolgreich waren.

Die Liste der Fehler entspricht nicht direkt der Liste der Elemente in der Anforderung. Die Liste kann leer sein, wenn keine Fehler aufgetreten sind, oder ein oder mehrere Fehlerobjekte enthalten, die jedem nicht erfolgreichen Listenelement in der Anforderung entsprechen.		 BatchError-Array
SharedEntityId Der Bezeichner für die freigegebene Entität, die hinzugefügt wurde. lang

Antwortheaderelemente

Element Beschreibung Datentyp
TrackingId Der Bezeichner des Protokolleintrags, der die Details des API-Aufrufs enthält. Zeichenfolge

JSON anfordern

Diese Vorlage wurde von einem Tool generiert, um die Text- und Headerelemente für die JSON-Anforderung anzuzeigen. Informationen zu unterstützten Typen, die Sie mit diesem Dienstvorgang verwenden können, finden Sie oben in der Referenz zu Anforderungstextelementen .

Im Folgenden finden Sie ein Beispiel, das anwendbar ist, wenn der Typ von SharedListItemBrandItem und SharedEntitySharedList ist.

{
  "SharedEntity": {
    "AssociationCount": IntValueHere,
    "ForwardCompatibilityMap": [
      {
        "key": "ValueHere",
        "value": "ValueHere"
      }
    ],
    "Id": "LongValueHere",
    "Name": "ValueHere",
    "Type": "SharedList",
    "ItemCount": IntValueHere
  },
  "ListItems": [
    {
      "ForwardCompatibilityMap": [
        {
          "key": "ValueHere",
          "value": "ValueHere"
        }
      ],
      "Type": "BrandItem",
      "BrandId": "LongValueHere"
    }
  ],
  "SharedEntityScope": "ValueHere"
}

Antwort-JSON

Diese Vorlage wurde von einem Tool generiert, um die Text- und Headerelemente für die JSON-Antwort anzuzeigen.

Im Folgenden finden Sie ein Beispiel, das anwendbar ist, wenn der Typ von BatchErrorEditorialError ist.

{
  "ListItemIds": [
    "LongValueHere"
  ],
  "PartialErrors": [
    {
      "Code": IntValueHere,
      "Details": "ValueHere",
      "ErrorCode": "ValueHere",
      "FieldPath": "ValueHere",
      "ForwardCompatibilityMap": [
        {
          "key": "ValueHere",
          "value": "ValueHere"
        }
      ],
      "Index": IntValueHere,
      "Message": "ValueHere",
      "Type": "EditorialError",
      "Appealable": "ValueHere",
      "DisapprovedText": "ValueHere",
      "Location": "ValueHere",
      "PublisherCountry": "ValueHere",
      "ReasonCode": IntValueHere
    }
  ],
  "SharedEntityId": "LongValueHere"
}

Codesyntax

Um die REST-API über SDKs aufzurufen, müssen Sie das SDK auf eine bestimmte Version aktualisieren und die Systemparameter konfigurieren. Die Beispielsyntax kann mit Bing Ads SDKs verwendet werden. Weitere Beispiele finden Sie unter Codebeispiele für die Bing Ads-API .

public async Task<AddSharedEntityResponse> AddSharedEntityAsync(
	SharedEntity sharedEntity,
	IList<SharedListItem> listItems,
	EntityScope? sharedEntityScope)
{
	var request = new AddSharedEntityRequest
	{
		SharedEntity = sharedEntity,
		ListItems = listItems,
		SharedEntityScope = sharedEntityScope
	};

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

static AddSharedEntityResponse addSharedEntity(
	SharedEntity sharedEntity,
	ArrayOfSharedListItem listItems,
	EntityScope sharedEntityScope) throws RemoteException, Exception
{
	AddSharedEntityRequest request = new AddSharedEntityRequest();

	request.setSharedEntity(sharedEntity);
	request.setListItems(listItems);
	request.setSharedEntityScope(sharedEntityScope);

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

static function AddSharedEntity(
	$sharedEntity,
	$listItems,
	$sharedEntityScope)
{

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

	$request = new AddSharedEntityRequest();

	$request->SharedEntity = $sharedEntity;
	$request->ListItems = $listItems;
	$request->SharedEntityScope = $sharedEntityScope;

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

response=campaignmanagement_service.AddSharedEntity(
	SharedEntity=SharedEntity,
	ListItems=ListItems,
	SharedEntityScope=SharedEntityScope)