Skip to content

Commit e973f56

Browse files
denisneufdenisneuf
committed
docs for sponsored_display added
1 parent f3b66a1 commit e973f56

File tree

8 files changed

+172
-2
lines changed

8 files changed

+172
-2
lines changed

‎README.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,12 @@ back to `%HOME%\AppData\Roaming` if undefined
136136
* Campaigns
137137
* Ad Groups
138138
* Reports
139+
* ProductAds
140+
* Targets
141+
* NegativeTargets
142+
* TargetsRecommendations
143+
* BidRecommendations
144+
* Creatives
139145
140146
141147
### Example Usage Campaigns

‎docs/sd.rst‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,9 @@ Sponsored Display
77
sd/campaigns
88
sd/ad_groups
99
sd/product_ads
10-
sd/reports
10+
sd/reports
11+
sd/product_targeting
12+
sd/targeting_recommendations
13+
sd/bid_recommendations
14+
sd/negative_product_targeting
15+
sd/creatives

‎docs/sd/bid_recommendations.rst‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
Bid Recommendations
2+
===================
3+
4+
.. warning::
5+
6+
Sponsored Display is not available for Sandbox endpoint
7+
8+
.. autoclass:: ad_api.api.sd.BidRecommendations
9+
10+
Endpoint available
11+
12+
.. csv-table::
13+
:widths: 25, 25, 50
14+
:header: "Method", "Endpoint", "Description"
15+
16+
"POST", "/sd/targets/bid/recommendations", "Returns a set of bid recommendations for targeting clauses"
17+
18+
.. autofunction:: ad_api.api.sd.BidRecommendations.list_targets_bid_recommendations(self, **kwargs) -> ApiResponse:
19+
20+

‎docs/sd/creatives.rst‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
Creatives
2+
=========
3+
4+
.. warning::
5+
6+
Sponsored Display is not available for Sandbox endpoint
7+
8+
.. autoclass:: ad_api.api.sd.Creatives
9+
10+
Endpoints available
11+
12+
.. csv-table::
13+
:widths: 25, 25, 50
14+
:header: "Method", "Endpoint", "Description"
15+
16+
"GET", "/sd/creatives", "Gets a list of creatives."
17+
"PUT", "/sd/creatives", "Updates one or more creatives."
18+
"POST", "/sd/creatives", "A POST request of one or more creatives."
19+
"POST", "/sd/creatives/preview", "Gets creative preview HTML."
20+
"GET", "/sd/moderation/creatives", "Gets a list of creative moderations"
21+
22+
.. autofunction:: ad_api.api.sd.Creatives.list_creatives(self, **kwargs) -> ApiResponse:
23+
24+
.. autofunction:: ad_api.api.sd.Creatives.edit_creatives(self, **kwargs) -> ApiResponse:
25+
26+
.. autofunction:: ad_api.api.sd.Creatives.create_creatives(self, **kwargs) -> ApiResponse:
27+
28+
.. autofunction:: ad_api.api.sd.Creatives.list_moderation_creatives(self, **kwargs) -> ApiResponse:
29+
30+
.. autofunction:: ad_api.api.sd.Creatives.show_creative_preview(self, **kwargs) -> ApiResponse:

‎docs/sd/negative_product_targeting.rst‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
Negative targeting
2+
==================
3+
4+
.. warning::
5+
6+
Sponsored Display is not available for Sandbox endpoint
7+
8+
.. autoclass:: ad_api.api.sd.NegativeTargets
9+
10+
Endpoints available
11+
12+
.. csv-table::
13+
:widths: 25, 25, 50
14+
:header: "Method", "Endpoint", "Description"
15+
16+
"GET", "/sd/negativeTargets", "Gets a list of negative targeting clauses."
17+
"PUT", "/sd/negativeTargets", "Updates one or more negative targeting clauses."
18+
"POST", "/sd/negativeTargets", "Creates one or more negative targeting clauses."
19+
"GET", "/sd/negativeTargets/{negativeTargetId}", "Gets a negative targeting clause specified by identifier."
20+
"DELETE", "/sd/negativeTargets/{negativeTargetId}", "Sets the `state` of a negative targeting clause to `archived`."
21+
"GET", "/sd/negativeTargets/extended", "Gets a list of negative targeting clause objects with extended fields."
22+
"GET", "/sd/negativeTargets/extended/{negativeTargetId}", "Gets extended information for a negative targeting clause."
23+
24+
25+
.. autofunction:: ad_api.api.sd.NegativeTargets.list_negative_targets(self, **kwargs) -> ApiResponse:
26+
27+
.. autofunction:: ad_api.api.sd.NegativeTargets.edit_negative_targets(self, **kwargs) -> ApiResponse:
28+
29+
.. autofunction:: ad_api.api.sd.NegativeTargets.create_negative_targets(self, **kwargs) -> ApiResponse:
30+
31+
.. autofunction:: ad_api.api.sd.NegativeTargets.get_negative_target(self, targetId, **kwargs) -> ApiResponse:
32+
33+
.. autofunction:: ad_api.api.sd.NegativeTargets.delete_negative_targets(self, targetId, **kwargs) -> ApiResponse:
34+
35+
.. autofunction:: ad_api.api.sd.NegativeTargets.list_negative_targets_extended(self, **kwargs) -> ApiResponse:
36+
37+
.. autofunction:: ad_api.api.sd.NegativeTargets.get_negative_target_extended(self, targetId, **kwargs) -> ApiResponse:
38+

