Ad Groups
- class ad_api.api.sb.AdGroupsV4(account: str = 'default', marketplace: Marketplaces = Marketplaces.EU, credentials: Dict[str, str] | None = None, proxies: Dict[str, str] | None = None, verify: bool = True, timeout: int | None = None, debug: bool = False, access_token: str | None = None, verify_additional_credentials: bool = True)
Version 4 of Sponsored Brands
- create_ad_groups(self, version: int = 4, **kwargs) ApiResponse:
Creates Sponsored Brand Ad Group.
Request Body | campaignId (string) : The identifier of the campaign to which the keyword is associated. | name (string) : The name of the ad group. | state (CreateOrUpdateEntityState > string) : Entity state for create or update operation. Enum : [ENABLED, PAUSED]
- Returns
ApiResponse
- edit_ad_groups(self, version: int = 4, **kwargs) ApiResponse:
Update Sponsored Brand Ad groups.
Request Body
campaignId (string) : The identifier of the campaign to which the keyword is associated. [optional]name (string) : The name of the ad group. [optional]state (CreateOrUpdateEntityState > string) : Entity state for create or update operation. Enum : [ENABLED, PAUSED]- Returns
ApiResponse
- list_ad_groups(self, version: int = 4, **kwargs) ApiResponse:
List Sponsored Brand Ad groups.
Request Body (optional) | campaignIdFilter (dict) : Filter entities by the list of objectIds. | stateFilter (dict) : Filter entities by state. | maxResults (int) : Number of records to include in the paginated response. Defaults to max page size for given API. | nextToken (string) : Token value allowing to navigate to the next response page. | adGroupIdFilter (dict) : Filter entities by the list of objectIds. | includeExtendedDataFields (boolean) Setting to true will slow down performance because the API needs to retrieve extra information for each campaign. | nameFilter (dict) : Filter entities by name.
- Returns:
- ApiResponse
- delete_ad_groups(self, version: int = 4, **kwargs) ApiResponse:
Delete Sponsored Brands ad groups.
- Request Body (optional) :
- adGroupIdFilter (dict)Filter entities by the list of objectIds. [optional]
include (list) : Entity object identifier.
- Returns
ApiResponse
- create_ad_groups(**kwargs)
Creates Sponsored Brand Ad Group.
Request Body | campaignId (string) : The identifier of the campaign to which the keyword is associated. | name (string) : The name of the ad group. | state (CreateOrUpdateEntityState > string) : Entity state for create or update operation. Enum : [ENABLED, PAUSED]
- Returns
ApiResponse
- edit_ad_groups(**kwargs)
Update Sponsored Brand Ad groups.
Request Body
campaignId (string) : The identifier of the campaign to which the keyword is associated. [optional]name (string) : The name of the ad group. [optional]state (CreateOrUpdateEntityState > string) : Entity state for create or update operation. Enum : [ENABLED, PAUSED]- Returns
ApiResponse
- list_ad_groups(**kwargs)
List Sponsored Brand Ad groups.
Request Body (optional) | campaignIdFilter (dict) : Filter entities by the list of objectIds. | stateFilter (dict) : Filter entities by state. | maxResults (int) : Number of records to include in the paginated response. Defaults to max page size for given API. | nextToken (string) : Token value allowing to navigate to the next response page. | adGroupIdFilter (dict) : Filter entities by the list of objectIds. | includeExtendedDataFields (boolean) Setting to true will slow down performance because the API needs to retrieve extra information for each campaign. | nameFilter (dict) : Filter entities by name.
- Returns:
- ApiResponse
- delete_ad_groups(**kwargs)
Delete Sponsored Brands ad groups.
- Request Body (optional) :
- adGroupIdFilter (dict)Filter entities by the list of objectIds. [optional]
include (list) : Entity object identifier.
- Returns
ApiResponse
