Skip to content

janjouketjalsma/yahoo-api

BranchesTags

Repository files navigation

OpenAPIClient-php

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 PHP package is automatically generated by the OpenAPI Generator project:

  • API version: v1
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/janjouketjalsma/yahoo-api.git"
    }
  ],
  "require": {
    "janjouketjalsma/yahoo-api": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure OAuth2 access token for authorization: oAuth
$config = Yahoo\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Yahoo\Api\AccountServiceApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$accountServiceSelector = new \Yahoo\Model\AccountServiceSelector(); // \Yahoo\Model\AccountServiceSelector | 

try {
    $result = $apiInstance->accountServiceGetPost($accountServiceSelector);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountServiceApi->accountServiceGetPost: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

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

Class Method HTTP request Description
AccountServiceApi accountServiceGetPost POST /AccountService/get
AccountServiceApi accountServiceSetPost POST /AccountService/set
AccountSharedServiceApi accountSharedServiceAddPost POST /AccountSharedService/add
AccountSharedServiceApi accountSharedServiceGetPost POST /AccountSharedService/get
AccountSharedServiceApi accountSharedServiceRemovePost POST /AccountSharedService/remove
AccountSharedServiceApi accountSharedServiceSetPost POST /AccountSharedService/set
AccountTrackingUrlServiceApi accountTrackingUrlServiceGetPost POST /AccountTrackingUrlService/get
AccountTrackingUrlServiceApi accountTrackingUrlServiceSetPost POST /AccountTrackingUrlService/set
AdGroupAdLabelServiceApi adGroupAdLabelServiceAddPost POST /AdGroupAdLabelService/add
AdGroupAdLabelServiceApi adGroupAdLabelServiceRemovePost POST /AdGroupAdLabelService/remove
AdGroupAdServiceApi adGroupAdServiceAddPost POST /AdGroupAdService/add
AdGroupAdServiceApi adGroupAdServiceGetPost POST /AdGroupAdService/get
AdGroupAdServiceApi adGroupAdServiceRemovePost POST /AdGroupAdService/remove
AdGroupAdServiceApi adGroupAdServiceSetPost POST /AdGroupAdService/set
AdGroupAdServiceApi adGroupAdServiceSetTrademarkStatusPost POST /AdGroupAdService/setTrademarkStatus
AdGroupBidMultiplierServiceApi adGroupBidMultiplierServiceGetPost POST /AdGroupBidMultiplierService/get
AdGroupBidMultiplierServiceApi adGroupBidMultiplierServiceRemovePost POST /AdGroupBidMultiplierService/remove
AdGroupBidMultiplierServiceApi adGroupBidMultiplierServiceSetPost POST /AdGroupBidMultiplierService/set
AdGroupCriterionLabelServiceApi adGroupCriterionLabelServiceAddPost POST /AdGroupCriterionLabelService/add
AdGroupCriterionLabelServiceApi adGroupCriterionLabelServiceRemovePost POST /AdGroupCriterionLabelService/remove
AdGroupCriterionServiceApi adGroupCriterionServiceAddPost POST /AdGroupCriterionService/add
AdGroupCriterionServiceApi adGroupCriterionServiceGetPost POST /AdGroupCriterionService/get
AdGroupCriterionServiceApi adGroupCriterionServiceRemovePost POST /AdGroupCriterionService/remove
AdGroupCriterionServiceApi adGroupCriterionServiceSetPost POST /AdGroupCriterionService/set
AdGroupFeedServiceApi adGroupFeedServiceGetPost POST /AdGroupFeedService/get
AdGroupFeedServiceApi adGroupFeedServiceSetPost POST /AdGroupFeedService/set
AdGroupLabelServiceApi adGroupLabelServiceAddPost POST /AdGroupLabelService/add
AdGroupLabelServiceApi adGroupLabelServiceRemovePost POST /AdGroupLabelService/remove
AdGroupRetargetingListServiceApi adGroupRetargetingListServiceAddPost POST /AdGroupRetargetingListService/add
AdGroupRetargetingListServiceApi adGroupRetargetingListServiceGetPost POST /AdGroupRetargetingListService/get
AdGroupRetargetingListServiceApi adGroupRetargetingListServiceRemovePost POST /AdGroupRetargetingListService/remove
AdGroupRetargetingListServiceApi adGroupRetargetingListServiceSetPost POST /AdGroupRetargetingListService/set
AdGroupServiceApi adGroupServiceAddPost POST /AdGroupService/add
AdGroupServiceApi adGroupServiceGetPost POST /AdGroupService/get
AdGroupServiceApi adGroupServiceRemovePost POST /AdGroupService/remove
AdGroupServiceApi adGroupServiceSetPost POST /AdGroupService/set
AdGroupWebpageServiceApi adGroupWebpageServiceAddPost POST /AdGroupWebpageService/add
AdGroupWebpageServiceApi adGroupWebpageServiceGetPost POST /AdGroupWebpageService/get
AdGroupWebpageServiceApi adGroupWebpageServiceRemovePost POST /AdGroupWebpageService/remove
AdGroupWebpageServiceApi adGroupWebpageServiceSetPost POST /AdGroupWebpageService/set
AuditLogServiceApi auditLogServiceAddJobPost POST /AuditLogService/addJob
AuditLogServiceApi auditLogServiceDownloadPost POST /AuditLogService/download
AuditLogServiceApi auditLogServiceGetPost POST /AuditLogService/get
BalanceServiceApi balanceServiceGetPost POST /BalanceService/get
BidLandscapeServiceApi bidLandscapeServiceGetPost POST /BidLandscapeService/get
BiddingStrategyServiceApi biddingStrategyServiceAddPost POST /BiddingStrategyService/add
BiddingStrategyServiceApi biddingStrategyServiceGetPost POST /BiddingStrategyService/get
BiddingStrategyServiceApi biddingStrategyServiceRemovePost POST /BiddingStrategyService/remove
BiddingStrategyServiceApi biddingStrategyServiceSetPost POST /BiddingStrategyService/set
CampaignCriterionServiceApi campaignCriterionServiceAddPost POST /CampaignCriterionService/add
CampaignCriterionServiceApi campaignCriterionServiceGetPost POST /CampaignCriterionService/get
CampaignCriterionServiceApi campaignCriterionServiceRemovePost POST /CampaignCriterionService/remove
CampaignExportServiceApi campaignExportServiceAddJobPost POST /CampaignExportService/addJob
CampaignExportServiceApi campaignExportServiceDownloadPost POST /CampaignExportService/download
CampaignExportServiceApi campaignExportServiceGetExportFieldsGet GET /CampaignExportService/getExportFields
CampaignExportServiceApi campaignExportServiceGetPost POST /CampaignExportService/get
CampaignFeedServiceApi campaignFeedServiceGetPost POST /CampaignFeedService/get
CampaignFeedServiceApi campaignFeedServiceSetPost POST /CampaignFeedService/set
CampaignLabelServiceApi campaignLabelServiceAddPost POST /CampaignLabelService/add
CampaignLabelServiceApi campaignLabelServiceRemovePost POST /CampaignLabelService/remove
CampaignRetargetingListServiceApi campaignRetargetingListServiceAddPost POST /CampaignRetargetingListService/add
CampaignRetargetingListServiceApi campaignRetargetingListServiceGetPost POST /CampaignRetargetingListService/get
CampaignRetargetingListServiceApi campaignRetargetingListServiceRemovePost POST /CampaignRetargetingListService/remove
CampaignRetargetingListServiceApi campaignRetargetingListServiceSetPost POST /CampaignRetargetingListService/set
CampaignServiceApi campaignServiceAddPost POST /CampaignService/add
CampaignServiceApi campaignServiceGetPost POST /CampaignService/get
CampaignServiceApi campaignServiceRemovePost POST /CampaignService/remove
CampaignServiceApi campaignServiceSetPost POST /CampaignService/set
CampaignSharedSetServiceApi campaignSharedSetServiceAddPost POST /CampaignSharedSetService/add
CampaignSharedSetServiceApi campaignSharedSetServiceGetPost POST /CampaignSharedSetService/get
CampaignSharedSetServiceApi campaignSharedSetServiceRemovePost POST /CampaignSharedSetService/remove
CampaignTargetServiceApi campaignTargetServiceAddPost POST /CampaignTargetService/add
CampaignTargetServiceApi campaignTargetServiceGetPost POST /CampaignTargetService/get
CampaignTargetServiceApi campaignTargetServiceRemovePost POST /CampaignTargetService/remove
CampaignTargetServiceApi campaignTargetServiceSetPost POST /CampaignTargetService/set
CampaignWebpageServiceApi campaignWebpageServiceAddPost POST /CampaignWebpageService/add
CampaignWebpageServiceApi campaignWebpageServiceGetPost POST /CampaignWebpageService/get
CampaignWebpageServiceApi campaignWebpageServiceRemovePost POST /CampaignWebpageService/remove
ConversionTrackerServiceApi conversionTrackerServiceAddPost POST /ConversionTrackerService/add
ConversionTrackerServiceApi conversionTrackerServiceGetPost POST /ConversionTrackerService/get
ConversionTrackerServiceApi conversionTrackerServiceSetPost POST /ConversionTrackerService/set
DictionaryServiceApi dictionaryServiceGetDisapprovalReasonPost POST /DictionaryService/getDisapprovalReason
DictionaryServiceApi dictionaryServiceGetGeographicLocationPost POST /DictionaryService/getGeographicLocation
FeedItemServiceApi feedItemServiceAddPost POST /FeedItemService/add
FeedItemServiceApi feedItemServiceGetPost POST /FeedItemService/get
FeedItemServiceApi feedItemServiceRemovePost POST /FeedItemService/remove
FeedItemServiceApi feedItemServiceSetPost POST /FeedItemService/set
FeedItemServiceApi feedItemServiceSetTrademarkStatusPost POST /FeedItemService/setTrademarkStatus
FeedServiceApi feedServiceAddPost POST /FeedService/add
FeedServiceApi feedServiceGetPost POST /FeedService/get
FeedServiceApi feedServiceRemovePost POST /FeedService/remove
FeedServiceApi feedServiceSetPost POST /FeedService/set
KeywordEstimatorServiceApi keywordEstimatorServiceGetPost POST /KeywordEstimatorService/get
LabelServiceApi labelServiceAddPost POST /LabelService/add
LabelServiceApi labelServiceGetPost POST /LabelService/get
LabelServiceApi labelServiceRemovePost POST /LabelService/remove
LabelServiceApi labelServiceSetPost POST /LabelService/set
OfflineConversionServiceApi offlineConversionServiceDownloadErrorFilePost POST /OfflineConversionService/downloadErrorFile
OfflineConversionServiceApi offlineConversionServiceDownloadPost POST /OfflineConversionService/download
OfflineConversionServiceApi offlineConversionServiceGetPost POST /OfflineConversionService/get
OfflineConversionServiceApi offlineConversionServiceUploadPost POST /OfflineConversionService/upload
PageFeedItemServiceApi pageFeedItemServiceAddDownloadJobPost POST /PageFeedItemService/addDownloadJob
PageFeedItemServiceApi pageFeedItemServiceDownloadErrorFilePost POST /PageFeedItemService/downloadErrorFile
PageFeedItemServiceApi pageFeedItemServiceDownloadPost POST /PageFeedItemService/download
PageFeedItemServiceApi pageFeedItemServiceGetJobStatusPost POST /PageFeedItemService/getJobStatus
PageFeedItemServiceApi pageFeedItemServiceGetPost POST /PageFeedItemService/get
PageFeedItemServiceApi pageFeedItemServiceGetReviewSummaryPost POST /PageFeedItemService/getReviewSummary
PageFeedItemServiceApi pageFeedItemServiceUploadPost POST /PageFeedItemService/upload
ReportDefinitionServiceApi reportDefinitionServiceAddPost POST /ReportDefinitionService/add
ReportDefinitionServiceApi reportDefinitionServiceDownloadPost POST /ReportDefinitionService/download
ReportDefinitionServiceApi reportDefinitionServiceGetPost POST /ReportDefinitionService/get
ReportDefinitionServiceApi reportDefinitionServiceGetReportFieldsPost POST /ReportDefinitionService/getReportFields
ReportDefinitionServiceApi reportDefinitionServiceRemovePost POST /ReportDefinitionService/remove
RetargetingListServiceApi retargetingListServiceAddPost POST /RetargetingListService/add
RetargetingListServiceApi retargetingListServiceGetCustomKeyPost POST /RetargetingListService/getCustomKey
RetargetingListServiceApi retargetingListServiceGetPost POST /RetargetingListService/get
RetargetingListServiceApi retargetingListServiceSetPost POST /RetargetingListService/set
SharedCriterionServiceApi sharedCriterionServiceAddPost POST /SharedCriterionService/add
SharedCriterionServiceApi sharedCriterionServiceGetPost POST /SharedCriterionService/get
SharedCriterionServiceApi sharedCriterionServiceRemovePost POST /SharedCriterionService/remove
TargetingIdeaServiceApi targetingIdeaServiceGetPost 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

Generated API for Yahoo JP based on OpenAPI spec

Resources

Readme
Activity

Stars

1 star

Watchers

2 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages