get

Возвращает параметры рекламодателя и настройки пользователя — представителя рекламодателя либо параметры агентства и настройки пользователя — представителя агентства.

Запрос от имени представителя рекламодателя

Любой представитель рекламодателя может получать параметры рекламодателя и собственные настройки.

Главный представитель рекламодателя может также получать настройки другого представителя: для этого необходимо передать логин представителя в HTTP-заголовке запроса Client-Login.

Запрос от имени представителя агентства

Любой представитель агентства может получать параметры рекламодателя — клиента агентства и настройки пользователя — представителя рекламодателя: для этого необходимо передать логин представителя рекламодателя в HTTP-заголовке запроса Client-Login.

Любой представитель агентства может получать параметры агентства и собственные настройки.

Главный представитель агентства может также получать настройки другого представителя агентства: для этого необходимо передать логин представителя в HTTP-заголовке запроса Client-Login.

Узнайте больше

Запрос

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

{
  "method": "get",
  "params": { /* params */
    "FieldNames": [( "AccountQuality" | "Archived" | "ClientId" | "ClientInfo" | "CountryId" | "CreatedAt" | "Currency" | "Grants" | "Bonuses" | "Login" | "Notification" | "OverdraftSumAvailable" | "Phone" | "Representatives" | "Restrictions" | "Settings" | "Type" | "VatRate" | "ForbiddenPlatform" | "AvailableCampaignTypes" ), ... ] /* required */,
    "TinInfoFieldNames" : [ ( "TinType" | "Tin" ), ... ],
    "OrganizationFieldNames": [( "Name" | "EpayNumber" | "RegNumber" | "OksmNumber" | "OkvedCode" ), ... ],
    "ContractFieldNames": [( "Number" | "Date" | "Price" | "Type" | "ActionType" | "SubjectType" ), ... ],
    "ContragentFieldNames": [( "Name" | "Phone" | "EpayNumber" | "RegNumber" | "OksmNumber" ), ... ],
    "ContragentTinInfoFieldNames": [( "TinType" | "Tin" ), ... ]
  }
}

Параметр	Тип	Описание	Обязательный
Структура params (для JSON) / GetRequest (для SOAP)
`FieldNames`	array of ClientFieldEnum	Имена параметров, которые требуется получить. Внимание При получении параметров агентства параметры `AccountQuality`, `Currency`, `Grants`, `OverdraftSumAvailable`, `Restrictions`, `Settings` не возвращаются.	Да
`TinInfoFieldNames`	array of TinInfoFieldEnum	Имена параметров с налоговыми данными о конечном рекламодателе, которые требуется получить.	Нет
`OrganizationFieldNames`	array of OrganizationFieldEnum	Имена параметров с информацией об организации конечного рекламодателя, которые требуется получить.	Нет
`ContractFieldNames`	array of ContractFieldEnum	Имена параметров с информацией о договоре клиента-контрагента с конечным рекламодателем, которые требуется получить.	Нет
`ContragentFieldNames`	array of ContragentFieldEnum	Имена параметров с информацией о контрагенте, которые требуется получить.	Нет
`ContragentTinInfoFieldNames`	array of TinInfoFieldEnum	Имена параметров с налоговыми данными о контрагенте, которые требуется получить.	Нет

Ответ

Примечание

Параметры Login, ClientInfo, CreatedAt, Notification, Phone относятся не к рекламодателю или агентству, а к его представителю:

пользователю, от имени которого выполняется запрос, — если в запросе отсутствует HTTP-заголовок Client-Login;
пользователю, чей логин указан в HTTP-заголовке Client-Login, — если в запросе присутствует HTTP-заголовок Client-Login.

Остальные параметры относятся к рекламодателю или агентству и не зависят от представителя.

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

