get

Для работы с товарными объявлениями используется адрес https://api.direct.yandex.com/v501/.

Метод возвращает не более 10 000 объектов.

Структура запроса в формате JSON:

{
  "method": "get",
  "params": { /* params */
    "SelectionCriteria": {  /* AdsSelectionCriteria */
      "Ids": [(long), ... ],
      "States": [( "OFF" | ... | "ARCHIVED" ), ... ],
      "Statuses": [( "ACCEPTED" | ... | "REJECTED" ), ... ],
      "CampaignIds": [(long), ... ],
      "AdGroupIds": [(long), ... ],
      "Types": [( "TEXT_AD" | "MOBILE_APP_AD" | "DYNAMIC_TEXT_AD" | "IMAGE_AD"
                  | "CPC_VIDEO_AD" | "CPM_BANNER_AD" | "CPM_VIDEO_AD"
                  | "SMART_AD" | "SHOPPING_AD" | "LISTING_AD" ), ... ],
      "Mobile": ( "YES" | "NO" ),
      "VCardIds": [(long), ... ],
      "SitelinkSetIds": [(long), ... ],
      "AdImageHashes": [(string), ... ],
      "VCardModerationStatuses": [( "ACCEPTED" | ... | "REJECTED" ), ... ],
      "SitelinksModerationStatuses": [( "ACCEPTED" | ... | "REJECTED" ), ... ],
      "AdImageModerationStatuses": [( "ACCEPTED" | ... | "REJECTED" ), ... ],
      "AdExtensionIds": [(long), ... ]
    }, /* required */
    "FieldNames": [( "AdCategories" | ... | "Subtype" ), ... ], /* required */
    "TextAdFieldNames": [( "AdImageHash" | ... | "BusinessId" | "PreferVCardOverBusiness" | "ErirAdDescription" | "AutogeneratedErirAdDescription" ), ... ],
    "TextAdPriceExtensionFieldNames": [( "Price" | "OldPrice" | "PriceCurrency" | "PriceQualifier" ), ... ],
    "MobileAppAdFieldNames": [( "AdImageHash" | ... | "TrackingUrl" | "ErirAdDescription" | "AutogeneratedErirAdDescription" ), ... ],
    "DynamicTextAdFieldNames": [( "AdImageHash" | ... | "AdExtensions" | "ErirAdDescription" | "AutogeneratedErirAdDescription" ), ... ],
    "TextImageAdFieldNames": [( "AdImageHash" | "Href" | "TurboPageId" | "TurboPageModeration" | "ErirAdDescription" | "AutogeneratedErirAdDescription" ), ... ],
    "MobileAppImageAdFieldNames": [( "AdImageHash" | "TrackingUrl" | "ErirAdDescription" | "AutogeneratedErirAdDescription" ), ... ],
    "TextAdBuilderAdFieldNames": [( "Creative" | "Href" | "TurboPageId" | "TurboPageModeration" | "ErirAdDescription" | "AutogeneratedErirAdDescription" ), ... ],
    "MobileAppAdBuilderAdFieldNames": [( "Creative" | "TrackingUrl" | "ErirAdDescription" | "AutogeneratedErirAdDescription" ), ... ],
    "MobileAppCpcVideoAdBuilderAdFieldNames" : [ ("Creative" | "TrackingUrl" | "ErirAdDescription" | "AutogeneratedErirAdDescription"), ... ],
    "CpcVideoAdBuilderAdFieldNames": [( "Creative" | "Href" | "TurboPageId" | "TurboPageModeration" | "ErirAdDescription" | "AutogeneratedErirAdDescription" ), ... ],
    "CpmBannerAdBuilderAdFieldNames": [( "Creative" | "Href" | "TrackingPixels" | "TurboPageId" | "TurboPageModeration" | "ErirAdDescription" | "AutogeneratedErirAdDescription" ), ... ],
    "CpmVideoAdBuilderAdFieldNames": [( "Creative" | "Href" | "TrackingPixels" | "TurboPageId" | "TurboPageModeration" | "ErirAdDescription" | "AutogeneratedErirAdDescription" ), ... ],
    "SmartAdBuilderAdFieldNames" : [( "Creative" ), ... ],
    "ShoppingAdFieldNames" : [ ("SitelinkSetId"|"SitelinksModeration"|"AdExtensions"|"BusinessId"|"FeedId"|"FeedFilterConditions"|"FeedProcessingStatus"|"TitleSources"|"TextSources"|"DefaultTexts") ],
    "ListingAdFieldNames" : [ ("SitelinkSetId"|"SitelinksModeration"|"AdExtensions"|"BusinessId"|"FeedId"|"FeedFilterConditions"|"FeedProcessingStatus"|"TitleSources"|"TextSources"|"DefaultTexts") ]
    "Page": {  /* LimitOffset */
      "Limit": (long),
      "Offset": (long)
    }
  }
}

