GetSharedEntities Service Operation – Kampagnenverwaltung
Ruft negative Schlüsselwort (keyword) Listen oder Websiteausschlusslisten ab.
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 GetSharedEntitiesRequest-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 |
|---|---|---|
| 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 Websiteausschlusslisten in Der freigegebenen Bibliothek Ihres Vorgesetztenkontos (Kunde) abzurufen. |
EntityScope |
| SharedEntityType | Der Typ der freigegebenen Entität, die aus dem Anzeigenkonto oder der Bibliothek des Vorgesetztenkontos (Kunde) abgerufen werden soll. Legen Sie dieses Element auf NegativeKeywordList fest, um negative Schlüsselwort (keyword) Listen (NegativeKeywordList) in Der freigegebenen Bibliothek Ihres Anzeigenkontos abzurufen. Legen Sie dieses Element auf PlacementExclusionList fest, um Websiteausschlusslisten (PlacementExclusionList) in Der freigegebenen Bibliothek Ihres Vorgesetztenkontos (Kunden) abzurufen. |
Zeichenfolge |
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 GetSharedEntitiesResponse-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 |
|---|---|---|
| SharedEntities | Die negativen Schlüsselwort (keyword) Listen oder Websiteausschlusslisten. | SharedEntity-Array |
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">GetSharedEntities</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>
<GetSharedEntitiesRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<SharedEntityType i:nil="false">ValueHere</SharedEntityType>
<SharedEntityScope i:nil="false">ValueHere</SharedEntityScope>
</GetSharedEntitiesRequest>
</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>
<GetSharedEntitiesResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<SharedEntities d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<SharedEntity d4p1:type="-- derived type specified here with the appropriate prefix --">
<AssociationCount d4p1:nil="false">ValueHere</AssociationCount>
<ForwardCompatibilityMap xmlns:e347="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e347:KeyValuePairOfstringstring>
<e347:key d4p1:nil="false">ValueHere</e347:key>
<e347:value d4p1:nil="false">ValueHere</e347:value>
</e347:KeyValuePairOfstringstring>
</ForwardCompatibilityMap>
<Id d4p1:nil="false">ValueHere</Id>
<Name d4p1:nil="false">ValueHere</Name>
<Type d4p1:nil="false">ValueHere</Type>
<!--This field is applicable if the derived type attribute is set to SharedList-->
<ItemCount d4p1:nil="false">ValueHere</ItemCount>
</SharedEntity>
</SharedEntities>
</GetSharedEntitiesResponse>
</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<GetSharedEntitiesResponse> GetSharedEntitiesAsync(
string sharedEntityType,
EntityScope? sharedEntityScope)
{
var request = new GetSharedEntitiesRequest
{
SharedEntityType = sharedEntityType,
SharedEntityScope = sharedEntityScope
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetSharedEntitiesAsync(r), request));
}
static GetSharedEntitiesResponse getSharedEntities(
java.lang.String sharedEntityType,
EntityScope sharedEntityScope) throws RemoteException, Exception
{
GetSharedEntitiesRequest request = new GetSharedEntitiesRequest();
request.setSharedEntityType(sharedEntityType);
request.setSharedEntityScope(sharedEntityScope);
return CampaignManagementService.getService().getSharedEntities(request);
}
static function GetSharedEntities(
$sharedEntityType,
$sharedEntityScope)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetSharedEntitiesRequest();
$request->SharedEntityType = $sharedEntityType;
$request->SharedEntityScope = $sharedEntityScope;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetSharedEntities($request);
}
response=campaignmanagement_service.GetSharedEntities(
SharedEntityType=SharedEntityType,
SharedEntityScope=SharedEntityScope)
Anforderungen
Dienst: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13
Anforderungs-URL
https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/SharedEntities/Query
Anfordern von Elementen
Das GetSharedEntitiesRequest-Objekt definiert den Text und die Headerelemente der Dienstvorgangsanforderung.
Hinweis
Sofern unten nicht anders angegeben, sind alle Anforderungselemente erforderlich.
Anforderungstextelemente
| Element | Beschreibung | Datentyp |
|---|---|---|
| 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 Websiteausschlusslisten in Der freigegebenen Bibliothek Ihres Vorgesetztenkontos (Kunde) abzurufen. |
EntityScope |
| SharedEntityType | Der Typ der freigegebenen Entität, die aus dem Anzeigenkonto oder der Bibliothek des Vorgesetztenkontos (Kunde) abgerufen werden soll. Legen Sie dieses Element auf NegativeKeywordList fest, um negative Schlüsselwort (keyword) Listen (NegativeKeywordList) in Der freigegebenen Bibliothek Ihres Anzeigenkontos abzurufen. Legen Sie dieses Element auf PlacementExclusionList fest, um Websiteausschlusslisten (PlacementExclusionList) in Der freigegebenen Bibliothek Ihres Vorgesetztenkontos (Kunden) abzurufen. |
Zeichenfolge |
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 GetSharedEntitiesResponse-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 |
|---|---|---|
| SharedEntities | Die negativen Schlüsselwort (keyword) Listen oder Websiteausschlusslisten. | SharedEntity-Array |
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 .
{
"SharedEntityType": "ValueHere",
"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 SharedEntity-TypSharedList ist.
{
"SharedEntities": [
{
"AssociationCount": IntValueHere,
"ForwardCompatibilityMap": [
{
"key": "ValueHere",
"value": "ValueHere"
}
],
"Id": "LongValueHere",
"Name": "ValueHere",
"Type": "SharedList",
"ItemCount": IntValueHere
}
]
}
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<GetSharedEntitiesResponse> GetSharedEntitiesAsync(
string sharedEntityType,
EntityScope? sharedEntityScope)
{
var request = new GetSharedEntitiesRequest
{
SharedEntityType = sharedEntityType,
SharedEntityScope = sharedEntityScope
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetSharedEntitiesAsync(r), request));
}
static GetSharedEntitiesResponse getSharedEntities(
java.lang.String sharedEntityType,
EntityScope sharedEntityScope) throws RemoteException, Exception
{
GetSharedEntitiesRequest request = new GetSharedEntitiesRequest();
request.setSharedEntityType(sharedEntityType);
request.setSharedEntityScope(sharedEntityScope);
return CampaignManagementService.getService().getSharedEntities(request);
}
static function GetSharedEntities(
$sharedEntityType,
$sharedEntityScope)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetSharedEntitiesRequest();
$request->SharedEntityType = $sharedEntityType;
$request->SharedEntityScope = $sharedEntityScope;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetSharedEntities($request);
}
response=campaignmanagement_service.GetSharedEntities(
SharedEntityType=SharedEntityType,
SharedEntityScope=SharedEntityScope)