README.md

Ad

Overview

Available Operations

• create_ads_ad - Create an ad
• get_ads_ad - Retrieve an ad
• list_ads_ads - List all ads
• patch_ads_ad - Update an ad
• remove_ads_ad - Remove an ad
• update_ads_ad - Update an ad

create_ads_ad

Create an ad

Example Usage

from unified_python_sdk import UnifiedTo
from unified_python_sdk.models import shared


with UnifiedTo(
    security=shared.Security(
        jwt="<YOUR_API_KEY_HERE>",
    ),
) as unified_to:

    res = unified_to.ad.create_ads_ad(request={
        "ads_ad": {},
        "connection_id": "<id>",
    })

    assert res.ads_ad is not None

    # Handle response
    print(res.ads_ad)

Parameters

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

Response

operations.CreateAdsAdResponse

Errors

Error Type	Status Code	Content Type
errors.SDKError	4XX, 5XX	*/*

get_ads_ad

Retrieve an ad

Example Usage

from unified_python_sdk import UnifiedTo
from unified_python_sdk.models import shared


with UnifiedTo(
    security=shared.Security(
        jwt="<YOUR_API_KEY_HERE>",
    ),
) as unified_to:

    res = unified_to.ad.get_ads_ad(request={
        "connection_id": "<id>",
        "id": "<id>",
    })

    assert res.ads_ad is not None

    # Handle response
    print(res.ads_ad)

Parameters

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

Response

operations.GetAdsAdResponse

Errors

Error Type	Status Code	Content Type
errors.SDKError	4XX, 5XX	*/*

list_ads_ads

List all ads

Example Usage

from unified_python_sdk import UnifiedTo
from unified_python_sdk.models import shared


with UnifiedTo(
    security=shared.Security(
        jwt="<YOUR_API_KEY_HERE>",
    ),
) as unified_to:

    res = unified_to.ad.list_ads_ads(request={
        "connection_id": "<id>",
    })

    assert res.ads_ads is not None

    # Handle response
    print(res.ads_ads)

Parameters

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

Response

operations.ListAdsAdsResponse

Errors

Error Type	Status Code	Content Type
errors.SDKError	4XX, 5XX	*/*

patch_ads_ad

Update an ad

Example Usage

from unified_python_sdk import UnifiedTo
from unified_python_sdk.models import shared


with UnifiedTo(
    security=shared.Security(
        jwt="<YOUR_API_KEY_HERE>",
    ),
) as unified_to:

    res = unified_to.ad.patch_ads_ad(request={
        "ads_ad": {},
        "connection_id": "<id>",
        "id": "<id>",
    })

    assert res.ads_ad is not None

    # Handle response
    print(res.ads_ad)

Parameters

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

Response

operations.PatchAdsAdResponse

Errors

Error Type	Status Code	Content Type
errors.SDKError	4XX, 5XX	*/*

remove_ads_ad

Remove an ad

Example Usage

from unified_python_sdk import UnifiedTo
from unified_python_sdk.models import shared


with UnifiedTo(
    security=shared.Security(
        jwt="<YOUR_API_KEY_HERE>",
    ),
) as unified_to:

    res = unified_to.ad.remove_ads_ad(request={
        "connection_id": "<id>",
        "id": "<id>",
    })

    assert res is not None

    # Handle response
    print(res)

Parameters

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

Response

operations.RemoveAdsAdResponse

Errors

Error Type	Status Code	Content Type
errors.SDKError	4XX, 5XX	*/*

update_ads_ad

Update an ad

Example Usage

from unified_python_sdk import UnifiedTo
from unified_python_sdk.models import shared


with UnifiedTo(
    security=shared.Security(
        jwt="<YOUR_API_KEY_HERE>",
    ),
) as unified_to:

    res = unified_to.ad.update_ads_ad(request={
        "ads_ad": {},
        "connection_id": "<id>",
        "id": "<id>",
    })

    assert res.ads_ad is not None

    # Handle response
    print(res.ads_ad)

Parameters

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

Response

operations.UpdateAdsAdResponse

Errors

Error Type	Status Code	Content Type
errors.SDKError	4XX, 5XX	*/*