+
### classmethod `create`
@@ -119,7 +135,7 @@ Keyword Args: Any valid keyword arguments or query parameters for endpoint.
---
-
+
### method `list_audiences`
@@ -153,7 +169,7 @@ Get a list of the audiences in the AdAccount, filtered by the specified argument
---
-
+
### method `list_campaigns`
@@ -192,7 +208,7 @@ Keyword Args: Any valid keyword arguments or query parameters for endpoint.
---
-
+
### method `list_customer_lists`
diff --git a/docs/pinterest/ads.ad_groups.md b/docs/pinterest/ads.ad_groups.md
index e2b94d3..e5f3e35 100644
--- a/docs/pinterest/ads.ad_groups.md
+++ b/docs/pinterest/ads.ad_groups.md
@@ -161,6 +161,14 @@ Initialize an AdGroup object.
+---
+
+#### property optimization_goal_metadata
+
+
+
+
+
---
#### property pacing_delivery_type
@@ -237,7 +245,7 @@ Initialize an AdGroup object.
---
-
+
### classmethod `create`
@@ -329,7 +337,7 @@ to ad campaigns. Some types of campaigns (e.g. budget optimization) have limits
---
-
+
### method `disable_auto_targeting`
@@ -347,7 +355,7 @@ Disable auto-targeting for ad group. Also known as
+
### classmethod `get_all`
@@ -405,7 +413,7 @@ List ad groups based on provided campaign IDs or ad group IDs.(campaign_ids or a
---
-
+
### method `list_ads`
@@ -441,7 +449,7 @@ Get list of ads under current AdGroup with specified arguments
---
-
+
### method `update_fields`
diff --git a/docs/pinterest/ads.ads.md b/docs/pinterest/ads.ads.md
index 97c9ecf..fbed9ba 100644
--- a/docs/pinterest/ads.ads.md
+++ b/docs/pinterest/ads.ads.md
@@ -258,7 +258,7 @@ Initialize an Ad object.
---
-
+
### classmethod `create`
@@ -323,7 +323,7 @@ Create a new ad. Request must contain ad_group_id, creative_type, and the source
---
-
+
### classmethod `get_all`
@@ -374,7 +374,7 @@ List ads that meet the filters provided:
---
-
+
### method `update_fields`
diff --git a/docs/pinterest/ads.campaigns.md b/docs/pinterest/ads.campaigns.md
index 4e2faf5..9a92d4c 100644
--- a/docs/pinterest/ads.campaigns.md
+++ b/docs/pinterest/ads.campaigns.md
@@ -142,6 +142,14 @@ Initialize a Campaign object.
+---
+
+#### property summary_status
+
+
+
+
+
---
#### property tracking_urls
@@ -170,7 +178,7 @@ Initialize a Campaign object.
---
-
+
### method `activate`
@@ -188,7 +196,7 @@ Activate a paused or archived campaign
---
-
+
### method `archive`
@@ -206,7 +214,7 @@ Archive an active or paused campaign
---
-
+
### classmethod `create`
@@ -298,7 +306,7 @@ Keyword Args: Any valid keyword arguments or query parameters for endpoint.
---
-
+
### classmethod `get_all`
@@ -340,7 +348,7 @@ Keyword Args: Any valid keyword arguments or query parameters for endpoint.
---
-
+
### method `get_daily_budget`
@@ -358,7 +366,7 @@ Get the current daily spend cap budget of the campaign.
---
-
+
### method `get_lifetime_budget`
@@ -376,7 +384,7 @@ Get the current life time spend cap budget of the campaign.
---
-
+
### method `list_ad_groups`
@@ -407,7 +415,7 @@ List ad groups directed related to campaign. This method makes a synchronous HTT
---
-
+
### method `pause`
@@ -425,7 +433,7 @@ Pause an active or archived campaign
---
-
+
### method `set_daily_budget`
@@ -449,7 +457,7 @@ Set new daily spend cap budget for the campaign.
---
-
+
### method `set_lifetime_budget`
@@ -473,7 +481,7 @@ Set new life time spend cap budget for the campaign.
---
-
+
### method `update_fields`
diff --git a/docs/pinterest/ads.conversion_events.md b/docs/pinterest/ads.conversion_events.md
new file mode 100644
index 0000000..167bfd4
--- /dev/null
+++ b/docs/pinterest/ads.conversion_events.md
@@ -0,0 +1,99 @@
+
+
+
+
+# module `ads.conversion_events`
+Conversion Event Class for Pinterest Python SDK
+
+
+
+---
+
+
+
+## class `Conversion`
+Conversion Event Model used to send conversion events to Pinterest API
+
+
+
+
+---
+
+
+
+### classmethod `create_conversion_event`
+
+```python
+create_conversion_event(
+ event_name: 'str',
+ action_source: 'str',
+ event_time: 'int',
+ event_id: 'str',
+ user_data: 'dict',
+ custom_data: 'dict',
+ event_source_url: 'str' = None,
+ partner_name: 'str' = None,
+ app_id: 'str' = None,
+ app_name: 'str' = None,
+ app_version: 'str' = None,
+ device_brand: 'str' = None,
+ device_carrier: 'str' = None,
+ device_model: 'str' = None,
+ device_type: 'str' = None,
+ os_version: 'str' = None,
+ language: 'str' = None,
+ **kwargs
+) → ConversionEventsData
+```
+
+Create Conversion Event Data to be sent.
+
+
+
+**Args:**
+
+ - `event_name` (str): The type of the user event, Enum: "add_to_cart", "checkout", "custom", "lead", "page_visit", "search", "signup", "view_category", "watch_video"
+ - `action_source` (str): The source indicating where the conversion event occurred, Enum: "app_adroid", "app_ios", "web", "offline"
+ - `event_time` (int): The time when the event happened. Unix timestamp in seconds
+ - `event_id` (str): The unique id string that identifies this event and can be used for deduping between events ingested via both the conversion API and Pinterest tracking
+ - `user_data` (dict): Object containing customer information data. Note, it is required at least one of 1) em, 2) hashed_maids or 3) pair client_ip_address + client_user_agent.
+ - `custom_data` (dict): Object containing other custom data.
+ - `event_source_url` (str, optional): URL of the web conversion event
+ - `partner_name` (str, optional): The third party partner name responsible to send the event to Conversion API on behalf of the adverstiser. Only send this field if Pinterest has worked directly with you to define a value for partner_name.
+ - `app_id` (str, optional): The app store app ID.
+ - `app_name` (str, optional): Name of the app.
+ - `app_version` (str, optional): Version of the app.
+ - `device_brand` (str, optional): Brand of the user device.
+ - `device_carrier` (str, optional): User device's model carrier.
+ - `device_model` (str, optional): Model of the user device.
+ - `device_type` (str, optional): Type of the user device.
+ - `os_version` (str, optional): Version of the device operating system.
+ - `language` (str, optional): Two-character ISO-639-1 language code indicating the user's language.
+
+
+
+**Returns:**
+
+ - `ConversionEventsData`: ConversionEventData to be sent
+
+---
+
+
+
+### classmethod `send_conversion_events`
+
+```python
+send_conversion_events(
+ ad_account_id: 'str',
+ conversion_events: 'list[ConversionEventsData]',
+ test: 'bool' = False,
+ client: 'PinterestSDKClient' = None,
+ **kwargs
+) → tuple(int, int, list[ConversionApiResponseEvents])
+```
+
+Send conversion events to Pinterest API for Conversions.
+
+Note: Highly recommend to use create_client_with_token (with Conversion Access Token) to create different client for this functionality.
+
+
diff --git a/docs/pinterest/ads.conversion_tags.md b/docs/pinterest/ads.conversion_tags.md
new file mode 100644
index 0000000..6666fd9
--- /dev/null
+++ b/docs/pinterest/ads.conversion_tags.md
@@ -0,0 +1,271 @@
+
+
+
+
+# module `ads.conversion_tags`
+Conversion Class for Pinterest Python SDK
+
+
+
+---
+
+
+
+## class `ConversionTag`
+Conversion Tag model used to view, create, update its attributes and list its different entities
+
+
+
+### method `__init__`
+
+```python
+__init__(
+ ad_account_id: 'str',
+ conversion_tag_id: 'str',
+ client: 'PinterestSDKClient' = None,
+ **kwargs
+) → None
+```
+
+Initialize Conversion Tag Object.
+
+
+
+**Args:**
+
+ - `ad_account_id` (str): ConversionTag's Ad Account ID
+ - `conversion_tag_id` (str): ConversionTag ID, must be associated with Ad Account ID provided
+ - `client` (PinterestSDKClient, optional): PinterestSDKClient Object. Uses the default client, if not provided.
+
+
+---
+
+#### property ad_account_id
+
+
+
+
+
+---
+
+#### property code_snippet
+
+
+
+
+
+---
+
+#### property configs
+
+
+
+
+
+---
+
+#### property enhanced_match_status
+
+
+
+
+
+---
+
+#### property id
+
+
+
+
+
+---
+
+#### property last_fired_time_ms
+
+
+
+
+
+---
+
+#### property name
+
+
+
+
+
+---
+
+#### property status
+
+
+
+
+
+---
+
+#### property version
+
+
+
+
+
+
+
+---
+
+
+
+### classmethod `create`
+
+```python
+create(
+ ad_account_id: 'str',
+ name: 'str',
+ aem_enabled: 'bool' = None,
+ md_frequency: 'float' = None,
+ aem_fnln_enabled: 'bool' = None,
+ aem_ph_enabled: 'bool' = None,
+ aem_ge_enabled: 'bool' = None,
+ aem_db_enabled: 'bool' = None,
+ aem_loc_enabled: 'bool' = None,
+ client: 'PinterestSDKClient' = None,
+ **kwargs
+) → ConversionTag
+```
+
+Create a conversion tag, also known as Pinterest tag with the option to enable enhance match.
+
+The Pinterest Tag tracks actions people take on the ad account’ s website after they view the ad account's ad on Pinterest. The advertiser needs to customize this tag to track conversions.
+
+For more information, see:
+
+Set up the Pinterest tag
+
+Pinterest Tag
+
+Enhanced match"
+
+
+
+**Args:**
+
+ - `ad_account_id` (str): ConversionTag's Ad Account ID
+ - `name` (str): ConversionTag name
+ - `aem_enabled` (bool=False, Nullable): Whether Automatic Enhanced Match email is enabled. See Enhanced match for more information.
+
+
+ - `md_frequency` (float=1.0, Nullable): Metadata ingestion frequency.
+ - `aem_fnln_enabled` (bool=False, Nullable): Whether Automatic Enhanced Match name is enabled. See Enhanced match for more information.
+
+
+ - `aem_ph_enabled` (bool=False, Nullable): Whether Automatic Enhanced Match phone is enabled. See Enhanced match for more information.
+
+
+ - `aem_ge_enabled` (bool=False, Nullable): Whether Automatic Enhanced Match gender is enabled. See Enhanced match for more information.
+
+
+ - `aem_db_enabled` (bool=False, Nullable): Whether Automatic Enhanced Match birthdate is enabled. See Enhanced match for more information.
+
+
+ - `aem_loc_enabled` (bool=False, Nullable): Whether Automatic Enhanced Match location is enabled. See Enhanced match for more information.
+
+
+
+**Returns:**
+
+ - `ConversionTag`: ConversionTag Object
+
+---
+
+
+
+### classmethod `get_all`
+
+```python
+get_all(
+ ad_account_id: 'str',
+ filter_deleted: 'bool' = False,
+ client: 'PinterestSDKClient' = None,
+ **kwargs
+) → list[ConversionTag]
+```
+
+Get a list of ConversionTag, filter by specified arguments
+
+
+
+**Args:**
+
+ - `ad_account_id` (str): Unique identifier of an ad account.
+ - `filter_deleted` (bool=False, optional): Filter out deleted tags.
+ - `client` (_type_, optional): PinterestSDKClient Object. Uses the default client, if not provided.
+
+
+
+**Returns:**
+
+ - `list[ConversionTag]`: List of ConversionTags
+
+---
+
+
+
+### classmethod `get_ocpm_eligible_conversion_tag_events`
+
+```python
+get_ocpm_eligible_conversion_tag_events(
+ ad_account_id: 'str',
+ client: 'PinterestSDKClient' = None,
+ **kwargs
+) → tuple[str, list[ConversionEventResponse]]
+```
+
+Get OCPM eligible conversion tag events for an Ad Account.
+
+
+
+**Args:**
+
+ - `ad_account_id` (str): Ad Account ID
+ - `client` (PinterestSDKClient, optional): PinterestSDKClient Object. Uses the default client, if not provided.
+
+
+
+**Returns:**
+
+ - `list[ConversionEventResponse]`: List of ConversionTagEvent
+
+---
+
+
+
+### classmethod `get_page_visit_conversion_tag_events`
+
+```python
+get_page_visit_conversion_tag_events(
+ ad_account_id: 'str',
+ page_size: 'int' = None,
+ order: 'str' = 'ASCENDING',
+ bookmark: 'str' = None,
+ client: 'PinterestSDKClient' = None,
+ **kwargs
+) → tuple[list[ConversionEventResponse], Bookmark]
+```
+
+Get page visit conversion tag events for an ad account.
+
+
+
+**Args:**
+
+ - `ad_account` (str): Ad Account ID
+ - `client` (PinterestSDKClient, optional): PinterestSDKClient Object. Uses the default client, if not provided.
+
+
+
+**Returns:**
+
+ - `list[ConversionEventResponse]`: List of ConversionTagEvent
+
+
diff --git a/docs/pinterest/organic.boards.md b/docs/pinterest/organic.boards.md
index 296e088..4b1ba75 100644
--- a/docs/pinterest/organic.boards.md
+++ b/docs/pinterest/organic.boards.md
@@ -419,8 +419,7 @@ Keyword Args: Any valid keyword arguments or query parameters for endpoint.
list_pins(
section_id: 'str' = None,
page_size: 'int' = None,
- bookmark: 'str' = None,
- **kwargs
+ bookmark: 'str' = None
) → tuple[list[Pin], Bookmark]
```
diff --git a/docs/pinterest/organic.pins.md b/docs/pinterest/organic.pins.md
index addad14..c8b5df2 100644
--- a/docs/pinterest/organic.pins.md
+++ b/docs/pinterest/organic.pins.md
@@ -9,12 +9,12 @@ Pin Class for Pinterest Python SDK
---
-
+
## class `Pin`
Pin model used to view, create, update its attributes and list its different entities.
-
+
### method `__init__`
@@ -152,7 +152,7 @@ By default, the "operation user_account" is the token user_account. Optional: Bu
---
-
+
### classmethod `create`
@@ -212,7 +212,7 @@ Keyword Args: Any valid keyword arguments or query parameters for endpoint.
---
-
+
### classmethod `delete`
@@ -240,7 +240,7 @@ Delete a Pin owned by the "operation user_account".
---
-
+
### method `save`
diff --git a/docs/pinterest/utils.base_model.md b/docs/pinterest/utils.base_model.md
index 061594d..ba5fe1c 100644
--- a/docs/pinterest/utils.base_model.md
+++ b/docs/pinterest/utils.base_model.md
@@ -9,12 +9,12 @@ Pinterest Base Model
---
-
+
## class `PinterestBaseModel`
Base Model for all other Higher Level Models in the Python Client
-
+
### method `__init__`
diff --git a/docs/pinterest/utils.bookmark.md b/docs/pinterest/utils.bookmark.md
index 67039cb..677ca0d 100644
--- a/docs/pinterest/utils.bookmark.md
+++ b/docs/pinterest/utils.bookmark.md
@@ -45,7 +45,7 @@ Initialize a Bookmark object.
---
-
+
### method `get_bookmark_token`
diff --git a/docs/pinterest/utils.load_json_config.md b/docs/pinterest/utils.load_json_config.md
index 7800ae2..6a6cb6a 100644
--- a/docs/pinterest/utils.load_json_config.md
+++ b/docs/pinterest/utils.load_json_config.md
@@ -19,3 +19,16 @@ load_json_config()
Parse a config.json file and then load all the variables found as environment variables.
+---
+
+
+
+## function `load_json_config_from_single_env_var`
+
+```python
+load_json_config_from_single_env_var()
+```
+
+Parse PINTEREST_JSON_ENV_VARIABLES environment variable to split long JSON string into individual environment variables.
+
+
diff --git a/docs/pinterest/utils.sdk_exceptions.md b/docs/pinterest/utils.sdk_exceptions.md
index f563d5c..1cea340 100644
--- a/docs/pinterest/utils.sdk_exceptions.md
+++ b/docs/pinterest/utils.sdk_exceptions.md
@@ -19,7 +19,7 @@ Raises an exception for Model's Errors
### method `__init__`
```python
-__init__(status=None, reason=None, http_resp=None)
+__init__(status=None, reason=None, http_resp=None, body=None)
```
diff --git a/docs/utils/README.md b/docs/utils/README.md
index 4c57256..4a08596 100644
--- a/docs/utils/README.md
+++ b/docs/utils/README.md
@@ -11,4 +11,4 @@ python3 docs/utils/script.py
## Documentation guide
-If you make change to this package, you have to regenerate doc, especially changes that add or remove module, you have to update `MODULES` and `IGNORED_FILES` under `script.py`
\ No newline at end of file
+When making change that add or remove module, you have to update `MODULES` and `IGNORED_FILES_INDEXING` accordingly and `IGNORE_MODULES` if needed.
\ No newline at end of file
diff --git a/docs/utils/python-sdk-doc.yaml b/docs/utils/python-sdk-doc.yaml
index 485bb35..531d11c 100644
--- a/docs/utils/python-sdk-doc.yaml
+++ b/docs/utils/python-sdk-doc.yaml
@@ -9,7 +9,7 @@ info:
url: https://spdx.org/licenses/MIT
termsOfService: https://developers.pinterest.com/terms/
title: Pinterest Python SDK
- version: 0.1.4
+ version: 0.2.0
openapi: 3.0.3
paths:
/test:
@@ -45,9 +45,10 @@ tags:
\ account. \nclient (PinterestSDKClient, optional):\
\ PinterestSDKClient Object. Defaults to default_api_client. \n Keyword Args:\
\ Any valid keyword arguments or query parameters for endpoint. Returns: Returns: \n\n Keyword Args: Any valid keyword arguments or query parameters for endpoint.\
\ Returns: Returns: \n\n Disable auto-targeting for ad group. Also\
\ known as \"\
expanded targeting\". Returns: Enable auto-targeting for ad group. Also\
\ known as \"\
expanded targeting\". Returns: Returns: Returns: Update adgroup fields using\
@@ -320,7 +322,7 @@ tags:
\ summary_status\n Returns: \n\n Returns: \n\n Update Ad fields suing any\
@@ -543,21 +545,21 @@ tags:
\ lifetime_spend_cap\n Activate a paused or archived campaign Returns: Archive an active or paused campaign Returns: Keyword Args: Any valid keyword arguments or query parameters\
\ for endpoint. Returns: \n\n Keyword Args: Any valid keyword arguments or query parameters\
\ for endpoint. Returns: \n\n Get the current daily spend cap\
\ budget of the campaign. Returns: \n\n Get the current life time spend\
\ cap budget of the campaign. Returns: \n\n Returns: \n\n Pause an active or archived campaign Returns: Update the campaign fields\
@@ -702,6 +704,155 @@ tags:
\ If campaign fields were successfully updated \n"
name: campaigns
x-traitTag: false
+- description: "\n\n Conversion\
+ \ Event Class for Pinterest Python SDK Conversion Event\
+ \ Model used to send conversion events to Pinterest API Create Conversion Event Data to be sent.\
+ \ Args: Returns: Send conversion events to Pinterest API for Conversions. Note: Highly\
+ \ recommend to use create_client_with_token (with Conversion Access Token) to\
+ \ create different client for this functionality. Conversion\
+ \ Class for Pinterest Python SDK Conversion\
+ \ Tag model used to view, create, update its attributes and list its different\
+ \ entities Initialize\
+ \ Conversion Tag Object. Args: Create a conversion\
+ \ tag, also known as Pinterest tag with the option to enable enhance match. The Pinterest Tag tracks actions people take on the ad account\u2019\
+ \ s website after they view the ad account's ad on Pinterest. The advertiser\
+ \ needs to customize this tag to track conversions. For more\
+ \ information, see: Args: Returns: Get a list of ConversionTag, filter by specified arguments Args: Returns: Get OCPM eligible conversion tag\
+ \ events for an Ad Account. Args: Returns: Get page visit\
+ \ conversion tag events for an ad account. Args: Returns: High\
@@ -1050,19 +1201,19 @@ tags:
> Get a list of the Pins on a board owned by the \"operation user_account\" -\
- \ or on a group board that has been shared with this account. Args: Keyword Args: Any valid keyword arguments or query parameters\
- \ for endpoint. Returns: Get a list\
+ \ of the Pins on a board owned by the \"operation user_account\" - or on a group\
+ \ board that has been shared with this account. Args: Keyword Args: Any valid keyword arguments or query parameters for endpoint.\
+ \ Returns: Pin Class\
- \ for Pinterest Python SDK \n Pin model used to view,\
\ create, update its attributes and list its different entities. property title\n Keyword Args:\
\ Any valid keyword arguments or query parameters for endpoint. Returns: Returns: \n Save a pin\
@@ -1211,11 +1362,11 @@ tags:
- description: "\n\n Pinterest\
- \ Base Model Parse PINTEREST_JSON_ENV_VARIABLES environment variable to split long JSON
+ string into individual environment variables.
\nproperty currency
\n
\nproperty\
+ \ id
\n
\nproperty name
\n
\nproperty\
+ \ owner
\n
\nproperty permissions
\n
\nproperty\
+ \ updated_time
\n
\nclassmethod
\ncreatepython\n\
create(\n name: 'str',\n owner_user_id: 'str',\n country: 'str',\n \
@@ -66,7 +67,7 @@ tags:
\ (PinterestSDKClient): PinterestSDKClient Object \n\n\n
\nAdAccount: AdAccount Object
\n\
- \nmethod
\nlist_audiencespython\n\
list_audiences(\n entity_statuses: 'list[str]' = None,\n page_size: 'int'\
@@ -85,7 +86,7 @@ tags:
\ Cursor used to fetch the next page of items. Defaults to None. \n\n\
\n
\nlist[Audience]:\
\ List of Audience Objects Bookmark: Bookmark\
- \ for pagination if present, else None.
\n
\nmethod
\nlist_campaignspython\n\
list_campaigns(\n campaign_ids: 'list[str]' = None,\n entity_statuses: 'list[str]'\
@@ -111,7 +112,7 @@ tags:
\n
\nlist[Campaign]:\
\ List of Campaign Objects Bookmark: Bookmark\
- \ for pagination if present, else None.
\nclient\
\ (PinterestSDKClient, optional): PinterestSDKClient Object. Defaults to default_api_client.\
\ \n
\nAdGroup:\
- \ AdGroup Object
\n
\nmethod
\ndisable_auto_targetingpython\n\
disable_auto_targeting()\n
\nbool:\
\ true if ad group disable auto_targeting_enabled
\nmethod
\nenable_auto_targetingpython\n\
enable_auto_targeting()\n
\nbool:\
\ true if ad group enable auto_targeting_enabled
\nclassmethod
\nget_allpython\n\
get_all(\n ad_account_id: 'str',\n campaign_ids: 'list[str]' = None,\n \
@@ -259,7 +261,7 @@ tags:
\ (PinterestSDKClient, optional): description. Defaults to default_api_client.\
\ \n\n\n
\ntuple[list[AdGroup],\
\ Bookmark]: description
\nmethod
\nlist_adspython\n\
list_ads(\n ad_ids: 'list[str]' = None,\n entity_statuses: 'list[str]' =\
@@ -279,7 +281,7 @@ tags:
\ Cursor used to fetch the next page of items. Defaults to None. \n\n\
\n
\n\
- list[Ad]: List\
\ of Ads Bookmark: Bookmark object
\nmethod
\nupdate_fieldspython\n\
update_fields(**kwargs) \u2192 bool
\nproperty tracking_urls
\nproperty type
\n
\nproperty updated_time
\n\
\nproperty view_tracking_url
\n
\nclassmethod
\ncreatepython\n\
create(\n ad_account_id: 'str',\n ad_group_id: 'str',\n creative_type:\
@@ -372,7 +374,7 @@ tags:
\ URL for ad impressions. Defaults to None. \nclient\
\ (PinterestSDKClient, optional): PinterestSDKClient Object. Defaults to default_api_client.\
\ \n
\nAd:\
- \ The newly created Ad.
\n
\nclassmethod
\nget_allpython\n\
get_all(\n ad_account_id: 'str',\n campaign_ids: 'list[str]' = None,\n \
@@ -404,7 +406,7 @@ tags:
\ \nclient (ApiClient): ApiClient Object \n
\nlist[Ad]:\
\ List of Ad Objects Bookmark: Bookmark for pagination\
- \ if present, else None.
\n
\nmethod
\nupdate_fieldspython\n\
update_fields(**kwargs) \u2192 bool
\nproperty name
\n
\n\
property objective_type
\n
\nproperty order_line_id
\n\
\nproperty start_time
\n
\nproperty\
- \ status
\n
\nproperty tracking_urls
\n
\nproperty\
- \ type
\n
\nproperty updated_time
\n
\n
\nproperty summary_status
\n
\nproperty\
+ \ tracking_urls
\n
\nproperty type
\n
\nproperty\
+ \ updated_time
\n
\nmethod
\nactivatepython\n\
activate() \u2192 bool\n
\nbool: If campaign\
\ status was successfully changed to 'ACTIVE'
\nmethod
\narchivepython\n\
archive() \u2192 bool\n
\nbool: If campaign\
\ status was successfully changed to 'ARCHIVED'
\nclassmethod
\ncreatepython\n\
create(\n ad_account_id: 'str',\n name: 'str',\n objective_type: 'str',\n\
@@ -623,7 +625,7 @@ tags:
\ optional): PinterestSDKClient Object, uses the default client, if not provided.\
\ \n\n\n
\nCampaign:\
- \ Campaign Object
\n
\nclassmethod
\nget_allpython\n\
get_all(\n ad_account_id: 'str',\n campaign_ids: 'list[str]' = None,\n \
@@ -648,17 +650,17 @@ tags:
\ Object \n\n\n
\nlist[Campaign]:\
\ List of Campaign Objects Bookmark: Bookmark\
- \ for pagination if present, else None.
\n
\nmethod
\nget_daily_budgetpython\n\
get_daily_budget() \u2192 float\n
\nfloat:\
- \ Current daily spend cap budget
\n
\nmethod
\nget_lifetime_budgetpython\n\
get_lifetime_budget() \u2192 float\n
\nfloat:\
- \ Current life time spend cap budget
\n
\nmethod
\nlist_ad_groupspython\n\
list_ad_groups(\n page_size: 'int' = 25,\n order: 'str' = 'ASCENDING',\n\
@@ -672,12 +674,12 @@ tags:
\ description. Defaults to None. \nentity_statuses\
\ (str, optional): description. Defaults to None. \n
\ntuple[list[AdGroup], Bookmark]: description\
- \
\n
\nmethod
\npausepython\npause()\
\ \u2192 bool\n
\nbool: If campaign status was successfully changed\
- \ to 'PAUSED'
\n\nmethod
\nupdate_fieldspython\n\
update_fields(**kwargs) \u2192 boolmodule
\nads.conversion_events
\nclass
\nConversion
\nclassmethod
\n\
+ create_conversion_eventpython\ncreate_conversion_event(\n event_name: 'str',\n action_source:\
+ \ 'str',\n event_time: 'int',\n event_id: 'str',\n user_data: 'dict',\n\
+ \ custom_data: 'dict',\n event_source_url: 'str' = None,\n partner_name:\
+ \ 'str' = None,\n app_id: 'str' = None,\n app_name: 'str' = None,\n app_version:\
+ \ 'str' = None,\n device_brand: 'str' = None,\n device_carrier: 'str' =\
+ \ None,\n device_model: 'str' = None,\n device_type: 'str' = None,\n \
+ \ os_version: 'str' = None,\n language: 'str' = None,\n **kwargs\n) \u2192\
+ \ ConversionEventsData\n
\nevent_name\
+ \ (str): The type of the user event, Enum: \"add_to_cart\", \"checkout\", \"\
+ custom\", \"lead\", \"page_visit\", \"search\", \"signup\", \"view_category\"\
+ , \"watch_video\" action_source (str): The source\
+ \ indicating where the conversion event occurred, Enum: \"app_adroid\", \"app_ios\"\
+ , \"web\", \"offline\" event_time (int): The time\
+ \ when the event happened. Unix timestamp in seconds event_id\
+ \ (str): The unique id string that identifies this event and can be used for\
+ \ deduping between events ingested via both the conversion API and Pinterest\
+ \ tracking user_data (dict): Object containing\
+ \ customer information data. Note, it is required at least one of 1) em, 2) hashed_maids\
+ \ or 3) pair client_ip_address + client_user_agent. custom_data\
+ \ (dict): Object containing other custom data. event_source_url\
+ \ (str, optional): URL of the web conversion event partner_name\
+ \ (str, optional): The third party partner name responsible to send the event\
+ \ to Conversion API on behalf of the adverstiser. Only send this field if Pinterest\
+ \ has worked directly with you to define a value for partner_name. app_id\
+ \ (str, optional): The app store app ID. app_name\
+ \ (str, optional): Name of the app. app_version\
+ \ (str, optional): Version of the app. device_brand\
+ \ (str, optional): Brand of the user device. device_carrier\
+ \ (str, optional): User device's model carrier. device_model\
+ \ (str, optional): Model of the user device. device_type\
+ \ (str, optional): Type of the user device. os_version\
+ \ (str, optional): Version of the device operating system. language\
+ \ (str, optional): Two-character ISO-639-1 language code indicating the user's\
+ \ language. \n
\nConversionEventsData:\
+ \ ConversionEventData to be sent
\nclassmethod
\n\
+ send_conversion_eventspython\nsend_conversion_events(\n ad_account_id: 'str',\n conversion_events:\
+ \ 'list[ConversionEventsData]',\n test: 'bool' = False,\n client: 'PinterestSDKClient'\
+ \ = None,\n **kwargs\n) \u2192 tuple(int, int, list[ConversionApiResponseEvents])module
\nads.conversion_tags
\nclass
\nConversionTagmethod
\n__init__python\n\
+ __init__(\n ad_account_id: 'str',\n conversion_tag_id: 'str',\n client:\
+ \ 'PinterestSDKClient' = None,\n **kwargs\n) \u2192 None\n
\nad_account_id\
+ \ (str): ConversionTag's Ad Account ID conversion_tag_id\
+ \ (str): ConversionTag ID, must be associated with Ad Account ID provided client (PinterestSDKClient, optional): PinterestSDKClient\
+ \ Object. Uses the default client, if not provided.
\nproperty\
+ \ ad_account_id
\n
\nproperty code_snippet
\n
\n\
+ property configs
\n
\nproperty enhanced_match_status
\n\
+
\nproperty id
\n
\nproperty last_fired_time_ms
\n\
+
\nproperty name
\n
\nproperty status
\n\
+
\nproperty version
\n
\nclassmethod
\ncreatepython\n\
+ create(\n ad_account_id: 'str',\n name: 'str',\n aem_enabled: 'bool'\
+ \ = None,\n md_frequency: 'float' = None,\n aem_fnln_enabled: 'bool' = None,\n\
+ \ aem_ph_enabled: 'bool' = None,\n aem_ge_enabled: 'bool' = None,\n aem_db_enabled:\
+ \ 'bool' = None,\n aem_loc_enabled: 'bool' = None,\n client: 'PinterestSDKClient'\
+ \ = None,\n **kwargs\n) \u2192 ConversionTag\n
\nad_account_id\
+ \ (str): ConversionTag's Ad Account ID name (str):\
+ \ ConversionTag name aem_enabled (bool=False,\
+ \ Nullable): Whether Automatic Enhanced Match email is enabled. See \
+ \ Enhanced match for more information. md_frequency\
+ \ (float=1.0, Nullable): Metadata ingestion frequency. aem_fnln_enabled\
+ \ (bool=False, Nullable): Whether Automatic Enhanced Match name is enabled. See\
+ \ Enhanced match for more information. aem_ph_enabled\
+ \ (bool=False, Nullable): Whether Automatic Enhanced Match phone is enabled.\
+ \ See Enhanced match for more information. aem_ge_enabled\
+ \ (bool=False, Nullable): Whether Automatic Enhanced Match gender is enabled.\
+ \ See Enhanced match for more information. aem_db_enabled\
+ \ (bool=False, Nullable): Whether Automatic Enhanced Match birthdate is enabled.\
+ \ See Enhanced match for more information. aem_loc_enabled\
+ \ (bool=False, Nullable): Whether Automatic Enhanced Match location is enabled.\
+ \ See Enhanced match for more information. \n
\n\
+ ConversionTag: ConversionTag Object
\nclassmethod
\nget_allpython\n\
+ get_all(\n ad_account_id: 'str',\n filter_deleted: 'bool' = False,\n \
+ \ client: 'PinterestSDKClient' = None,\n **kwargs\n) \u2192 list[ConversionTag]\n
\nad_account_id (str): Unique identifier of an ad\
+ \ account. filter_deleted (bool=False, optional):\
+ \ Filter out deleted tags. client (type,\
+ \ optional): PinterestSDKClient Object. Uses the default client, if not provided.\
+ \ \n
\nlist[ConversionTag]:\
+ \ List of ConversionTags
\nclassmethod
\n\
+ get_ocpm_eligible_conversion_tag_eventspython\nget_ocpm_eligible_conversion_tag_events(\n ad_account_id:\
+ \ 'str',\n client: 'PinterestSDKClient' = None,\n **kwargs\n) \u2192 tuple[str,\
+ \ list[ConversionEventResponse]]\n
\nad_account_id\
+ \ (str): Ad Account ID client (PinterestSDKClient,\
+ \ optional): PinterestSDKClient Object. Uses the default client, if not provided.\
+ \ \n
\nlist[ConversionEventResponse]:\
+ \ List of ConversionTagEvent
\nclassmethod
\n\
+ get_page_visit_conversion_tag_eventspython\nget_page_visit_conversion_tag_events(\n ad_account_id: 'str',\n\
+ \ page_size: 'int' = None,\n order: 'str' = 'ASCENDING',\n bookmark:\
+ \ 'str' = None,\n client: 'PinterestSDKClient' = None,\n **kwargs\n) \u2192\
+ \ tuple[list[ConversionEventResponse], Bookmark]\n
\nad_account (str): Ad Account ID client\
+ \ (PinterestSDKClient, optional): PinterestSDKClient Object. Uses the default\
+ \ client, if not provided. \n\
+
"
+ name: conversion_tags
+ x-traitTag: false
- description: "\n\nlist[ConversionEventResponse]: List of ConversionTagEvent\
+ \ module
\nads.customer_listsmethod
\nlist_pinspython\n\
list_pins(\n section_id: 'str' = None,\n page_size: 'int' = None,\n bookmark:\
- \ 'str' = None,\n **kwargs\n) \u2192 tuple[list[Pin], Bookmark]\n
\n\
- \n
\nsection_id (str,\
- \ optional): Unique identifier of a board section. If not passed in, all pins\
- \ under the board will be listed. page_size (int[1..100],\
- \ optional): Maximum number of items to include in a single page of the response.\
- \ See documentation on Pagination for more information. Defaults to None which\
- \ will return default page size campaigns. bookmark\
- \ (str, optional): Cursor used to fetch the next page of items. Defaults to None.\
- \ \n
list[Pin]:\
+ \ 'str' = None\n) \u2192 tuple[list[Pin], Bookmark]\n
\n\n
\n\
+ section_id (str, optional): Unique identifier of\
+ \ a board section. If not passed in, all pins under the board will be listed.\
+ \ page_size (int[1..100], optional): Maximum number\
+ \ of items to include in a single page of the response. See documentation on\
+ \ Pagination for more information. Defaults to None which will return default\
+ \ page size campaigns. bookmark (str, optional):\
+ \ Cursor used to fetch the next page of items. Defaults to None. \n
\nlist[Pin]:\
\ List of Pin Objects Bookmark: Bookmark for\
\ pagination if present, else None.
\n![](\"https://img.shields.io/badge/-source-cccccc?style=flat-square\"\){kind=icon}
module
\norganic.pins
\n
\nclass
\nPinmethod
\n__init__python\n\
__init__(\n pin_id: 'str',\n ad_account_id: 'str' = None,\n client: 'PinterestSDKClient'\
@@ -1144,7 +1295,7 @@ tags:
\ dominant_color\n
\nproperty id
\n
\nproperty\
\ link
\n
\nproperty media
\n
\nproperty\
\ media_source
\n
\nproperty parent_pin_id
\n
\n\
- property title
\n
\n
\nclassmethod
\ncreatepython\n\
create(\n board_id: 'str',\n media_source: 'dict',\n link: 'str' = None,\n\
@@ -1185,7 +1336,7 @@ tags:
\ Object, uses the default client, if not provided. \n\n\n
\nPin: Pin object
\nclassmethod
\ndeletepython\n\
delete(pin_id: 'str', client: 'PinterestSDKClient' = None) \u2192 boolclient (PinterestSDKClient, optional): PinterestSDKClient\
\ Object. Uses the default client, if not provided. \n
\nbool: If the pin was deleted successfully.
\n
\nmethod
\nsavepython\nsave(board_id:\
\ 'str', board_section_id: 'str' = None) \u2192 Nonemodule
\nutils.base_model
\n
+
+
+
+ function
+
+ load_json_config_from_single_env_varpython
+
+ load_json_config_from_single_env_var()