|
|
TargetingService
TargetingService provides operations for managing ad group and campaign targets.
Operations
- addTargetingAttributesForAdGroup (changed in Version 5.2.0)
- addTargetingAttributesForCampaign (changed in Version 5.2.0)
- deleteTargetingAttributesForAdGroup (changed in Version 5.2.0)
- deleteTargetingAttributesForCampaign (changed in Version 5.2.0)
- deleteTargetingByTargetingAttributeDescriptorsForAdGroup (added in Version 5.2.0)
- deleteTargetingByTargetingAttributeDescriptorsForCampaign (added in Version 5.2.0)
- deleteTargetingByTypesForAdGroup (changed in Version 5.2.0)
- deleteTargetingByTypesForCampaign (changed in Version 5.2.0)
- deleteTargetingForAdGroup
- deleteTargetingForCampaign
- getTargetableLevelForCampaign
- getTargetingAttributesForAdGroup (changed in Version 5.2.0)
- getTargetingAttributesForCampaign (changed in Version 5.2.0)
- getTargetingProfileForAdGroup
- getTargetingProfileForCampaign
- setTargetableLevelAsAdGroup
- setTargetableLevelAsCampaign
- updatePremiumByTargetingAttributesForAdGroup (added in Version 5.2.0)
- updatePremiumByTargetingAttributesForCampaign (added in Version 5.2.0)
- updatePremiumByTargetingProfileForAdGroup (added in Version 5.2.0)
- updatePremiumByTargetingProfileForCampaign (added in Version 5.2.0)
- updateTargetingProfileForAdGroup
- updateTargetingProfileForCampaign
addTargetingAttributesForAdGroup
Add targeting attributes to an ad group.
Changed in: Version 5.2.0
Capability required: CampaignWrite
License command group: Marketing
Supported accounts: Web
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| adGroupID | long | The ad group ID. |
| targetingAttributes | TargetingAttribute[] | The list of targeting attributes to add. Use the getAdGroupSupportedTargetingTypesByTacticType operation in TargetingDictionaryService to retrieve the list of available targeting types. |
Response
BasicResponse - The response, which indicates if the operation succeeded or failed.
addTargetingAttributesForCampaign
Add targeting attributes to a campaign.
Changed in: Version 5.2.0
Capability required: CampaignWrite
License command group: Marketing
Supported accounts: Web
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| campaignID | long | The campaign ID. |
| targetingAttributes | TargetingAttribute[] | The list of targeting attributes to add. Use the getCampaignSupportedTargetingTypesByTacticType operation in TargetingDictionaryService to retrieve the list of available targeting types. |
Response
BasicResponse - The response, which indicates if the operation succeeded or failed.
deleteTargetingAttributesForAdGroup
Delete the specified targeting attributes from the specified ad group.
Changed in: Version 5.2.0
Capability required: CampaignWrite
License command group: Marketing
Supported accounts: Web
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| adGroupID | long | The ad group ID. |
| targetingAttributes | TargetingAttribute[] | The list of targeting attributes to delete (from ad group). |
Response
BasicResponse - The response, which indicates if the operation succeeded or failed.
deleteTargetingAttributesForCampaign
Delete the specified targeting attributes from the specified campaign.
Changed in: Version 5.2.0
Capability required: CampaignWrite
License command group: Marketing
Supported accounts: Web
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| campaignID | long | The campaign ID. |
| targetingAttributes | TargetingAttribute[] | The list of targeting attributes to delete (from campaign). |
Response
BasicResponse - The response, which indicates if the operation succeeded or failed.
deleteTargetingByTargetingAttributeDescriptorsForAdGroup
Delete targeting attributes matching the given targeting attribute descriptors from the specified ad group.
Note: For Day Parting if a partial set of the existing Day Parting is specified then it is selectively deleted and the remaining will still exist.
| Example: | |
| Existing DayParting | : Monday 1 to 10 with 5% premium |
| API argument | : Monday 4 to 6 |
| Remaining DayParting | : Monday 1 to 4 with 5% premium and Monday 6 to 10 with 5% premium |
Added in: Version 5.2.0
Capability required: CampaignWrite
License command group: Marketing
Supported accounts: Web
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| adGroupID | long | The ad group ID. |
| targetingAttributeDescriptors | TargetingAttributeDescriptor[] | The descriptors of the targeting attributes to delete from the ad group. |
Response
BasicResponse - The response, which indicates if the operation succeeded or failed.
deleteTargetingByTargetingAttributeDescriptorsForCampaign
Delete targeting attributes matching the given targeting attribute descriptors from the specified campaign.
Note: For Day Parting if a partial set of the existing Day Parting is specified then it is selectively deleted and the remaining will still exist.
| Example: | |
| Existing DayParting | : Monday 1 to 10 with 5% premium |
| API argument | : Monday 4 to 6 |
| Remaining DayParting | : Monday 1 to 4 with 5% premium and Monday 6 to 10 with 5% premium |
Added in: Version 5.2.0
Capability required: CampaignWrite
License command group: Marketing
Supported accounts: Web
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| campaignID | long | The campaign ID. |
| targetingAttributeDescriptors | TargetingAttributeDescriptor[] | The descriptors of the targeting attributes to delete from the campaign. |
Response
BasicResponse - The response, which indicates if the operation succeeded or failed.
deleteTargetingByTypesForAdGroup
Delete the specified types of targeting from the specified ad group.
Changed in: Version 5.2.0
Capability required: CampaignWrite
License command group: Marketing
Supported accounts: Web
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| adGroupID | long | The ID of the ad group. |
| targetingTypes | TargetingType[] | The types of targeting to delete. You can pass the TargetingType values obtained from TargetingDictionaryService or TargetingConverterService. |
Response
BasicResponse - The response, which indicates if the operation succeeded or failed.
deleteTargetingByTypesForCampaign
Delete the specified types of targeting from the specified campaign.
Changed in: Version 5.2.0
Capability required: CampaignWrite
License command group: Marketing
Supported accounts: Web
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| campaignID | long | The campaign ID. |
| targetingTypes | TargetingType[] | The types of targeting to delete. You can pass the TargetingType values obtained from TargetingDictionaryService or TargetingConverterService. |
Response
BasicResponse - The response, which indicates if the operation succeeded or failed.
deleteTargetingForAdGroup
Delete all targeting for an ad group.
Capability required: CampaignWrite
License command group: Marketing
Supported accounts: Web
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| adGroupID | long | The ad group ID. |
Response
BasicResponse - The response, which indicates if the operation succeeded or failed.
deleteTargetingForCampaign
Delete all targeting for a campaign.
Capability required: CampaignWrite
License command group: Marketing
Supported accounts: Web
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| campaignID | long | The campaign ID. |
Response
BasicResponse - The response, which indicates if the operation succeeded or failed.
getTargetableLevelForCampaign
Return the targetable level of a campaign.
Capability required: CampaignRead
License command group: Marketing
Supported accounts: Web
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| campaignID | long | The campaign ID. |
Response
TargetableLevel - The targetable level of the specified campaign.
getTargetingAttributesForAdGroup
Return the targeting attributes of an ad group.
Changed in: Version 5.2.0
Capability required: CampaignRead
License command group: Marketing
Supported accounts: Web
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| adGroupID | long | The ad group ID. |
Response
TargetingAttribute[] - The list of targeting attributes for the specified ad group.
getTargetingAttributesForCampaign
Return the targeting attributes of a campaign.
Changed in: Version 5.2.0
Capability required: CampaignRead
License command group: Marketing
Supported accounts: Web
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| campaignID | long | The campaign ID. |
Response
TargetingAttribute[] - The list of targeting attributes for the specified campaign.
getTargetingProfileForAdGroup
Retrieve the targeting profile of an ad group.
Capability required: CampaignRead
License command group: Marketing
Supported accounts: Web
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| adGroupID | long | The ad group ID. |
Response
TargetingProfile - The targeting profile of the specified ad group.
getTargetingProfileForCampaign
Retrieve the targeting profile of a campaign.
Capability required: CampaignRead
License command group: Marketing
Supported accounts: Web
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| campaignID | long | The campaign ID. |
Response
TargetingProfile - The targeting profile of the specified campaign.
setTargetableLevelAsAdGroup
Set the targetable level of a campaign to ad group. Optionally, move the targeting
applied at the campaign level to the ad groups under the campaign.
Note: By default, targeting is allowed at the campaign level only. For the U.S.A market (only),
you can set targets at the ad group level also.
If you target at the ad group level, you can
specify targeting preferences for ad group in the campaign individually.
After this operation, there will be no targeting defined for the campaign and
targeting cannot be set at the campaign level (all set targeting calls will fail).
After this operation, targeting can be set for the ad groups under this campaign.
Capability required: CampaignWrite
License command group: AdvancedTools
Supported accounts: Web
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| campaignID | long | The ID of the campaign whose targetable level is to be set to ad group. |
| moveExistingTargets | boolean | If true, the targeting applied at the campaign level will be moved to the ad groups under it and the
opt-in settings for the campaign will also be preserved at the ad group level.
If false, the targeting applied at the campaign level is deleted (lost) and the ad groups under it will have no targeting. |
Response
none
setTargetableLevelAsCampaign
Set the targetable level of a campaign to campaign. If you target at the campaign level,
all ad groups in the
campaign will use the same targeting preferences set for the campaign. By default,
targeting will be allowed at the campaign level.
Capability required: CampaignWrite
License command group: AdvancedTools
Supported accounts: Web
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| campaignID | long | The ID of the campaign whose targetable level is to be set to campaign. |
Response
none
updatePremiumByTargetingAttributesForAdGroup
Updates the targeting premium of the existing targeting attributes to the premium specified in the given
targeting attributes for the specified ad group.
For Day Parting, if a partial set of the existing Day Parting is specified then it will be selectively
updated and the remaining will still exist with the premium as it was before.
Note: Providing a targeting attribute to update premium which is not set will throw an error.
| Example: | |
| Existing DayParting | : Monday 1 to 10 with 5% premium |
| API argument | : Monday 4 to 6 with 10% premium |
| New DayParting | : Monday 1 to 4 with 5% premium, Monday 6 to 10 with 5% premium and Monday 4 to 6 with 10% premium |
Added in: Version 5.2.0
Capability required: CampaignWrite
License command group: Marketing
Supported accounts: Web
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| adGroupID | long | The ad group ID. |
| targetingAttributes | TargetingAttribute[] | The targeting attributes to be updated (in the ad group). |
Response
BasicResponse - The response, which indicates if the operation succeeded or failed.
updatePremiumByTargetingAttributesForCampaign
Updates the targeting premium of the existing targeting attributes to the premium specified in the given
targeting attributes for the specified specified campaign.
For Day Parting, if a partial set of the existing Day Parting is specified then it will be selectively
updated and the remaining will still exist with the premium as it was before.
Note: Providing a targeting attribute to update premium which is not set will throw an error.
| Example: | |
| Existing DayParting | : Monday 1 to 10 with 5% premium |
| API argument | : Monday 4 to 6 with 10% premium |
| New DayParting | : Monday 1 to 4 with 5% premium, Monday 6 to 10 with 5% premium and Monday 4 to 6 with 10% premium |
Added in: Version 5.2.0
Capability required: CampaignWrite
License command group: Marketing
Supported accounts: Web
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| campaignID | long | The campaign ID. |
| targetingAttributes | TargetingAttribute[] | The targeting attributes for which the premium has to be updated (in the campaign). |
Response
BasicResponse - The response, which indicates if the operation succeeded or failed.
updatePremiumByTargetingProfileForAdGroup
Updates the targeting premium of the existing targeting profile to the premium specified in the given
targeting profile for the specified ad group.
For Day Parting, if a partial set of the already existing Day Parting is selected then it will be selectively
updated and the remaining will exist with the premium as it was before.
Note: Providing an element to update premium which is not set will throw an error.
| Example: | |
| Existing DayParting | : Monday 1 to 10 with 5% premium |
| API argument | : Monday 4 to 6 with 10% premium |
| New DayParting | : Monday 1 to 4 with 5% premium, Monday 6 to 10 with 5% premium and Monday 4 to 6 with 10% premium |
Added in: Version 5.2.0
Capability required: CampaignWrite
License command group: Marketing
Supported accounts: Web
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| adGroupID | long | The ad group ID. |
| targetingProfile | TargetingProfile | The Targeting Profile that has to be updated. |
Response
BasicResponse - The response, which indicates if the operation succeeded or failed.
updatePremiumByTargetingProfileForCampaign
Updates the targeting premium of the existing targeting profile to the premium specified in the given
targeting profile for the specified campaign.
For Day Parting, if a partial set of the already existing Day Parting is selected then it will be selectively
updated and the remaining will exist with the premium as it was before.
Note: Providing an element to update premium that is not set will throw an error.
| Example: | |
| Existing DayParting | : Monday 1 to 10 with 5% premium |
| API argument | : Monday 4 to 6 with 10% premium |
| New DayParting | : Monday 1 to 4 with 5% premium, Monday 6 to 10 with 5% premium and Monday 4 to 6 with 10% premium |
Added in: Version 5.2.0
Capability required: CampaignWrite
License command group: Marketing
Supported accounts: Web
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| campaignID | long | The campaign ID |
| targetingProfile | TargetingProfile | The Targeting Profile which has to be updated. |
Response
BasicResponse - The response, which indicates if the operation succeeded or failed.
updateTargetingProfileForAdGroup
Update the targeting profile of an ad group.
Capability required: CampaignWrite
License command group: Marketing
Supported accounts: Web
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| adGroupID | long | The ad group ID. |
| targetingProfile | TargetingProfile | The targeting profile to update. |
| updateAll | boolean | If true, the system performs a full update.
All elements are updated. If you pass in the null value or omit an element,
the current value is cleared.
If false, the system performs a partial update. Only those elements you specify are updated. If you pass in the null value or omit an optional element, the current value is not changed. Note: If demographicTargeting is not null, then only the non-null elements in the demographicTargeting will be updated. |
Response
BasicResponse - The response, which indicates if the operation succeeded or failed.
updateTargetingProfileForCampaign
Update the targeting profile of a Campaign.
Capability required: CampaignWrite
License command group: Marketing
Supported accounts: Web
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| campaignID | long | The campaign ID. |
| targetingProfile | TargetingProfile | The targeting profile to update. |
| updateAll | boolean | If true, the system performs a full update.
All elements are updated. If you pass in the null value or omit an element,
the current value is cleared.
If false, the system performs a partial update. Only those elements you specify are updated. If you pass in the null value or omit an optional element, the current value is not changed. Note: If demographicTargeting is not null, then only the non-null elements in the demographicTargeting will be updated. |
Response
BasicResponse - The response, which indicates if the operation succeeded or failed.