/
v8v9_display-ads_diff.txt
2602 lines (2508 loc) · 196 KB
/
v8v9_display-ads_diff.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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
------
diff -ru v8/Route.yaml v9/Route.yaml
--- v8/Route.yaml 2022-09-30 11:54:54.000000000 +0900
+++ v9/Route.yaml 2022-09-30 11:54:55.000000000 +0900
@@ -1,11 +1,11 @@
openapi: 3.0.2
info:
title: 'Yahoo!広告 ディスプレイ広告 API リファレンス / Yahoo! JAPAN Ads Display Ads API Reference'
- version: 'v8'
+ version: 'v9'
description: |
<div lang="ja">Yahoo!広告 ディスプレイ広告 APIのWebサービスについて説明します。</div>
<div lang="en">Display Ads API Web Services supported in Yahoo! JAPAN Ads API.</div>
- <div><a target="_blank" href="https://github.com/yahoojp-marketing/ads-display-api-documents/blob/master/design/v8/Route.yaml">OpenAPI Specification</a></div>
+ <div><a target="_blank" href="https://github.com/yahoojp-marketing/ads-display-api-documents/blob/master/design/v9/Route.yaml">OpenAPI Specification</a></div>
<div lang="ja"><a target="_blank" href="https://github.com/yahoojp-marketing/ads-display-api-documents/blob/master/bestpractice/ja">Best Practice</a></div>
<div lang="en"><a target="_blank" href="https://github.com/yahoojp-marketing/ads-display-api-documents/blob/master/bestpractice/en">Best Practice</a></div>
@@ -23,9 +23,20 @@
- oAuth: [yahooads]
servers:
- - url: https://ads-display.yahooapis.jp/api/v8
+ - url: https://ads-display.yahooapis.jp/api/v9
tags:
+ - name: AbTestService
+ description: |
+ <label class="campaign"></label>
+ <div lang="ja">
+ AbTestServiceでは、A/Bテストに関する情報の取得および、追加、更新を行います。<br>
+ ※現在、こちらのサービスは利用できません。
+ </div>
+ <div lang="en">
+ AbTestService provides functions for creating and managing A/B test.<br>
+ *Currently this service is not available.
+ </div>
- name: AccountManagementService
description: |
<label class="account"></label>
@@ -92,6 +103,11 @@
<label class="account"></label>
<div lang="ja">RetargetingTagServiceでは、サイトリターゲティングのタグに関する情報の取得・作成を行います。</div>
<div lang="en">RetargetingTagService retrieves the site retargeting tag information.</div>
+ - name: AppLinkService
+ description: |
+ <label class="account"></label>
+ <div lang="ja">AppLinkServiceでは、アプリ連携に関する情報の取得を行います。</div>
+ <div lang="en">AppLinkService retrieves the app link information.</div>
- name: PlacementUrlIdeaService
description: |
<label class="campaign"></label>
@@ -156,17 +172,17 @@
<h2 lang="ja">レポートフィールド</h2>
<h2 lang="en">Report Fields</h2>
<ul>
- <li><div lang="ja"><a href="./reports/v8/AD.csv" download>広告レポート(アカウントレポート、キャンペーンレポート、広告グループレポート、リンク先URLレポート)</a></div></li><li><div lang="en"><a href="./reports/v8/AD.csv" download>Ad reports (Account report, Campaign report, Ad group report, Destination URL report)</a></div></li>
- <li><div lang="ja"><a href="./reports/v8/AUDIENCE_CATEGORY.csv" download>オーディエンスカテゴリーレポート</a></div></li><li><div lang="en"><a href="./reports/v8/AUDIENCE_CATEGORY.csv" download>Audience category report</a></div></li>
- <li><div lang="ja"><a href="./reports/v8/SITE_CATEGORY.csv" download>サイトカテゴリーレポート</a></div></li><li><div lang="en"><a href="./reports/v8/SITE_CATEGORY.csv" download>Site category report</a></div></li>
- <li><div lang="ja"><a href="./reports/v8/URL.csv" download>配信先URLレポート</a></div></li><li><div lang="en"><a href="./reports/v8/URL.csv" download>Ad Delivery URL report</a></div></li>
- <li><div lang="ja"><a href="./reports/v8/REACH.csv" download>リーチレポート</a></div></li><li><div lang="en"><a href="./reports/v8/REACH.csv" download>Reach report</a></div></li>
- <li><div lang="ja"><a href="./reports/v8/AUDIENCE_LIST.csv" download>オーディエンスリストターゲティング</a></div></li><li><div lang="en"><a href="./reports/v8/AUDIENCE_LIST.csv" download>Audience list targeting report</a></div></li>
- <li><div lang="ja"><a href="./reports/v8/SEARCH_KEYWORD_LIST.csv" download>サーチターゲティング</a></div></li><li><div lang="en"><a href="./reports/v8/SEARCH_KEYWORD_LIST.csv" download>Search targeting report</a></div></li>
- <li><div lang="ja"><a href="./reports/v8/PLACEMENT_LIST.csv" download>プレイスメントターゲティング</a></div></li><li><div lang="en"><a href="./reports/v8/PLACEMENT_LIST.csv" download>Placement targeting report</a></div></li>
- <li><div lang="ja"><a href="./reports/v8/LABEL.csv" download>ラベルレポート</a></div></li><li><div lang="en"><a href="./reports/v8/LABEL.csv" download>Label report</a></div></li>
- <li><div lang="ja"><a href="./reports/v8/CROSS_CAMPAIGN_REACHES.csv" download>横断リーチレポート</a></div></li><li><div lang="en"><a href="./reports/v8/CROSS_CAMPAIGN_REACHES.csv" download>Cross-campaign Reach Report</a></div></li>
- <li><div lang="ja"><a href="./reports/v8/CONVERSION_PATH.csv" download>コンバージョン経路レポート</a></div></li><li><div lang="en"><a href="./reports/v8/CONVERSION_PATH.csv" download>Conversion Path Report</a></div></li>
+ <li><div lang="ja"><a href="./reports/v9/AD.csv" download>広告レポート(アカウントレポート、キャンペーンレポート、広告グループレポート、リンク先URLレポート)</a></div></li><li><div lang="en"><a href="./reports/v9/AD.csv" download>Ad reports (Account report, Campaign report, Ad group report, Destination URL report)</a></div></li>
+ <li><div lang="ja"><a href="./reports/v9/AUDIENCE_CATEGORY.csv" download>オーディエンスカテゴリーレポート</a></div></li><li><div lang="en"><a href="./reports/v9/AUDIENCE_CATEGORY.csv" download>Audience category report</a></div></li>
+ <li><div lang="ja"><a href="./reports/v9/SITE_CATEGORY.csv" download>サイトカテゴリーレポート</a></div></li><li><div lang="en"><a href="./reports/v9/SITE_CATEGORY.csv" download>Site category report</a></div></li>
+ <li><div lang="ja"><a href="./reports/v9/URL.csv" download>配信先URLレポート</a></div></li><li><div lang="en"><a href="./reports/v9/URL.csv" download>Ad Delivery URL report</a></div></li>
+ <li><div lang="ja"><a href="./reports/v9/REACH.csv" download>リーチレポート</a></div></li><li><div lang="en"><a href="./reports/v9/REACH.csv" download>Reach report</a></div></li>
+ <li><div lang="ja"><a href="./reports/v9/AUDIENCE_LIST.csv" download>オーディエンスリストターゲティング</a></div></li><li><div lang="en"><a href="./reports/v9/AUDIENCE_LIST.csv" download>Audience list targeting report</a></div></li>
+ <li><div lang="ja"><a href="./reports/v9/SEARCH_KEYWORD_LIST.csv" download>サーチターゲティング</a></div></li><li><div lang="en"><a href="./reports/v9/SEARCH_KEYWORD_LIST.csv" download>Search targeting report</a></div></li>
+ <li><div lang="ja"><a href="./reports/v9/PLACEMENT_LIST.csv" download>プレイスメントターゲティング</a></div></li><li><div lang="en"><a href="./reports/v9/PLACEMENT_LIST.csv" download>Placement targeting report</a></div></li>
+ <li><div lang="ja"><a href="./reports/v9/LABEL.csv" download>ラベルレポート</a></div></li><li><div lang="en"><a href="./reports/v9/LABEL.csv" download>Label report</a></div></li>
+ <li><div lang="ja"><a href="./reports/v9/CROSS_CAMPAIGN_REACHES.csv" download>横断リーチレポート</a></div></li><li><div lang="en"><a href="./reports/v9/CROSS_CAMPAIGN_REACHES.csv" download>Cross-campaign Reach Report</a></div></li>
+ <li><div lang="ja"><a href="./reports/v9/CONVERSION_PATH.csv" download>コンバージョン経路レポート</a></div></li><li><div lang="en"><a href="./reports/v9/CONVERSION_PATH.csv" download>Conversion Path Report</a></div></li>
</ul>
- name: MediaService
description: |
@@ -292,17 +308,6 @@
<div lang="en">Use this service to get and update guaranteed campaign.<br>
The maximum number of campaigns that can be added per account includes the campaign number of both CampaignService and GuaranteedCampaignService.
</div>
- - name: GuaranteedReservationService
- description: |
- <label class="campaign"></label>
- <div lang="ja">GuaranteedReservationServiceでは、GuaranteedSimulationServiceで実施したシミュレーション結果をもとにキャンペーンに指定された掲載期間、配信量を予約します。<br>
- 配信時は予約された内容を保証して配信を実施します。<br>
- ディスプレイ広告（予約型）に関する詳細については、以下のリンクもご参照ください。<br>
- <a href="https://ads-help.yahoo.co.jp/yahooads/rf/articledetail?lan=ja&aid=72885&o=default">予約型のキャンペーンを作成する（予約する）</a>
- </div>
- <div lang="en"> GuaranteedReservationService reserves delivery period and delivery volume specified in campaign based on simulation result obtained via GuaranteedSimulationService. <br>
- It will be delivered with guarantee of the reserved contents.
- </div>
- name: GuaranteedAdGroupService
description: |
<label class="campaign"></label>
@@ -331,39 +336,6 @@
<div lang="en">Use this service to get, add and update guaranteed ad.<br>
Use AdGroupAdService/remove to delete the guaranteed ad.
</div>
- - name: GuaranteedSimulationService
- description: |
- <label class="campaign"></label>
- <div lang="ja">
- GuaranteedSimulationServiceでは、予約型キャンペーンの配信シミュレーションの実施や、商品・広告カテゴリ一覧の取得を行います。<br>
- ディスプレイ広告（予約型）に関する詳細については、以下のリンクもご参照ください。<br>
- <a href="https://ads-help.yahoo.co.jp/yahooads/rf/articledetail?lan=ja&aid=72966&o=default">ディスプレイ広告（予約型）の商品について</a>
- </div>
- <div lang="en">
- GuaranteedSimulationService implements the delivery simulation and returns list of package/ad categories on the guaranteed campaign.
- </div>
- - name: GuaranteedPreviewService
- description: |
- <label class="campaign"></label>
- <div lang="ja">
- GuaranteedPreviewServiceでは、予約型キャンペーンのプレビューURLの取得を行います。
- </div>
- <div lang="en">
- GuaranteedPreviewService returns the preview URL of the guaranteed campaign.<br>
- </div>
- - name: GuaranteedInventoryService
- description: |
- <label class="campaign"></label>
- <div lang="ja">
- GuaranteedInventoryServiceでは、予約型キャンペーンの配信シミュレーションの実施や、商品の在庫情報の取得を行います。<br>
- ディスプレイ広告（予約型）に関する詳細については、以下のリンクもご参照ください。<br>
- <a href="https://ads-help.yahoo.co.jp/yahooads/rf/articledetail?lan=ja&aid=72966&o=default">ディスプレイ広告（予約型）の商品について</a>
- </div>
- <div lang="en">
- GuaranteedInventoryService executes delivery simulation of guaranteed campaign and obtains inventory information of a product. <br>
- Refer to the following link for more information about Yahoo! JAPAN Ads Display Ads (Guaranteed). <br>
- <a href="https://ads-help.yahoo.co.jp/yahooads/rf/articledetail?lan=ja&aid=72966&o=default">About Yahoo! JAPAN Ads Display Ads (Guaranteed) products</a>
- </div>
- name: BudgetOrderService
description: |
<label class="account"></label>
@@ -381,6 +353,238 @@
<div lang="en">ConversionGroupService provides ConversionGroup information operations.</div>
paths:
+ /AbTestService/get:
+ post:
+ description: |
+ <div lang="ja">
+ A/Bテストの情報を取得します。<br>
+ ※現在、こちらのサービスは利用できません。
+ </div>
+ <div lang="en">
+ Retrieves A/B test information.<br>
+ *Currently this service is not available.
+ </div>
+ tags:
+ - AbTestService
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: 'abtest/AbTestServiceSelector.yaml#/AbTestServiceSelector'
+ responses:
+ 503:
+ $ref: '../Response503.yaml#/Response503'
+ 500:
+ $ref: '../Response500.yaml#/Response500'
+ 403:
+ $ref: '../Response403.yaml#/Response403'
+ 401:
+ $ref: '../Response401.yaml#/Response401'
+ 400:
+ $ref: '../Response400.yaml#/Response400'
+ 200:
+ description: |
+ <p class="cellContent__head">Error codes</p>
+ <div class="cellContent__body">
+ <table class="apiTable">
+ <colgroup span="1" class="short"></colgroup>
+ <colgroup span="2"></colgroup>
+ <thead>
+ <tr><th>Code</th><th>Message</th><th>Description</th></tr>
+ </thead>
+ <tbody>
+ <tr><td>0001</td><td>Invalid Request.</td><td><div lang="ja">さまざまな要因が考えられます。<br>主な要因は、パラメータの値が不正か、誤りがあるためにオペレーションが完了できません。</div><div lang="en">This error can result for a variety of reasons. <br>Typically because one of the parameter values in the request is wrong or invalid and the operation cannot be completed.</div></td></tr>
+ <tr><td>R0001</td><td>Require.</td><td><div lang="ja">必須です。</div><div lang="en">It is missing required parameter.</div></td></tr>
+ <tr><td>V0001</td><td>Invalid value.</td><td><div lang="ja">値が無効です。</div><div lang="en">The value is invalid.</div></td></tr>
+ <tr><td>I0001</td><td>Deactivated Id.</td><td><div lang="ja">IDが無効です。</div><div lang="en">The ID is Deactivated.</div></td></tr>
+ <tr><td>F0001</td><td>Invalid format.</td><td><div lang="ja">値の形式が不正です。</div><div lang="en">The value format is invalid.</div></td></tr>
+ <tr><td>L0002</td><td>Over list size.</td><td><div lang="ja">配列の要素数が上限値を超過しています。</div><div lang="en">The number of elements in the array exceeds the upper limit.</div></td></tr>
+ <tr><td>D0001</td><td>Duplicate.</td><td><div lang="ja">一意な値が重複しています。</div><div lang="en">The unique value is duplicated.</div></td></tr>
+ <tr><td>RL001</td><td>Invalid relation.</td><td><div lang="ja">リクエストの関連性が矛盾しています。<br> たとえば、開始＞終了の日付指定を行なっているなど</div><div lang="en">The relation of the request is contradictory.<br> For example, you are specifying the date of start > end.</div></td></tr>
+ <tr><td>L0001</td><td>Lower list size.</td><td><div lang="ja">配列の要素数が下限値を下回っています。</div><div lang="en">The number of elements in the array is below the lower limit.</div></td></tr>
+ <tr><td>120020</td><td>Can not set value.</td><td><div lang="ja">値を設定することができません。</div><div lang="en">Value cannot be set.</div></td></tr>
+ <tr><td>LT001</td><td>Over limit.</td><td><div lang="ja">登録できる上限値を超過しています。</div><div lang="en">The upper limit value that can be registered is exceeded.</div></td></tr>
+ </tbody>
+ </table>
+ </div>
+ content:
+ application/json:
+ schema:
+ $ref: 'abtest/AbTestServiceGetResponse.yaml#/AbTestServiceGetResponse'
+ /AbTestService/add:
+ post:
+ description: |
+ <div lang="ja">
+ A/Bテストを追加します。<br>
+ ※現在、こちらのサービスは利用できません。
+ </div>
+ <div lang="en">
+ Adds A/B test.<br>
+ *Currently this service is not available.
+ </div>
+ tags:
+ - AbTestService
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: 'abtest/AbTestServiceOperation.yaml#/AbTestServiceOperation'
+ responses:
+ 503:
+ $ref: '../Response503.yaml#/Response503'
+ 500:
+ $ref: '../Response500.yaml#/Response500'
+ 403:
+ $ref: '../Response403.yaml#/Response403'
+ 401:
+ $ref: '../Response401.yaml#/Response401'
+ 400:
+ $ref: '../Response400.yaml#/Response400'
+ 200:
+ description: |
+ <p class="cellContent__head">Error codes</p>
+ <div class="cellContent__body">
+ <table class="apiTable">
+ <colgroup span="1" class="short"></colgroup>
+ <colgroup span="2"></colgroup>
+ <thead>
+ <tr><th>Code</th><th>Message</th><th>Description</th></tr>
+ </thead>
+ <tbody>
+ <tr><td>0001</td><td>Invalid Request.</td><td><div lang="ja">さまざまな要因が考えられます。<br>主な要因は、パラメータの値が不正か、誤りがあるためにオペレーションが完了できません。</div><div lang="en">This error can result for a variety of reasons. <br>Typically because one of the parameter values in the request is wrong or invalid and the operation cannot be completed.</div></td></tr>
+ <tr><td>R0001</td><td>Require.</td><td><div lang="ja">必須です。</div><div lang="en">It is missing required parameter.</div></td></tr>
+ <tr><td>V0001</td><td>Invalid value.</td><td><div lang="ja">値が無効です。</div><div lang="en">The value is invalid.</div></td></tr>
+ <tr><td>I0001</td><td>Deactivated Id.</td><td><div lang="ja">IDが無効です。</div><div lang="en">The ID is Deactivated.</div></td></tr>
+ <tr><td>F0001</td><td>Invalid format.</td><td><div lang="ja">値の形式が不正です。</div><div lang="en">The value format is invalid.</div></td></tr>
+ <tr><td>L0002</td><td>Over list size.</td><td><div lang="ja">配列の要素数が上限値を超過しています。</div><div lang="en">The number of elements in the array exceeds the upper limit.</div></td></tr>
+ <tr><td>D0001</td><td>Duplicate.</td><td><div lang="ja">一意な値が重複しています。</div><div lang="en">The unique value is duplicated.</div></td></tr>
+ <tr><td>RL001</td><td>Invalid relation.</td><td><div lang="ja">リクエストの関連性が矛盾しています。<br> たとえば、開始＞終了の日付指定を行なっているなど</div><div lang="en">The relation of the request is contradictory.<br> For example, you are specifying the date of start > end.</div></td></tr>
+ <tr><td>L0001</td><td>Lower list size.</td><td><div lang="ja">配列の要素数が下限値を下回っています。</div><div lang="en">The number of elements in the array is below the lower limit.</div></td></tr>
+ <tr><td>120020</td><td>Can not set value.</td><td><div lang="ja">値を設定することができません。</div><div lang="en">Value cannot be set.</div></td></tr>
+ <tr><td>LT001</td><td>Over limit.</td><td><div lang="ja">登録できる上限値を超過しています。</div><div lang="en">The upper limit value that can be registered is exceeded.</div></td></tr>
+ </tbody>
+ </table>
+ </div>
+ content:
+ application/json:
+ schema:
+ $ref: 'abtest/AbTestServiceMutateResponse.yaml#/AbTestServiceMutateResponse'
+ /AbTestService/set:
+ post:
+ description: |
+ <div lang="ja">
+ A/Bテストを変更します。<br>
+ ※現在、こちらのサービスは利用できません。
+ </div>
+ <div lang="en">
+ Updates information of A/B test.<br>
+ *Currently this service is not available.
+ </div>
+ tags:
+ - AbTestService
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: 'abtest/AbTestServiceOperation.yaml#/AbTestServiceOperation'
+ responses:
+ 503:
+ $ref: '../Response503.yaml#/Response503'
+ 500:
+ $ref: '../Response500.yaml#/Response500'
+ 403:
+ $ref: '../Response403.yaml#/Response403'
+ 401:
+ $ref: '../Response401.yaml#/Response401'
+ 400:
+ $ref: '../Response400.yaml#/Response400'
+ 200:
+ description: |
+ <p class="cellContent__head">Error codes</p>
+ <div class="cellContent__body">
+ <table class="apiTable">
+ <colgroup span="1" class="short"></colgroup>
+ <colgroup span="2"></colgroup>
+ <thead>
+ <tr><th>Code</th><th>Message</th><th>Description</th></tr>
+ </thead>
+ <tbody>
+ <tr><td>0001</td><td>Invalid Request.</td><td><div lang="ja">さまざまな要因が考えられます。<br>主な要因は、パラメータの値が不正か、誤りがあるためにオペレーションが完了できません。</div><div lang="en">This error can result for a variety of reasons. <br>Typically because one of the parameter values in the request is wrong or invalid and the operation cannot be completed.</div></td></tr>
+ <tr><td>R0001</td><td>Require.</td><td><div lang="ja">必須です。</div><div lang="en">It is missing required parameter.</div></td></tr>
+ <tr><td>V0001</td><td>Invalid value.</td><td><div lang="ja">値が無効です。</div><div lang="en">The value is invalid.</div></td></tr>
+ <tr><td>I0001</td><td>Deactivated Id.</td><td><div lang="ja">IDが無効です。</div><div lang="en">The ID is Deactivated.</div></td></tr>
+ <tr><td>F0001</td><td>Invalid format.</td><td><div lang="ja">値の形式が不正です。</div><div lang="en">The value format is invalid.</div></td></tr>
+ <tr><td>L0002</td><td>Over list size.</td><td><div lang="ja">配列の要素数が上限値を超過しています。</div><div lang="en">The number of elements in the array exceeds the upper limit.</div></td></tr>
+ <tr><td>D0001</td><td>Duplicate.</td><td><div lang="ja">一意な値が重複しています。</div><div lang="en">The unique value is duplicated.</div></td></tr>
+ <tr><td>RL001</td><td>Invalid relation.</td><td><div lang="ja">リクエストの関連性が矛盾しています。<br> たとえば、開始＞終了の日付指定を行なっているなど</div><div lang="en">The relation of the request is contradictory.<br> For example, you are specifying the date of start > end.</div></td></tr>
+ <tr><td>L0001</td><td>Lower list size.</td><td><div lang="ja">配列の要素数が下限値を下回っています。</div><div lang="en">The number of elements in the array is below the lower limit.</div></td></tr>
+ <tr><td>120020</td><td>Can not set value.</td><td><div lang="ja">値を設定することができません。</div><div lang="en">Value cannot be set.</div></td></tr>
+ <tr><td>LT001</td><td>Over limit.</td><td><div lang="ja">登録できる上限値を超過しています。</div><div lang="en">The upper limit value that can be registered is exceeded.</div></td></tr>
+ </tbody>
+ </table>
+ </div>
+ content:
+ application/json:
+ schema:
+ $ref: 'abtest/AbTestServiceMutateResponse.yaml#/AbTestServiceMutateResponse'
+ /AbTestService/remove:
+ post:
+ description: |
+ <div lang="ja">
+ A/Bテストを削除します。<br>
+ ※現在、こちらのサービスは利用できません。
+ </div>
+ <div lang="en">
+ Removes A/B test.<br>
+ *Currently this service is not available.
+ </div>
+ tags:
+ - AbTestService
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: 'abtest/AbTestServiceOperation.yaml#/AbTestServiceOperation'
+ responses:
+ 503:
+ $ref: '../Response503.yaml#/Response503'
+ 500:
+ $ref: '../Response500.yaml#/Response500'
+ 403:
+ $ref: '../Response403.yaml#/Response403'
+ 401:
+ $ref: '../Response401.yaml#/Response401'
+ 400:
+ $ref: '../Response400.yaml#/Response400'
+ 200:
+ description: |
+ <p class="cellContent__head">Error codes</p>
+ <div class="cellContent__body">
+ <table class="apiTable">
+ <colgroup span="1" class="short"></colgroup>
+ <colgroup span="2"></colgroup>
+ <thead>
+ <tr><th>Code</th><th>Message</th><th>Description</th></tr>
+ </thead>
+ <tbody>
+ <tr><td>0001</td><td>Invalid Request.</td><td><div lang="ja">さまざまな要因が考えられます。<br>主な要因は、パラメータの値が不正か、誤りがあるためにオペレーションが完了できません。</div><div lang="en">This error can result for a variety of reasons. <br>Typically because one of the parameter values in the request is wrong or invalid and the operation cannot be completed.</div></td></tr>
+ <tr><td>R0001</td><td>Require.</td><td><div lang="ja">必須です。</div><div lang="en">It is missing required parameter.</div></td></tr>
+ <tr><td>V0001</td><td>Invalid value.</td><td><div lang="ja">値が無効です。</div><div lang="en">The value is invalid.</div></td></tr>
+ <tr><td>I0001</td><td>Deactivated Id.</td><td><div lang="ja">IDが無効です。</div><div lang="en">The ID is Deactivated.</div></td></tr>
+ <tr><td>F0001</td><td>Invalid format.</td><td><div lang="ja">値の形式が不正です。</div><div lang="en">The value format is invalid.</div></td></tr>
+ <tr><td>L0002</td><td>Over list size.</td><td><div lang="ja">配列の要素数が上限値を超過しています。</div><div lang="en">The number of elements in the array exceeds the upper limit.</div></td></tr>
+ <tr><td>D0001</td><td>Duplicate.</td><td><div lang="ja">一意な値が重複しています。</div><div lang="en">The unique value is duplicated.</div></td></tr>
+ <tr><td>RL001</td><td>Invalid relation.</td><td><div lang="ja">リクエストの関連性が矛盾しています。<br> たとえば、開始＞終了の日付指定を行なっているなど</div><div lang="en">The relation of the request is contradictory.<br> For example, you are specifying the date of start > end.</div></td></tr>
+ <tr><td>L0001</td><td>Lower list size.</td><td><div lang="ja">配列の要素数が下限値を下回っています。</div><div lang="en">The number of elements in the array is below the lower limit.</div></td></tr>
+ <tr><td>120020</td><td>Can not set value.</td><td><div lang="ja">値を設定することができません。</div><div lang="en">Value cannot be set.</div></td></tr>
+ <tr><td>LT001</td><td>Over limit.</td><td><div lang="ja">登録できる上限値を超過しています。</div><div lang="en">The upper limit value that can be registered is exceeded.</div></td></tr>
+ </tbody>
+ </table>
+ </div>
+ content:
+ application/json:
+ schema:
+ $ref: 'abtest/AbTestServiceMutateResponse.yaml#/AbTestServiceMutateResponse'
/AccountManagementService/get:
post:
description: "<div lang=\"ja\">アカウントに関する情報を取得します。契約状況などのフィルタ条件を設定することが可能です。</div><div lang=\"en\">Returns the account information. Enable to set the filter condition, such as the account Type.</div>"
@@ -2431,18 +2635,18 @@
application/json:
schema:
$ref: 'retargetingtag/RetargetingTagServiceGetResponse.yaml#/RetargetingTagServiceGetResponse'
- /RetargetingTagService/add:
+ /AppLinkService/get:
post:
description: |
- <div lang="ja">サイトリターゲティングのタグに関する情報を作成します。</div>
- <div lang="en">Create an tag for site retargeting.</div>
+ <div lang="ja">アプリ連携に関する情報の取得を行います。</div>
+ <div lang="en">AppLinkService retrieves the app link information.</div>
tags:
- - RetargetingTagService
+ - AppLinkService
requestBody:
content:
application/json:
schema:
- $ref: 'retargetingtag/RetargetingTagServiceOperation.yaml#/RetargetingTagServiceOperation'
+ $ref: 'applinkservice/AppLinkServiceSelector.yaml#/AppLinkServiceSelector'
responses:
503:
$ref: '../Response503.yaml#/Response503'
@@ -2469,29 +2673,31 @@
<tr><td>R0001</td><td>Require.</td><td><div lang="ja">必須です。</div><div lang="en">It is missing required parameter.</div></td></tr>
<tr><td>V0001</td><td>Invalid value.</td><td><div lang="ja">値が無効です。</div><div lang="en">The value is invalid.</div></td></tr>
<tr><td>I0001</td><td>Deactivated Id.</td><td><div lang="ja">IDが無効です。</div><div lang="en">The ID is Deactivated.</div></td></tr>
- <tr><td>F0001</td><td>Invalid format.</td><td><div lang="ja">値の形式が不正です。</div><div lang="en">The value format is invalid.</div></td></tr>
- <tr><td>110005</td><td>Not a valid id.</td><td><div lang="ja">IDが有効ではありません。</div><div lang="en">Not a valid id.</div></td></tr>
<tr><td>L0002</td><td>Over list size.</td><td><div lang="ja">配列の要素数が上限値を超過しています。</div><div lang="en">The number of elements in the array exceeds the upper limit.</div></td></tr>
<tr><td>D0001</td><td>Duplicate.</td><td><div lang="ja">一意な値が重複しています。</div><div lang="en">The unique value is duplicated.</div></td></tr>
+ <tr><td>120020</td><td>Can not set value.</td><td><div lang="ja">値を設定することができません。</div><div lang="en">Value cannot be set.</div></td></tr>
+ <tr><td>F0001</td><td>Invalid format.</td><td><div lang="ja">値の形式が不正です。</div><div lang="en">The value format is invalid.</div></td></tr>
+ <tr><td>LT001</td><td>Over limit.</td><td><div lang="ja">登録できる上限値を超過しています。</div><div lang="en">The upper limit value that can be registered is exceeded.</div></td></tr>
+ <tr><td>RL001</td><td>Invalid relation.</td><td><div lang="ja">リクエストの関連性が矛盾しています。<br> たとえば、開始＞終了の日付指定を行なっているなど</div><div lang="en">The relation of the request is contradictory.<br> For example, you are specifying the date of start > end.</div></td></tr>
</tbody>
</table>
</div>
content:
application/json:
schema:
- $ref: 'retargetingtag/RetargetingTagServiceMutateResponse.yaml#/RetargetingTagServiceMutateResponse'
- /PlacementUrlIdeaService/get:
+ $ref: 'applinkservice/AppLinkServiceGetResponse.yaml#/AppLinkServiceGetResponse'
+ /RetargetingTagService/add:
post:
description: |
- <div lang="ja">URL候補を取得します。</div>
- <div lang="en">Can retrieve candidate URL.</div>
+ <div lang="ja">サイトリターゲティングのタグに関する情報を作成します。</div>
+ <div lang="en">Create an tag for site retargeting.</div>
tags:
- - PlacementUrlIdeaService
+ - RetargetingTagService
requestBody:
content:
application/json:
schema:
- $ref: 'placementurlidea/PlacementUrlIdeaServiceSelector.yaml#/PlacementUrlIdeaServiceSelector'
+ $ref: 'retargetingtag/RetargetingTagServiceOperation.yaml#/RetargetingTagServiceOperation'
responses:
503:
$ref: '../Response503.yaml#/Response503'
@@ -2522,7 +2728,56 @@
<tr><td>110005</td><td>Not a valid id.</td><td><div lang="ja">IDが有効ではありません。</div><div lang="en">Not a valid id.</div></td></tr>
<tr><td>L0002</td><td>Over list size.</td><td><div lang="ja">配列の要素数が上限値を超過しています。</div><div lang="en">The number of elements in the array exceeds the upper limit.</div></td></tr>
<tr><td>D0001</td><td>Duplicate.</td><td><div lang="ja">一意な値が重複しています。</div><div lang="en">The unique value is duplicated.</div></td></tr>
- <tr><td>RL001</td><td>Invalid relation.</td><td><div lang="ja">リクエストの関連性が矛盾しています。<br> たとえば、開始＞終了の日付指定を行なっているなど</div><div lang="en">The relation of the request is contradictory.<br> For example, you are specifying the date of start > end.</div></td></tr>
+ </tbody>
+ </table>
+ </div>
+ content:
+ application/json:
+ schema:
+ $ref: 'retargetingtag/RetargetingTagServiceMutateResponse.yaml#/RetargetingTagServiceMutateResponse'
+ /PlacementUrlIdeaService/get:
+ post:
+ description: |
+ <div lang="ja">URL候補を取得します。</div>
+ <div lang="en">Can retrieve candidate URL.</div>
+ tags:
+ - PlacementUrlIdeaService
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: 'placementurlidea/PlacementUrlIdeaServiceSelector.yaml#/PlacementUrlIdeaServiceSelector'
+ responses:
+ 503:
+ $ref: '../Response503.yaml#/Response503'
+ 500:
+ $ref: '../Response500.yaml#/Response500'
+ 403:
+ $ref: '../Response403.yaml#/Response403'
+ 401:
+ $ref: '../Response401.yaml#/Response401'
+ 400:
+ $ref: '../Response400.yaml#/Response400'
+ 200:
+ description: |
+ <p class="cellContent__head">Error codes</p>
+ <div class="cellContent__body">
+ <table class="apiTable">
+ <colgroup span="1" class="short"></colgroup>
+ <colgroup span="2"></colgroup>
+ <thead>
+ <tr><th>Code</th><th>Message</th><th>Description</th></tr>
+ </thead>
+ <tbody>
+ <tr><td>0001</td><td>Invalid Request.</td><td><div lang="ja">さまざまな要因が考えられます。<br>主な要因は、パラメータの値が不正か、誤りがあるためにオペレーションが完了できません。</div><div lang="en">This error can result for a variety of reasons. <br>Typically because one of the parameter values in the request is wrong or invalid and the operation cannot be completed.</div></td></tr>
+ <tr><td>R0001</td><td>Require.</td><td><div lang="ja">必須です。</div><div lang="en">It is missing required parameter.</div></td></tr>
+ <tr><td>V0001</td><td>Invalid value.</td><td><div lang="ja">値が無効です。</div><div lang="en">The value is invalid.</div></td></tr>
+ <tr><td>I0001</td><td>Deactivated Id.</td><td><div lang="ja">IDが無効です。</div><div lang="en">The ID is Deactivated.</div></td></tr>
+ <tr><td>F0001</td><td>Invalid format.</td><td><div lang="ja">値の形式が不正です。</div><div lang="en">The value format is invalid.</div></td></tr>
+ <tr><td>110005</td><td>Not a valid id.</td><td><div lang="ja">IDが有効ではありません。</div><div lang="en">Not a valid id.</div></td></tr>
+ <tr><td>L0002</td><td>Over list size.</td><td><div lang="ja">配列の要素数が上限値を超過しています。</div><div lang="en">The number of elements in the array exceeds the upper limit.</div></td></tr>
+ <tr><td>D0001</td><td>Duplicate.</td><td><div lang="ja">一意な値が重複しています。</div><div lang="en">The unique value is duplicated.</div></td></tr>
+ <tr><td>RL001</td><td>Invalid relation.</td><td><div lang="ja">リクエストの関連性が矛盾しています。<br> たとえば、開始＞終了の日付指定を行なっているなど</div><div lang="en">The relation of the request is contradictory.<br> For example, you are specifying the date of start > end.</div></td></tr>
<tr><td>L0001</td><td>Lower list size.</td><td><div lang="ja">配列の要素数が下限値を下回っています。</div><div lang="en">The number of elements in the array is below the lower limit.</div></td></tr>
<tr><td>120020</td><td>Can not set value.</td><td><div lang="ja">値を設定することができません。</div><div lang="en">Value cannot be set.</div></td></tr>
<tr><td>119999</td><td>An internal error has occurred.</td><td><div lang="ja">内部エラーが発生しました。</div><div lang="en">An internal error has occurred.</div></td></tr>
@@ -3047,65 +3302,6 @@
application/json:
schema:
$ref: 'dictionary/DictionaryServiceGetBusinessCategoryResponse.yaml#/DictionaryServiceGetBusinessCategoryResponse'
- /DictionaryService/getStationPlacementCategory:
- post:
- description: |
- <div lang="ja">
- プレイスメントカテゴリリストに含まれる駅情報一覧を取得します。
- </div>
- <div lang="en">Obtains the list of station information included in placement category list.</div>
- tags:
- - DictionaryService
- requestBody:
- content:
- application/json:
- schema:
- $ref: 'dictionary/DictionaryServicePlacementCategorySelector.yaml#/DictionaryServicePlacementCategorySelector'
- responses:
- 503:
- $ref: '../Response503.yaml#/Response503'
- 500:
- $ref: '../Response500.yaml#/Response500'
- 403:
- $ref: '../Response403.yaml#/Response403'
- 401:
- $ref: '../Response401.yaml#/Response401'
- 400:
- $ref: '../Response400.yaml#/Response400'
- 200:
- description: |
- <p class="cellContent__head">Error codes</p>
- <div class="cellContent__body">
- <table class="apiTable">
- <colgroup span="1" class="short"></colgroup>
- <colgroup span="2"></colgroup>
- <thead>
- <tr><th>Code</th><th>Message</th><th>Description</th></tr>
- </thead>
- <tbody>
- <tr><td>F0001</td><td>Invalid format.</td><td><div lang="ja">値の形式が不正です。</div><div lang="en">The value format is invalid.</div></td></tr>
- <tr><td>F0002</td><td>Invalid file format.</td><td><div lang="ja">アップロードファイルの形式が不正です。</div><div lang="en">The upload file format is invalid.</div></td></tr>
- <tr><td>R0001</td><td>Require.</td><td><div lang="ja">必須です。</div><div lang="en">It is missing required parameter.</div></td></tr>
- <tr><td>V0001</td><td>Invalid value.</td><td><div lang="ja">値が無効です。</div><div lang="en">The value is invalid.</div></td></tr>
- <tr><td>V0002</td><td>Empty file.</td><td><div lang="ja">アップロードファイルが0byteです。</div><div lang="en">The upload file is 0 byte.</div></td></tr>
- <tr><td>V0003</td><td>Over limit of the file size.</td><td><div lang="ja">アップロードファイルサイズが上限を超過しています。</div><div lang="en">The upload file size exceeds the limit.</div></td></tr>
- <tr><td>L0001</td><td>Lower list size.</td><td><div lang="ja">配列の要素数が下限値を下回っています。</div><div lang="en">The number of elements in the array is below the lower limit.</div></td></tr>
- <tr><td>L0002</td><td>Over list size.</td><td><div lang="ja">配列の要素数が上限値を超過しています。</div><div lang="en">The number of elements in the array exceeds the upper limit.</div></td></tr>
- <tr><td>S0001</td><td>Invalid Status.</td><td><div lang="ja">ステータスが無効です。</div><div lang="en">The status is invalid.</div></td></tr>
- <tr><td>I0001</td><td>Deactivated Id.</td><td><div lang="ja">IDが無効です。</div><div lang="en">The ID is Deactivated.</div></td></tr>
- <tr><td>D0001</td><td>Duplicate.</td><td><div lang="ja">一意な値が重複しています。</div><div lang="en">The unique value is duplicated.</div></td></tr>
- <tr><td>RL001</td><td>Invalid relation.</td><td><div lang="ja">リクエストの関連性が矛盾しています。<br> たとえば、開始＞終了の日付指定を行なっているなど</div><div lang="en">The relation of the request is contradictory.<br> For example, you are specifying the date of start > end.</div></td></tr>
- <tr><td>LT001</td><td>Over limit.</td><td><div lang="ja">登録できる上限値を超過しています。</div><div lang="en">The upper limit value that can be registered is exceeded.</div></td></tr>
- <tr><td>110005</td><td>Not a valid id.</td><td><div lang="ja">IDが有効ではありません。</div><div lang="en">Not a valid id.</div></td></tr>
- <tr><td>0001</td><td>Invalid Request.</td><td><div lang="ja">さまざまな要因が考えられます。<br>主な要因は、パラメータの値が不正か、誤りがあるためにオペレーションが完了できません。</div><div lang="en">This error can result for a variety of reasons. <br>Typically because one of the parameter values in the request is wrong or invalid and the operation cannot be completed.</div></td></tr>
- <tr><td>120020</td><td>Can not set value.</td><td><div lang="ja">値を設定することができません。</div><div lang="en">Value cannot be set.</div></td></tr>
- </tbody>
- </table>
- </div>
- content:
- application/json:
- schema:
- $ref: 'dictionary/DictionaryServiceGetPlacementCategoryResponse.yaml#/DictionaryServiceGetPlacementCategoryResponse'
/SearchKeywordIdeaService/get:
post:
description: |
@@ -6818,121 +7014,6 @@
$ref: '../Response401.yaml#/Response401'
400:
$ref: '../Response400.yaml#/Response400'
- /GuaranteedCampaignService/set:
- post:
- description: |
- <div lang="ja">キャンペーン情報を更新します。</div>
- <div lang="en">Updates campaign information. </div>
- tags:
- - GuaranteedCampaignService
- requestBody:
- content:
- application/json:
- schema:
- $ref: 'guaranteedcampaign/GuaranteedCampaignServiceOperation.yaml#/GuaranteedCampaignServiceOperation'
- responses:
- 503:
- $ref: '../Response503.yaml#/Response503'
- 500:
- $ref: '../Response500.yaml#/Response500'
- 403:
- $ref: '../Response403.yaml#/Response403'
- 401:
- $ref: '../Response401.yaml#/Response401'
- 400:
- $ref: '../Response400.yaml#/Response400'
- 200:
- description: |
- <p class="cellContent__head">Error codes</p>
- <div class="cellContent__body">
- <table class="apiTable">
- <colgroup span="1" class="short"></colgroup>
- <colgroup span="2"></colgroup>
- <thead>
- <tr><th>Code</th><th>Message</th><th>Description</th></tr>
- </thead>
- <tbody>
- <tr><td>0001</td><td>Invalid Request.</td><td><div lang="ja">さまざまな要因が考えられます。<br>主な要因は、パラメータの値が不正か、誤りがあるためにオペレーションが完了できません。</div><div lang="en">This error can result for a variety of reasons. <br>Typically because one of the parameter values in the request is wrong or invalid and the operation cannot be completed.</div></td></tr>
- <tr><td>R0001</td><td>Require.</td><td><div lang="ja">必須です。</div><div lang="en">It is missing required parameter.</div></td></tr>
- <tr><td>V0001</td><td>Invalid value.</td><td><div lang="ja">値が無効です。</div><div lang="en">The value is invalid.</div></td></tr>
- <tr><td>I0001</td><td>Deactivated Id.</td><td><div lang="ja">IDが無効です。</div><div lang="en">The ID is Deactivated.</div></td></tr>
- <tr><td>F0001</td><td>Invalid format.</td><td><div lang="ja">値の形式が不正です。</div><div lang="en">The value format is invalid.</div></td></tr>
- <tr><td>110005</td><td>Not a valid id.</td><td><div lang="ja">IDが有効ではありません。</div><div lang="en">Not a valid id.</div></td></tr>
- <tr><td>L0002</td><td>Over list size.</td><td><div lang="ja">配列の要素数が上限値を超過しています。</div><div lang="en">The number of elements in the array exceeds the upper limit.</div></td></tr>
- <tr><td>D0001</td><td>Duplicate.</td><td><div lang="ja">一意な値が重複しています。</div><div lang="en">The unique value is duplicated.</div></td></tr>
- <tr><td>RL001</td><td>Invalid relation.</td><td><div lang="ja">リクエストの関連性が矛盾しています。<br> たとえば、開始＞終了の日付指定を行なっているなど</div><div lang="en">The relation of the request is contradictory.<br> For example, you are specifying the date of start > end.</div></td></tr>
- <tr><td>L0001</td><td>Lower list size.</td><td><div lang="ja">配列の要素数が下限値を下回っています。</div><div lang="en">The number of elements in the array is below the lower limit.</div></td></tr>
- <tr><td>120020</td><td>Can not set value.</td><td><div lang="ja">値を設定することができません。</div><div lang="en">Value cannot be set.</div></td></tr>
- <tr><td>220014</td><td>Budget is lower than bidding price.</td><td><div lang="ja">予算額が入札価格を下回っています。</div><div lang="en">The bidding price has been set higher than the budget.</div></td></tr>
- <tr><td>220007</td><td>Unavailable the adProductType.</td><td><div lang="ja">指定された広告掲載方式は購入できません。</div><div lang="en">adProductType specified is not available.</div></td></tr>
- <tr><td>LT001</td><td>Over limit.</td><td><div lang="ja">登録できる上限値を超過しています。</div><div lang="en">The upper limit value that can be registered is exceeded.</div></td></tr>
- <tr><td>220121</td><td>Frequency setting was made to the product that is not available.</td><td><div lang="ja">指定された広告商品ではフリークエンシー設定できません。</div><div lang="en">You can not set frequency ads instruments designated.</div></td></tr>
- <tr><td>220122</td><td>Unavailable combination of frequency settings.</td><td><div lang="ja">フリークエンシー設定の組み合わせが不正です。</div><div lang="en">Combination of frequency setting is invalid.</div></td></tr>
- <tr><td>220123</td><td>Unavailable conversion optimizer.</td><td><div lang="ja">コンバージョンオプティマイザーの設定が出来ない商品です。</div><div lang="en">Conversion optimization setting is not possible due to the non-eligible Ad distribution.</div></td></tr>
- <tr><td>220124</td><td>Disable conversion optimizer.</td><td><div lang="ja">コンバージョンオプティマイザーの有効設定が不正です。</div><div lang="en">Target CPA cannot be set</div></td></tr>
- </tbody>
- </table>
- </div>
- content:
- application/json:
- schema:
- $ref: 'guaranteedcampaign/GuaranteedCampaignServiceMutateResponse.yaml#/GuaranteedCampaignServiceMutateResponse'
- /GuaranteedReservationService/add:
- post:
- description: |
- <div lang="ja">シミュレーション結果に基づいて配信を予約します。予約を確定すると、シミュレーション時に指定した条件で予約型のキャンペーン、予約型の広告グループが自動的に作成されます。</div>
- <div lang="en">Reserves the delivery based on simulation result. If the reservation is confirmed, guaranteed campaign or guaranteed ad group will be automatically created based on the specified condition during simulation.</div>
- tags:
- - GuaranteedReservationService
- requestBody:
- content:
- application/json:
- schema:
- $ref: 'guaranteedreservation/GuaranteedReservationServiceOperation.yaml#/GuaranteedReservationServiceOperation'
- responses:
- 503:
- $ref: '../Response503.yaml#/Response503'
- 500:
- $ref: '../Response500.yaml#/Response500'
- 403:
- $ref: '../Response403.yaml#/Response403'
- 401:
- $ref: '../Response401.yaml#/Response401'
- 400:
- $ref: '../Response400.yaml#/Response400'
- 200:
- description: |
- <p class="cellContent__head">Error codes</p>
- <div class="cellContent__body">
- <table class="apiTable">
- <colgroup span="1" class="short"></colgroup>
- <colgroup span="2"></colgroup>
- <thead>
- <tr><th>Code</th><th>Message</th><th>Description</th></tr>
- </thead>
- <tbody>
- <tr><td>0001</td><td>Invalid Request.</td><td><div lang="ja">さまざまな要因が考えられます。<br>主な要因は、パラメータの値が不正か、誤りがあるためにオペレーションが完了できません。</div><div lang="en">This error can result for a variety of reasons. <br>Typically because one of the parameter values in the request is wrong or invalid and the operation cannot be completed.</div></td></tr>
- <tr><td>R0001</td><td>Require.</td><td><div lang="ja">必須です。</div><div lang="en">It is missing required parameter.</div></td></tr>
- <tr><td>V0001</td><td>Invalid value.</td><td><div lang="ja">値が無効です。</div><div lang="en">The value is invalid.</div></td></tr>
- <tr><td>I0001</td><td>Deactivated Id.</td><td><div lang="ja">IDが無効です。</div><div lang="en">The ID is Deactivated.</div></td></tr>
- <tr><td>F0001</td><td>Invalid format.</td><td><div lang="ja">値の形式が不正です。</div><div lang="en">The value format is invalid.</div></td></tr>
- <tr><td>110005</td><td>Not a valid id.</td><td><div lang="ja">IDが有効ではありません。</div><div lang="en">Not a valid id.</div></td></tr>
- <tr><td>L0002</td><td>Over list size.</td><td><div lang="ja">配列の要素数が上限値を超過しています。</div><div lang="en">The number of elements in the array exceeds the upper limit.</div></td></tr>
- <tr><td>D0001</td><td>Duplicate.</td><td><div lang="ja">一意な値が重複しています。</div><div lang="en">The unique value is duplicated.</div></td></tr>
- <tr><td>RL001</td><td>Invalid relation.</td><td><div lang="ja">リクエストの関連性が矛盾しています。<br> たとえば、開始＞終了の日付指定を行なっているなど</div><div lang="en">The relation of the request is contradictory.<br> For example, you are specifying the date of start > end.</div></td></tr>
- <tr><td>L0001</td><td>Lower list size.</td><td><div lang="ja">配列の要素数が下限値を下回っています。</div><div lang="en">The number of elements in the array is below the lower limit.</div></td></tr>
- <tr><td>120020</td><td>Can not set value.</td><td><div lang="ja">値を設定することができません。</div><div lang="en">Value cannot be set.</div></td></tr>
- <tr><td>LT001</td><td>Over limit.</td><td><div lang="ja">登録できる上限値を超過しています。</div><div lang="en">The upper limit value that can be registered is exceeded.</div></td></tr>
- <tr><td>260011</td><td>Specify the simulation result of 24 hours within.</td><td><div lang="ja">24時間以内のシミュレーション結果を指定してください。</div><div lang="en">Specify the simulation result of 24 hours within.</div></td></tr>
- <tr><td>260012</td><td>Simulation ID that has already been used cannot be specified.</td><td><div lang="ja">使用済みのシミュレーションIDは指定できません。</div><div lang="en">Simulation ID that has already been used cannot be specified.</div></td></tr>
- <tr><td>260016</td><td>Available balance required for reservation is insufficient.</td><td><div lang="ja">予約に必要なアカウント残高が不足しています。</div><div lang="en">Available balance required for reservation is insufficient.</div></td></tr>
- </tbody>
- </table>
- </div>
- content:
- application/json:
- schema:
- $ref: 'guaranteedreservation/GuaranteedReservationServiceMutateResponse.yaml#/GuaranteedReservationServiceMutateResponse'
/GuaranteedAdGroupService/get:
post:
description: |
@@ -6985,18 +7066,18 @@
$ref: '../Response401.yaml#/Response401'
400:
$ref: '../Response400.yaml#/Response400'
- /GuaranteedAdGroupService/add:
+ /GuaranteedAdGroupAdService/get:
post:
description: |
- <div lang="ja">予約型の広告グループを追加します。</div>
- <div lang="en">Adds guaranteed ad group.</div>
+ <div lang="ja">予約型の広告に関する情報を取得します。</div>
+ <div lang="en">Returns the guaranteed ad information.</div>
tags:
- - GuaranteedAdGroupService
+ - GuaranteedAdGroupAdService
requestBody:
content:
application/json:
schema:
- $ref: 'guaranteedadgroup/GuaranteedAdGroupServiceOperation.yaml#/GuaranteedAdGroupServiceOperation'
+ $ref: 'guaranteedadgroupad/GuaranteedAdGroupAdServiceSelector.yaml#/GuaranteedAdGroupAdServiceSelector'
responses:
503:
$ref: '../Response503.yaml#/Response503'
@@ -7024,530 +7105,31 @@
<tr><td>RL001</td><td>Invalid relation.</td><td><div lang="ja">リクエストの関連性が矛盾しています。<br> たとえば、開始＞終了の日付指定を行なっているなど</div><div lang="en">The relation of the request is contradictory.<br> For example, you are specifying the date of start > end.</div></td></tr>
<tr><td>LT001</td><td>Over limit.</td><td><div lang="ja">登録できる上限値を超過しています。</div><div lang="en">The upper limit value that can be registered is exceeded.</div></td></tr>
<tr><td>I0001</td><td>Deactivated Id.</td><td><div lang="ja">IDが無効です。</div><div lang="en">The ID is Deactivated.</div></td></tr>
- <tr><td>220134</td><td>Out of range of the target settings that can be specified.</td><td><div lang="ja">指定可能なターゲット設定の範囲外です。</div><div lang="en">Out of range of the target settings that can be specified.</div></td></tr>
</tbody>
</table>
</div>
content:
application/json:
schema:
- $ref: 'guaranteedadgroup/GuaranteedAdGroupServiceMutateResponse.yaml#/GuaranteedAdGroupServiceMutateResponse'
+ $ref: 'guaranteedadgroupad/GuaranteedAdGroupAdServiceGetResponse.yaml#/GuaranteedAdGroupAdServiceGetResponse'
403:
$ref: '../Response403.yaml#/Response403'
401:
$ref: '../Response401.yaml#/Response401'
400:
$ref: '../Response400.yaml#/Response400'
- /GuaranteedAdGroupService/set:
+ /BrandLiftService/get:
post:
description: |
- <div lang="ja">予約型の広告グループを変更します。</div>
- <div lang="en">Updates guaranteed ad group.</div>
+ <div lang="ja">ブランドリフト情報を取得します。</div>
+ <div lang="en">Returns BrandLift information.</div>
tags:
- - GuaranteedAdGroupService
+ - BrandLiftService
requestBody:
content:
application/json:
schema:
- $ref: 'guaranteedadgroup/GuaranteedAdGroupServiceOperation.yaml#/GuaranteedAdGroupServiceOperation'
- responses:
- 503:
- $ref: '../Response503.yaml#/Response503'
- 500:
- $ref: '../Response500.yaml#/Response500'
- 200:
- description: |
- <p class="cellContent__head">Error codes</p>
- <div class="cellContent__body">
- <table class="apiTable">
- <colgroup span="1" class="short"></colgroup>
- <colgroup span="2"></colgroup>
- <thead>
- <tr><th>Code</th><th>Message</th><th>Description</th></tr>
- </thead>
- <tbody>
- <tr><td>0001</td><td>Invalid Request.</td><td><div lang="ja">さまざまな要因が考えられます。<br>主な要因は、パラメータの値が不正か、誤りがあるためにオペレーションが完了できません。</div><div lang="en">This error can result for a variety of reasons. <br>Typically because one of the parameter values in the request is wrong or invalid and the operation cannot be completed.</div></td></tr>
- <tr><td>R0001</td><td>Require.</td><td><div lang="ja">必須です。</div><div lang="en">It is missing required parameter.</div></td></tr>
- <tr><td>F0001</td><td>Invalid format.</td><td><div lang="ja">値の形式が不正です。</div><div lang="en">The value format is invalid.</div></td></tr>
- <tr><td>V0001</td><td>Invalid value.</td><td><div lang="ja">値が無効です。</div><div lang="en">The value is invalid.</div></td></tr>
- <tr><td>S0001</td><td>Invalid Status.</td><td><div lang="ja">ステータスが無効です。</div><div lang="en">The status is invalid.</div></td></tr>
- <tr><td>L0002</td><td>Over list size.</td><td><div lang="ja">配列の要素数が上限値を超過しています。</div><div lang="en">The number of elements in the array exceeds the upper limit.</div></td></tr>
- <tr><td>L0001</td><td>Lower list size.</td><td><div lang="ja">配列の要素数が下限値を下回っています。</div><div lang="en">The number of elements in the array is below the lower limit.</div></td></tr>
- <tr><td>D0001</td><td>Duplicate.</td><td><div lang="ja">一意な値が重複しています。</div><div lang="en">The unique value is duplicated.</div></td></tr>
- <tr><td>RL001</td><td>Invalid relation.</td><td><div lang="ja">リクエストの関連性が矛盾しています。<br> たとえば、開始＞終了の日付指定を行なっているなど</div><div lang="en">The relation of the request is contradictory.<br> For example, you are specifying the date of start > end.</div></td></tr>
- <tr><td>LT001</td><td>Over limit.</td><td><div lang="ja">登録できる上限値を超過しています。</div><div lang="en">The upper limit value that can be registered is exceeded.</div></td></tr>
- <tr><td>I0001</td><td>Deactivated Id.</td><td><div lang="ja">IDが無効です。</div><div lang="en">The ID is Deactivated.</div></td></tr>
- </tbody>
- </table>
- </div>
- content:
- application/json:
- schema:
- $ref: 'guaranteedadgroup/GuaranteedAdGroupServiceMutateResponse.yaml#/GuaranteedAdGroupServiceMutateResponse'
- 403:
- $ref: '../Response403.yaml#/Response403'
- 401:
- $ref: '../Response401.yaml#/Response401'
- 400:
- $ref: '../Response400.yaml#/Response400'
- /GuaranteedAdGroupAdService/get:
- post:
- description: |
- <div lang="ja">予約型の広告に関する情報を取得します。</div>
- <div lang="en">Returns the guaranteed ad information.</div>
- tags:
- - GuaranteedAdGroupAdService
- requestBody:
- content:
- application/json:
- schema:
- $ref: 'guaranteedadgroupad/GuaranteedAdGroupAdServiceSelector.yaml#/GuaranteedAdGroupAdServiceSelector'
- responses:
- 503:
- $ref: '../Response503.yaml#/Response503'
- 500:
- $ref: '../Response500.yaml#/Response500'
- 200:
- description: |
- <p class="cellContent__head">Error codes</p>
- <div class="cellContent__body">
- <table class="apiTable">
- <colgroup span="1" class="short"></colgroup>
- <colgroup span="2"></colgroup>
- <thead>
- <tr><th>Code</th><th>Message</th><th>Description</th></tr>
- </thead>
- <tbody>
- <tr><td>0001</td><td>Invalid Request.</td><td><div lang="ja">さまざまな要因が考えられます。<br>主な要因は、パラメータの値が不正か、誤りがあるためにオペレーションが完了できません。</div><div lang="en">This error can result for a variety of reasons. <br>Typically because one of the parameter values in the request is wrong or invalid and the operation cannot be completed.</div></td></tr>
- <tr><td>R0001</td><td>Require.</td><td><div lang="ja">必須です。</div><div lang="en">It is missing required parameter.</div></td></tr>
- <tr><td>F0001</td><td>Invalid format.</td><td><div lang="ja">値の形式が不正です。</div><div lang="en">The value format is invalid.</div></td></tr>
- <tr><td>V0001</td><td>Invalid value.</td><td><div lang="ja">値が無効です。</div><div lang="en">The value is invalid.</div></td></tr>
- <tr><td>S0001</td><td>Invalid Status.</td><td><div lang="ja">ステータスが無効です。</div><div lang="en">The status is invalid.</div></td></tr>
- <tr><td>L0002</td><td>Over list size.</td><td><div lang="ja">配列の要素数が上限値を超過しています。</div><div lang="en">The number of elements in the array exceeds the upper limit.</div></td></tr>
- <tr><td>L0001</td><td>Lower list size.</td><td><div lang="ja">配列の要素数が下限値を下回っています。</div><div lang="en">The number of elements in the array is below the lower limit.</div></td></tr>
- <tr><td>D0001</td><td>Duplicate.</td><td><div lang="ja">一意な値が重複しています。</div><div lang="en">The unique value is duplicated.</div></td></tr>
- <tr><td>RL001</td><td>Invalid relation.</td><td><div lang="ja">リクエストの関連性が矛盾しています。<br> たとえば、開始＞終了の日付指定を行なっているなど</div><div lang="en">The relation of the request is contradictory.<br> For example, you are specifying the date of start > end.</div></td></tr>
- <tr><td>LT001</td><td>Over limit.</td><td><div lang="ja">登録できる上限値を超過しています。</div><div lang="en">The upper limit value that can be registered is exceeded.</div></td></tr>
- <tr><td>I0001</td><td>Deactivated Id.</td><td><div lang="ja">IDが無効です。</div><div lang="en">The ID is Deactivated.</div></td></tr>
- </tbody>
- </table>
- </div>
- content:
- application/json:
- schema:
- $ref: 'guaranteedadgroupad/GuaranteedAdGroupAdServiceGetResponse.yaml#/GuaranteedAdGroupAdServiceGetResponse'
- 403:
- $ref: '../Response403.yaml#/Response403'
- 401:
- $ref: '../Response401.yaml#/Response401'
- 400:
- $ref: '../Response400.yaml#/Response400'
- /GuaranteedAdGroupAdService/add:
- post:
- description: |
- <div lang="ja">予約型の広告を追加します。</div>
- <div lang="en">Adds guaranteed ad.</div>
- tags:
- - GuaranteedAdGroupAdService
- requestBody:
- content:
- application/json:
- schema:
- $ref: 'guaranteedadgroupad/GuaranteedAdGroupAdServiceOperation.yaml#/GuaranteedAdGroupAdServiceOperation'
- responses:
- 503:
- $ref: '../Response503.yaml#/Response503'
- 500:
- $ref: '../Response500.yaml#/Response500'
- 403:
- $ref: '../Response403.yaml#/Response403'
- 401:
- $ref: '../Response401.yaml#/Response401'
- 400:
- $ref: '../Response400.yaml#/Response400'
- 200:
- description: |
- <p class="cellContent__head">Error codes</p>
- <div class="cellContent__body">
- <table class="apiTable">
- <colgroup span="1" class="short"></colgroup>
- <colgroup span="2"></colgroup>
- <thead>
- <tr><th>Code</th><th>Message</th><th>Description</th></tr>
- </thead>
- <tbody>
- <tr><td>0001</td><td>Invalid Request.</td><td><div lang="ja">さまざまな要因が考えられます。<br>主な要因は、パラメータの値が不正か、誤りがあるためにオペレーションが完了できません。</div><div lang="en">This error can result for a variety of reasons. <br>Typically because one of the parameter values in the request is wrong or invalid and the operation cannot be completed.</div></td></tr>
- <tr><td>R0001</td><td>Require.</td><td><div lang="ja">必須です。</div><div lang="en">It is missing required parameter.</div></td></tr>
- <tr><td>V0001</td><td>Invalid value.</td><td><div lang="ja">値が無効です。</div><div lang="en">The value is invalid.</div></td></tr>
- <tr><td>I0001</td><td>Deactivated Id.</td><td><div lang="ja">IDが無効です。</div><div lang="en">The ID is Deactivated.</div></td></tr>
- <tr><td>F0001</td><td>Invalid format.</td><td><div lang="ja">値の形式が不正です。</div><div lang="en">The value format is invalid.</div></td></tr>
- <tr><td>110005</td><td>Not a valid id.</td><td><div lang="ja">IDが有効ではありません。</div><div lang="en">Not a valid id.</div></td></tr>
- <tr><td>L0002</td><td>Over list size.</td><td><div lang="ja">配列の要素数が上限値を超過しています。</div><div lang="en">The number of elements in the array exceeds the upper limit.</div></td></tr>
- <tr><td>D0001</td><td>Duplicate.</td><td><div lang="ja">一意な値が重複しています。</div><div lang="en">The unique value is duplicated.</div></td></tr>
- <tr><td>RL001</td><td>Invalid relation.</td><td><div lang="ja">リクエストの関連性が矛盾しています。<br> たとえば、開始＞終了の日付指定を行なっているなど</div><div lang="en">The relation of the request is contradictory.<br> For example, you are specifying the date of start > end.</div></td></tr>
- <tr><td>L0001</td><td>Lower list size.</td><td><div lang="ja">配列の要素数が下限値を下回っています。</div><div lang="en">The number of elements in the array is below the lower limit.</div></td></tr>
- <tr><td>120020</td><td>Can not set value.</td><td><div lang="ja">値を設定することができません。</div><div lang="en">Value cannot be set.</div></td></tr>
- <tr><td>220009</td><td>Ad type you chose does not support the specified adProductType.</td><td><div lang="ja">キャンペーンで設定した広告商品種別では指定出来ない広告タイプが入力されています。</div><div lang="en">Ad type you chose does not support the specified adProductType.</div></td></tr>
- <tr><td>LT001</td><td>Over limit.</td><td><div lang="ja">登録できる上限値を超過しています。</div><div lang="en">The upper limit value that can be registered is exceeded.</div></td></tr>
- <tr><td>S0001</td><td>Invalid Status.</td><td><div lang="ja">ステータスが無効です。</div><div lang="en">The status is invalid.</div></td></tr>
- <tr><td>220113</td><td>Unsupported ad product type.</td><td><div lang="ja">キャンペーンの配信方法（AdproductType）が、画像紐づけ不可となっています。</div><div lang="en">Delivery method of campaign (AdproductType) cannot relate to media.</div></td></tr>
- <tr><td>220115</td><td>Unexpected aspect ratio of an image.</td><td><div lang="ja">指定したピクセルサイズをご利用いただけません。</div><div lang="en">The pixel size is not available to use for the specific image.</div></td></tr>
- <tr><td>220136</td><td>Url restriction for Commerce ads.</td><td><div lang="ja">コマース広告の表示URL,リンクURLが規定違反です。</div><div lang="en">Url restriction for Commerce ads.</div></td></tr>
- <tr><td>220015</td><td>Bidding price is higher than campaign budget.</td><td><div lang="ja">入札価格がキャンペーン予算を超えています。</div><div lang="en">The bidding price has been set higher than the campaign budget.</div></td></tr>
- <tr><td>210003</td><td>A function is not permitted this account.</td><td><div lang="ja">利用が許可されていないアカウントです。</div><div lang="en">Custom audience is not available for this account.</div></td></tr>
- <tr><td>220133</td><td>Not allowed to set impression beacon url.</td><td><div lang="ja">広告効果測定ツール提供企業など外部との連係許可がないため、<br>インプレッションビーコンURLの設定はできません。</div><div lang="en">Impression beacon URL is not available since the external link to analyzing tool providers is not allowed.</div></td></tr>
- <tr><td>220301</td><td>Over limit to delivered ad.</td><td><div lang="ja">配信設定中の広告の件数が上限を超えています。</div><div lang="en">Number of ads set to be distributed exceeded the limit.</div></td></tr>
- <tr><td>220302</td><td>Over limit to ad under account.</td><td><div lang="ja">アカウント配下の広告の件数が上限を超えています。</div><div lang="en">Number of ads under an account exceeded the limit.</div></td></tr>
- <tr><td>220322</td><td>Invalid tracking parameter.</td><td><div lang="ja">無効な文字列（無効なトラッキングパラメータなど）が存在します。</div><div lang="en">Invalid string (such as invalid Tracking Parameter</div></td></tr>
- <tr><td>220323</td><td>Tracking parameter is not available for this type of ad distribution.</td><td><div lang="ja">指定された広告掲載方式に対し、トラッキングパラメータは対応していません。</div><div lang="en">There is a Tracking Parameter which is not available for the ad product.</div></td></tr>
- <tr><td>220324</td><td>Entered tracking parameter cannot be used.</td><td><div lang="ja">入力されたトラッキングパラメータは利用できません。</div><div lang="en">There is a Tracking Parameter which is not available for the YDN-unaligned tracking tool</div></td></tr>
- <tr><td>220325</td><td>Invalid relation of video and thumbnail format.</td><td><div lang="ja">動画とサムネイルのフォーマットが異なります。</div><div lang="en">Invalid relation of video and thumbnail format.</div></td></tr>
- <tr><td>220326</td><td>Not allowed to set video beacon url.</td><td><div lang="ja">動画視聴用のbeacon urlを設定する権限がありません。</div><div lang="en">Not allowed to set video beacon url.</div></td></tr>
- <tr><td>220330</td><td>Invalid combination in user status and campaign banner media.</td><td><div lang="ja">キャンペーンバナー画像の配信設定は変更できません。</div><div lang="en">Unmodifiable the user status on campaign banner media.</div></td></tr>
- <tr><td>260010</td><td>Ad type that is not registered in simulation cannot be specified.</td><td><div lang="ja">シミュレーションに登録されていない広告種別は指定できません。</div><div lang="en">Ad type that is not registered in simulation cannot be specified.</div></td></tr>
- <tr><td>220120</td><td>Cannot operate with only one ad in an ad group.</td><td><div lang="ja">広告グループ内に1件しかない広告の操作はできません。</div><div lang="en">Cannot operate with only one ad in an ad group.</div></td></tr>
- <tr><td>220116</td><td>This video duration cannot be used with the specified ad type.</td><td><div lang="ja">指定した広告種別では利用できない動画時間です。</div><div lang="en">This video duration cannot be used with the specified ad type.</div></td></tr>
- <tr><td>220217</td><td>Running time of the video file exceeds the upper limit.</td><td><div lang="ja">動画ファイルの再生時間が上限値を超えています。</div><div lang="en">Running time of the video file exceeds the upper limit.</div></td></tr>
- <tr><td>220218</td><td>Running time of the video file is below the lower limit.</td><td><div lang="ja">動画ファイルの再生時間が下限値を満たしていません。</div><div lang="en">Running time of the video file is below the lower limit.</div></td></tr>
- <tr><td>220219</td><td>Video file does not include sounds.</td><td><div lang="ja">動画ファイルに音声がありません。</div><div lang="en">Video file does not include sounds.</div></td></tr>
- </tbody>
- </table>
- </div>
- content:
- application/json:
- schema:
- $ref: 'guaranteedadgroupad/GuaranteedAdGroupAdServiceMutateResponse.yaml#/GuaranteedAdGroupAdServiceMutateResponse'
- /GuaranteedAdGroupAdService/set:
- post:
- description: |
- <div lang="ja">予約型の広告を変更します。</div>
- <div lang="en">Updates guaranteed ad.</div>
- tags:
- - GuaranteedAdGroupAdService
- requestBody:
- content:
- application/json:
- schema:
- $ref: 'guaranteedadgroupad/GuaranteedAdGroupAdServiceOperation.yaml#/GuaranteedAdGroupAdServiceOperation'
- responses:
- 503:
- $ref: '../Response503.yaml#/Response503'
- 500:
- $ref: '../Response500.yaml#/Response500'
- 403:
- $ref: '../Response403.yaml#/Response403'
- 401:
- $ref: '../Response401.yaml#/Response401'
- 400:
- $ref: '../Response400.yaml#/Response400'
- 200:
- description: |
- <p class="cellContent__head">Error codes</p>
- <div class="cellContent__body">
- <table class="apiTable">
- <colgroup span="1" class="short"></colgroup>
- <colgroup span="2"></colgroup>
- <thead>
- <tr><th>Code</th><th>Message</th><th>Description</th></tr>
- </thead>
- <tbody>
- <tr><td>0001</td><td>Invalid Request.</td><td><div lang="ja">さまざまな要因が考えられます。<br>主な要因は、パラメータの値が不正か、誤りがあるためにオペレーションが完了できません。</div><div lang="en">This error can result for a variety of reasons. <br>Typically because one of the parameter values in the request is wrong or invalid and the operation cannot be completed.</div></td></tr>
- <tr><td>R0001</td><td>Require.</td><td><div lang="ja">必須です。</div><div lang="en">It is missing required parameter.</div></td></tr>
- <tr><td>V0001</td><td>Invalid value.</td><td><div lang="ja">値が無効です。</div><div lang="en">The value is invalid.</div></td></tr>
- <tr><td>I0001</td><td>Deactivated Id.</td><td><div lang="ja">IDが無効です。</div><div lang="en">The ID is Deactivated.</div></td></tr>
- <tr><td>F0001</td><td>Invalid format.</td><td><div lang="ja">値の形式が不正です。</div><div lang="en">The value format is invalid.</div></td></tr>
- <tr><td>110005</td><td>Not a valid id.</td><td><div lang="ja">IDが有効ではありません。</div><div lang="en">Not a valid id.</div></td></tr>
- <tr><td>L0002</td><td>Over list size.</td><td><div lang="ja">配列の要素数が上限値を超過しています。</div><div lang="en">The number of elements in the array exceeds the upper limit.</div></td></tr>
- <tr><td>D0001</td><td>Duplicate.</td><td><div lang="ja">一意な値が重複しています。</div><div lang="en">The unique value is duplicated.</div></td></tr>
- <tr><td>RL001</td><td>Invalid relation.</td><td><div lang="ja">リクエストの関連性が矛盾しています。<br> たとえば、開始＞終了の日付指定を行なっているなど</div><div lang="en">The relation of the request is contradictory.<br> For example, you are specifying the date of start > end.</div></td></tr>
- <tr><td>L0001</td><td>Lower list size.</td><td><div lang="ja">配列の要素数が下限値を下回っています。</div><div lang="en">The number of elements in the array is below the lower limit.</div></td></tr>
- <tr><td>120020</td><td>Can not set value.</td><td><div lang="ja">値を設定することができません。</div><div lang="en">Value cannot be set.</div></td></tr>
- <tr><td>220009</td><td>Ad type you chose does not support the specified adProductType.</td><td><div lang="ja">キャンペーンで設定した広告商品種別では指定出来ない広告タイプが入力されています。</div><div lang="en">Ad type you chose does not support the specified adProductType.</div></td></tr>
- <tr><td>LT001</td><td>Over limit.</td><td><div lang="ja">登録できる上限値を超過しています。</div><div lang="en">The upper limit value that can be registered is exceeded.</div></td></tr>
- <tr><td>S0001</td><td>Invalid Status.</td><td><div lang="ja">ステータスが無効です。</div><div lang="en">The status is invalid.</div></td></tr>
- <tr><td>220113</td><td>Unsupported ad product type.</td><td><div lang="ja">キャンペーンの配信方法（AdproductType）が、画像紐づけ不可となっています。</div><div lang="en">Delivery method of campaign (AdproductType) cannot relate to media.</div></td></tr>
- <tr><td>220115</td><td>Unexpected aspect ratio of an image.</td><td><div lang="ja">指定したピクセルサイズをご利用いただけません。</div><div lang="en">The pixel size is not available to use for the specific image.</div></td></tr>
- <tr><td>220136</td><td>Url restriction for Commerce ads.</td><td><div lang="ja">コマース広告の表示URL,リンクURLが規定違反です。</div><div lang="en">Url restriction for Commerce ads.</div></td></tr>
- <tr><td>220015</td><td>Bidding price is higher than campaign budget.</td><td><div lang="ja">入札価格がキャンペーン予算を超えています。</div><div lang="en">The bidding price has been set higher than the campaign budget.</div></td></tr>
- <tr><td>210003</td><td>A function is not permitted this account.</td><td><div lang="ja">利用が許可されていないアカウントです。</div><div lang="en">Custom audience is not available for this account.</div></td></tr>
- <tr><td>220133</td><td>Not allowed to set impression beacon url.</td><td><div lang="ja">広告効果測定ツール提供企業など外部との連係許可がないため、<br>インプレッションビーコンURLの設定はできません。</div><div lang="en">Impression beacon URL is not available since the external link to analyzing tool providers is not allowed.</div></td></tr>
- <tr><td>220301</td><td>Over limit to delivered ad.</td><td><div lang="ja">配信設定中の広告の件数が上限を超えています。</div><div lang="en">Number of ads set to be distributed exceeded the limit.</div></td></tr>
- <tr><td>220302</td><td>Over limit to ad under account.</td><td><div lang="ja">アカウント配下の広告の件数が上限を超えています。</div><div lang="en">Number of ads under an account exceeded the limit.</div></td></tr>
- <tr><td>220322</td><td>Invalid tracking parameter.</td><td><div lang="ja">無効な文字列（無効なトラッキングパラメータなど）が存在します。</div><div lang="en">Invalid string (such as invalid Tracking Parameter</div></td></tr>
- <tr><td>220323</td><td>Tracking parameter is not available for this type of ad distribution.</td><td><div lang="ja">指定された広告掲載方式に対し、トラッキングパラメータは対応していません。</div><div lang="en">There is a Tracking Parameter which is not available for the ad product.</div></td></tr>
- <tr><td>220324</td><td>Entered tracking parameter cannot be used.</td><td><div lang="ja">入力されたトラッキングパラメータは利用できません。</div><div lang="en">There is a Tracking Parameter which is not available for the YDN-unaligned tracking tool</div></td></tr>
- <tr><td>220325</td><td>Invalid relation of video and thumbnail format.</td><td><div lang="ja">動画とサムネイルのフォーマットが異なります。</div><div lang="en">Invalid relation of video and thumbnail format.</div></td></tr>
- <tr><td>220326</td><td>Not allowed to set video beacon url.</td><td><div lang="ja">動画視聴用のbeacon urlを設定する権限がありません。</div><div lang="en">Not allowed to set video beacon url.</div></td></tr>
- <tr><td>220330</td><td>Invalid combination in user status and campaign banner media.</td><td><div lang="ja">キャンペーンバナー画像の配信設定は変更できません。</div><div lang="en">Unmodifiable the user status on campaign banner media.</div></td></tr>
- <tr><td>220120</td><td>Cannot operate with only one ad in an ad group.</td><td><div lang="ja">広告グループ内に1件しかない広告の操作はできません。</div><div lang="en">Cannot operate with only one ad in an ad group.</div></td></tr>
- <tr><td>260010</td><td>Ad type that is not registered in simulation cannot be specified.</td><td><div lang="ja">シミュレーションに登録されていない広告種別は指定できません。</div><div lang="en">Ad type that is not registered in simulation cannot be specified.</div></td></tr>
- <tr><td>220116</td><td>This video duration cannot be used with the specified ad type.</td><td><div lang="ja">指定した広告種別では利用できない動画時間です。</div><div lang="en">This video duration cannot be used with the specified ad type.</div></td></tr>
- <tr><td>220217</td><td>Running time of the video file exceeds the upper limit.</td><td><div lang="ja">動画ファイルの再生時間が上限値を超えています。</div><div lang="en">Running time of the video file exceeds the upper limit.</div></td></tr>
- <tr><td>220218</td><td>Running time of the video file is below the lower limit.</td><td><div lang="ja">動画ファイルの再生時間が下限値を満たしていません。</div><div lang="en">Running time of the video file is below the lower limit.</div></td></tr>
- <tr><td>220219</td><td>Video file does not include sounds.</td><td><div lang="ja">動画ファイルに音声がありません。</div><div lang="en">Video file does not include sounds.</div></td></tr>
- </tbody>
- </table>
- </div>
- content:
- application/json:
- schema:
- $ref: 'guaranteedadgroupad/GuaranteedAdGroupAdServiceMutateResponse.yaml#/GuaranteedAdGroupAdServiceMutateResponse'
- /GuaranteedSimulationService/get:
- post:
- description: |
- <div lang="ja">予約型キャンペーンの配信シミュレーション結果に関する情報を取得します。</div>
- <div lang="en">Returns the information about delivery simulation results of the guaranteed campaign.</div>
- tags:
- - GuaranteedSimulationService
- requestBody:
- content:
- application/json:
- schema: