forked from keifujikawa/sponsored-search-api-php-samples
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathreadme_EN.txt
75 lines (62 loc) · 3 KB
/
readme_EN.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
--------------------------------
[Version]
--------------------------------
Version 201909
- Change logs
-----------
2019/09/25:
- 201909 is now available.
--------------------------------
[Overview]
--------------------------------
These code samples show how to use APIs through PHP.
We utilize SoapClient Library to call APIs.
--------------------------------
[Contents]
--------------------------------
conf/
- api_config.ini : Config files to specify Ids.
src/Jp/YahooApis/SS/
- V201909 : PHP Entity classes for written versions (V201909).
- AdApiSample/
- Basic/ : Examples of each services.
- Feature/ : Examples of how to create ads, set targeting.
- Repository/ : Utilities which help you use the code samples.
- Util/ : Utilities which help you use the code samples.
download/ : Directory where downloaded files stored when using download feature.
upload/ : Directory where uploaded files stored when using upload feature.
--------------------------------
[Feature]
--------------------------------
src/Jp/YahooApis/SS/AdApiSample/Feature/
- AdCustomizerSample.php : Examples of AdCustomizer features.
- AdDisplayOptionSample.php : Examples of AdDisplayOption features.
- AdSample.php : Examples of AdvancedUrl features.
- DynamicAdsForSearchSample.php : Examples of DynamicAdsForSearch features.
- LabelSample.php : Examples of Label features.
- SharedNegativeCampaignCriterionSample.php : Examples of SharedNegativeCampaignCriterion features.
- SiteRetargetingSample.php : Examples of SiteRetargeting features.
- StructuredSnippetSample.php : Examples of StructuredSnippet features.
--------------------------------
[Development environment]
--------------------------------
Regardless of the operation system you use (wheter windows, unix or not), install software mentioned below.
1. PHP 7.2.x or above
2. Extensions which are written in composer.json
3. Write Ids in conf/api_config.ini like this.
- location : choose either sandbox or production environment by removing comment out.
- license : API license
- apiAccountId : API account id
- apiAccountPassword : API account password
- onBehalfOfAccountId : On Behalf Of Account Id (optional)
- onBehalfOfPassword : On Behalf Of Password (optional)
- accountId : AccountId (required)
--------------------------------
[How to execute Sample Code]
--------------------------------
Move into the directory where you cloned and execute the command below.
- Example
$ php ./src/Jp/YahooApis/SS/AdApiSample/Basic/Account/AccountServiceSample.php
$ php ./src/Jp/YahooApis/SS/AdApiSample/Feature/AdSample.php
*1 Downloaded files are stored in "download"directory when downloading data.
*2 The file is required to be put on "upload" directory before uploading data.