Ad Group Dynamic Search Ad Target Record - Bulk

Defines an Ad Group Dynamic Search Ad Target that can be uploaded and downloaded in a bulk file.

You can download all Ad Group Dynamic Search Ad Target records in the account by including the DownloadEntity value of AdGroupDynamicSearchAdTargets in the DownloadCampaignsByAccountIds or DownloadCampaignsByCampaignIds service request. Additionally the download request must include the EntityData scope. For more details about the Bulk service including best practices, see Bulk Download and Upload.

The following Bulk CSV example would add a new ad group dynamic search ad target if a valid Parent Id value is provided.

Type,Status,Id,Parent Id,Campaign,Ad Group,Client Id,Modified Time,Bid,Name,Tracking Template,Custom Parameter,Dynamic Ad Target Condition 1,Dynamic Ad Target Condition 2,Dynamic Ad Target Condition 3,Dynamic Ad Target Value 1,Dynamic Ad Target Value 2,Dynamic Ad Target Value 3
Format Version,,,,,,,,,6.0,,,,,,,,
Ad Group Dynamic Search Ad Target,Paused,,-1113,,,ClientIdGoesHere,,0.5,Bulk Ad Group Dynamic Search Ad Target,,{_promoCode}=PROMO1; {_season}=summer,Url,Category,PageContent,contoso.com,US/CA/SFO,flowers

If you are using the Bing Ads SDKs for .NET, Java, or Python, you can save time using the BulkServiceManager to upload and download the BulkAdGroupDynamicSearchAdTarget object, instead of calling the service operations directly and writing custom code to parse each field in the bulk file.

var uploadEntities = new List<BulkEntity>();

// Map properties in the Bulk file to the BulkAdGroupDynamicSearchAdTarget
var bulkAdGroupDynamicSearchAdTarget = new BulkAdGroupDynamicSearchAdTarget
{
    // Map properties in the Bulk file to the 
    // BiddableAdGroupCriterion object of the Campaign Management service.
    BiddableAdGroupCriterion = new BiddableAdGroupCriterion
    {
        // 'Parent Id' column header in the Bulk file
        AdGroupId = adGroupIdKey,
        Criterion = new Webpage
        {
            Parameter = new WebpageParameter
            {
                // Set Conditions null if you want to target all webpages
                Conditions = new []
                {
                    new WebpageCondition
                    {
                        // 'Dynamic Ad Target Value 1' column header in the Bulk file
                        Argument = "contoso.com",
                        // 'Dynamic Ad Target Condition 1' column header in the Bulk file
                        Operand = WebpageConditionOperand.Url
                    },
                    new WebpageCondition
                    {
                        // 'Dynamic Ad Target Value 2' column header in the Bulk file
                        Argument = "US/CA/SFO",
                        // 'Dynamic Ad Target Condition 2' column header in the Bulk file
                        Operand = WebpageConditionOperand.Category
                    },
                    new WebpageCondition
                    {
                        // 'Dynamic Ad Target Value 3' column header in the Bulk file
                        Argument = "flowers",
                        // 'Dynamic Ad Target Condition 3' column header in the Bulk file
                        Operand = WebpageConditionOperand.PageContent
                    },
                },
                // 'Name' column header in the Bulk file
                CriterionName = "Bulk Ad Group Dynamic Search Ad Target"
            }
        },
        CriterionBid = new FixedBid
        {
            // 'Bid' column header in the Bulk file
            Bid = new Bid
            {
                Amount = 0.50
            }
        },
        // 'Id' column header in the Bulk file
        Id = null,
        // 'Status' column header in the Bulk file
        Status = AdGroupCriterionStatus.Paused,
        // 'Tracking Template' column header in the Bulk file
        TrackingUrlTemplate = null,
        // 'Custom Parameter' column header in the Bulk file
        UrlCustomParameters = new CustomParameters
        {
            // Each custom parameter is delimited by a semicolon (;) in the Bulk file
            Parameters = new[] {
                new CustomParameter(){
                    Key = "promoCode",
                    Value = "PROMO1"
                },
                new CustomParameter(){
                    Key = "season",
                    Value = "summer"
                },
            }
        },
    },
    // 'Ad Group' column header in the Bulk file
    AdGroupName = null,
    // 'Campaign' column header in the Bulk file
    CampaignName = null,
    // 'Client Id' column header in the Bulk file
    ClientId = "ClientIdGoesHere",
};

uploadEntities.Add(bulkAdGroupDynamicSearchAdTarget);

var entityUploadParameters = new EntityUploadParameters
{
    Entities = uploadEntities,
    ResponseMode = ResponseMode.ErrorsAndResults,
    ResultFileDirectory = FileDirectory,
    ResultFileName = DownloadFileName,
    OverwriteResultFile = true,
};

var uploadResultEntities = (await BulkServiceManager.UploadEntitiesAsync(entityUploadParameters)).ToList();