{
  "result": { /* result */
    "Clients": [{  /* ClientGetItem */
      "AccountQuality": (decimal), /* nillable */
      "Archived": ( "YES" | "NO" ),
      "ClientId": (long),
      "ClientInfo": (string),
      "CountryId": (int),
      "CreatedAt": (string),
      "Currency": ( "RUB" | "BYN" | "CHF" | "EUR" | "KZT" | "TRY" | "UAH" | "USD" ),
      "Grants": [{  /* GrantGetItem */
        "Privilege": ( "EDIT_CAMPAIGNS" | "IMPORT_XLS" | "TRANSFER_MONEY" ), /* required */
        "Value": ( "YES" | "NO" ), /* required */
        "Agency": (string)
      }, ... ],
      "Bonuses" : {  /* BonusesGet */
        "AwaitingBonus" : (long) /* required */,
        "AwaitingBonusWithoutNds" : (long) /* required */
      },
      "Login": (string),
      "Notification": {  /* NotificationGet */
        "Lang": ( "RU" | "UK" | "EN" | "TR" ), /* required */
        "SmsPhoneNumber": (string), /* required */
        "Email": (string), /* required */
        "EmailSubscriptions": [{  /* EmailSubscriptionItem */
          "Option": ( "RECEIVE_RECOMMENDATIONS" | "TRACK_MANAGED_CAMPAIGNS" | "TRACK_POSITION_CHANGES" ), /* required */
          "Value": ( "YES" | "NO" ) /* required */
        }, ... ]
      },
      "OverdraftSumAvailable": (long),
      "Phone": (string),
      "Representatives": [{  /* Representative */
        "Login": (string), /* required */
        "Email": (string), /* required */
        "Role": ( "CHIEF" | "DELEGATE" | "LIMITED" | "READONLY" | "UNKNOWN" ) /* required */
      }, ... ],
      "Restrictions": [{  /* ClientRestrictionItem */
        "Element": ( "CAMPAIGNS_TOTAL_PER_CLIENT" | "CAMPAIGNS_UNARCHIVED_PER_CLIENT" | "ADGROUPS_TOTAL_PER_CAMPAIGN" | "ADS_TOTAL_PER_ADGROUP" | "KEYWORDS_TOTAL_PER_ADGROUP" | "AD_EXTENSIONS_TOTAL" | "STAT_REPORTS_TOTAL_IN_QUEUE" | "FORECAST_REPORTS_TOTAL_IN_QUEUE" | "WORDSTAT_REPORTS_TOTAL_IN_QUEUE" | "API_POINTS" | "GENERAL_DOMAIN_BLACKLIST_SIZE" | "VIDEO_DOMAIN_BLACKLIST_SIZE" ), /* required */
        "Value": (int) /* required */
      }, ... ],
      "Settings": [{  /* ClientSettingGetItem */
        "Option": ( "CORRECT_TYPOS_AUTOMATICALLY" | "DISPLAY_STORE_RATING" | "SHARED_ACCOUNT_ENABLED" ), /* required */
        "Value": ( "YES" | "NO" ) /* required */
      }, ... ],
      "Type": (string),
      "VatRate": (decimal) /* nillable */,
      "ForbiddenPlatform": ("SEARCH" | "NETWORK" | "NONE"),
      "AvailableCampaignTypes": ("TEXT_CAMPAIGN" | "MOBILE_APP_CAMPAIGN" | "DYNAMIC_TEXT_CAMPAIGN" | "CPM_BANNER_CAMPAIGN" | "SMART_CAMPAIGN" | "CONTENT_PROMOTION" | "BILLING_AGGREGATE" | "UNIFIED_CAMPAIGN" ),
      "TinInfo" : { /* TinInfoGet */
        "TinType" : ( "PHYSICAL" | "FOREIGN_PHYSICAL" | "LEGAL" | "FOREIGN_LEGAL" | "INDIVIDUAL" ),
        "Tin" : (string) /* nillable */
      },
      "ErirAttributes": { /* ErirAttributesGet */
        "Organization": { /* OrganizationGet */
          "Name": (string), /* nillable */
          "EpayNumber": (string), /* nillable */
          "RegNumber": (string), /* nillable */
          "OksmNumber": (string), /* nillable */
          "OkvedCode": (string) /* nillable */
        },
        "Contract": { /* ContractGet */
          "Number": (string), /* nillable */
          "Date": (string), /* nillable */
          "Type": ( "CONTRACT" | "INTERMEDIARY_CONTRACT" | "ADDITIONAL_AGREEMENT" ), /* nillable */
          "ActionType": ( "COMMERCIAL" | "DISTRIBUTION" | "CONCLUDE" | "OTHER" ), /* nillable */
          "SubjectType": ( "REPRESENTATION" | "MEDIATION" | "DISTRIBUTION" | "ORG_DISTRIBUTION" | "OTHER" ), /* nillable */
          "Price": { /* PriceGet */
            "Amount": (decimal), /* required */
            "IncludingVat": ( "YES" | "NO" ) /* required */
          }
        },
        "Contragent": { /* ContragentGet */
          "Name": (string), /* nillable */
          "Phone": (string), /* nillable */
          "EpayNumber": (string), /* nillable */
          "RegNumber": (string), /* nillable */
          "OksmNumber": (string), /* nillable */
          "TinInfo": { /* TinInfoGet */
            "TinType": ( "PHYSICAL" | "FOREIGN_PHYSICAL" | "LEGAL" | "FOREIGN_LEGAL" | "INDIVIDUAL" ),
            "Tin": (string) /* nillable */
          }
        }
      }
    }, ... ]
  }
}

