Export (0) Print
Expand All

ApplyOpportunities Service Operation

Applies the recommended opportunities that the get opportunities operations returned, for example the OpportunityKeys returned by the GetBidOpportunities operation.

Request | Response

Error Codes

Service: OptimizerService.svc v9 | Namespace: https://bingads.microsoft.com/Optimizer/v9

ApplyOpportunitiesRequest Message

Request Body

The ApplyOpportunitiesRequest object defines the elements of the request’s body. The elements must be in the same order as shown in the SOAP example.

Element

Description

Data Type

Required

AccountId

The identifier of the account that owns the entities to apply the opportunities to.

long

Yes

OpportunityKeys

The list of opportunity objects identifying the opportunities that you want to apply. For example, GetBidOpportunities may return one or more opportunity keys, and to apply the opportunity keys you can specify them in this list.

You can specify a maximum of 10,000 keys.

System_CLiX_note Note

Either one of the OpportunityKeys or OpportunityModifiers element is required. Items in the OpportunityKeys element are ignored if the OpportunityModifiers element is specified.

string array

No

OpportunityModifiers

An array of modifiers that overrides the available opportunity keys.

You can specify a maximum of 10,000 modifiers of any type, including the OpportunityModifier base class.

System_CLiX_note Note

Either one of the OpportunityKeys or OpportunityModifiers element is required. Items in the OpportunityKeys element are ignored if the OpportunityModifiers element is specified.

OpportunityModifier array

No

Request Header

For information about the values you set the DeveloperToken, Password, and UserName elements to, see Getting Started With the Bing Ads API.

Element

Description

Data Type

ApplicationToken

The application-access token. This header element is not used and should be null.

string

AuthenticationToken

The OAuth access token used to manage Bing Ads accounts linked to a Microsoft Account. For more information, see Managing User Authentication with OAuth.

string

CustomerAccountId

The identifier of the account that owns the entities in the request.

string

CustomerId

The identifier of the customer that owns the account.

string

DeveloperToken

The client application's developer access token.

string

Password

The Bing Ads user's sign-in password.

string

UserName

The Bing Ads user's sign-in user name. You may not set this element to a Microsoft account.

string

Request SOAP

The following example shows the complete request envelope.


<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/Optimizer/v9">
    <Action mustUnderstand="1">ApplyOpportunities</Action>
    <ApplicationToken i:nil="false"></ApplicationToken>
    <AuthenticationToken i:nil="false"></AuthenticationToken>
    <CustomerAccountId i:nil="false"></CustomerAccountId>
    <CustomerId i:nil="false"></CustomerId>
    <DeveloperToken i:nil="false"></DeveloperToken>
    <Password i:nil="false"></Password>
    <UserName i:nil="false"></UserName>
  </s:Header>
  <s:Body>
    <ApplyOpportunitiesRequest xmlns="https://bingads.microsoft.com/Optimizer/v9">
      <AccountId></AccountId>
      <OpportunityKeys i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:string></a1:string>
      </OpportunityKeys>
      <OpportunityModifiers xmlns:e1="http://schemas.datacontract.org/2004/07/Microsoft.BingAds.Advertiser.Optimizer.Api.DataContracts.Entities" i:nil="false">
        <e1:OpportunityModifier i:type="-- specify derived type here with the appropriate prefix --">
          <e1:OpportunityKey i:nil="false"></e1:OpportunityKey>
          <!--Keep these fields if you set the i:type attribute to KeywordOpportunityModifier-->
          <e1:AdGroupId i:nil="false"></e1:AdGroupId>
          <!--Keep these fields if you set the i:type attribute to BudgetOpportunityModifier-->
          <e1:Budget i:nil="false"></e1:Budget>
          <!--Keep these fields if you set the i:type attribute to BroadMatchOpportunityModifier-->
          <e1:Bid i:nil="false"></e1:Bid>
          <!--Keep these fields if you set the i:type attribute to BidOpportunityModifier-->
          <e1:Bid i:nil="false"></e1:Bid>
        </e1:OpportunityModifier>
      </OpportunityModifiers>
    </ApplyOpportunitiesRequest>
  </s:Body>

ApplyOpportunitiesResponse Message

Response Body

The response does not contain additional body elements.

Response Header

Element

Description

Data Type

TrackingId

The identifier of the log entry that contains details about the API call.

string

Response SOAP

The following example shows the complete response envelope.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/Optimizer/v9">
    <TrackingId p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance"></TrackingId>
  </s:Header>
  <s:Body>
    <ApplyOpportunitiesResponse xmlns="https://bingads.microsoft.com/Optimizer/v9" />
  </s:Body>
</s:Envelope>

Error Codes

If the service operation fails, it throws a FaultException exception, which contains one or more of the Bing Ads API error data objects. For information about the fault detail objects, see Optimizer Error Data Objects and Handling Service Errors and Exceptions.

The following are example error codes that the error objects can include when using this service operation. For all documented error codes, please see Bing Ads Operation Error Codes.

Error Code

InvalidCredentials

Community Additions

ADD
Show:
© 2014 Microsoft