For an Ad Group Dynamic Search Ad Target record, the following attribute fields are available in the Bulk File Schema.

Ad Group

The name of the ad group that contains the dynamic ad target (webpage criterion).

Add: Read-only and Required
Update: Read-only and Required
Delete: Read-only and Required

Note

For add, update, and delete, you must specify either the Parent Id or Ad Group field.

Bid

The amount to bid in the auction.

Add: Required
Update: Optional. If no value is set for the update, this setting is not changed.
Delete: Read-only

Campaign

The name of the campaign that contains the ad group and dynamic ad target (webpage criterion).

Add: Read-only
Update: Read-only
Delete: Read-only

Client Id

Used to associate records in the bulk upload file with records in the results file. The value of this field is not used or stored by the server; it is simply copied from the uploaded record to the corresponding result record. It may be any valid string to up 100 in length.

Add: Optional
Update: Optional
Delete: Read-only

Custom Parameter

Your custom collection of key and value parameters for URL tracking.

In a bulk file, the list of custom parameters are formatted as follows.

  • Format each custom parameter pair as Key=Value, for example {_promoCode}=PROMO1.

  • Microsoft Advertising will accept the first 3 custom parameter key and value pairs that you include, and any additional custom parameters will be ignored. For customers in the Custom Parameters Limit Increase Phase 2 pilot (GetCustomerPilotFeatures returns 565), Microsoft Advertising will accept the first 8 custom parameter key and value pairs that you include, and if you include more than 8 custom parameters an error will be returned. During calendar year 2019 the limit will be increased from 3 to 8 for all customers. Each key and value pair are delimited by a semicolon and space ("; "), for example {_promoCode}=PROMO1; {_season}=summer.

  • A Key cannot contain a semicolon. If a Value contains a semicolon it must be escaped as ';'. Additionally if the Value contains a backslash it must also be escaped as '\'.

  • The Key cannot exceed 16 UTF-8 bytes, and the Value cannot exceed 200 UTF-8 bytes. The Key is required and the Value is optional. The maximum size of the Key does not include the braces and underscore i.e., '{', '_', and '}'.

    Note

    With the Bulk service the Key must be formatted with surrounding braces and a leading underscore, for example if the Key is promoCode, it must be formatted as {_promoCode}. With the Campaign Management service you cannot specify the surrounding braces and underscore.

Add: Optional
Update: Optional. If no value is set for the update, this setting is not changed. To remove all custom parameters, set this field to delete_value. The delete_value keyword removes the previous setting. To remove a subset of custom parameters, specify the custom parameters that you want to keep and omit any that you do not want to keep. The new set of custom parameters will replace any previous custom parameter set.
Delete: Read-only

Dynamic Ad Target Condition 1

The first of up to 3 webpage condition operands. The condition is met if the webpage property that is referenced by this field contains or equals the Dynamic Ad Target Value 1 value.

Possible values include Category, CustomLabel, PageContent, PageTitle, and Url.

Add: Optional. If you do not set any of the dynamic ad target condition or value fields, then you are effectively targeting all webpages. You can only have one dynamic ad target per ad group for all webpages.
Update: Not allowed. You cannot update the dynamic ad target condition or value fields. To update the webpage conditions you must delete the dynamic ad target and add a new one.
Delete: Read-only

Dynamic Ad Target Condition 2

The second of up to 3 webpage condition operands. The condition is met if the webpage property that is referenced by this field contains or equals the Dynamic Ad Target Value 2 value.

Possible values include Category, CustomLabel, PageContent, PageTitle, and Url.

Add: Optional. If you do not set any of the dynamic ad target condition or value fields, then you are effectively targeting all webpages. You can only have one dynamic ad target per ad group for all webpages.
Update: Not allowed. You cannot update the dynamic ad target condition or value fields. To update the webpage conditions you must delete the dynamic ad target and add a new one.
Delete: Read-only

Dynamic Ad Target Condition 3

The third of up to 3 webpage condition operands. The condition is met if the webpage property that is referenced by this field contains or equals the Dynamic Ad Target Value 1 value.

Possible values include Category, CustomLabel, PageContent, PageTitle, and Url.

Add: Optional. If you do not set any of the dynamic ad target condition or value fields, then you are effectively targeting all webpages. You can only have one dynamic ad target per ad group for all webpages.
Update: Not allowed. You cannot update the dynamic ad target condition or value fields. To update the webpage conditions you must delete the dynamic ad target and add a new one.
Delete: Read-only

Dynamic Ad Target Value 1

The first of up to 3 webpage condition or criterion arguments.

You can set this string to the URL, category, page title, or page content for your site. For example if the Dynamic Ad Target Condition 1 field is set to Url, then you might set this field to contoso.com/flowers.

