AddKeywords Service Operation - Campaign Management
Adds one or more keywords to an ad group.
Request Elements
The AddKeywordsRequest 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 |
|---|---|---|
| AdGroupId | The identifier of the ad group to add the keywords to. | long |
| Keywords | The list of keywords to add to the ad group. You can add a maximum of 1,000 keywords to an ad group per service request. |
Keyword array |
| ReturnInheritedBidStrategyTypes | Determines whether or not the service should return the bid strategy type that is inherited from the parent campaign or ad group. The default value is false, and the InheritedBidStrategyTypes element will only be returned if you set this element true. |
boolean |
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 |
| Password | This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. | string |
| UserName | This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. | string |
Response Elements
The AddKeywordsResponse 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 |
|---|---|---|
| InheritedBidStrategyTypes | The value of each string represents the type of bidding scheme or bid strategy type that is inherited from the parent campaign or ad group. Each string in the list is returned in the same order and corresponds to the keywords in the request message. If a keyword does not inherit from the ad group or campaign, the corresponding item in the list will be nil. This element is not returned by default. You must set ReturnInheritedBidStrategyTypes true in the request. |
string array |
| KeywordIds | A list of unique system identifiers corresponding to the keywords that were added. The list of identifiers corresponds directly to the list of keywords in the request. Items of the list may be returned as null. For each list index where a keyword was not added, the corresponding element will be null. |
long array |
| PartialErrors | An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request. |
BatchError 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/CampaignManagement/v13">
<Action mustUnderstand="1">AddKeywords</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>
<AddKeywordsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<AdGroupId>ValueHere</AdGroupId>
<Keywords i:nil="false">
<Keyword>
<Bid i:nil="false">
<Amount i:nil="false">ValueHere</Amount>
</Bid>
<BiddingScheme i:nil="false" i:type="-- derived type specified here with the appropriate prefix --">
<Type i:nil="false">ValueHere</Type>
<!--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 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 i:nil="false">ValueHere</InheritedBidStrategyType>
<!--This field is applicable if the derived type attribute is set to PercentCpcBiddingScheme-->
<MaxPercentCpc i:nil="false">ValueHere</MaxPercentCpc>
<!--This field is applicable if the derived type attribute is set to CommissionBiddingScheme-->
<CommissionRate i:nil="false">ValueHere</CommissionRate>
<!--This field is applicable if the derived type attribute is set to ManualCpaBiddingScheme-->
<ManualCpi i:nil="false">ValueHere</ManualCpi>
<!--This field is applicable if the derived type attribute is set to CostPerSaleBiddingScheme-->
<TargetCostPerSale i:nil="false">ValueHere</TargetCostPerSale>
</BiddingScheme>
<DestinationUrl i:nil="false">ValueHere</DestinationUrl>
<EditorialStatus i:nil="false">ValueHere</EditorialStatus>
<FinalAppUrls i:nil="false">
<AppUrl>
<OsType i:nil="false">ValueHere</OsType>
<Url i:nil="false">ValueHere</Url>
</AppUrl>
</FinalAppUrls>
<FinalMobileUrls i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</FinalMobileUrls>
<FinalUrlSuffix i:nil="false">ValueHere</FinalUrlSuffix>
<FinalUrls i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</FinalUrls>
<ForwardCompatibilityMap xmlns:e101="http://schemas.datacontract.org/2004/07/System.Collections.Generic" i:nil="false">
<e101:KeyValuePairOfstringstring>
<e101:key i:nil="false">ValueHere</e101:key>
<e101:value i:nil="false">ValueHere</e101:value>
</e101:KeyValuePairOfstringstring>
</ForwardCompatibilityMap>
<Id i:nil="false">ValueHere</Id>
<MatchType i:nil="false">ValueHere</MatchType>
<Param1 i:nil="false">ValueHere</Param1>
<Param2 i:nil="false">ValueHere</Param2>
<Param3 i:nil="false">ValueHere</Param3>
<Status i:nil="false">ValueHere</Status>
<Text i:nil="false">ValueHere</Text>
<TrackingUrlTemplate i:nil="false">ValueHere</TrackingUrlTemplate>
<UrlCustomParameters i:nil="false">
<Parameters i:nil="false">
<CustomParameter>
<Key i:nil="false">ValueHere</Key>
<Value i:nil="false">ValueHere</Value>
</CustomParameter>
</Parameters>
</UrlCustomParameters>
</Keyword>
</Keywords>
<ReturnInheritedBidStrategyTypes i:nil="false">ValueHere</ReturnInheritedBidStrategyTypes>
</AddKeywordsRequest>
</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/CampaignManagement/v13">
<TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
</s:Header>
<s:Body>
<AddKeywordsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<InheritedBidStrategyTypes d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<a1:string>ValueHere</a1:string>
</InheritedBidStrategyTypes>
<KeywordIds 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>
</KeywordIds>
<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:e102="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e102:KeyValuePairOfstringstring>
<e102:key d4p1:nil="false">ValueHere</e102:key>
<e102:value d4p1:nil="false">ValueHere</e102:value>
</e102: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>
</AddKeywordsResponse>
</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<AddKeywordsResponse> AddKeywordsAsync(
long adGroupId,
IList<Keyword> keywords,
bool? returnInheritedBidStrategyTypes)
{
var request = new AddKeywordsRequest
{
AdGroupId = adGroupId,
Keywords = keywords,
ReturnInheritedBidStrategyTypes = returnInheritedBidStrategyTypes
};
return (await CampaignManagementService.CallAsync((s, r) => s.AddKeywordsAsync(r), request));
}
static AddKeywordsResponse addKeywords(
java.lang.Long adGroupId,
ArrayOfKeyword keywords,
boolean returnInheritedBidStrategyTypes) throws RemoteException, Exception
{
AddKeywordsRequest request = new AddKeywordsRequest();
request.setAdGroupId(adGroupId);
request.setKeywords(keywords);
request.setReturnInheritedBidStrategyTypes(returnInheritedBidStrategyTypes);
return CampaignManagementService.getService().addKeywords(request);
}
static function AddKeywords(
$adGroupId,
$keywords,
$returnInheritedBidStrategyTypes)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new AddKeywordsRequest();
$request->AdGroupId = $adGroupId;
$request->Keywords = $keywords;
$request->ReturnInheritedBidStrategyTypes = $returnInheritedBidStrategyTypes;
return $GLOBALS['CampaignManagementProxy']->GetService()->AddKeywords($request);
}
response=campaignmanagement_service.AddKeywords(
AdGroupId=AdGroupId,
Keywords=Keywords,
ReturnInheritedBidStrategyTypes=ReturnInheritedBidStrategyTypes)
Requirements
Service: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13
Request Url
https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/Keywords
Request Elements
The AddKeywordsRequest 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 |
|---|---|---|
| AdGroupId | The identifier of the ad group to add the keywords to. | long |
| Keywords | The list of keywords to add to the ad group. You can add a maximum of 1,000 keywords to an ad group per service request. |
Keyword array |
| ReturnInheritedBidStrategyTypes | Determines whether or not the service should return the bid strategy type that is inherited from the parent campaign or ad group. The default value is false, and the InheritedBidStrategyTypes element will only be returned if you set this element true. |
boolean |
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 |
| Password | This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. | string |
| UserName | This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. | string |
Response Elements
The AddKeywordsResponse 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 |
|---|---|---|
| InheritedBidStrategyTypes | The value of each string represents the type of bidding scheme or bid strategy type that is inherited from the parent campaign or ad group. Each string in the list is returned in the same order and corresponds to the keywords in the request message. If a keyword does not inherit from the ad group or campaign, the corresponding item in the list will be nil. This element is not returned by default. You must set ReturnInheritedBidStrategyTypes true in the request. |
string array |
| KeywordIds | A list of unique system identifiers corresponding to the keywords that were added. The list of identifiers corresponds directly to the list of keywords in the request. Items of the list may be returned as null. For each list index where a keyword was not added, the corresponding element will be null. |
long array |
| PartialErrors | An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request. |
BatchError 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.
Below is an example that is applicable if the type of BiddingScheme is CommissionBiddingScheme.
{
"AdGroupId": "LongValueHere",
"Keywords": [
{
"Bid": {
"Amount": DoubleValueHere
},
"BiddingScheme": {
"Type": "CommissionBiddingScheme",
"CommissionRate": DoubleValueHere
},
"DestinationUrl": "ValueHere",
"EditorialStatus": "ValueHere",
"FinalAppUrls": [
{
"OsType": "ValueHere",
"Url": "ValueHere"
}
],
"FinalMobileUrls": [
"ValueHere"
],
"FinalUrls": [
"ValueHere"
],
"FinalUrlSuffix": "ValueHere",
"ForwardCompatibilityMap": [
{
"key": "ValueHere",
"value": "ValueHere"
}
],
"Id": "LongValueHere",
"MatchType": "ValueHere",
"Param1": "ValueHere",
"Param2": "ValueHere",
"Param3": "ValueHere",
"Status": "ValueHere",
"Text": "ValueHere",
"TrackingUrlTemplate": "ValueHere",
"UrlCustomParameters": {
"Parameters": [
{
"Key": "ValueHere",
"Value": "ValueHere"
}
]
}
}
],
"ReturnInheritedBidStrategyTypes": "ValueHere"
}
Response JSON
This template was generated by a tool to show the body and header elements for the JSON response.
Below is an example that is applicable if the type of BatchError is EditorialError.
{
"InheritedBidStrategyTypes": [
"ValueHere"
],
"KeywordIds": [
"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
}
]
}
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<AddKeywordsResponse> AddKeywordsAsync(
long adGroupId,
IList<Keyword> keywords,
bool? returnInheritedBidStrategyTypes)
{
var request = new AddKeywordsRequest
{
AdGroupId = adGroupId,
Keywords = keywords,
ReturnInheritedBidStrategyTypes = returnInheritedBidStrategyTypes
};
return (await CampaignManagementService.CallAsync((s, r) => s.AddKeywordsAsync(r), request));
}
static AddKeywordsResponse addKeywords(
java.lang.Long adGroupId,
ArrayOfKeyword keywords,
boolean returnInheritedBidStrategyTypes) throws RemoteException, Exception
{
AddKeywordsRequest request = new AddKeywordsRequest();
request.setAdGroupId(adGroupId);
request.setKeywords(keywords);
request.setReturnInheritedBidStrategyTypes(returnInheritedBidStrategyTypes);
return CampaignManagementService.getService().addKeywords(request);
}
static function AddKeywords(
$adGroupId,
$keywords,
$returnInheritedBidStrategyTypes)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new AddKeywordsRequest();
$request->AdGroupId = $adGroupId;
$request->Keywords = $keywords;
$request->ReturnInheritedBidStrategyTypes = $returnInheritedBidStrategyTypes;
return $GLOBALS['CampaignManagementProxy']->GetService()->AddKeywords($request);
}
response=campaignmanagement_service.AddKeywords(
AdGroupId=AdGroupId,
Keywords=Keywords,
ReturnInheritedBidStrategyTypes=ReturnInheritedBidStrategyTypes)