Ниже приведено описание параметров.

Структура ответа в формате JSON:

{
  "result": { /* result */
    "Ads": [{  /* AdGetItem */
      "Id": (long),
      "CampaignId": (long),
      "AdGroupId": (long),
      "Status": ( "ACCEPTED" | ... | "UNKNOWN" ),
      "State": ( "OFF" | ... | "UNKNOWN" ),
      "StatusClarification": (string),
      "AdCategories": {  /* ArrayOfAdCategoryEnum */
        "Items": [( "ABORTION" | ... | "TOBACCO" ), ... ] /* required */
      }, /* nillable */
      "AgeLabel": ( "AGE_0" | ... | "MONTHS_12"), /* nillable */
      "Type": ( "TEXT_AD" | "MOBILE_APP_AD" | "DYNAMIC_TEXT_AD" | "IMAGE_AD" | "CPC_VIDEO_AD"
                | "CPM_BANNER_AD" | "CPM_VIDEO_AD" | "SMART_AD" | "SHOPPING_AD" | "LISTING_AD" ),
      "Subtype": ( "NONE" | "TEXT_IMAGE_AD" | "MOBILE_APP_IMAGE_AD" | "MOBILE_APP_CPC_VIDEO_AD_BUILDER_AD" | "TEXT_AD_BUILDER_AD" | "MOBILE_APP_AD_BUILDER_AD" ),
      "TextAd": {  /* TextAdGet */
        "Title": (string),
        "Title2": (string), /* nillable */
        "Text": (string),
        "Href": (string), /* nillable */
        "Mobile": ( "YES" | "NO" ),
        "DisplayDomain": (string), /* nillable */
        "DisplayUrlPath": (string), /* nillable */
        "VCardId": (long), /* nillable */
        "AdImageHash": (string), /* nillable */
        "SitelinkSetId": (long), /* nillable */
        "DisplayUrlPathModeration": {  /* ExtensionModeration */
          "Status": ( "ACCEPTED" | ... | "UNKNOWN" ), /* required */
          "StatusClarification": (string)
        }, /* nillable */
        "VCardModeration": {  /* ExtensionModeration */
          "Status": ( "ACCEPTED" | ... | "UNKNOWN" ), /* required */
          "StatusClarification": (string)
        }, /* nillable */
        "SitelinksModeration": {  /* ExtensionModeration */
          "Status": ( "ACCEPTED" | ... | "UNKNOWN" ), /* required */
          "StatusClarification": (string)
        }, /* nillable */
        "AdImageModeration": {  /* ExtensionModeration */
          "Status": ( "ACCEPTED" | ... | "UNKNOWN" ), /* required */
          "StatusClarification": (string)
        }, /* nillable */
        "AdExtensions": [{  /* AdExtensionAdGetItem */
          "AdExtensionId": (long), /* required */
          "Type": ( "CALLOUT" | "UNKNOWN" ) /* required */
        }, ... ],
        "VideoExtension": {  /* VideoExtensionGetItem */
          "CreativeId": (long), /* required */
          "Status": ( "ACCEPTED" | ... | "UNKNOWN" ),
          "ThumbnailUrl": (string), /* required */
          "PreviewUrl": (string) /* required */
        }, /* nillable */
        "PriceExtension": {  /* PriceExtensionGetItem */
          "Price": (long),
          "OldPrice": (long), /* nillable */
          "PriceQualifier": ( "FROM" | "UP_TO" | "NONE" ),
          "PriceCurrency": ( "RUB" | "BYN" | "CHF" | "EUR" | "KZT" | "TRY" | "UAH" | "USD" | "UZS" )
        }, /* nillable */
        "TurboPageId": (long), /* nillable */
        "TurboPageModeration": {  /* ExtensionModeration */
          "Status": ( "ACCEPTED" | ... | "UNKNOWN" ), /* required */
          "StatusClarification": (string)
        }, /* nillable */
        "BusinessId": (long) /* nillable */,
        "PreferVCardOverBusiness": ( "YES" | "NO" ),
        "ErirAdDescription" : (string), /* nillable */
        "AutogeneratedErirAdDescription" : (string) /* nillable */
      },
      "DynamicTextAd": {  /* DynamicTextAdGet */
        "VCardId": (long), /* nillable */
        "AdImageHash": (string), /* nillable */
        "SitelinkSetId": (long), /* nillable */
        "VCardModeration": {  /* ExtensionModeration */
          "Status": ( "ACCEPTED" | ... | "UNKNOWN" ), /* required */
          "StatusClarification": (string)
        }, /* nillable */
        "SitelinksModeration": {  /* ExtensionModeration */
          "Status": ( "ACCEPTED" | ... | "UNKNOWN" ), /* required */
          "StatusClarification": (string)
        }, /* nillable */
        "AdImageModeration": {  /* ExtensionModeration */
          "Status": ( "ACCEPTED" | ... | "UNKNOWN" ), /* required */
          "StatusClarification": (string)
        }, /* nillable */
        "AdExtensions": [{  /* AdExtensionAdGetItem */
          "AdExtensionId": (long), /* required */
          "Type": ( "CALLOUT" | "UNKNOWN" ) /* required */
        }, ... ],
        "Text": (string)
      },
      "MobileAppAd": {  /* MobileAppAdGet */
        "Title": (string),
        "Text": (string),
        "TrackingUrl": (string), /* nillable */
        "Action": ( "DOWNLOAD" | "GET" | "INSTALL" | "MORE" | "OPEN" | "UPDATE" | "PLAY" | "BUY_AUTODETECT" ),
        "AdImageHash": (string), /* nillable */
        "Features": [{  /* MobileAppAdFeatureGetItem */
          "Feature": ( "PRICE" | "ICON" | "CUSTOMER_RATING" | "RATINGS" ), /* required */
          "Enabled": ( "YES" | "NO" ), /* required */
          "IsAvailable": ( "YES" | "NO" | "UNKNOWN" ) /* required */
        }, ... ],
        "AdImageModeration": {  /* ExtensionModeration */
          "Status": ( "ACCEPTED" | ... | "UNKNOWN" ), /* required */
          "StatusClarification": (string)
        }, /* nillable */
        "VideoExtension": {  /* VideoExtensionGetItem */
          "CreativeId": (long), /* required */
          "Status": ( "ACCEPTED" | ... | "UNKNOWN" ),
          "ThumbnailUrl": (string), /* required */
          "PreviewUrl": (string) /* required */
        }, /* nillable */
        "ErirAdDescription" : (string), /* nillable */
        "AutogeneratedErirAdDescription" : (string) /* nillable */
      },
      "TextImageAd": {  /* TextImageAdGet */
        "AdImageHash": (string),
        "Href": (string), /* nillable */
        "TurboPageId": (long), /* nillable */
        "TurboPageModeration": {  /* ExtensionModeration */
          "Status": ( "ACCEPTED" | ... | "UNKNOWN" ), /* required */
          "StatusClarification": (string)
        }, /* nillable */
        "ErirAdDescription" : (string), /* nillable */
        "AutogeneratedErirAdDescription" : (string) /* nillable */
      },
      "MobileAppImageAd": {  /* MobileAppImageAdGet */
        "AdImageHash": (string),
        "TrackingUrl": (string), /* nillable */
        "ErirAdDescription" : (string), /* nillable */
        "AutogeneratedErirAdDescription" : (string) /* nillable */
      },
      "TextAdBuilderAd": {  /* TextAdBuilderAdGet */
        "Creative": { /* AdBuilderAdGetItem */
          "CreativeId": (long), /* required */
          "ThumbnailUrl": (string),
          "PreviewUrl": (string),
          "ErirAdDescription" : (string), /* nillable */
          "AutogeneratedErirAdDescription" : (string) /* nillable */
        },
        "Href": (string), /* nillable */
        "TurboPageId": (long), /* nillable */
        "TurboPageModeration": {  /* ExtensionModeration */
          "Status": ( "ACCEPTED" | ... | "UNKNOWN" ), /* required */
          "StatusClarification": (string)
        }, /* nillable */
        "ErirAdDescription" : (string), /* nillable */
        "AutogeneratedErirAdDescription" : (string) /* nillable */
      },
      "MobileAppAdBuilderAd": {  /* MobileAppAdBuilderAdGet */
        "Creative": { /* AdBuilderAdGetItem */
          "CreativeId": (long), /* required */
          "ThumbnailUrl": (string),
          "PreviewUrl": (string)
        },
        "TrackingUrl": (string), /* nillable */
        "ErirAdDescription" : (string), /* nillable */
        "AutogeneratedErirAdDescription" : (string) /* nillable */
      },
      "MobileAppCpcVideoAdBuilderAd" : {  /* MobileAppCpcVideoAdBuilderAdGet */
        "Creative" : { /* AdBuilderAdGetItem */
          "CreativeId" : (long) /* required */,
          "ThumbnailUrl" : (string),
          "PreviewUrl" : (string)
        },
        "TrackingUrl" : (string), /* nillable */
        "ErirAdDescription" : (string), /* nillable */
        "AutogeneratedErirAdDescription" : (string) /* nillable */
      },
      "CpmBannerAdBuilderAd": {  /* CpmBannerAdBuilderAdGet */
        "Creative": { /* AdBuilderAdGetItem */
          "CreativeId": (long), /* required */
          "ThumbnailUrl": (string),
          "PreviewUrl": (string)
        },
        "Href": (string), /* nillable */
        "TrackingPixels": { /* TrackingPixelGetArray */
          "Items": [{ /* TrackingPixelGetItem */
            "TrackingPixel": (string), /* required */
            "Provider": (string) /* required */
          }, ... ] /* required */
        }, /* nillable */
        "TurboPageId": (long), /* nillable */
        "TurboPageModeration": {  /* ExtensionModeration */
          "Status": ( "ACCEPTED" | ... | "UNKNOWN" ), /* required */
          "StatusClarification": (string)
        }, /* nillable */
        "ErirAdDescription" : (string), /* nillable */
        "AutogeneratedErirAdDescription" : (string) /* nillable */
      },
      "CpcVideoAdBuilderAd": {  /* CpcVideoAdBuilderAdGet */
        "Creative": { /* AdBuilderAdGetItem */
          "CreativeId": (long), /* required */
          "ThumbnailUrl": (string),
          "PreviewUrl": (string)
        },
        "Href": (string), /* nillable */
        "TurboPageId": (long), /* nillable */
        "TurboPageModeration": {  /* ExtensionModeration */
          "Status": ( "ACCEPTED" | ... | "UNKNOWN" ), /* required */
          "StatusClarification": (string)
        }, /* nillable */
        "ErirAdDescription" : (string), /* nillable */
        "AutogeneratedErirAdDescription" : (string) /* nillable */
      },
      "CpmVideoAdBuilderAd": {  /* CpmVideoAdBuilderAdGet */
        "Creative": { /* AdBuilderAdGetItem */
          "CreativeId": (long), /* required */
          "ThumbnailUrl": (string),
          "PreviewUrl": (string)
        },
        "Href": (string), /* nillable */
        "TrackingPixels": { /* TrackingPixelGetArray */
          "Items": [{ /* TrackingPixelGetItem */
            "TrackingPixel": (string), /* required */
            "Provider": (string) /* required */
          }, ... ] /* required */
        }, /* nillable */
        "TurboPageId": (long), /* nillable */
        "TurboPageModeration": {  /* ExtensionModeration */
          "Status": ( "ACCEPTED" | ... | "UNKNOWN" ), /* required */
          "StatusClarification": (string)
        }, /* nillable */
        "ErirAdDescription" : (string), /* nillable */
        "AutogeneratedErirAdDescription" : (string) /* nillable */
      },
      "SmartAdBuilderAd": {  /* SmartAdBuilderAdGet */
        "Creative": { /* AdBuilderAdGetItem */
          "CreativeId": (long), /* required */
          "ThumbnailUrl": (string),
          "PreviewUrl" : (string)
        },
        "ErirAdDescription" : (string), /* nillable */
        "AutogeneratedErirAdDescription" : (string) /* nillable */
      },
      "ShoppingAd" : {
        "SitelinkSetId" : (long) /* nillable */,
        "SitelinksModeration" : { /* nillable */
            "Status" : ("ACCEPTED"|"DRAFT"|"MODERATION"|"PREACCEPTED"|"REJECTED"|"UNKNOWN") /* required */,
            "StatusClarification" : (string)
        },
        "AdExtensions" : [{
            "AdExtensionId" : (long) /* required */,
            "Type" : ("CALLOUT"|"UNKNOWN") /* required */
        }, ... ],
        "BusinessId" : (long) /* nillable */,
        "FeedId" : (long),
        "FeedFilterConditions" : { /* nillable */
            "Items" : [{ /* required */
                "Operand" : (string) /* required */,
                "Operator" : ("CONTAINS_ANY"|"EQUALS_ANY"|"EXISTS"|"GREATER_THAN"|"IN_RANGE"|"LESS_THAN"|"NOT_CONTAINS_ALL") /* required */,
                "Arguments" : [ (string) ] /* required */
            }, ... ]
        },
        "FeedProcessingStatus" : ("EMPTY_RESULT"|"PROCESSED"|"UNKNOWN"|"UNPROCESSED"),
        "TitleSources" : { /* nillable */
            "Items" : [ (string) ] /* required */
        },
        "TextSources" : { /* nillable */
            "Items" : [ (string) ] /* required */
        },
        "DefaultTexts" : [ (string) ]
      },
      "ListingAd" : {
        "SitelinkSetId" : (long) /* nillable */,
        "SitelinksModeration" : { /* nillable */
            "Status" : ("ACCEPTED"|"DRAFT"|"MODERATION"|"PREACCEPTED"|"REJECTED"|"UNKNOWN") /* required */,
            "StatusClarification" : (string)
        },
        "AdExtensions" : [{
            "AdExtensionId" : (long) /* required */,
            "Type" : ("CALLOUT"|"UNKNOWN") /* required */
        }, ... ],
        "BusinessId" : (long) /* nillable */,
        "FeedId" : (long),
        "FeedFilterConditions" : { /* nillable */
            "Items" : [{ /* required */
                "Operand" : (string) /* required */,
                "Operator" : ("CONTAINS_ANY"|"EQUALS_ANY"|"EXISTS"|"GREATER_THAN"|"IN_RANGE"|"LESS_THAN"|"NOT_CONTAINS_ALL") /* required */,
                "Arguments" : [ (string) ] /* required */
            }, ... ]
        },
        "FeedProcessingStatus" : ("EMPTY_RESULT"|"PROCESSED"|"UNKNOWN"|"UNPROCESSED"),
        "TitleSources" : { /* nillable */
            "Items" : [ (string) ] /* required */
        },
        "TextSources" : { /* nillable */
            "Items" : [ (string) ] /* required */
        },
        "DefaultTexts" : [ (string) ]
      }
    }, ... ],
    }, ... ],
    "LimitedBy": (long)
  }
}

Ниже приведено описание параметров.