get

Returns parameters of groups that match the specified criteria.

  1. Restrictions
  2. Request
  3. Response
  4. Examples

Restrictions

The method returns a maximum of 10,000 objects.

Request

Request structure in JSON format:

{
  "method": "get",
  "params": { /* params */
    "SelectionCriteria": {  /* AdGroupsSelectionCriteria */
      "CampaignIds": [(long), ... ],
      "Ids": [(long), ... ],
      "Types": [( "TEXT_AD_GROUP" | "MOBILE_APP_AD_GROUP" | "DYNAMIC_TEXT_AD_GROUP" ), ... ],
      "Statuses": [( "ACCEPTED" | "DRAFT" | "MODERATION" | "PREACCEPTED" | "REJECTED" ), ... ],
      "ServingStatuses": [( "ELIGIBLE" | "RARELY_SERVED" ), ... ],
      "AppIconStatuses": [( "ACCEPTED" | "MODERATION" | "REJECTED" ), ... ]
    }, /* required */
    "FieldNames": [( "CampaignId" | ... | "Type" ), ... ], /* required */
    "MobileAppAdGroupFieldNames": [( "StoreUrl" | ... | "AppIconModeration" ), ... ],
    "DynamicTextAdGroupFieldNames": [( "DomainUrl" | "DomainUrlProcessingStatus" ), ... ],
    "DynamicTextFeedAdGroupFieldNames": [( "Source" | "SourceType" | "SourceProcessingStatus" )],
    "Page": {  /* LimitOffset */
      "Limit": (long),
      "Offset": (long)
    }
  }
}
Parameter Type Description Required
Params structure (for JSON) / GetRequest (for SOAP)
SelectionCriteria AdGroupsSelectionCriteria Group selection criteria. Yes
FieldNames array of AdGroupFieldEnum Names of top-level parameters to get. Yes
MobileAppAdGroupFieldNames array of MobileAppAdGroupFieldEnum Names of parameters to get for a mobile app ad group. See Group type.
Note. If a different type of group is selected according to SelectionCriteria, parameters from MobileAppAdGroupFieldNames are not returned.
No
DynamicTextAdGroupFieldNames array of DynamicTextAdGroupFieldEnum Names of parameters for a group of dynamic ads that has a website as the data source. See Group type.
Note. If a different type of group is selected according to SelectionCriteria, parameters from DynamicTextAdGroupFieldNames are not returned.
No
DynamicTextFeedAdGroupFieldNames array of DynamicTextFeedAdGroupFieldEnum Names of parameters for a group of dynamic ads that has a feed as the data source. See Group type.
Note. If a different type of group is selected according to SelectionCriteria, parameters from DynamicTextFeedAdGroupFieldNames are not returned.
No
Page LimitOffset Structure that defines the page for paginated selection of data. No
AdGroupsSelectionCriteria structure
CampaignIds array of long Selects groups of the specified campaigns. From 1 to 10 items in the array. At least one of the CampaignIds or Ids parameters, or both
Ids array of long Selects groups with the specified IDs. From 1 to 10,000 items in the array.
Types array of AdGroupTypesEnum Selects groups of the specified types. See Group type. No
Statuses array of AdGroupStatusSelectionEnum Selects groups with the specified statuses. See Group Status. No
ServingStatuses array of ServingStatusEnum Selects groups with the specified ad serving statuses. See Serving status for the ad group. No
AppIconStatuses array of AdGroupAppIconStatusSelectionEnum Selects groups based on results of app icon review:
  • ACCEPTED — Accepted after review.

  • MODERATION — Currently under review.

  • REJECTED — Rejected.

If this parameter is set, only groups for mobile app advertising will be received. Don't set it if you need to get other types of groups.

No
Note.
  • If the SelectionCriteria structure has more than one criterion set, you will get the groups that simultaneously match all the criteria.

Response

Response structure in JSON format:

