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)
    }
  }
}
Parameter Type Description Required
Params structure (for JSON) / GetRequest (for SOAP)
SelectionCriteria BidModifiersSelectionCriteria

Criteria for selecting adjustments.

Yes
FieldNames array of BidModifierFieldEnum

Names of top-level parameters to get.

Yes
MobileAdjustmentFieldNames array of MobileAdjustmentFieldEnum Names of mobile adjustment parameters to get. No
DesktopAdjustmentFieldNames array of DesktopAdjustmentFieldEnum Names of parameters to get for bid adjustments on computers, tablets, and Smart TVs. No
DemographicsAdjustmentFieldNames array of DemographicsAdjustmentFieldEnum Names of gender and age adjustment parameters to get. No
RetargetingAdjustmentFieldNames array of RetargetingAdjustmentFieldEnum Names of parameters to get for adjustments for a target audience. No
RegionalAdjustmentFieldNames array of RegionalAdjustmentFieldEnum Names of regional bid adjustment parameters to get. No
VideoAdjustmentFieldNames array of VideoAdjustmentFieldEnum Names of parameters to get for video extension adjustments. No
Page LimitOffset

Structure that defines the page for paginated selection of data.

No
BidModifiersSelectionCriteria structure
CampaignIds array 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
AdGroupIds array of long

Selects adjustments set for the specified groups.

From 1 to 1000 items in the array.

Ids array of long Selects adjustments with the specified IDs. From 1 to 10,000 items in the array.
Types array of BidModifierTypeEnum Selects the specified types of adjustments. See Types of adjustments. No
Levels array 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)
  }
}
Parameter Type Description
Result structure (for JSON) / GetResponse (for SOAP)
BidModifiers array of BidModifierGetItem Bid adjustments.
LimitedBy long Sequential 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
CampaignId long ID 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.
AdGroupId long, nillable ID of the ad group that the adjustment is set for.
Id long Bid adjustment ID.
Level BidModifierLevelEnum Level of the adjustment: set for a campaign, or for an ad group.
Type BidModifierTypeEnum Type of bid adjustment.
MobileAdjustment MobileAdjustmentGet Mobile adjustment parameters.
DesktopAdjustment DesktopAdjustmentGet Parameters for the bid adjustment on computers, tablets, and Smart TVs.
VideoAdjustment VideoAdjustmentGet Parameters for the bid adjustment for video extensions.
DemographicsAdjustment DemographicsAdjustmentGet Parameters for the bid adjustment for gender and age.
RetargetingAdjustment RetargetingAdjustmentGet Parameters for the bid adjustment for a target audience.
RegionalAdjustment RegionalAdjustmentGet Parameters for the regional bid adjustment.
MobileAdjustmentGet structure
BidModifier int

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.
OperatingSystemType OperatingSystemTypeEnum

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

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

DesktopAdjustmentGet structure
BidModifier int

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

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

Within a single ad group, you can't set the coefficient to 0 for mobile phones without specifying the OS and simultaneously set it to 0 for computers, tablets, and Smart TVs.

DemographicsAdjustmentGet structure
Gender GenderEnum, nillable

The user's gender: GENDER_MALE or GENDER_FEMALE.

If the parameter is omitted, any gender is assumed.

Age AgeRangeEnum, 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.

BidModifier int

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.

Enabled YesNoEnum Whether the set of demographics adjustments is enabled or disabled.
RetargetingAdjustmentGet structure
RetargetingConditionId long ID of the retargeting list. The list must have the RETARGETING type. See the section Retargeting list (RetargetingList).
BidModifier int

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.

Accessible YesNoEnum Indicates 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.
Enabled YesNoEnum Whether the set of target audience adjustments is enabled or disabled.
RegionalAdjustmentGet structure
RegionId long

ID of the region from the reference list of regions.

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

BidModifier int

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.

Enabled YesNoEnum Whether the set of regional bid adjustments is enabled or disabled.
VideoAdjustmentGet structure
BidModifier int

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.