Skip to content

ota2000/yahoo-ads-search

Repository files navigation

yahoo-ads-search

Yahoo!広告 検索広告 APIのWebサービスについて説明します。
「Try it out」のご利用には、事前にアプリケーションの登録が必要です。また、アプリケーションのリダイレクトURIの1つに
https://yahoojp-marketing.github.io/ads-search-api-documents/oauth2-redirect.htmlを登録してください。
Search Ads API Web Services supported in Yahoo! Ads API.
When you use \"Try it out\", you need to register your application in advance.
As one of redirect URI for application, you need to set \"https://yahoojp-marketing.github.io/ads-search-api-documents/oauth2-redirect.html\".

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: v1
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import yahoo_ads_search

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import yahoo_ads_search

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function

import time
import yahoo_ads_search
from yahoo_ads_search.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://ads-search.yahooapis.jp/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = yahoo_ads_search.Configuration(
    host = "https://ads-search.yahooapis.jp/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure OAuth2 access token for authorization: oAuth
configuration = yahoo_ads_search.Configuration(
    host = "https://ads-search.yahooapis.jp/api/v1"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Enter a context with an instance of the API client
with yahoo_ads_search.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = yahoo_ads_search.AccountServiceApi(api_client)
    account_service_selector = yahoo_ads_search.AccountServiceSelector() # AccountServiceSelector |  (optional)

    try:
        api_response = api_instance.account_service_get_post(account_service_selector=account_service_selector)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AccountServiceApi->account_service_get_post: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://ads-search.yahooapis.jp/api/v1

Class Method HTTP request Description
AccountServiceApi account_service_get_post POST /AccountService/get
AccountServiceApi account_service_set_post POST /AccountService/set
AccountSharedServiceApi account_shared_service_add_post POST /AccountSharedService/add
AccountSharedServiceApi account_shared_service_get_post POST /AccountSharedService/get
AccountSharedServiceApi account_shared_service_remove_post POST /AccountSharedService/remove
AccountSharedServiceApi account_shared_service_set_post POST /AccountSharedService/set
AccountTrackingUrlServiceApi account_tracking_url_service_get_post POST /AccountTrackingUrlService/get
AccountTrackingUrlServiceApi account_tracking_url_service_set_post POST /AccountTrackingUrlService/set
AdGroupAdLabelServiceApi ad_group_ad_label_service_add_post POST /AdGroupAdLabelService/add
AdGroupAdLabelServiceApi ad_group_ad_label_service_remove_post POST /AdGroupAdLabelService/remove
AdGroupAdServiceApi ad_group_ad_service_add_post POST /AdGroupAdService/add
AdGroupAdServiceApi ad_group_ad_service_get_post POST /AdGroupAdService/get
AdGroupAdServiceApi ad_group_ad_service_remove_post POST /AdGroupAdService/remove
AdGroupAdServiceApi ad_group_ad_service_set_post POST /AdGroupAdService/set
AdGroupAdServiceApi ad_group_ad_service_set_trademark_status_post POST /AdGroupAdService/setTrademarkStatus
AdGroupBidMultiplierServiceApi ad_group_bid_multiplier_service_get_post POST /AdGroupBidMultiplierService/get
AdGroupBidMultiplierServiceApi ad_group_bid_multiplier_service_remove_post POST /AdGroupBidMultiplierService/remove
AdGroupBidMultiplierServiceApi ad_group_bid_multiplier_service_set_post POST /AdGroupBidMultiplierService/set
AdGroupCriterionLabelServiceApi ad_group_criterion_label_service_add_post POST /AdGroupCriterionLabelService/add
AdGroupCriterionLabelServiceApi ad_group_criterion_label_service_remove_post POST /AdGroupCriterionLabelService/remove
AdGroupCriterionServiceApi ad_group_criterion_service_add_post POST /AdGroupCriterionService/add
AdGroupCriterionServiceApi ad_group_criterion_service_get_post POST /AdGroupCriterionService/get
AdGroupCriterionServiceApi ad_group_criterion_service_remove_post POST /AdGroupCriterionService/remove
AdGroupCriterionServiceApi ad_group_criterion_service_set_post POST /AdGroupCriterionService/set
AdGroupFeedServiceApi ad_group_feed_service_get_post POST /AdGroupFeedService/get
AdGroupFeedServiceApi ad_group_feed_service_set_post POST /AdGroupFeedService/set
AdGroupLabelServiceApi ad_group_label_service_add_post POST /AdGroupLabelService/add
AdGroupLabelServiceApi ad_group_label_service_remove_post POST /AdGroupLabelService/remove
AdGroupRetargetingListServiceApi ad_group_retargeting_list_service_add_post POST /AdGroupRetargetingListService/add
AdGroupRetargetingListServiceApi ad_group_retargeting_list_service_get_post POST /AdGroupRetargetingListService/get
AdGroupRetargetingListServiceApi ad_group_retargeting_list_service_remove_post POST /AdGroupRetargetingListService/remove
AdGroupRetargetingListServiceApi ad_group_retargeting_list_service_set_post POST /AdGroupRetargetingListService/set
AdGroupServiceApi ad_group_service_add_post POST /AdGroupService/add
AdGroupServiceApi ad_group_service_get_post POST /AdGroupService/get
AdGroupServiceApi ad_group_service_remove_post POST /AdGroupService/remove
AdGroupServiceApi ad_group_service_set_post POST /AdGroupService/set
AdGroupWebpageServiceApi ad_group_webpage_service_add_post POST /AdGroupWebpageService/add
AdGroupWebpageServiceApi ad_group_webpage_service_get_post POST /AdGroupWebpageService/get
AdGroupWebpageServiceApi ad_group_webpage_service_remove_post POST /AdGroupWebpageService/remove
AdGroupWebpageServiceApi ad_group_webpage_service_set_post POST /AdGroupWebpageService/set
AuditLogServiceApi audit_log_service_add_job_post POST /AuditLogService/addJob
AuditLogServiceApi audit_log_service_download_post POST /AuditLogService/download
AuditLogServiceApi audit_log_service_get_post POST /AuditLogService/get
BalanceServiceApi balance_service_get_post POST /BalanceService/get
BidLandscapeServiceApi bid_landscape_service_get_post POST /BidLandscapeService/get
BiddingStrategyServiceApi bidding_strategy_service_add_post POST /BiddingStrategyService/add
BiddingStrategyServiceApi bidding_strategy_service_get_post POST /BiddingStrategyService/get
BiddingStrategyServiceApi bidding_strategy_service_remove_post POST /BiddingStrategyService/remove
BiddingStrategyServiceApi bidding_strategy_service_set_post POST /BiddingStrategyService/set
CampaignCriterionServiceApi campaign_criterion_service_add_post POST /CampaignCriterionService/add
CampaignCriterionServiceApi campaign_criterion_service_get_post POST /CampaignCriterionService/get
CampaignCriterionServiceApi campaign_criterion_service_remove_post POST /CampaignCriterionService/remove
CampaignExportServiceApi campaign_export_service_add_job_post POST /CampaignExportService/addJob
CampaignExportServiceApi campaign_export_service_download_post POST /CampaignExportService/download
CampaignExportServiceApi campaign_export_service_get_export_fields_get GET /CampaignExportService/getExportFields
CampaignExportServiceApi campaign_export_service_get_post POST /CampaignExportService/get
CampaignFeedServiceApi campaign_feed_service_get_post POST /CampaignFeedService/get
CampaignFeedServiceApi campaign_feed_service_set_post POST /CampaignFeedService/set
CampaignLabelServiceApi campaign_label_service_add_post POST /CampaignLabelService/add
CampaignLabelServiceApi campaign_label_service_remove_post POST /CampaignLabelService/remove
CampaignRetargetingListServiceApi campaign_retargeting_list_service_add_post POST /CampaignRetargetingListService/add
CampaignRetargetingListServiceApi campaign_retargeting_list_service_get_post POST /CampaignRetargetingListService/get
CampaignRetargetingListServiceApi campaign_retargeting_list_service_remove_post POST /CampaignRetargetingListService/remove
CampaignRetargetingListServiceApi campaign_retargeting_list_service_set_post POST /CampaignRetargetingListService/set
CampaignServiceApi campaign_service_add_post POST /CampaignService/add
CampaignServiceApi campaign_service_get_post POST /CampaignService/get
CampaignServiceApi campaign_service_remove_post POST /CampaignService/remove
CampaignServiceApi campaign_service_set_post POST /CampaignService/set
CampaignSharedSetServiceApi campaign_shared_set_service_add_post POST /CampaignSharedSetService/add
CampaignSharedSetServiceApi campaign_shared_set_service_get_post POST /CampaignSharedSetService/get
CampaignSharedSetServiceApi campaign_shared_set_service_remove_post POST /CampaignSharedSetService/remove
CampaignTargetServiceApi campaign_target_service_add_post POST /CampaignTargetService/add
CampaignTargetServiceApi campaign_target_service_get_post POST /CampaignTargetService/get
CampaignTargetServiceApi campaign_target_service_remove_post POST /CampaignTargetService/remove
CampaignTargetServiceApi campaign_target_service_set_post POST /CampaignTargetService/set
CampaignWebpageServiceApi campaign_webpage_service_add_post POST /CampaignWebpageService/add
CampaignWebpageServiceApi campaign_webpage_service_get_post POST /CampaignWebpageService/get
CampaignWebpageServiceApi campaign_webpage_service_remove_post POST /CampaignWebpageService/remove
ConversionTrackerServiceApi conversion_tracker_service_add_post POST /ConversionTrackerService/add
ConversionTrackerServiceApi conversion_tracker_service_get_post POST /ConversionTrackerService/get
ConversionTrackerServiceApi conversion_tracker_service_set_post POST /ConversionTrackerService/set
DictionaryServiceApi dictionary_service_get_disapproval_reason_post POST /DictionaryService/getDisapprovalReason
DictionaryServiceApi dictionary_service_get_geographic_location_post POST /DictionaryService/getGeographicLocation
FeedItemServiceApi feed_item_service_add_post POST /FeedItemService/add
FeedItemServiceApi feed_item_service_get_post POST /FeedItemService/get
FeedItemServiceApi feed_item_service_remove_post POST /FeedItemService/remove
FeedItemServiceApi feed_item_service_set_post POST /FeedItemService/set
FeedItemServiceApi feed_item_service_set_trademark_status_post POST /FeedItemService/setTrademarkStatus
FeedServiceApi feed_service_add_post POST /FeedService/add
FeedServiceApi feed_service_get_post POST /FeedService/get
FeedServiceApi feed_service_remove_post POST /FeedService/remove
FeedServiceApi feed_service_set_post POST /FeedService/set
KeywordEstimatorServiceApi keyword_estimator_service_get_post POST /KeywordEstimatorService/get
LabelServiceApi label_service_add_post POST /LabelService/add
LabelServiceApi label_service_get_post POST /LabelService/get
LabelServiceApi label_service_remove_post POST /LabelService/remove
LabelServiceApi label_service_set_post POST /LabelService/set
OfflineConversionServiceApi offline_conversion_service_download_error_file_post POST /OfflineConversionService/downloadErrorFile
OfflineConversionServiceApi offline_conversion_service_download_post POST /OfflineConversionService/download
OfflineConversionServiceApi offline_conversion_service_get_post POST /OfflineConversionService/get
OfflineConversionServiceApi offline_conversion_service_upload_post POST /OfflineConversionService/upload
PageFeedItemServiceApi page_feed_item_service_add_download_job_post POST /PageFeedItemService/addDownloadJob
PageFeedItemServiceApi page_feed_item_service_download_error_file_post POST /PageFeedItemService/downloadErrorFile
PageFeedItemServiceApi page_feed_item_service_download_post POST /PageFeedItemService/download
PageFeedItemServiceApi page_feed_item_service_get_job_status_post POST /PageFeedItemService/getJobStatus
PageFeedItemServiceApi page_feed_item_service_get_post POST /PageFeedItemService/get
PageFeedItemServiceApi page_feed_item_service_get_review_summary_post POST /PageFeedItemService/getReviewSummary
PageFeedItemServiceApi page_feed_item_service_upload_post POST /PageFeedItemService/upload
ReportDefinitionServiceApi report_definition_service_add_post POST /ReportDefinitionService/add
ReportDefinitionServiceApi report_definition_service_download_post POST /ReportDefinitionService/download
ReportDefinitionServiceApi report_definition_service_get_post POST /ReportDefinitionService/get
ReportDefinitionServiceApi report_definition_service_get_report_fields_post POST /ReportDefinitionService/getReportFields
ReportDefinitionServiceApi report_definition_service_remove_post POST /ReportDefinitionService/remove
RetargetingListServiceApi retargeting_list_service_add_post POST /RetargetingListService/add
RetargetingListServiceApi retargeting_list_service_get_custom_key_post POST /RetargetingListService/getCustomKey
RetargetingListServiceApi retargeting_list_service_get_post POST /RetargetingListService/get
RetargetingListServiceApi retargeting_list_service_set_post POST /RetargetingListService/set
SharedCriterionServiceApi shared_criterion_service_add_post POST /SharedCriterionService/add
SharedCriterionServiceApi shared_criterion_service_get_post POST /SharedCriterionService/get
SharedCriterionServiceApi shared_criterion_service_remove_post POST /SharedCriterionService/remove
TargetingIdeaServiceApi targeting_idea_service_get_post POST /TargetingIdeaService/get

Documentation For Models

Documentation For Authorization

oAuth

  • Type: OAuth
  • Flow: accessCode
  • Authorization URL: https://biz-oauth.yahoo.co.jp/oauth/v1/authorize
  • Scopes:
  • yahooads: アプリケーションを経由したYahoo!広告の各機能の操作/Operation by each function of Yahoo! Ads via applications.

Author

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages