examples.ipynb

{
    "cells": [
        {
            "cell_type": "code",
            "execution_count": null,
            "outputs": [],
            "source": ["!pip install tapi-yandex-direct"],
            "metadata": {"collapsed": false, "pycharm": {"name": "#%%\n"}},
        },
        {
            "cell_type": "code",
            "execution_count": 2,
            "metadata": {"collapsed": true},
            "outputs": [],
            "source": [
                "import datetime as dt\n",
                "from pprint import pprint\n",
                "from tapi_yandex_direct import YandexDirect",
            ],
        },
        {
            "cell_type": "code",
            "execution_count": 3,
            "metadata": {"collapsed": true},
            "outputs": [],
            "source": ['ACCESS_TOKEN = ""'],
        },
        {
            "cell_type": "code",
            "execution_count": 4,
            "metadata": {"collapsed": true},
            "outputs": [],
            "source": [
                "client = YandexDirect(\n",
                "    # Токен доступа.\n",
                "    access_token=ACCESS_TOKEN,\n",
                "    # Не будет повторять запрос, если закончаться баллы.\n",
                "    retry_if_not_enough_units=False,\n",
                ")",
            ],
        },
        {
            "cell_type": "markdown",
            "metadata": {},
            "source": ["### Доступные ресурсы API Я.Директ"],
        },
        {
            "cell_type": "code",
            "execution_count": 5,
            "metadata": {},
            "outputs": [
                {
                    "name": "stdout",
                    "output_type": "stream",
                    "text": [
                        "['adextensions',\n",
                        " 'adgroups',\n",
                        " 'adimages',\n",
                        " 'ads',\n",
                        " 'agencyclients',\n",
                        " 'audiencetargets',\n",
                        " 'bidmodifiers',\n",
                        " 'bids',\n",
                        " 'businesses',\n",
                        " 'campaigns',\n",
                        " 'changes',\n",
                        " 'clients',\n",
                        " 'creatives',\n",
                        " 'debugtoken',\n",
                        " 'dictionaries',\n",
                        " 'dynamicads',\n",
                        " 'feeds',\n",
                        " 'keywordbids',\n",
                        " 'keywords',\n",
                        " 'keywordsresearch',\n",
                        " 'leads',\n",
                        " 'negativekeywordsharedsets',\n",
                        " 'reports',\n",
                        " 'retargeting',\n",
                        " 'sitelinks',\n",
                        " 'smartadtargets',\n",
                        " 'turbopages',\n",
                        " 'vcards']\n",
                    ],
                }
            ],
            "source": ["pprint(dir(client))"],
        },
        {"cell_type": "markdown", "metadata": {}, "source": ["### Создание кампании"]},
        {
            "cell_type": "code",
            "execution_count": 6,
            "metadata": {},
            "outputs": [
                {
                    "data": {
                        "text/plain": "{'result': {'AddResults': [{'Id': 61683485}]}}"
                    },
                    "execution_count": 6,
                    "metadata": {},
                    "output_type": "execute_result",
                }
            ],
            "source": [
                "body = {\n",
                '    "method": "add",\n',
                '    "params": {\n',
                '        "Campaigns": [\n',
                "            {\n",
                '                "Name": "MyCampaignTest3",\n',
                '                "StartDate": str(dt.datetime.now().date()),\n',
                '                "TextCampaign": {\n',
                '                    "BiddingStrategy": {\n',
                '                        "Search": {\n',
                '                            "BiddingStrategyType": "HIGHEST_POSITION"\n',
                "                        },\n",
                '                        "Network": {\n',
                '                            "BiddingStrategyType": "SERVING_OFF"\n',
                "                        }\n",
                "                    },\n",
                '                    "Settings": []\n',
                "                }\n",
                "            }\n",
                "        ]\n",
                "    }\n",
                "}\n",
                "campaigns = client.campaigns().post(data=body)\n",
                "campaigns.data",
            ],
        },
        {
            "cell_type": "code",
            "execution_count": 7,
            "metadata": {},
            "outputs": [
                {
                    "data": {"text/plain": "61683485"},
                    "execution_count": 7,
                    "metadata": {},
                    "output_type": "execute_result",
                }
            ],
            "source": [
                "campaigns_list = campaigns().extract()\n",
                "campaign_id = campaigns_list[0]['Id']\n",
                "campaign_id",
            ],
        },
        {"cell_type": "markdown", "metadata": {}, "source": ["### Создание группы"]},
        {
            "cell_type": "code",
            "execution_count": 8,
            "metadata": {},
            "outputs": [
                {
                    "name": "stdout",
                    "output_type": "stream",
                    "text": ["{'result': {'AddResults': [{'Id': 4560252809}]}}\n"],
                },
                {
                    "data": {"text/plain": "4560252809"},
                    "execution_count": 8,
                    "metadata": {},
                    "output_type": "execute_result",
                },
            ],
            "source": [
                "body = {\n",
                '    "method": "add",\n',
                '    "params": {\n',
                '        "AdGroups": [\n',
                "            {\n",
                '                "Name": "MyAdGroupTest",\n',
                '                "CampaignId": campaign_id,\n',
                '                "RegionIds": [0],\n',
                "            }\n",
                "        ]\n",
                "    }\n",
                "}\n",
                "adgroups = client.adgroups().post(data=body)\n",
                "print(adgroups.data)\n",
                "adgroups_list = adgroups().extract()\n",
                "adgroup_id = adgroups_list[0]['Id']\n",
                "adgroup_id",
            ],
        },
        {
            "cell_type": "markdown",
            "metadata": {},
            "source": ["### Создание набора быстрых ссылок"],
        },
        {
            "cell_type": "code",
            "execution_count": 9,
            "metadata": {},
            "outputs": [
                {
                    "name": "stdout",
                    "output_type": "stream",
                    "text": [
                        "{'result': {'AddResults': [{'Id': 1093350622, 'Warnings': [{'Code': 10120, 'Message': 'Specified selection of sitelinks is duplicated in a previously-created selection'}]}]}}\n"
                    ],
                },
                {
                    "data": {"text/plain": "1093350622"},
                    "execution_count": 9,
                    "metadata": {},
                    "output_type": "execute_result",
                },
            ],
            "source": [
                "body = {\n",
                '  "method": "add",\n',
                '  "params": {\n',
                '    "SitelinksSets": [{\n',
                '        "Sitelinks": [\n',
                "            {\n",
                '                "Title": "SitelinkTitle",\n',
                '                "Href": "https://yandex.ru",\n',
                '                "Description": "SitelinkDescription",\n',
                "            },{\n",
                '                "Title": "SitelinkTitle2",\n',
                '                "Href": "https://yandex.ru",\n',
                '                "Description": "SitelinkDescription2",\n',
                "            },\n",
                "        ]\n",
                "    }]\n",
                "  }\n",
                "}\n",
                "sitelinks = client.sitelinks().post(data=body)\n",
                "print(sitelinks.data)\n",
                "sitelinks_list = sitelinks().extract()\n",
                "sitelinks_id = sitelinks_list[0]['Id']\n",
                "sitelinks_id",
            ],
        },
        {
            "cell_type": "markdown",
            "metadata": {},
            "source": ["### Создание объявления"],
        },
        {
            "cell_type": "code",
            "execution_count": 10,
            "metadata": {},
            "outputs": [
                {
                    "name": "stdout",
                    "output_type": "stream",
                    "text": ["{'result': {'AddResults': [{'Id': 10689207161}]}}\n"],
                },
                {
                    "data": {"text/plain": "10689207161"},
                    "execution_count": 10,
                    "metadata": {},
                    "output_type": "execute_result",
                },
            ],
            "source": [
                "body = {\n",
                '    "method": "add",\n',
                '    "params": {\n',
                '        "Ads": [\n',
                "            {\n",
                '                "AdGroupId": adgroup_id,\n',
                '                "TextAd": {\n',
                '                    "Title": "MyTitleTest",\n',
                '                    "Text": "MyTextTest",\n',
                '                    "Mobile": "NO",\n',
                '                    "Href": "https://yandex.ru",\n',
                '                    "SitelinkSetId": sitelinks_id\n',
                "                }\n",
                "            }\n",
                "        ]\n",
                "    }\n",
                "}\n",
                "ads = client.ads().post(data=body)\n",
                "print(ads.data)\n",
                "ads_list = ads().extract()\n",
                "ad_id = ads_list[0]['Id']\n",
                "ad_id",
            ],
        },
        {
            "cell_type": "markdown",
            "metadata": {},
            "source": ["### Создание ключевого слова"],
        },
        {
            "cell_type": "code",
            "execution_count": 11,
            "metadata": {},
            "outputs": [
                {
                    "name": "stdout",
                    "output_type": "stream",
                    "text": ["{'result': {'AddResults': [{'Id': 31714249487}]}}\n"],
                },
                {
                    "data": {"text/plain": "31714249487"},
                    "execution_count": 11,
                    "metadata": {},
                    "output_type": "execute_result",
                },
            ],
            "source": [
                "body = {\n",
                '    "method": "add",\n',
                '    "params": {\n',
                '        "Keywords": [\n',
                "            {\n",
                '                "AdGroupId": adgroup_id,\n',
                '                "Keyword": "Keyword",\n',
                '                "Bid": 10 * 1000000,\n',
                "            }\n",
                "        ]\n",
                "    }\n",
                "}\n",
                "keywords = client.keywords().post(data=body)\n",
                "print(keywords.data)\n",
                "keywords_list = keywords().extract()\n",
                "keyword_id = keywords_list[0]['Id']\n",
                "keyword_id",
            ],
        },
        {
            "cell_type": "markdown",
            "metadata": {},
            "source": ["### Изменение ставки ключевого слова"],
        },
        {
            "cell_type": "code",
            "execution_count": 12,
            "metadata": {},
            "outputs": [
                {
                    "name": "stdout",
                    "output_type": "stream",
                    "text": [
                        "{'result': {'SetResults': [{'KeywordId': 31714249487}]}}\n"
                    ],
                },
                {
                    "data": {"text/plain": "[{'KeywordId': 31714249487}]"},
                    "execution_count": 12,
                    "metadata": {},
                    "output_type": "execute_result",
                },
            ],
            "source": [
                "body = {\n",
                '  "method": "set",\n',
                '  "params": {\n',
                '    "Bids": [{\n',
                '      "KeywordId": keyword_id,\n',
                '      "Bid": 15 * 1000000\n',
                "    }]\n",
                "  }\n",
                "}\n",
                "bids = client.bids().post(data=body)\n",
                "print(bids.data)\n",
                "bids().extract()",
            ],
        },
        {
            "cell_type": "markdown",
            "metadata": {},
            "source": ["### Добавление минус слов в кампанию"],
        },
        {
            "cell_type": "code",
            "execution_count": 13,
            "metadata": {},
            "outputs": [
                {
                    "name": "stdout",
                    "output_type": "stream",
                    "text": ["{'result': {'UpdateResults': [{'Id': 61683485}]}}\n"],
                },
                {
                    "data": {"text/plain": "[{'Id': 61683485}]"},
                    "execution_count": 13,
                    "metadata": {},
                    "output_type": "execute_result",
                },
            ],
            "source": [
                "body = {\n",
                '  "method": "update",\n',
                '  "params": {\n',
                '    "Campaigns": [{\n',
                '      "Id": campaign_id,\n',
                '      "NegativeKeywords": {"Items": ["минусслово1", "минусслово2"]}\n',
                "    }]\n",
                "  }\n",
                "}\n",
                "result = client.campaigns().post(data=body)\n",
                "print(result.data)\n",
                "result().extract()",
            ],
        },
        {
            "cell_type": "markdown",
            "metadata": {},
            "source": ["#### Проверим, получив данные кампании"],
        },
        {
            "cell_type": "code",
            "execution_count": 14,
            "metadata": {},
            "outputs": [
                {
                    "name": "stdout",
                    "output_type": "stream",
                    "text": [
                        "{'result': {'Campaigns': [{'NegativeKeywords': {'Items': ['минусслово1', 'минусслово2']}, 'Id': 61683485, 'Name': 'MyCampaignTest3'}]}}\n"
                    ],
                },
                {
                    "data": {
                        "text/plain": "[{'Id': 61683485,\n  'Name': 'MyCampaignTest3',\n  'NegativeKeywords': {'Items': ['минусслово1', 'минусслово2']}}]"
                    },
                    "execution_count": 14,
                    "metadata": {},
                    "output_type": "execute_result",
                },
            ],
            "source": [
                "body = {\n",
                '    "method": "get",\n',
                '    "params": {\n',
                '        "SelectionCriteria": {\n',
                '            "Ids": [campaign_id]\n',
                "        },\n",
                '        "FieldNames": [\n',
                '            "Id",\n',
                '            "Name",\n',
                '            "NegativeKeywords"\n',
                "        ],\n",
                "    }\n",
                "}\n",
                "campaigns = client.campaigns().post(data=body)\n",
                "print(campaigns.data)\n",
                "campaigns().extract()",
            ],
        },
        {
            "cell_type": "markdown",
            "metadata": {"collapsed": true},
            "source": ["### Получение всех кампаний"],
        },
        {
            "cell_type": "code",
            "execution_count": 15,
            "metadata": {},
            "outputs": [
                {
                    "name": "stdout",
                    "output_type": "stream",
                    "text": [
                        "{'Name': 'MyCampaignTest', 'Id': 61682946}\n",
                        "{'Name': 'MyCampaignTest', 'Id': 61683466}\n",
                        "{'Name': 'MyCampaignTest2', 'Id': 61683474}\n",
                        "{'Name': 'MyCampaignTest3', 'Id': 61683476}\n",
                        "{'Name': 'MyCampaignTest3', 'Id': 61683485}\n",
                    ],
                }
            ],
            "source": [
                "campaigns = client.campaigns().post(\n",
                "    data={\n",
                '        "method": "get",\n',
                '        "params": {\n',
                '            "SelectionCriteria": {},\n',
                '            "FieldNames": ["Id","Name"],\n',
                '            "Page": {"Limit": 1},\n',
                "        },\n",
                "    }\n",
                ")\n",
                "\n",
                "campaign_ids = []\n",
                "for item in campaigns().iter_items():\n",
                "    print(item)\n",
                '    campaign_ids.append(item["Id"])',
            ],
        },
        {
            "cell_type": "markdown",
            "metadata": {"pycharm": {"name": "#%% md\n"}},
            "source": ["Или так"],
        },
        {
            "cell_type": "code",
            "execution_count": 16,
            "outputs": [
                {
                    "name": "stdout",
                    "output_type": "stream",
                    "text": [
                        "[{'Name': 'MyCampaignTest', 'Id': 61682946}]\n",
                        "{'Name': 'MyCampaignTest', 'Id': 61682946}\n",
                        "[{'Name': 'MyCampaignTest', 'Id': 61683466}]\n",
                        "{'Name': 'MyCampaignTest', 'Id': 61683466}\n",
                        "[{'Id': 61683474, 'Name': 'MyCampaignTest2'}]\n",
                        "{'Id': 61683474, 'Name': 'MyCampaignTest2'}\n",
                        "[{'Name': 'MyCampaignTest3', 'Id': 61683476}]\n",
                        "{'Name': 'MyCampaignTest3', 'Id': 61683476}\n",
                        "[{'Id': 61683485, 'Name': 'MyCampaignTest3'}]\n",
                        "{'Id': 61683485, 'Name': 'MyCampaignTest3'}\n",
                    ],
                }
            ],
            "source": [
                "campaigns = client.campaigns().post(\n",
                "    data={\n",
                '        "method": "get",\n',
                '        "params": {\n',
                '            "SelectionCriteria": {},\n',
                '            "FieldNames": ["Id","Name"],\n',
                '            "Page": {"Limit": 1},\n',
                "        },\n",
                "    }\n",
                ")\n",
                "\n",
                "campaign_ids = []\n",
                "\n",
                "# Будет делать запросы, пока не получит все кампании.\n",
                "for page in campaigns().pages():\n",
                "    print(page.data)\n",
                "\n",
                "    # Есть метод итерирования полученных данных.\n",
                "    for item in page().items():\n",
                "        print(item)\n",
                '        campaign_ids.append(item["Id"])\n',
            ],
            "metadata": {"collapsed": false, "pycharm": {"name": "#%%\n"}},
        },
        {
            "cell_type": "markdown",
            "metadata": {},
            "source": ["### Получение объявлений"],
        },
        {
            "cell_type": "code",
            "execution_count": 17,
            "metadata": {},
            "outputs": [
                {
                    "name": "stdout",
                    "output_type": "stream",
                    "text": [
                        "{'result': {'Ads': [{'Id': 10689109178, 'Type': 'TEXT_AD', 'TextAd': {'Title': 'MyTitleTest'}}, {'Id': 10689206008, 'Type': 'TEXT_AD', 'TextAd': {'Title': 'MyTitleTest'}}, {'Id': 10689207161, 'Type': 'TEXT_AD', 'TextAd': {'Title': 'MyTitleTest'}}]}}\n"
                    ],
                },
                {
                    "data": {
                        "text/plain": "[{'Id': 10689109178, 'TextAd': {'Title': 'MyTitleTest'}, 'Type': 'TEXT_AD'},\n {'Id': 10689206008, 'TextAd': {'Title': 'MyTitleTest'}, 'Type': 'TEXT_AD'},\n {'Id': 10689207161, 'TextAd': {'Title': 'MyTitleTest'}, 'Type': 'TEXT_AD'}]"
                    },
                    "execution_count": 17,
                    "metadata": {},
                    "output_type": "execute_result",
                },
            ],
            "source": [
                "ads = client.ads().post(\n",
                "    data={\n",
                '        "method": "get",\n',
                '        "params": {\n',
                '            "SelectionCriteria": {\n',
                '                "CampaignIds":campaign_ids,\n',
                '                "Types": ["TEXT_AD"]\n',
                "            },\n",
                '            "FieldNames": ["Id", "Type"],\n',
                '            "TextAdFieldNames": [\n',
                '                "Title"\n',
                "            ]\n",
                "        },\n",
                "    }\n",
                ")\n",
                "print(ads.data)\n",
                "ads().extract()",
            ],
        },
        {
            "cell_type": "markdown",
            "metadata": {"collapsed": true},
            "source": ["### Получить идентификаторы объектов, которые были изменены"],
        },
        {
            "cell_type": "code",
            "execution_count": 18,
            "metadata": {},
            "outputs": [
                {
                    "name": "stdout",
                    "output_type": "stream",
                    "text": [
                        "{'result': {'Modified': {'CampaignIds': [61682946, 61683466, 61683474, 61683476, 61683485], 'AdIds': [10689109178, 10689206008, 10689207161]}, 'Timestamp': '2021-05-07T14:02:28Z'}}\n"
                    ],
                },
                {
                    "data": {
                        "text/plain": "{'AdIds': [10689109178, 10689206008, 10689207161],\n 'CampaignIds': [61682946, 61683466, 61683474, 61683476, 61683485]}"
                    },
                    "execution_count": 18,
                    "metadata": {},
                    "output_type": "execute_result",
                },
            ],
            "source": [
                "body = {\n",
                '  "method": "check",\n',
                '  "params": {\n',
                '    "CampaignIds": campaign_ids,\n',
                '    "Timestamp": "2021-01-01T00:00:00Z",  # Проверить изменения после указанного времени\n',
                '    "FieldNames": ["CampaignIds","AdIds"]\n',
                "  }\n",
                "}\n",
                "changes = client.changes().post(data=body)\n",
                "print(changes.data)\n",
                "changes().extract()",
            ],
        },
        {
            "cell_type": "code",
            "execution_count": 19,
            "outputs": [
                {
                    "name": "stdout",
                    "output_type": "stream",
                    "text": [
                        "{'result': {'Timestamp': '2021-05-07T14:01:20Z', 'Campaigns': [{'ChangesIn': ['SELF', 'CHILDREN'], 'CampaignId': 61682946}, {'CampaignId': 61683466, 'ChangesIn': ['SELF', 'CHILDREN']}, {'ChangesIn': ['SELF'], 'CampaignId': 61683474}, {'ChangesIn': ['SELF'], 'CampaignId': 61683476}, {'CampaignId': 61683485, 'ChangesIn': ['SELF', 'CHILDREN']}]}}\n"
                    ],
                },
                {
                    "data": {
                        "text/plain": "[{'CampaignId': 61682946, 'ChangesIn': ['SELF', 'CHILDREN']},\n {'CampaignId': 61683466, 'ChangesIn': ['SELF', 'CHILDREN']},\n {'CampaignId': 61683474, 'ChangesIn': ['SELF']},\n {'CampaignId': 61683476, 'ChangesIn': ['SELF']},\n {'CampaignId': 61683485, 'ChangesIn': ['SELF', 'CHILDREN']}]"
                    },
                    "execution_count": 19,
                    "metadata": {},
                    "output_type": "execute_result",
                },
            ],
            "source": [
                "body = {\n",
                '  "method": "checkCampaigns",\n',
                '  "params": {\n',
                '    "Timestamp": "2021-01-01T00:00:00Z",  # Проверить изменения после указанного времени\n',
                "  }\n",
                "}\n",
                "changes = client.changes().post(data=body)\n",
                "print(changes.data)\n",
                "changes().extract()",
            ],
            "metadata": {"collapsed": false, "pycharm": {"name": "#%%\n"}},
        },
    ],
    "metadata": {
        "kernelspec": {
            "display_name": "Python 3",
            "language": "python",
            "name": "python3",
        },
        "language_info": {
            "codemirror_mode": {"name": "ipython", "version": 3},
            "file_extension": ".py",
            "mimetype": "text/x-python",
            "name": "python",
            "nbconvert_exporter": "python",
            "pygments_lexer": "ipython3",
            "version": "3.6.3",
        },
    },
    "nbformat": 4,
    "nbformat_minor": 2,
}