{
  "result": { /* result */
    "AdGroups": [{  /* AdGroupGetItem */
      "Id": (long),
      "Name": (string),
      "CampaignId": (long),
      "RegionIds": [(long), ... ],
      "RestrictedRegionIds": {  /* ArrayOfLong */
        "Items": [(long), ... ] /* required */
      }, /* nillable */
      "NegativeKeywords": {  /* ArrayOfString */
        "Items": [(string), ... ] /* required */
      }, /* nillable */
      "TrackingParams": (string),
      "Status": ( "ACCEPTED" | "DRAFT" | "MODERATION" | "PREACCEPTED" | "REJECTED" ),
      "ServingStatus": ( "ELIGIBLE" | "RARELY_SERVED" ),
      "Type": ( "TEXT_AD_GROUP" | "MOBILE_APP_AD_GROUP" | "DYNAMIC_TEXT_AD_GROUP" ),
      "Subtype": ( "WEBPAGE" | "FEED" | "NONE" ),
      "MobileAppAdGroup": {  /* MobileAppAdGroupGet */
        "StoreUrl": (string),
        "TargetDeviceType": [( "DEVICE_TYPE_MOBILE" | "DEVICE_TYPE_TABLET" ), ... ],
        "TargetCarrier": ( "WI_FI_ONLY" | "WI_FI_AND_CELLULAR" ),
        "TargetOperatingSystemVersion": (string),
        "AppIconModeration": {  /* ExtensionModeration */
          "Status": ( "ACCEPTED" | "MODERATION" | "REJECTED" ), /* required */
          "StatusClarification": (string)
        } /* nillable */
        "AppOperatingSystemType": ("IOS" | "ANDROID" | "OS_TYPE_UNKNOWN"),
        "AppAvailabilityStatus": ("UNPROCESSED" | "AVAILABLE" | "NOT_AVAILABLE")
      },
      "DynamicTextAdGroup": {  /* DynamicTextAdGroupGet */
        "DomainUrl": (string),
        "DomainUrlProcessingStatus": ("EMPTY_RESULT" | "PROCESSED" | "UNKNOWN" | "UNPROCESSED" )
      },
      "DynamicTextFeedAdGroup": {  /* DynamicTextFeedAdGroupGet */
        "Source": (string),
        "SourceType": ( "RETAIL_FEED" | "UNKNOWN" ),
        "SourceProcessingStatus": ( "EMPTY_RESULT" | "PROCESSED" | "UNKNOWN" | "UNPROCESSED" )
      }
    }, ... ],
  "LimitedBy": (long)
  }
}
Parameter Type Description
result structure (for JSON) / GetResponse (for SOAP)
AdGroups array of AdGroupGetItem Groups of ads.
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.
AdGroupGetItem structure
Id long ID of the ad group.
Name string Name of the group.
CampaignId long The campaign ID.
RegionIds array of long

IDs of regions where ad impressions are enabled or disabled.

The ID 0 specifies to display ads in all regions.

A minus sign before a region ID disables impressions in this region. For example, [1,-219] indicates to display for Moscow and the entire Moscow area, except Chernogolovka.

RestrictedRegionIds ArrayOfLong, nillable IDs of regions where ads won't be served due to legal restrictions.
NegativeKeywords ArrayOfString, nillable

Negative keywords that are shared by all the ad group's keywords.

TrackingParams string

GET parameters for tracking traffic sources that are added to the link of all ads in the group (maximum of 1024 characters). May contain substitution variables.

For example: from=direct&ad={ad_id}

The parameter can be specified for any type of group, but it is currently only used for groups of dynamic ads. For other types of groups, the specified GET parameters aren't added to links.

Status StatusEnum Group status. See Group Status.
ServingStatus ServingStatusEnum Serving status for the ad group. See Serving status for the ad group.
Type AdGroupTypesEnum Type of ad group. See Group type.
Subtype AdGroupSubtypeEnum The subtype of ad group. For a group with a type other than DYNAMIC_TEXT_AD_GROUP, the value NONE is returned.
MobileAppAdGroup MobileAppAdGroupGet Parameters of groups for mobile app advertising. See Group type.
DynamicTextAdGroup DynamicTextAdGroupGet Parameters for a group of dynamic ads that has a website as the data source. See Group type.
DynamicTextFeedAdGroup DynamicTextFeedAdGroupGet Parameters for a group of dynamic ads that has a feed as the data source. See Group type.
MobileAppAdGroupGet structure
StoreUrl string

