Edit

Share via

LocationCriterion Data Object - Campaign Management

  • Article

Defines a criterion that can be used to show ads to users in a specific location.

With location criterions, you can choose to show ads to potential customers in, searching for, or viewing pages about:

  • All available countries/regions
  • Selected cities, postal codes, metro areas Microsoft Market Area in the United States), counties, states/provinces, and countries/regions

Each location criterion defines a location code for the accompanying criterion bid adjustment.

The maximum number of combined location and negative location criterions that you can specify per campaign or ad group is 10,000.

Note

You can only have one LocationIntentCriterion per campaign or ad group to determine the location intent option that applies for all of the campaign or ad group's geographical criterions (location, negative location, and radius criterions). When you create the campaign or ad group's first criterion, a LocationIntentCriterion will also be added automatically with the default IntentOption set to PeopleInOrSearchingForOrViewingPages. You can add or update a campaign or ad group's LocationIntentCriterion, whether or not the campaign or ad group has any other criterions. You cannot delete a LocationIntentCriterion, although it has no purpose without location or radius criterions.

The LocationCriterion can be included within BiddableAdGroupCriterion, NegativeAdGroupCriterion, BiddableCampaignCriterion, and NegativeCampaignCriterion objects. If ad group level location criterions are specified (positive or negative), the campaign level location criterions are ignored for that ad group. In other words the ad group location criterions override the campaign location criterions, and are not applied as a union.

Also note that you must consider the location, negative location, and radius criterions as a set of geo criterions. If the ad group has any geo criterions, then none of the campaign's geo criterions are inherited. If the ad group doesn't have any geo criterions, then all of the campaign's geo criterions are inherited. The geo criterions can be inherited from the campaign even if the ad group has a location intent criterion. If the ad group's geo criterions are used, then the ad group's location intent criterion is used; if the campaign's geo criterions are inherited, then the campaign's location intent criterion is used and the ad group's location intent criterion is ignored. You cannot delete a campaign or ad group's location intent criterion, although it has no purpose without location or radius criterions.

<xs:complexType name="LocationCriterion" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:Criterion">
      <xs:sequence>
        <xs:element minOccurs="0" name="DisplayName" nillable="true" type="xs:string" />
        <xs:element xmlns:q81="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="EnclosedLocationIds" nillable="true" type="q81:ArrayOflong" />
        <xs:element minOccurs="0" name="LocationId" nillable="true" type="xs:long" />
        <xs:element minOccurs="0" name="LocationType" nillable="true" type="xs:string" />
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

Elements

The LocationCriterion object has the following elements: DisplayName, EnclosedLocationIds, LocationId, LocationType.

Element Description Data Type
DisplayName The location display name.

Add: Read-only
Update: Read-only		 string
EnclosedLocationIds Reserved for internal use.

Add: Read-only
Update: Read-only		 long array
LocationId The unique Microsoft Advertising identifier for the location where you want to show your ads.

For possible values, see the Location Id field of the geographical locations file. You can call the GetGeoLocationsFileUrl operation to download the file.

IMPORTANT: Please check the Status field in the geographical locations file before adding or updating a location criterion. If the status is PendingDeprecation, the location criterion is no longer used for targeting or exclusions. Deprecated location criteria can still be retrieved, but you cannot add or update deprecated location criteria.

Add: Required
Update: Not allowed. If you specify this element it must match the existing setting.		 long
LocationType The location type.

Possible values include, but are not limited to City, Country, MetroArea, Neighborhood, PostalCode, and State.

New location sub types can be added anytime. Rarely will the location type change for a given location ID.

Add: Read-only
Update: Read-only		 string

The LocationCriterion object has Inherited Elements.

Inherited Elements

Inherited Elements from Criterion

The LocationCriterion object derives from the Criterion object, and inherits the following elements: Type. The descriptions below are specific to LocationCriterion, and might not apply to other objects that inherit the same elements from the Criterion object.

Element Description Data Type
Type The type of the criterion. This value is Location when you retrieve a location criterion. For more information about criterion types, see the Criterion Data Object Remarks.

Add: Read-only
Update: Read-only		 string

Requirements

Service: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13