Edit

Share via

Ad Group Length Of Stay Criterion Record - Bulk

  • Article

Defines an ad group length of stay criterion that can be uploaded and downloaded in a bulk file.

Tip

For an overview of how to use target criterions, see Show Ads to Your Target Audience.

You can download all Ad Group Length Of Stay Criterion records in the account by including the DownloadEntity value of AdGroupTargetCriterions 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 length of stay criterion if a valid Parent Id value is provided.

Type,Status,Id,Parent Id,Sub Type,Campaign,Ad Group,Client Id,Modified Time,Bid Adjustment,Target,Min Target Value,Max Target Value,Name
Format Version,,,,,,,,,,,,,6
Ad Group Length of Stay Criterion,Active,,-1111,,,,ClientIdGoesHere,,10,,5,10,

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 BulkAdGroupLengthOfStayCriterion 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 BulkAdGroupLengthOfStayCriterion
var bulkAdGroupLengthOfStayCriterion = new BulkAdGroupLengthOfStayCriterion
{
    // 'Ad Group' column header in the Bulk file is read-only
    AdGroupName = null,

    // 'Campaign' column header in the Bulk file is read-only
    CampaignName = null,

    // 'Client Id' column header in the Bulk file
    ClientId = "ClientIdGoesHere",

    // 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 LengthOfStayCriterion
        {
            // 'MinNights' column header in the Bulk file
            MinNights = 2,

            // 'MaxNights' column header in the Bulk file
            MaxNights = 5
        },

        CriterionBid = new BidMultiplier
        {
            // 'Bid Adjustment' column header in the Bulk file
            Multiplier = 20,
        },

        // 'Id' column header in the Bulk file
        Id = null,

        // 'Status' column header in the Bulk file
        Status = AdGroupCriterionStatus.Active,
    }
};

uploadEntities.Add(bulkAdGroupLengthOfStayCriterion);

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 Length Of Stay Criterion record, the following attribute fields are available in the Bulk File Schema.

Ad Group

The name of the ad group where this criterion is applied or removed.

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

Bid Adjustment

The percentage amount that you want to adjust the bid for the corresponding Target.

Supported values are negative ninety (-90) through positive nine hundred (900).

Add: Optional. The bid adjustment will be set to the default of 0 if not included.
Update: Required
Delete: Read-only

Campaign

The name of the campaign that contains the ad group where this criterion is applied or removed.

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: Optional

Id

The Microsoft Advertising unique identifier of the 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

Parent Id

The identifier of the ad group where this criterion is applied or removed.

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 criterions to a new ad group in the same Bulk file. For more information, see Bulk File Schema Reference Keys.
Update: Read-only and Required
Delete: Read-only and Required

Status

Represents the association status between the ad group and the criterion. If the criterion is applied to the ad group, this field's value is Active. To delete the criterion, set the status to Deleted.

Add: Read-only. The status will always be set to Active when you add criterions. If you upload another value e.g., Foo the result file will contain the same value although the criterion is active.
Update: Optional
Delete: Required. The Status must be set to Deleted. To delete a specific length of stay criterion bid, you must upload the Status, Id, and Parent Id.

Sub Type

The length of stay sub type that you are targeting.

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

Target

The identifier of the length of stay that you want to target with the corresponding Bid Adjustment.

Add: Required
Update: Required
Delete: Read-only