Edit

Ad Group Custom Segment Association Record - Bulk

Defines an Ad Group Custom Segment Association that can be uploaded and downloaded in a bulk file.

Custom segment association is supported only at the ad group level for biddable audience criteria.

Tip

For an overview and more information about audiences, see the Audience APIs technical guide.

You can download all Ad Group Custom Segment Association records in the account by including the DownloadEntity value of AdGroupCustomSegmentAssociations 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 custom segment association if a valid Parent Id value is provided.

Type,Status,Id,Parent Id,Campaign,Ad Group,Client Id,Modified Time,Bid Adjustment,Name,Audience Id,Audience
Format Version,,,,,,,,,6.0,,
Ad Group Custom Segment Association,Paused,,-1111,,,ClientIdGoesHere,,10,,CustomSegmentIdHere,My Custom Segment

For an Ad Group Custom Segment Association record, the following attribute fields are available in the Bulk File Schema.

Ad Group

The name of the ad group that is associated with the custom segment.

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.

Audience

The name of the custom segment.

This bulk field maps to the Audience field of the Custom Segment record.

Add: Read-only and Required for some use cases. You must either specify the Audience or Audience Id field. If you are adding new ad group custom segment associations with new custom segments in the same Bulk file, and if you do not set the Audience Id field, then this Audience field must be set as a logical key to the same value as the Audience field of the Custom Segment record. For more information, see Bulk File Schema Reference Keys.
Update: Read-only
Delete: Read-only

Audience Id

The Microsoft Advertising identifier of the custom segment associated with the ad group.

This bulk field maps to the Id field of the Custom Segment record.

Add: Read-only and Required for some use cases. You must either specify the Audience or Audience Id field. If you set the Audience Id field, you must either specify an existing custom segment identifier or specify a negative identifier that is equal to the Id field of the parent Custom Segment record. If the Audience Id field is not set, then you must set the Audience field as a logical key to the same value as the Audience field of the Custom Segment record. Any of these options are recommended if you are adding new ad group custom segment associations with new custom segments in the same Bulk file. For more information, see Bulk File Schema Reference Keys.
Update: Read-only
Delete: Read-only

Bid Adjustment

The percentage you want to increase/decrease the bid amount for the custom segment.

Supported values are negative ninety (-90.00) through positive nine hundred (900.00).

Important

If not specified, the default bid adjustment value is 0. The default value is subject to change.

Important

Microsoft Advertising won't apply any bid boosts until the associated custom segment has at least 1,000 users. If someone qualifies to be part of multiple custom segments AND the custom segments are associated with the same ad group with different bid adjustments, the highest bid adjustment will be applied. For more information about Remarketing in Paid Search, see Reach your audience.

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

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

Id

The system-generated identifier for the association between an ad group and custom segment.

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 system-generated identifier of the ad group that is associated to the custom segment.

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 custom segments 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

Note

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

Status

The association status.

Possible values are Active, Paused, or Deleted.

Add: Optional. The default status value is Active.
Update: Optional
Delete: Required. The Status must be set to Deleted.

  • Last updated on