get

Returns parameters of adjustments that match the specified criteria.

  1. Restrictions
  2. Request
  3. Response

Restrictions

The method returns a maximum of 10,000 objects.

The total of the Limit and Offset values must not exceed 120,000 (if Limit is omitted, the Offset value must not exceed 110,000).

Request

Request structure in JSON format:

{
  "method": "get",
  "params": { /* params */
    "SelectionCriteria": {  /* BidModifiersSelectionCriteria */
      "CampaignIds": [(long), ... ],
      "AdGroupIds": [(long), ... ],
      "Ids": [(long), ... ],
      "Types": [( "MOBILE_ADJUSTMENT" | "DESKTOP_ADJUSTMENT" | "DEMOGRAPHICS_ADJUSTMENT" | "RETARGETING_ADJUSTMENT" | "REGIONAL_ADJUSTMENT" | "VIDEO_ADJUSTMENT" ), ... ],
      "Levels": [( "CAMPAIGN" | "AD_GROUP" ), ... ] /* required */
    }, /* required */
    "FieldNames": [( "Id" | "CampaignId" | "AdGroupId" | "Level" | "Type" )], /* required */
    "MobileAdjustmentFieldNames": [( "BidModifier" | "OperatingSystemType" ), ... ],
    "DesktopAdjustmentFieldNames": [( "BidModifier" )],
    "DemographicsAdjustmentFieldNames": [( "Gender" | "Age" | "BidModifier" | "Enabled" ), ... ],
    "RetargetingAdjustmentFieldNames": [( "RetargetingConditionId" | "BidModifier" | "Accessible" | "Enabled" ), ... ],
    "RegionalAdjustmentFieldNames": [( "RegionId" | "BidModifier" | "Enabled" ), ... ],
    "VideoAdjustmentFieldNames": [( "BidModifier" )],
    "Page": {  /* LimitOffset */
      "Limit": (long),
      "Offset": (long)
    }
  }
}
ParameterTypeDescriptionRequired
Params structure (for JSON) / GetRequest (for SOAP)
SelectionCriteriaBidModifiersSelectionCriteria

Criteria for selecting adjustments.

Yes
FieldNamesarray of BidModifierFieldEnum

Names of top-level parameters to get.

Yes
MobileAdjustmentFieldNamesarray of MobileAdjustmentFieldEnumNames of mobile adjustment parameters to get.No
DesktopAdjustmentFieldNamesarray of DesktopAdjustmentFieldEnumNames of parameters to get for bid adjustments on computers and tablets.No
DemographicsAdjustmentFieldNamesarray of DemographicsAdjustmentFieldEnumNames of gender and age adjustment parameters to get.No
RetargetingAdjustmentFieldNamesarray of RetargetingAdjustmentFieldEnumNames of parameters to get for adjustments for a target audience.No
RegionalAdjustmentFieldNamesarray of RegionalAdjustmentFieldEnumNames of regional bid adjustment parameters to get.No
VideoAdjustmentFieldNamesarray of VideoAdjustmentFieldEnumNames of parameters to get for video extension adjustments.No
PageLimitOffset

Structure that defines the page for paginated selection of data.

No
BidModifiersSelectionCriteria structure
CampaignIdsarray of long

Selects adjustments set for the specified campaigns and/or child groups.

From 1 to 10 items in the array.

At least one of the CampaignIds, AdGroupIds or Ids parameters
AdGroupIdsarray of long

Selects adjustments set for the specified groups.

From 1 to 1000 items in the array.

Idsarray of longSelects adjustments with the specified IDs. From 1 to 10,000 items in the array.
Typesarray of BidModifierTypeEnumSelects the specified types of adjustments. See Types of adjustments.No
Levelsarray of BidModifierLevelEnum

Selects the specified levels of adjustments:

  • CAMPAIGN — Adjustments set for campaigns.
  • AD_GROUP — Adjustments set for ad groups.
Yes

Response

Response structure in JSON format:

