Skip to content

Latest commit

 

History

History
255 lines (174 loc) · 16.7 KB

README.md

File metadata and controls

255 lines (174 loc) · 16.7 KB
Raw

PolarAdvertisements

(users.advertisements)

Overview

Available Operations

  • list - List Advertisements
  • create - Create Advertisement
  • get - Get Advertisement
  • update - Update Advertisement
  • delete - Delete Advertisement
  • enable - Enable Advertisement

list

List advertisement campaigns.

Example Usage

from polar_sdk import Polar

with Polar(
    access_token="<YOUR_BEARER_TOKEN_HERE>",
) as s:
    res = s.users.advertisements.list()

    if res is not None:
        while True:
            # handle items

            res = res.next()
            if res is None:
                break

Parameters

Parameter Type Required Description
page Optional[int] ➖ Page number, defaults to 1.
limit Optional[int] ➖ Size of a page, defaults to 10. Maximum is 100.
sorting List[models.UserAdvertisementSortProperty] ➖ Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.UsersAdvertisementsListResponse

Errors

Error Type Status Code Content Type
models.HTTPValidationError 422 application/json
models.SDKError 4XX, 5XX */*

create

Create an advertisement campaign.

Example Usage

from polar_sdk import Polar

with Polar(
    access_token="<YOUR_BEARER_TOKEN_HERE>",
) as s:
    res = s.users.advertisements.create(request={
        "image_url": "http://limp-pastry.org",
        "text": "<value>",
        "link_url": "http://flashy-cartload.net",
    })

    if res is not None:
        # handle response
        pass

Parameters

Parameter Type Required Description
request models.UserAdvertisementCampaignCreate ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.UserAdvertisementCampaign

Errors

Error Type Status Code Content Type
models.HTTPValidationError 422 application/json
models.SDKError 4XX, 5XX */*

get

Get an advertisement campaign by ID.

Example Usage

from polar_sdk import Polar

with Polar(
    access_token="<YOUR_BEARER_TOKEN_HERE>",
) as s:
    res = s.users.advertisements.get(id="<value>")

    if res is not None:
        # handle response
        pass

Parameters

Parameter Type Required Description
id str ✔️ The advertisement campaign ID.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.UserAdvertisementCampaign

Errors

Error Type Status Code Content Type
models.ResourceNotFound 404 application/json
models.HTTPValidationError 422 application/json
models.SDKError 4XX, 5XX */*

update

Update an advertisement campaign.

Example Usage

from polar_sdk import Polar

with Polar(
    access_token="<YOUR_BEARER_TOKEN_HERE>",
) as s:
    res = s.users.advertisements.update(id="<value>", user_advertisement_campaign_update={})

    if res is not None:
        # handle response
        pass

Parameters

Parameter Type Required Description
id str ✔️ The advertisement campaign ID.
user_advertisement_campaign_update models.UserAdvertisementCampaignUpdate ✔️ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.UserAdvertisementCampaign

Errors

Error Type Status Code Content Type
models.ResourceNotFound 404 application/json
models.HTTPValidationError 422 application/json
models.SDKError 4XX, 5XX */*

delete

Delete an advertisement campaign.

It'll be automatically disabled on all granted benefits.

Example Usage

from polar_sdk import Polar

with Polar(
    access_token="<YOUR_BEARER_TOKEN_HERE>",
) as s:
    res = s.users.advertisements.delete(id="<value>")

    if res is not None:
        # handle response
        pass

Parameters

Parameter Type Required Description
id str ✔️ The advertisement campaign ID.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

Any

Errors

Error Type Status Code Content Type
models.ResourceNotFound 404 application/json
models.HTTPValidationError 422 application/json
models.SDKError 4XX, 5XX */*

enable

Enable an advertisement campaign on a granted benefit.

Example Usage

from polar_sdk import Polar

with Polar(
    access_token="<YOUR_BEARER_TOKEN_HERE>",
) as s:
    s.users.advertisements.enable(id="<value>", user_advertisement_campaign_enable={
        "benefit_id": "<value>",
    })

    # Use the SDK ...

Parameters

Parameter Type Required Description
id str ✔️ The advertisement campaign ID.
user_advertisement_campaign_enable models.UserAdvertisementCampaignEnable ✔️ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Errors

Error Type Status Code Content Type
models.ResourceNotFound 404 application/json
models.HTTPValidationError 422 application/json
models.SDKError 4XX, 5XX */*