Edit

Ad Group App Ad Extension Record - Bulk

  • Article

Defines an association record between an Ad Group and an App Ad Extension that can be uploaded and downloaded in a bulk file. To upload or download the ad group or app ad extension, use the Ad Group or App Ad Extension record.

You can download all Ad Group App Ad Extension records in the account by including the DownloadEntity value of AdGroupAppAdExtensions 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 associate an app ad extension to an ad group if valid Id and Parent Id values are provided.

Type,Status,Id,Parent Id,Campaign,Ad Group,Client Id,Modified Time,Name
Format Version,,,,,,,,6.0
Ad Group App Ad Extension,Active,-11,-1111,,,ClientIdGoesHere,,

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 BulkAdGroupAppAdExtension 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 BulkAdGroupAppAdExtension
var bulkAdGroupAppAdExtension = new BulkAdGroupAppAdExtension
{
    // Map properties in the Bulk file to the 
    // AdExtensionIdToEntityIdAssociation object of the Campaign Management service.
    AdExtensionIdToEntityIdAssociation = new AdExtensionIdToEntityIdAssociation
    {
        // 'Id' column header in the Bulk file
        AdExtensionId = appAdExtensionIdKey,
        // 'Parent Id' column header in the Bulk file
        EntityId = adGroupIdKey,
    },
                
    // 'Client Id' column header in the Bulk file
    ClientId = "ClientIdGoesHere",
    // 'Status' column header in the Bulk file
    Status = Status.Active,
};

uploadEntities.Add(bulkAdGroupAppAdExtension);

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 App Ad Extension record, the following attribute fields are available in the Bulk File Schema.

Ad Group

The name of the ad group where this ad extension is associated or removed.

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

Note

For add and delete, you must specify either the Parent Id or both of the Ad Group and Campaign fields.

Campaign

The name of the campaign that contains the ad group where this ad extension is associated or removed.

Add: Read-only
Delete: Read-only

Note

For add and delete, you must specify either the Parent Id or both of the Ad Group and Campaign fields.

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
Delete: Read-only

Editorial Location

The component or property of the ad extension that failed editorial review.

Add: Read-only
Delete: Read-only

Editorial Reason Code

A code that identifies the reason for the failure. For a list of possible reason codes, see Editorial Reason Codes.

Add: Read-only
Delete: Read-only

Editorial Status

The editorial status of the ad extension.

Possible values are described in the table below.

Value Description
Active The ad extension passed editorial review.
ActiveLimited The ad extension passed editorial review in one or more markets, and one or more elements of the ad extension is undergoing editorial review in another market. For example the ad extension passed editorial review for Canada and is still pending review in the United States.
Disapproved The ad extension failed editorial review.
Inactive One or more elements of the ad extension is undergoing editorial review.

Add: Read-only
Delete: Read-only

Editorial Term

The term that failed editorial review.

This field will not be set if a combination of terms caused the failure or if the failure was based on a policy violation.

Add: Read-only
Delete: Read-only

Id

The identifier of the ad extension that is associated or removed from the ad group.

This bulk field maps to the Id field of the App Ad Extension record.

Add: Read-only and Required. You must either specify an existing ad extension identifier, or specify a negative identifier that is equal to the Id field of the parent App Ad Extension record. This is recommended if you are adding new ad extensions and associations in the same Bulk file. For more information, see Bulk File Schema Reference Keys.
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
Delete: Read-only

Parent Id

The identifier of the ad group where this ad extension is associated 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 associating ad extensions to a new ad group in the same Bulk file. For more information, see Bulk File Schema Reference Keys.
Delete: Read-only and Required

Note

For add and delete, you must specify either the Parent Id or both of the Ad Group and Campaign fields.

Publisher Countries

The list of publisher countries or regions whose editorial guidelines do not allow the specified term.

In a bulk file, the list of publisher countries or regions are delimited with a semicolon (;).

Add: Read-only
Delete: Read-only

Status

Represents the association status between the account and the ad extension.

Possible values are Active and Deleted. If the ad extension is associated with the ad group, this field's value is Active.

Add: Read-only
Delete: Required. The Status must be set to Deleted.