‎docs/sd/product_ads.rst‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,4 +126,14 @@ Product Ads
126126

127127
.. code-block:: JSON
128128
129-
[{"code": "SUCCESS", "adId": 182575048323550}]
129+
[{"code": "SUCCESS", "adId": 182575048323550}]
130+
131+
.. autofunction:: ad_api.api.sd.ProductAds.create_product_ads(self, **kwargs) -> ApiResponse:
132+
133+
.. autofunction:: ad_api.api.sd.ProductAds.get_product_ad(self, adId, **kwargs) -> ApiResponse:
134+
135+
.. autofunction:: ad_api.api.sd.ProductAds.delete_product_ad(self, adId, **kwargs) -> ApiResponse:
136+
137+
.. autofunction:: ad_api.api.sd.ProductAds.list_product_ads_extended(self, **kwargs) -> ApiResponse:
138+
139+
.. autofunction:: ad_api.api.sd.ProductAds.get_product_ad_extended(self, adId, **kwargs) -> ApiResponse:

‎docs/sd/product_targeting.rst‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
Product Targeting
2+
=================
3+
4+
.. warning::
5+
6+
Sponsored Display is not available for Sandbox endpoint
7+
8+
.. autoclass:: ad_api.api.sd.Targets
9+
10+
Endpoints available
11+
12+
.. csv-table::
13+
:widths: 25, 25, 50
14+
:header: "Method", "Endpoint", "Description"
15+
16+
"GET", "/sd/targets", "Gets a list of targeting clauses."
17+
"PUT", "/sd/targets", "Updates one or more targeting clauses."
18+
"POST", "/sd/targets", "Creates one or more targeting clauses."
19+
"GET", "/sd/targets/{targetId}", "Gets a targeting clause specified by identifier."
20+
"DELETE", "/sd/targets/{targetId}", "Sets the `state` of a targeting clause to `archived`."
21+
"GET", "/sd/targets/extended", "Gets a list of targeting clause objects with extended fields."
22+
"GET", "/sd/targets/extended/{targetId}", "Gets extended information for a targeting clause."
23+
24+
25+
.. autofunction:: ad_api.api.sd.Targets.list_products_targets(self, **kwargs) -> ApiResponse:
26+
27+
.. autofunction:: ad_api.api.sd.Targets.edit_products_targets(self, **kwargs) -> ApiResponse:
28+
29+
.. autofunction:: ad_api.api.sd.Targets.create_products_targets(self, **kwargs) -> ApiResponse:
30+
31+
.. autofunction:: ad_api.api.sd.Targets.get_products_target(self, targetId, **kwargs) -> ApiResponse:
32+
33+
.. autofunction:: ad_api.api.sd.Targets.delete_products_target(self, targetId, **kwargs) -> ApiResponse:
34+
35+
.. autofunction:: ad_api.api.sd.Targets.list_products_targets_extended(self, **kwargs) -> ApiResponse:
36+
37+
.. autofunction:: ad_api.api.sd.Targets.get_products_target_extended(self, targetId, **kwargs) -> ApiResponse:
38+
39+
40+
41+

‎docs/sd/targeting_recommendations.rst‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
Targeting Recommendations
2+
=========================
3+
4+
.. warning::
5+
6+
Sponsored Display is not available for Sandbox endpoint
7+
8+
.. autoclass:: ad_api.api.sd.TargetsRecommendations
9+
10+
Endpoint available
11+
12+
.. csv-table::
13+
:widths: 25, 25, 50
14+
:header: "Method", "Endpoint", "Description"
15+
16+
"POST", "/sd/targets/recommendations", "Returns a set of bid recommendations for targeting clauses"
17+
18+
.. autofunction:: ad_api.api.sd.TargetsRecommendations.list_targets_recommendations(self, **kwargs) -> ApiResponse:
19+
20+

0 commit comments

Comments
 (0)