GetCampaignsByIds Service Operation – Kampagnenverwaltung
Ruft die angegebenen Kampagnen innerhalb eines Kontos ab.
Anfordern von Elementen
Das GetCampaignsByIdsRequest-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 |
|---|---|---|
| Accountid | Der Bezeichner des Kontos, das die abzurufenden Kampagnen enthält. | Lange |
| CampaignIds | Maximal 100 Bezeichner der Kampagnen, die vom angegebenen Konto abgerufen werden sollen. Die Bezeichner müssen Kampagnen der angegebenen CampaignType-Typen entsprechen, andernfalls gibt der Dienst den Fehlercode EntityIdFilterMismatch (Code 516) zurück. |
langes Array |
| CampaignType | Der Typ der kampagnen, die abgerufen werden sollen, z. B. Search, Shopping oder DynamicSearchAds. Dieses Anforderungselement ist optional. Wenn Sie keinen Kampagnentyp festlegen, lautet der Standardwert Search , d. h., es werden nur Suchkampagnen zurückgegeben. Sie können mehrere Werte als Flags einschließen. Wie Sie mehrere Flags angeben, hängt von der programmiersprache ab, die Sie verwenden. C# behandelt diese Werte beispielsweise als Flagwerte, und Java behandelt sie als Array von Zeichenfolgen. Das SOAP sollte eine Zeichenfolge enthalten, die eine durch Leerzeichen getrennte Liste von Werten enthält, <CampaignType>Search Shopping</CampaignType>z. B. . |
CampaignType |
| ReturnAdditionalFields | Die Liste der zusätzlichen Eigenschaften, die in jede zurückgegebene Kampagne eingeschlossen werden sollen. Mit den zusätzlichen Feldwerten können Sie die neuesten Features mithilfe der aktuellen Version der Kampagnenverwaltungs-API abrufen, und in der nächsten Version sind die entsprechenden Elemente standardmäßig enthalten. Dieses Anforderungselement ist optional. |
CampaignAdditionalField |
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 GetCampaignsByIdsResponse-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 |
|---|---|---|
| Kampagnen | Ein Array von Campaign-Objekten , das direkt den Kampagnenbezeichnern entspricht, die Sie in der Anforderung angegeben haben. Elemente der Liste können als NULL zurückgegeben werden. Für jeden Listenindex, in dem eine Kampagne nicht abgerufen wurde, ist das entsprechende Element NULL. | Kampagnenarray |
| PartialErrors | Ein Array von BatchError-Objekten , die Details für alle Kampagnen enthalten, die nicht erfolgreich abgerufen wurden. Die Fehlerliste entspricht direkt der Liste der Kampagnen in der Anforderung. Elemente der Liste können als NULL zurückgegeben werden. Für jeden Listenindex, in dem eine Kampagne erfolgreich abgerufen wurde, ist das entsprechende Fehlerelement NULL. Im Idealfall werden alle Kampagnen erfolgreich abgerufen, und alle Elemente in dieser Liste sind NULL. |
BatchError-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">GetCampaignsByIds</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>
<GetCampaignsByIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<AccountId>ValueHere</AccountId>
<CampaignIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</CampaignIds>
<CampaignType>ValueHere</CampaignType>
<ReturnAdditionalFields i:nil="false">ValueHere</ReturnAdditionalFields>
</GetCampaignsByIdsRequest>
</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>
<GetCampaignsByIdsResponse 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>
<!--This field is applicable if the derived type attribute is set to ManualCpaBiddingScheme-->
<ManualCpi d4p1:nil="false">ValueHere</ManualCpi>
<!--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:e136="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e136:KeyValuePairOfstringstring>
<e136:key d4p1:nil="false">ValueHere</e136:key>
<e136:value d4p1:nil="false">ValueHere</e136:value>
</e136: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:e137="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e137:ArrayOfKeyValuePairOfstringstring>
<e137:KeyValuePairOfstringstring>
<e137:key d4p1:nil="false">ValueHere</e137:key>
<e137:value d4p1:nil="false">ValueHere</e137:value>
</e137:KeyValuePairOfstringstring>
</e137: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>
<CostPerSaleOptOut d4p1:nil="false">ValueHere</CostPerSaleOptOut>
<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>
<!--These fields are applicable if the derived type attribute is set to VanityPharmaSetting-->
<DisplayUrlMode d4p1:nil="false">ValueHere</DisplayUrlMode>
<WebsiteDescription d4p1:nil="false">ValueHere</WebsiteDescription>
</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>
<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:e138="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e138:KeyValuePairOfstringstring>
<e138:key d4p1:nil="false">ValueHere</e138:key>
<e138:value d4p1:nil="false">ValueHere</e138:value>
</e138: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>
</GetCampaignsByIdsResponse>
</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<GetCampaignsByIdsResponse> GetCampaignsByIdsAsync(
long accountId,
IList<long> campaignIds,
CampaignType campaignType,
CampaignAdditionalField? returnAdditionalFields)
{
var request = new GetCampaignsByIdsRequest
{
AccountId = accountId,
CampaignIds = campaignIds,
CampaignType = campaignType,
ReturnAdditionalFields = returnAdditionalFields
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetCampaignsByIdsAsync(r), request));
}
static GetCampaignsByIdsResponse getCampaignsByIds(
java.lang.Long accountId,
ArrayOflong campaignIds,
ArrayList<CampaignType> campaignType,
ArrayList<CampaignAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
GetCampaignsByIdsRequest request = new GetCampaignsByIdsRequest();
request.setAccountId(accountId);
request.setCampaignIds(campaignIds);
request.setCampaignType(campaignType);
request.setReturnAdditionalFields(returnAdditionalFields);
return CampaignManagementService.getService().getCampaignsByIds(request);
}
static function GetCampaignsByIds(
$accountId,
$campaignIds,
$campaignType,
$returnAdditionalFields)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetCampaignsByIdsRequest();
$request->AccountId = $accountId;
$request->CampaignIds = $campaignIds;
$request->CampaignType = $campaignType;
$request->ReturnAdditionalFields = $returnAdditionalFields;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetCampaignsByIds($request);
}
response=campaignmanagement_service.GetCampaignsByIds(
AccountId=AccountId,
CampaignIds=CampaignIds,
CampaignType=CampaignType,
ReturnAdditionalFields=ReturnAdditionalFields)
Anforderungen
Dienst: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13