Add: Optional. If you do not set any of the dynamic ad target condition or value fields, then you are effectively targeting all webpages. You can only have one dynamic ad target per ad group for all webpages.
Update: Not allowed. You cannot update the dynamic ad target condition or value fields. To update the webpage conditions you must delete the dynamic ad target and add a new one.
Delete: Read-only

Dynamic Ad Target Value 2

The second of up to 3 webpage condition or criterion arguments.

You can set this string to the URL, category, page title, or page content for your site. For example if the Dynamic Ad Target Condition 2 field is set to Url, then you might set this field to contoso.com/flowers.

Add: Optional. If you do not set any of the dynamic ad target condition or value fields, then you are effectively targeting all webpages. You can only have one dynamic ad target per ad group for all webpages.
Update: Not allowed. You cannot update the dynamic ad target condition or value fields. To update the webpage conditions you must delete the dynamic ad target and add a new one.
Delete: Read-only

Dynamic Ad Target Value 3

The third of up to 3 webpage condition or criterion arguments.

You can set this string to the URL, category, page title, or page content for your site. For example if the Dynamic Ad Target Condition 3 field is set to Url, then you might set this field to contoso.com/flowers.

Add: Optional. If you do not set any of the dynamic ad target condition or value fields, then you are effectively targeting all webpages. You can only have one dynamic ad target per ad group for all webpages.
Update: Not allowed. You cannot update the dynamic ad target condition or value fields. To update the webpage conditions you must delete the dynamic ad target and add a new one.
Delete: Read-only

Id

The system generated identifier of the dynamic ad target (webpage criterion).

Add: Read-only
Update: Read-only and Required
Delete: Read-only and Required

Modified Time

The date and time that the entity was last updated. The value is in Coordinated Universal Time (UTC).

Note

The date and time value reflects the date and time at the server, not the client. For information about the format of the date and time, see the dateTime entry in Primitive XML Data Types.

Add: Read-only
Update: Read-only
Delete: Read-only

Name

The criterion name that you can use to identify the criteria, for example you can filter or sort alphabetically.

The criterion name length must be between 1 to 2048, inclusive.

Add: Optional. If you do not specify any name, by default the name will be set to a concatenated list of conditions. Each condition will be delimited by the and keyword. For example if the conditions are a) Url contains flower , b) Url contains book , and c) PageContent contains seattle, then the default criterion name will be Url contains flower and Url contains book and PageContent contains seattle. If all condition and value fields are empty, then you are effectively targeting all webpages and the name will be set to All Webpages.
Update: Optional. If no value is set for the update, this setting is not changed. If you specify the delete_value keyword, then the criterion name will be updated to the default value i.e. either All Webpages or a concatenated list of criterions.
Delete: Read-only

Parent Id

The system generated identifier of the ad group that contains the dynamic ad target (webpage criterion).

This bulk field maps to the Id field of the Ad Group record.

Add: Read-only and Required. You must either specify an existing ad group identifier, or specify a negative identifier that is equal to the Id field of the parent Ad Group record. This is recommended if you are adding new dynamic ad targets to a new ad group in the same Bulk file. For more information, see Bulk File Schema Reference Keys.
Update: Read-only
Delete: Read-only

Note

For add, update, and delete, you must specify either the Parent Id or Ad Group field.

Status

The status of the dynamic ad target (webpage criterion).

Possible values are Active, Paused, or Deleted.

Add: Optional. The default value is Active.
Update: Optional. If no value is set for the update, this setting is not changed.
Delete: Required. The Status must be set to Deleted.

Tracking Template

Tracking templates can be used in tandem with the landing page URL that is generated dynamically from the domain that you specified for your Dynamic Search Ads campaign. By combining the domain with the tracking template, the landing page URL is assembled where a user is directed after clicking the ad.

The following validation rules apply to tracking templates. For more details about supported templates and parameters, see the Microsoft Advertising help article What tracking or URL parameters can I use?

  • Tracking templates defined for lower level entities e.g. ads override those set for higher level entities e.g. campaign. For more information, see Entity Limits.

  • The length of the tracking template is limited to 2,048 characters. The HTTP or HTTPS protocol string does count towards the 2,048 character limit.

  • The tracking template must be a well-formed URL beginning with one of the following: http://, https://, {lpurl}, or {unescapedlpurl}.

  • Microsoft Advertising does not validate whether custom parameters exist. If you use custom parameters in your tracking template and they do not exist, then the landing page URL will include the key and value placeholders of your custom parameters without substitution. For example, if your tracking template is http://tracker.example.com/?season={_season}&promocode={_promocode}&u={lpurl}, and neither {_season} or {_promocode} are defined at the campaign, ad group, criterion, keyword, or ad level, then the landing page URL will be the same.

Add: Optional
Update: Optional. If no value is set for the update, this setting is not changed. If you set this field to the delete_value string, the prior setting is removed.
Delete: Read-only