FAQ

- Apply For API
- Account Management
- Other

Apply For API

How I can offer an additional administrator access for Yahoo! JAPAN Ads API?

You can add the access from Yahoo! Business Manager.
The Yahoo! JAPAN Business ID (hereinafter "business ID") that you apply use of Yahoo! JAPAN Ads API with will be given the administrator access.
Log in with the same business ID, and add users in your company (business ID holders) as an administrator of "Yahoo! JAPAN Ads API Management Console".
Please refer to the help page below for details on setting procedures.
- Adding or changing tool administrator (Yahoo! Business Manager Help) *Japanese document only.

Do I need to re-contract when the jurisdiction of our API team changes in our company?

Yahoo! JAPAN Ads API Terms of Use requires a contract by each company.
It means that you don't need to re-contract after the jurisdiction of your API team changed.

What do I need to take care of when outsourcing application development?

Following procedure is required on outsourcing application development.
- Conclude a contract that is same to the rule laid down in Article 18 Confidentiality of Yahoo! JAPAN Ads API Terms of Use to your outsourcer of the development.
- When Yahoo! JAPAN request a disclosure of information regarding your outsourcer, it is required to notify the outsourcer information such as company name.
Learn more detail on Yahoo! JAPAN Ads API Terms of Use.

Can I share the authentication information with our outsourcer of development?

Please make sure the Article 7 of Yahoo! JAPAN Ads API Terms of Use.

We received a request from our client to develop a system using API.
Who should apply for API? The client? Or from us?

It differs depending on the contract type between the client and the developer company.
For example, in the case of outsourcing agreement, it is advisable to apply for API from the client side, because the assets of the system belongs to the client.
Please contact us from the Inquiry form placed at the bottom part of this page for any question.

Account Management

Is there any difference between administrator permission and user permission in Yahoo! JAPAN Ads API?

The operation that can be performed in Yahoo! JAPAN Ads API Management Console differs between administrator permission and user permission.
Please refer to the table below for the available operation for each permission.

What technical supports can I expect?

Following supports are available for our API users.
Please contact us from the Inquiry form placed at the bottom of this page.
- Inquiry about implementation of interface level
- Inquiry about Yahoo! JAPAN Ads API specification
- Inquiry about defects resulting from our side

Following inquiries are not supported.
- Inquiry about Yahoo! JAPAN Ads specification * Please ask from Yahoo! JAPAN Ads Help.
- Inquiry about the application source code developed by Yahoo! JAPAN Ads API user
- Inquiry about a specific programming language
- Inquiry about user environment such as installation, server, network, etc.
- Inquiry about behavior of sample program
- Customize of sample program
- Coordination of external tools

Can I use the same functions as production with test account?

Yes, you can. Please note that ad contents created on test account are not delivered, so performance data such as report is not available.
Please refer to the following page for information about test accounts.
- Test Account

Can I check about test account and ad contents created by test account on the Campaign Management Tool?

No, you cannot.

Will the ad contents created on test account be reset in some cases?

No, it won't.

Can I request a sample report?

No, we don't offer a sample report.
Learn more about reports in detail by downloading the report definition from the following API reference (GitHub).
- Yahoo! JAPAN Ads Search Ads API
- Yahoo! JAPAN Ads Display Ads API

Does the number of request restrictions (QPS) count by each application?

It's max. 1/sec for Search Ads API "proposal" type only. By each API service type, it's max. 5/sec for others.
Please note that requests on production account and test account, and requests on Search Ads and Requests on Display Ads are counted separately even if any request of the same service.
You can refer to Request Restrictions (QPS).

How I can request regenerating client secret?

The client secret can be regenerated when the person in charge of Yahoo! JAPAN Ads API changed or the client secret was leaked.
Please refer to the help pages below for details on setting procedures.
- Edit Application

How can I download YAML file of OpenAPI Specification?

It is available from the following URL link.
- Yahoo! JAPAN Ads Search Ads API
- Yahoo! JAPAN Ads Display Ads API

Why can I get no response from API for maxCpc?

maxCpc is not available for ad groups under the campaigns (campaign by goal) created on Display Ads (Auction).
maxCpc is available only on ad groups under the campaigns of Display Ads (YDN).
Learn about the difference between Display Ads (Auction) and Display Ads (YDN) on About Display Ads (Auction).

*Yahoo! JAPAN Display Ads (YDN) was discontinued in June 2021.
maxCpc is a field exclusive for Display Ads (YDN) and cannot be used in Display Ads (Auction).

Why does an error occur on specifying ad distribution type on adProductType?

There is a possibility of following cases. Confirm the error code and find a case.

Case 1: Using API with account of Display Ads (YDN)
Available ad distribution types vary by account.
Confirm available ad distribution type by get of AccountAdProductService.

Case 2: Using API with account of Display Ads (Auction)
There is no ad distribution type on Display Ads (Auction).
Create a campaign by goal to set an appropriate ad type for your campaign.
Confirm details on accountAuthorities of AccountService.

*Yahoo! JAPAN Display Ads (YDN) was discontinued in June 2021.
adProductType is a field exclusive for Display Ads (YDN) and cannot be used in Display Ads (Auction).

An API error occurred. How can I do?

Confirm error codes described on Reference.
- Yahoo! JAPAN Ads Search Ads API
- Yahoo! JAPAN Ads Display Ads API

If the error cannot be fixed, contact us via the following inquiry form.
Please include the following information when you request.
- Client ID
- Type and version of using API
- Error detail *Please describe the details as much as possible such as what occurred, when (including your time zone), frequency, account ID, entity ID, etc.
- API request/response
- image file
- other attachment

How can I get the information when there is a system fault on Yahoo! JAPAN Ads API?

Please confirm on "Announcement" in Yahoo! JAPAN Ads API Developer Center about API system fault.