{
  "result": { /* result */
    "BidModifiers": [{  /* BidModifierGetItem */
      "CampaignId": (long),
      "AdGroupId": (long), /* nillable */
      "Id": (long),
      "Level": ( "CAMPAIGN" | "AD_GROUP" ),
      "Type": ( "MOBILE_ADJUSTMENT" | "DESKTOP_ADJUSTMENT" | "DEMOGRAPHICS_ADJUSTMENT" | "RETARGETING_ADJUSTMENT" | "REGIONAL_ADJUSTMENT" | "VIDEO_ADJUSTMENT" ),
      "MobileAdjustment": {  /* MobileAdjustmentGet */
        "BidModifier": (int),
        "OperatingSystemType": ( "IOS" | "ANDROID" )
      },
      "DesktopAdjustment": {  /* DesktopAdjustmentGet */
        "BidModifier": (int)
      },
      "DemographicsAdjustment": {  /* DemographicsAdjustmentGet */
        "Gender": ( "GENDER_MALE" | "GENDER_FEMALE" ), /* nillable */
        "Age": ( "AGE_0_17" | "AGE_18_24" | "AGE_25_34" | "AGE_35_44" | "AGE_45" | "AGE_45_54" | "AGE_55" ), /* nillable */
        "BidModifier": (int),
        "Enabled": ( "YES" | "NO" )
      },
      "RetargetingAdjustment": {  /* RetargetingAdjustmentGet */
        "RetargetingConditionId": (long),
        "BidModifier": (int),
        "Accessible": ( "YES" | "NO" ),
        "Enabled": ( "YES" | "NO" )
      },
      "RegionalAdjustment": {  /* RegionalAdjustmentGet */
        "RegionId": (long),
        "BidModifier": (int),
        "Enabled": ("YES"|"NO")
      },
      "VideoAdjustment": {  /* VideoAdjustmentGet */
        "BidModifier": (int)
      }
    }, ... ],
    "LimitedBy": (long)
  }
}
ParameterTypeDescription
Result structure (for JSON) / GetResponse (for SOAP)
BidModifiersarray of BidModifierGetItemBid adjustments.
LimitedBylongSequential number of the last object returned. It is included if there was a limit on the number of objects in the response. See the section Paginated data selection.
BidModifierGetItem structure
CampaignIdlongID of the campaign that the adjustment is set for, or the ID of the campaign that belongs to the ad group that the adjustment is set for.
AdGroupIdlong, nillableID of the ad group that the adjustment is set for.
IdlongBid adjustment ID.
LevelBidModifierLevelEnumLevel of the adjustment: set for a campaign, or for an ad group.
TypeBidModifierTypeEnumType of bid adjustment.
MobileAdjustmentMobileAdjustmentGetMobile adjustment parameters.
DesktopAdjustmentDesktopAdjustmentGetParameters for the bid adjustment on computers and tablets.
VideoAdjustmentVideoAdjustmentGetParameters for the bid adjustment for video extensions.
DemographicsAdjustmentDemographicsAdjustmentGetParameters for the bid adjustment for gender and age.
RetargetingAdjustmentRetargetingAdjustmentGetParameters for the bid adjustment for a target audience.
RegionalAdjustmentRegionalAdjustmentGetParameters for the regional bid adjustment.
MobileAdjustmentGet structure
BidModifierint

Value of the bid coefficient for serving ads on mobile phones.

Specified as a percent:
  • From 0 to 1300 for adjustments in a group of display ads.
  • From 50 to 1300 for adjustments in other types of campaigns and groups.
The bid is multiplied by the value of BidModifier/100.
OperatingSystemTypeOperatingSystemTypeEnum

The type of operating system. Allowed only for adjustments in groups of display ads.

If this parameter is specified, ads won't be served on mobile phones with other types of operating systems.

If this parameter is omitted, any operating system is acceptable.

DesktopAdjustmentGet structure
BidModifierint

The value of the bid coefficient for serving ads on computers and tablets.

Indicated as a percentage from 0 to 1300. The bid is multiplied by the value of BidModifier/100.

You can't set the coefficient to 0 simultaneously for mobile phones and for computers and tablets in the same ad group.

DemographicsAdjustmentGet structure
GenderGenderEnum, nillable

The user's gender: GENDER_MALE or GENDER_FEMALE.

If the parameter is omitted, any gender is assumed.

AgeAgeRangeEnum, nillable

The user's age group: one of the values AGE_0_17, AGE_18_24, AGE_25_34, AGE_35_44, AGE_45_54 or AGE_55.

The value AGE_45 has been deprecated. We recommend creating separate adjustments for AGE_45_54 and AGE_55.

If the parameter is omitted, any age is assumed.

BidModifierint

The value of the bid coefficient for serving ads to users of the specified gender and/or age group.

Indicated as a percentage from 0 to 1300. The bid is multiplied by the value of BidModifier/100.

EnabledYesNoEnumWhether the set of demographics adjustments is enabled or disabled.
RetargetingAdjustmentGet structure
RetargetingConditionIdlongID of the retargeting list. The list must have the RETARGETING type. See the section Retargeting list (RetargetingList).
BidModifierint

The value of the bid coefficient for serving ads to users who match the retargeting list.

Indicated as a percentage from 0 to 1300. The bid is multiplied by the value of BidModifier/100.

AccessibleYesNoEnumIndicates that all goals and segments in the retargeting list are available to the advertiser. The value NO means that one or more goals or segments are not available.
EnabledYesNoEnumWhether the set of target audience adjustments is enabled or disabled.
RegionalAdjustmentGet structure
RegionIdlong

ID of the region from the reference list of regions.

To get the list of regions, use the Dictionaries.get method.

BidModifierint

Value of the bid coefficient for serving ads in the specified region.

Indicated as a percentage from 10 to 1300. The bid is multiplied by the value of BidModifier/100.

EnabledYesNoEnumWhether the set of regional bid adjustments is enabled or disabled.
VideoAdjustmentGet structure
BidModifierint

Value of the bid coefficient for serving ads with video extensions.

Indicated as a percentage from 50 to 1300. The bid is multiplied by the value of BidModifier/100.