Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Given a list of existing campaigns, this operation returns for each a list of suggested bids and estimated performance statistics. You can use the landscape view of multiple bid points with estimated traffic for the same campaign to help make decisions about how to adjust your campaign level default bid to optimize for clicks, impressions, and cost. For example you might use the resulting data to visualize a clicks to cost curve or a bid to impressions curve.
The estimates are based on the last 7 days of performance data, and not a prediction or guarantee of future performance.
Note
This operation applies to Search, Shopping, and Performance Max campaigns that use Target CPA or Target ROAS bid strategies, and is not available for shared budgets. We'll expand supported campaign types in the future.
Request Elements
The GetBidLandscapeByCampaignIdsRequest object defines the body and header elements of the service operation request. The elements must be in the same order as shown in the Request SOAP.
Note
Unless otherwise noted below, all request elements are required.
Request Body Elements
| Element | Description | Data Type |
|---|---|---|
| CampaignIds | The campaign identifiers. | long array |
Request Header Elements
| Element | Description | Data Type |
|---|---|---|
| AuthenticationToken | The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts. For more information see Authentication with OAuth. |
string |
| CustomerAccountId | The identifier of the ad account that owns or is associated with the entities in the request. This header element must have the same value as the AccountId body element when both are required. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs. |
string |
| CustomerId | The identifier of the manager account (customer) the user is accessing or operating from. A user can have access to multiple manager accounts. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs. |
string |
| DeveloperToken | The developer token used to access the Bing Ads API. For more information see Get a Developer Token. |
string |
Response Elements
The GetBidLandscapeByCampaignIdsResponse object defines the body and header elements of the service operation response. The elements are returned in the same order as shown in the Response SOAP.
Response Body Elements
| Element | Description | Data Type |
|---|---|---|
| BidLandscape | An array of CampaignBidLandscape objects. The array contains a CampaignBidLandscape corresponding to each campaign and bid landscape type input specified in the request. Duplicate input are allowed in the same call and will return the same results. If the specified input is invalid or has no associated data results, all elements within the CampaignBidLandscape will be nil except the CampaignId which reflects the campaign identifier specified in the request. If there is data available for the campaign, the CampaignBidLandscape object will provide a list of suggested bids and estimated performance statistics. |
CampaignBidLandscape array |
Response Header Elements
| Element | Description | Data Type |
|---|---|---|
| TrackingId | The identifier of the log entry that contains the details of the API call. | string |
Request SOAP
This template was generated by a tool to show the order of the body and header elements for the SOAP request. For supported types that you can use with this service operation, see the Request Body Elements reference above.
<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/AdInsight/v13">
<Action mustUnderstand="1">GetBidLandscapeByCampaignIds</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>
<GetBidLandscapeByCampaignIdsRequest xmlns="https://bingads.microsoft.com/AdInsight/v13">
<CampaignIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</CampaignIds>
</GetBidLandscapeByCampaignIdsRequest>
</s:Body>
</s:Envelope>
Response SOAP
This template was generated by a tool to show the order of the body and header elements for the SOAP response.
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header xmlns="https://bingads.microsoft.com/AdInsight/v13">
<TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
</s:Header>
<s:Body>
<GetBidLandscapeByCampaignIdsResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
<BidLandscape d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<CampaignBidLandscape>
<CampaignId>ValueHere</CampaignId>
<CampaignBidLandscapeType>ValueHere</CampaignBidLandscapeType>
<StartDate d4p1:nil="false">
<Day>ValueHere</Day>
<Month>ValueHere</Month>
<Year>ValueHere</Year>
</StartDate>
<EndDate d4p1:nil="false">
<Day>ValueHere</Day>
<Month>ValueHere</Month>
<Year>ValueHere</Year>
</EndDate>
<CampaignBidLandscapePoints d4p1:nil="false">
<CampaignBidLandscapePoint>
<Bid d4p1:nil="false">ValueHere</Bid>
<TargetCpa d4p1:nil="false">ValueHere</TargetCpa>
<TargetRoas d4p1:nil="false">ValueHere</TargetRoas>
<Clicks d4p1:nil="false">ValueHere</Clicks>
<Impressions d4p1:nil="false">ValueHere</Impressions>
<TopImpressions d4p1:nil="false">ValueHere</TopImpressions>
<CurrencyCode>ValueHere</CurrencyCode>
<Cost d4p1:nil="false">ValueHere</Cost>
<Conversions d4p1:nil="false">ValueHere</Conversions>
<ConversionValues d4p1:nil="false">ValueHere</ConversionValues>
<MarginalCPC d4p1:nil="false">ValueHere</MarginalCPC>
</CampaignBidLandscapePoint>
</CampaignBidLandscapePoints>
</CampaignBidLandscape>
</BidLandscape>
</GetBidLandscapeByCampaignIdsResponse>
</s:Body>
</s:Envelope>
Code Syntax
The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.
public async Task<GetBidLandscapeByCampaignIdsResponse> GetBidLandscapeByCampaignIdsAsync(
IList<long> campaignIds)
{
var request = new GetBidLandscapeByCampaignIdsRequest
{
CampaignIds = campaignIds
};
return (await AdInsightService.CallAsync((s, r) => s.GetBidLandscapeByCampaignIdsAsync(r), request));
}
static GetBidLandscapeByCampaignIdsResponse getBidLandscapeByCampaignIds(
ArrayOflong campaignIds) throws RemoteException, Exception
{
GetBidLandscapeByCampaignIdsRequest request = new GetBidLandscapeByCampaignIdsRequest();
request.setCampaignIds(campaignIds);
return AdInsightService.getService().getBidLandscapeByCampaignIds(request);
}
static function GetBidLandscapeByCampaignIds(
$campaignIds)
{
$GLOBALS['Proxy'] = $GLOBALS['AdInsightProxy'];
$request = new GetBidLandscapeByCampaignIdsRequest();
$request->CampaignIds = $campaignIds;
return $GLOBALS['AdInsightProxy']->GetService()->GetBidLandscapeByCampaignIds($request);
}
response=adinsight_service.GetBidLandscapeByCampaignIds(
CampaignIds=CampaignIds)
Requirements
Service: AdInsightService.svc v13
Namespace: https://bingads.microsoft.com/AdInsight/v13
Request Url
https://adinsight.api.bingads.microsoft.com/AdInsight/v13/BidLandscape/QueryByCampaignIds
Request Elements
The GetBidLandscapeByCampaignIdsRequest object defines the body and header elements of the service operation request.
Note
Unless otherwise noted below, all request elements are required.
Request Body Elements
| Element | Description | Data Type |
|---|---|---|
| CampaignIds | The campaign identifiers. | long array |
Request Header Elements
| Element | Description | Data Type |
|---|---|---|
| Authorization | The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts. Please ensure that the token is prefixed with "Bearer ", this is necessary for proper authentication. For more information see Authentication with OAuth. |
string |
| CustomerAccountId | The identifier of the ad account that owns or is associated with the entities in the request. This header element must have the same value as the AccountId body element when both are required. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs. |
string |
| CustomerId | The identifier of the manager account (customer) the user is accessing or operating from. A user can have access to multiple manager accounts. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs. |
string |
| DeveloperToken | The developer token used to access the Bing Ads API. For more information see Get a Developer Token. |
string |
Response Elements
The GetBidLandscapeByCampaignIdsResponse object defines the body and header elements of the service operation response. The elements are returned in the same order as shown in the Response JSON.
Response Body Elements
| Element | Description | Data Type |
|---|---|---|
| BidLandscape | An array of CampaignBidLandscape objects. The array contains a CampaignBidLandscape corresponding to each campaign and bid landscape type input specified in the request. Duplicate input are allowed in the same call and will return the same results. If the specified input is invalid or has no associated data results, all elements within the CampaignBidLandscape will be nil except the CampaignId which reflects the campaign identifier specified in the request. If there is data available for the campaign, the CampaignBidLandscape object will provide a list of suggested bids and estimated performance statistics. |
CampaignBidLandscape array |
Response Header Elements
| Element | Description | Data Type |
|---|---|---|
| TrackingId | The identifier of the log entry that contains the details of the API call. | string |
Request JSON
This template was generated by a tool to show the body and header elements for the JSON request. For supported types that you can use with this service operation, see the Request Body Elements reference above.
{
"CampaignIds": [
"LongValueHere"
]
}
Response JSON
This template was generated by a tool to show the body and header elements for the JSON response.
{
"BidLandscape": [
{
"CampaignBidLandscapePoints": [
{
"Bid": DoubleValueHere,
"Clicks": DoubleValueHere,
"Conversions": DoubleValueHere,
"ConversionValues": DoubleValueHere,
"Cost": DoubleValueHere,
"CurrencyCode": "ValueHere",
"Impressions": "LongValueHere",
"MarginalCPC": DoubleValueHere,
"TargetCpa": DoubleValueHere,
"TargetRoas": DoubleValueHere,
"TopImpressions": "LongValueHere"
}
],
"CampaignBidLandscapeType": "ValueHere",
"CampaignId": "LongValueHere",
"EndDate": {
"Day": IntValueHere,
"Month": IntValueHere,
"Year": IntValueHere
},
"StartDate": {
"Day": IntValueHere,
"Month": IntValueHere,
"Year": IntValueHere
}
}
]
}
Code Syntax
To call REST API through SDKs, you need to upgrade SDK to a certain version and configure the system parameters.The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.
public async Task<GetBidLandscapeByCampaignIdsResponse> GetBidLandscapeByCampaignIdsAsync(
IList<long> campaignIds)
{
var request = new GetBidLandscapeByCampaignIdsRequest
{
CampaignIds = campaignIds
};
return (await AdInsightService.CallAsync((s, r) => s.GetBidLandscapeByCampaignIdsAsync(r), request));
}
static GetBidLandscapeByCampaignIdsResponse getBidLandscapeByCampaignIds(
ArrayOflong campaignIds) throws RemoteException, Exception
{
GetBidLandscapeByCampaignIdsRequest request = new GetBidLandscapeByCampaignIdsRequest();
request.setCampaignIds(campaignIds);
return AdInsightService.getService().getBidLandscapeByCampaignIds(request);
}
static function GetBidLandscapeByCampaignIds(
$campaignIds)
{
$GLOBALS['Proxy'] = $GLOBALS['AdInsightProxy'];
$request = new GetBidLandscapeByCampaignIdsRequest();
$request->CampaignIds = $campaignIds;
return $GLOBALS['AdInsightProxy']->GetService()->GetBidLandscapeByCampaignIds($request);
}
response=adinsight_service.GetBidLandscapeByCampaignIds(
CampaignIds=CampaignIds)