Link to the app in AppStore or Google Play (maximum of 1024 characters). The link must contain the protocol. Not editable.

See Link to App in Store in the Help for Yandex.Direct.

TargetDeviceType array of DeviceTypeEnum Which devices to show ads on:
  • DEVICE_TYPE_MOBILE — smartphones

  • DEVICE_TYPE_TABLET — tablets

TargetCarrier CarrierEnum Which types of internet connections to show ads on:
  • WI_FI_ONLY — only Wi-Fi
  • WI_FI_AND_CELLULAR — cellular internet and Wi-Fi
TargetOperatingSystemVersion string The minimum OS version to display the ad on. For example, 2.3.
Note. If the minimum OS version in the app store is higher than the one set in this parameter, ads are displayed only for OS versions equal to or higher than the one in the app store.
AppIconModeration ExtensionModeration Result of reviewing the mobile app icon.
AppOperatingSystemType MobileOperatingSystemTypeEnum

Type of operating system (detected automatically based data from the app store):

  • IOS — iOS
  • ANDROID — Android
  • OS_TYPE_UNKNOWN — Data hasn't been received from the app store yet.
AppAvailabilityStatus AppAvailabilityStatusEnum

Whether the app is available in the app store:

  • AVAILABLE — The app is available.

  • NOT_AVAILABLE — The app isn't available.

  • UNPROCESSED — Data hasn't been received from the app store yet.

ExtensionModeration structure
Status ModerationStatusEnum Result of reviewing the mobile app icon:
  • ACCEPTED — Accepted after review.

  • MODERATION — Currently under review.

  • REJECTED — Rejected.

StatusClarification string Text explanation of the status and/or reasons for rejection after review.
DynamicTextAdGroupGet structure
DomainUrl string The domain name of the site to generate dynamic ads for (a maximum of 100 characters). The protocol can be omitted.
DomainUrlProcessingStatus SourceProcessingStatusEnum

Status of generating dynamic ads:

  • UNPROCESSED — Ad generation has not finished.

  • PROCESSED — Ads have been created.

  • EMPTY_RESULT — No ads could be created.

DynamicTextFeedAdGroupGet structure
Source string The feed ID.
SourceType SourceTypeGetEnum The type of data source. Only the value RETAIL_FEED is currently available.
SourceProcessingStatus SourceProcessingStatusEnum

Status of generating dynamic ads:

  • UNPROCESSED — Ad generation has not finished.

  • PROCESSED — Ads have been created.

  • EMPTY_RESULT — No ads could be created.

Examples

Request example
{
  "method" : "get",
  "params" : {
    "SelectionCriteria" : {
      "CampaignIds" : [
        2991372,
        4193065,
        4193084,
        7273721
      ],
      "Statuses" : [ "DRAFT" ]
    },
    "FieldNames" : [
      "Id",
      "Name",
      "CampaignId",
      "Status",
      "RegionIds",
      "NegativeKeywords"
    ]
  }
}
Response example
{
  "result" : {
    "AdGroups" : [
      {
        "Id" : 45625656,
        "Status" : "DRAFT",
        "CampaignId" : 4193065,
        "RegionIds" : [
          225
        ],
        "NegativeKeywords" : null,
        "Name" : "AdGroup #1"
      },
      {
        "Id" : 198171138,
        "Status" : "DRAFT",
        "CampaignId" : 7273721,
        "RegionIds" : [
          225
        ],
        "NegativeKeywords" : null,
        "Name" : "AdGroup #2"
      },
      {
        "Id" : 636056252,
        "Status" : "DRAFT",
        "CampaignId" : 7273721,
        "RegionIds" : [
          0
        ],
        "NegativeKeywords" : {
          "Items" : [
            "buy"
          ]
        },
        "Name" : "AdGroup #3"
      }
    ]
  }
}