Is it possible to let the users to use our developed application without showing them the authorization screen?

When using the application, the authorization screen will be displayed in any case.
Display of the said screen cannot be avoided.

When does the refresh token expire?

It will expire in the following cases.
- Deleted the application
- User revoked the authorization of application (access cancelled)
- Revoke operation was called
- Conflicted with Article 20 Number 1 of Yahoo! JAPAN Ads API Terms of Use

If multiple refresh tokens were issued within the same client ID, are previously issued tokens still valid?

All refresh tokens are valid, including the previously issued refresh token.

Are there any conditions for issuing refresh tokens?

There is no limit for validity time and the number of issues.
Furthermore, there are no other conditions.

When does the access token expire?

It will expire if any of the following applies.
- Validity time (1 hour after being issued) has exceeded
- Deleted the application
- User revoked the authorization of application that was approved using Yahoo! JAPAN Business ID
- Revoke operation was called
- Conflicted with Article 20 Number 1 of Yahoo! JAPAN Ads API Terms of Use
Please refer to the following page for information about reacquiring access tokens.
- API call

How can I receive notification of enhancement and version up?

We will send emails to the address set on your Yahoo! JAPAN Business ID (Business ID) that you used to apply Yahoo! JAPAN Ads API.
And those information will be published on "Announcement" of this Developer Center website.

Which currency can we select?

You can select only Japanese Yen.

Which time zone will be applied?

Only in Japan local time (JST).

Is there any documents that we can refer the use cases, how to use, operations for each API?

Please refer to the best practice below.
- Yahoo! JAPAN Ads Search Ads API
- Yahoo! JAPAN Ads Display Ads API

Can we test the uploading of offline conversion via API using test accounts?

When obtaining processStatus in OfflineConversionService/get, DONE_WITH_ERROR will be returned and the uploading will fail.

Is offline conversion provided for Yahoo! JAPAN Ads Display Ads? Or do I need to created another one separately?

Offline conversions are only provided for Yahoo! JAPAN Ads Search Ads.

Is there a recommended environment or language for API development?

We do not have a recommended environment or language.
We provide sample programs for Java, PHP, Python, and Ruby.
- Sample programs

(Yahoo! JAPAN Ads Search Ads API)
When adding report definition (ReportDefinitionService/add), if I specified "DAY" in fields[], will the specification of "reportIncludeZeroImpressions" be nullified?

Yes. In Yahoo! JAPAN Ads Search Ads API, if you specified "DAY" in fields[] when adding report definition via ReportDefinitionService/add, the specification of "reportIncludeZeroImpression" will be nullified.
*In ReportDefinitionService/add, if you specified "fieldName": "DAY", even if you specified "ReportIncludeZeroImpressions" as 'TRUE', it will be returned with a line of 0 impression.

(Yahoo! JAPAN Ads Display Ads API)
In StatsService/get, if I requested with "REALTIME_TODAY" specified as statsPeriod after the date has changed, will it be returned with an empty result?

Yes. If you requested with "REALTIME_TODAY" as statsPeriod after the date has changed, an empty result will be returned until the process for updating statistical information is completed.

Other

Will Yahoo! JAPAN Ads Search Ads API and Yahoo! JAPAN Ads Display Ads API be merged?

There is no plan to merge.

How can I publish a press release about the conclusion of Yahoo! JAPAN Ads API contracts?

Before publishing a press release regarding our service, it has to be reviewed on our side.
Please contact us from the Inquiry form placed at the bottom of this page.

Can we continue to use API after business transfer?

Please contact us via the following inquiry form with your details.
We will reply you after confirmation.
Note that disclosure of confidential information may be required based on Yahoo! JAPAN Ads API Terms of Use for further consideration.

How can I receive/quit API alert mails?

The announcement mail for Yahoo! JAPAN Ads API will be sent to the registered email address of the following Yahoo! JAPAN Business ID (hereinafter referred to as business ID).
- Contractor of Yahoo! JAPAN Ads API
- Administrator and user of Yahoo! JAPAN Ads API Management Console
If the above items applies, you cannot stop the reception of an announcement mail. We hope for your understanding.

If you want to receive an announcement mail, add the business ID of the recipient to Yahoo! JAPAN Ads API Management Console.
For procedures to add user to the tool, please refer to the following pages.
- Granting tool user permission (Adding tool users) (Yahoo! Business Manager Help)
- Change the employees email address (Yahoo! Business Manager Help)
*Japanese document only.

How can I get the permission to access Yahoo! JAPAN Ads API Management Console when I don't own the business ID for the console?

If "Yahoo! Ads API Management Console" is not displayed in the Available Tools when you logged in to Yahoo! JAPAN Business Center with the said business ID, that business ID does not have any permission (administrator permission or user permission) for API Management Console.
If you need a permission for API, please request your tool administrator to grant a permission.

How can I terminate my Yahoo! JAPAN Ads API account?

Please contact us from the Inquiry form placed at the bottom part of this page with "Yahoo! JAPAN Ads API in general" selected for the item "API", and the following details filled in "Describe your question in detail" item.
We will confirm the details and contact you. The termination process will be completed in approximately 5 business days after the confirmation.

[Details to be filled]
- Your company name
- Yahoo! JAPAN Business ID with "Administrator access to Yahoo! JAPAN Ads API Management Console" and "Organization permission" and a full name of person registered in the said business ID
- A full name and email address of person requesting for termination

Need help?

If you have any question about Yahoo! JAPAN Ads API, please use the following inquiry forms to contact us.

- For customers who have not yet applied to use Yahoo! JAPAN Ads API
- For customers who are currently using Yahoo! JAPAN Ads API　※Please have your Yahoo! JAPAN business ID that can access to API console to sign