Параметр	Тип	Для рекламодателя	Для агентства
Структура result (для JSON) / GetResponse (для SOAP)
`Clients`	array of ClientGetItem	Параметры рекламодателя и настройки пользователя — представителя рекламодателя.	Параметры агентства и настройки пользователя — представителя агентства.
Структура ClientGetItem
`AccountQuality`	decimal, nillable	Показатель качества аккаунта.	—
`Archived`	YesNoEnum	Признак того, что рекламодатель помещен в архив (не активен).	Признак того, что агентство помещено в архив (не активно).
`ClientId`	long	Идентификатор рекламодателя.	Идентификатор агентства.
`ClientInfo`	string	ФИО пользователя Директа (до 255 символов).	ФИО пользователя Директа (до 255 символов).
`CountryId`	int	Идентификатор страны рекламодателя из справочника регионов. Справочник регионов можно получить с помощью метода Dictionaries.get.	Идентификатор страны агентства из справочника регионов. Справочник регионов можно получить с помощью метода Dictionaries.get.
`CreatedAt`	string	Дата регистрации пользователя в Директе, в формате YYYY-MM-DD.	Дата регистрации пользователя в Директе, в формате YYYY-MM-DD.
`Currency`	CurrencyEnum	Валюта рекламодателя. Справочник валют можно получить с помощью метода Dictionaries.get.	—
`Grants`	array of GrantGetItem	Полномочия рекламодателя по управлению кампаниями.	—
`Bonuses`	BonusesGet	Бонус, ожидающий начисления. Параметр актуален только для валюты RUB.	Бонус, ожидающий начисления. Параметр актуален только для валюты RUB.
`Login`	string	Логин пользователя Директа.	Логин пользователя Директа.
`Notification`	NotificationGet	Настройки SMS- и email-уведомлений пользователя Директа.	Настройки SMS- и email-уведомлений пользователя Директа.
`OverdraftSumAvailable`	long	Лимит овердрафта, которым рекламодатель может воспользоваться в текущий момент времени (см. раздел Отсрочка платежа помощи Директа). Возвращается в виде целого числа, которое представляет собой лимит овердрафта в валюте рекламодателя, умноженный на 1 000 000.	—
`Phone`	string	Номер телефона пользователя Директа (до 255 символов).	Номер телефона пользователя Директа (до 255 символов).
`Representatives`	array of Representative	Представители рекламодателя (см. раздел Регистрация представителей помощи Директа). Для главного представителя возвращаются все представители, для обычного представителя — только главный представитель.	Представители агентства (см. раздел Управление представителями агентства помощи Директа). Для главного представителя возвращаются все представители, для остальных представителей — только главный представитель.
`Restrictions`	array of ClientRestrictionItem	Количественные ограничения на объекты рекламодателя.	—
`Settings`	array of ClientSettingGetItem	Настройки рекламодателя, допускающие только значения YES или NO.	—
`Type`	string	Тип клиента: CLIENT — прямой рекламодатель; SUBCLIENT — рекламодатель, являющийся клиентом агентства. См. Клиент (Client).	Тип клиента: AGENCY.
`VatRate`	decimal, nillable	Ставка НДС клиента, осуществляющего оплату: прямого рекламодателя или агентства.	Ставка НДС агентства.
`ForbiddenPlatform`	ForbiddenPlatformEnum	Запрещенные площадки: SEARCH. NETWORK. NONE.
`AvailableCampaignTypes`	AvailableCampaignTypesEnum	Типы кампаний, которые доступны логину: TEXT_CAMPAIGN. MOBILE_APP_CAMPAIGN. DYNAMIC_TEXT_CAMPAIGN. CPM_BANNER_CAMPAIGN. SMART_CAMPAIGN. CONTENT_PROMOTION. BILLING_AGGREGATE. UNIFIED_CAMPAIGN.
`TinInfo`	TinInfoGet	Налоговые данные конечного рекламодателя.	—
`ErirAttributes`	ErirAttributesGet	Дополнительные данные рекламодателя для маркировки рекламы.	—
Структура GrantGetItem
`Privilege`	PrivilegeEnum	Имя полномочия: EDIT_CAMPAIGNS — редактирование кампаний. IMPORT_XLS — управление кампаниями с помощью файлов (см. разделы Управление кампаниями с помощью файлов формата XLS и XLSX и Загрузка кампаний из CSV-файлов помощи Директа). TRANSFER_MONEY — перенос средств между кампаниями (см. раздел Перенос средств между кампаниями).	—
`Value`	YesNoEnum	Есть ли у клиента данное полномочие.	—
`Agency`	string	Название рекламного агентства, если полномочие предоставлено агентством.	—
Структура BonusesGet
`AwaitingBonus`	decimal	Размер бонуса с НДС, который ожидает начисления. Возвращается в виде целого числа, умноженного на 1 000 000.	Размер бонуса с НДС, который ожидает начисления. Возвращается в виде целого числа, умноженного на 1 000 000.
`AwaitingBonusWithoutNds`	decimal	Размер бонуса без НДС, который ожидает начисления. Возвращается в виде целого числа, умноженного на 1 000 000.	Размер бонуса без НДС, который ожидает начисления. Возвращается в виде целого числа, умноженного на 1 000 000.
Структура NotificationGet
`Lang`	LangEnum	Язык уведомлений.	Язык уведомлений.
`SmsPhoneNumber`	string	Телефонный номер для отправки SMS-уведомлений из профиля пользователя на Яндексе (см. раздел Мои телефоны помощи Яндекс Паспорта).	Телефонный номер для отправки SMS-уведомлений из профиля пользователя на Яндексе (см. раздел Мои телефоны помощи Яндекс Паспорта).
`Email`	string	Адрес электронной почты для отправки уведомлений, связанных с аккаунтом (до 255 символов).	Адрес электронной почты для отправки уведомлений, связанных с аккаунтом (до 255 символов).
`EmailSubscriptions`	array of EmailSubscriptionItem	Типы уведомлений, отправляемых по электронной почте.	—
Структура EmailSubscriptionItem
`Option`	EmailSubscriptionEnum	Тип уведомления: RECEIVE_RECOMMENDATIONS — новости Директа и рекомендации. TRACK_MANAGED_CAMPAIGNS — уведомления по кампаниям, обслуживаемым персональным менеджером. TRACK_POSITION_CHANGES — предупреждения о снижении прогноза трафика относительно того, который обеспечивали ставки на момент установки.	—
`Value`	YesNoEnum	Отправлять ли уведомления данного типа.	—
Структура Representative
`Login`	string	Логин пользователя.	Логин пользователя.
`Email`	string	Адрес электронной почты для отправки уведомлений.	Адрес электронной почты для отправки уведомлений.
`Role`	RepresentativeRoleEnum	Роль пользователя: CHIEF — главный представитель рекламодателя. DELEGATE — представитель рекламодателя с полным доступом. READONLY — представитель с доступом “Только чтение”. UNKNOWN — роль не поддерживается в данной версии API. См. Роли и доступы пользователей Директа.	Роль пользователя: CHIEF — главный представитель агентства. DELEGATE — представитель агентства. LIMITED — представитель агентства по работе с клиентами. UNKNOWN — роль не поддерживается в данной версии API. См. Роли и доступы пользователей Директа.
Структура ClientRestrictionItem
`Element`	ClientRestrictionEnum	Имя ограничения: CAMPAIGNS_TOTAL_PER_CLIENT — максимальное количество кампаний у рекламодателя. CAMPAIGNS_UNARCHIVED_PER_CLIENT — максимальное количество кампаний, не находящихся в архиве. ADGROUPS_TOTAL_PER_CAMPAIGN — максимальное количество групп в кампании. ADS_TOTAL_PER_ADGROUP — максимальное количество объявлений в группе. KEYWORDS_TOTAL_PER_ADGROUP — максимальное количество ключевых фраз в группе. AD_EXTENSIONS_TOTAL — максимальное количество расширений к объявлениям у рекламодателя. STAT_REPORTS_TOTAL_IN_QUEUE — максимальное количество одновременно формируемых статистических отчетов. FORECAST_REPORTS_TOTAL_IN_QUEUE — максимальное количество хранимых на сервере отчетов о прогнозируемом бюджете, количестве показов и кликов. WORDSTAT_REPORTS_TOTAL_IN_QUEUE — максимальное количество хранимых на сервере отчетов о статистике поисковых запросов. API_POINTS — суточный лимит баллов. GENERAL_DOMAIN_BLACKLIST_SIZE — максимальное количество площадок, на которых запрещены показы объявлений. VIDEO_DOMAIN_BLACKLIST_SIZE — максимальное количество площадок, на которых запрещены показы видеообъявлений.	—
`Value`	int	Значение ограничения.	—
Структура ClientSettingGetItem
`Option`	ClientSettingGetEnum	Имя настройки: CORRECT_TYPOS_AUTOMATICALLY — автоматически исправлять ошибки и опечатки. DISPLAY_STORE_RATING — дополнять объявления данными из внешних источников (см. раздел Данные из внешних источников помощи Директа). SHARED_ACCOUNT_ENABLED — подключен общий счет.	—
`Value`	YesNoEnum	Значение настройки.	—
Структура TinInfoGet
`TinType`	TinTypeEnum	Тип организации: LEGAL — юридическое лицо; PHYSICAL — физическое лицо; INDIVIDUAL — индивидуальный предприниматель; FOREIGN_LEGAL — иностранное юридическое лицо; FOREIGN_PHYSICAL — иностранное физическое лицо.	—
`Tin`	string	Номер налогоплательщика либо его аналог в стране регистрации.	—
Структура ErirAttributesGet
`Organization`	OrganizationGet	Информация об организации конечного рекламодателя.	—
`Contract`	ContractGet	Информация о договоре клиента-контрагента с конечным рекламодателем.	—
`Contragent`	ContragentGet	Информация о контрагенте конечного рекламодателя.	—
Структура OrganizationGet
`Name`	string	Наименование организации.	—
`EpayNumber`	string	Номер электронного средства платежа.	—
`RegNumber`	string	Регистрационный номер либо его аналог.	—
`OksmNumber`	string	Код страны регистрации юрлица в соответствии с ОКСМ.	—
`OkvedCode`	string	Код вида деятельности по ОКВЭД.	—
Структура ContractGet
`Number`	string	Номер договора.	—
`Date`	string	Дата договора в формате YYYY-MM-DD.	—
`Type`	ContractTypeEnum	Тип договора: CONTRACT — договор оказания услуг; INTERMEDIARY_CONTRACT — посреднический договор; ADDITIONAL_AGREEMENT — дополнительное соглашение. Внимание Значение ADDITIONAL_AGREEMENT устарело, больше не принимается.	—
`ActionType`	ContractActionTypeEnum	Тип осуществляемых посредником-представителем действий: COMMERCIAL — коммерческое представительство; DISTRIBUTION — действия в целях распространения рекламы; CONCLUDE — заключение договоров; OTHER — иное.	—
`SubjectType`	ContractSubjectTypeEnum	Предмет договора: REPRESENTATION — представительство; MEDIATION — посредничество; DISTRIBUTION — договор на распространение рекламы; ORG_DISTRIBUTION — договор на организацию распространения рекламы; OTHER — иное.	—
`Price`	ContractPrice	Цена договора.	—
Структура ContractPrice
`Amount`	decimal	Стоимость договора.	—
`IncludingVat`	YesNoEnum	Включен ли в стоимость НДС.	—
Структура ContragentGet
`Name`	string	Наименование.	—
`Phone`	string	Номер телефона.	—
`EpayNumber`	string	Номер электронного средства платежа.	—
`RegNumber`	string	Регистрационный номер либо его аналог.	—
`OksmNumber`	string	Код страны регистрации юрлица в соответствии с ОКСМ.	—
`TinInfo`	TinInfoGet	Налоговые данные контрагента.	—

Была ли статья полезна?

Clients: управление параметрами рекламодателя и настройками пользователя

update