bingads.v13.internal package

Subpackages

Submodules

bingads.v13.internal.extensions module

bingads.v13.internal.extensions.ad_group_bid_bulk_str(value)[source]
bingads.v13.internal.extensions.ad_rotation_bulk_str(value, id)[source]
bingads.v13.internal.extensions.bid_bulk_str(value, id)[source]
bingads.v13.internal.extensions.bid_multiplier_bulk_str(value)[source]
bingads.v13.internal.extensions.bid_strategy_biddingscheme_to_csv(bulk_bid_strategy, row_values)[source]
bingads.v13.internal.extensions.budget_to_csv(bulk_campaign, row_values)[source]
bingads.v13.internal.extensions.bulk_date_str(value)[source]
bingads.v13.internal.extensions.bulk_datetime_str(value)[source]
bingads.v13.internal.extensions.bulk_datetime_str2(value)[source]
bingads.v13.internal.extensions.bulk_device_preference_str(value)[source]
bingads.v13.internal.extensions.bulk_optional_str(value, id)[source]
bingads.v13.internal.extensions.bulk_str(value)[source]
bingads.v13.internal.extensions.bulk_upper_str(value)[source]
bingads.v13.internal.extensions.campaign_biddingscheme_to_csv(bulk_campaign, row_values)[source]
bingads.v13.internal.extensions.combination_rules_to_bulkstring(combination_rules)[source]
bingads.v13.internal.extensions.create_target_setting_detail(token)[source]
bingads.v13.internal.extensions.csv_to_bid_strategy_biddingscheme(row_values, bulk_bid_strategy)[source]
bingads.v13.internal.extensions.csv_to_budget(row_values, bulk_campaign)[source]
bingads.v13.internal.extensions.csv_to_campaign_biddingscheme(row_values, bulk_campaign)[source]
bingads.v13.internal.extensions.csv_to_commission_rate(entity, value)[source]
bingads.v13.internal.extensions.csv_to_entity_DSAWebpageParameter(row_values, entity)[source]

convert Campaign/Ad Group Criterion (WebpagePage) Web page parameters to bulk row values :param row_values: bulk row values :param entity: campaign/ad group criterion entity

bingads.v13.internal.extensions.csv_to_entity_PriceTableRows(row_values, entity)[source]

convert Price Ad Extension price table rows to bulk row values :param row_values: bulk row values :param entity: price ad extension entity

bingads.v13.internal.extensions.csv_to_field_AdSchedule(entity, value)[source]
bingads.v13.internal.extensions.csv_to_field_AgeRanges(entity, value)[source]
bingads.v13.internal.extensions.csv_to_field_AgeTarget(entity, value)[source]
bingads.v13.internal.extensions.csv_to_field_AudienceIds(entity, value)[source]
bingads.v13.internal.extensions.csv_to_field_BidAdjustment(entity, value)[source]
bingads.v13.internal.extensions.csv_to_field_BidStrategyType(entity, value)[source]

set BiddingScheme :param entity: entity which has BiddingScheme attribute :param value: the content in csv :return:

bingads.v13.internal.extensions.csv_to_field_BudgetType(entity, value, version=13)[source]
bingads.v13.internal.extensions.csv_to_field_CampaignAssociations(entity, value)[source]
bingads.v13.internal.extensions.csv_to_field_CampaignLanguages(entity, value)[source]

set Languages string field :param entity: Languages :param value: the content in csv :return:set field values

bingads.v13.internal.extensions.csv_to_field_CampaignType(entity, value)[source]
bingads.v13.internal.extensions.csv_to_field_CashbackAdjustment(entity, value)[source]
bingads.v13.internal.extensions.csv_to_field_CheckInDay(entity, value)[source]
bingads.v13.internal.extensions.csv_to_field_CriterionAudienceId(entity, value)[source]
bingads.v13.internal.extensions.csv_to_field_CustomAttributes(feed, value)[source]
bingads.v13.internal.extensions.csv_to_field_Date(entity, property_name, value)[source]
bingads.v13.internal.extensions.csv_to_field_DayTimeTarget(entity, value)[source]
bingads.v13.internal.extensions.csv_to_field_DealTarget(entity, value)[source]
bingads.v13.internal.extensions.csv_to_field_DeviceTarget(entity, value)[source]
bingads.v13.internal.extensions.csv_to_field_EndDate(entity, value)[source]
bingads.v13.internal.extensions.csv_to_field_FeedItemAdSchedule(entity, value)[source]
bingads.v13.internal.extensions.csv_to_field_FromHour(entity, value)[source]
bingads.v13.internal.extensions.csv_to_field_FromMinute(entity, value)[source]
bingads.v13.internal.extensions.csv_to_field_GenderTarget(entity, value)[source]
bingads.v13.internal.extensions.csv_to_field_GenderTypes(entity, value)[source]
bingads.v13.internal.extensions.csv_to_field_GenreId(entity, value)[source]
bingads.v13.internal.extensions.csv_to_field_HotelDateSelectionType(entity, value)[source]
bingads.v13.internal.extensions.csv_to_field_LatitudeDegrees(entity, value)[source]
bingads.v13.internal.extensions.csv_to_field_LocationIntentTarget(entity, value)[source]
bingads.v13.internal.extensions.csv_to_field_LocationName(entity, value)[source]
bingads.v13.internal.extensions.csv_to_field_LocationTarget(entity, value)[source]
bingads.v13.internal.extensions.csv_to_field_LocationType(entity, value)[source]
bingads.v13.internal.extensions.csv_to_field_LongitudeDegrees(entity, value)[source]
bingads.v13.internal.extensions.csv_to_field_MaxDays(entity, value)[source]
bingads.v13.internal.extensions.csv_to_field_MaxNights(entity, value)[source]
bingads.v13.internal.extensions.csv_to_field_MediaIds(entity, value)[source]

MediaIds csv to entity :param entity: :return:

bingads.v13.internal.extensions.csv_to_field_MinDays(entity, value)[source]
bingads.v13.internal.extensions.csv_to_field_MinNights(entity, value)[source]
bingads.v13.internal.extensions.csv_to_field_OSName(entity, value)[source]
bingads.v13.internal.extensions.csv_to_field_PageFeedIds(value)[source]
bingads.v13.internal.extensions.csv_to_field_Radius(entity, value)[source]
bingads.v13.internal.extensions.csv_to_field_RadiusName(entity, value)[source]
bingads.v13.internal.extensions.csv_to_field_RadiusUnit(entity, value)[source]
bingads.v13.internal.extensions.csv_to_field_RemarketingRule(entity, value)[source]

parse remarketing rule string and set remarketing rule attribute value :param entity: remarketing list entity :param value: bulk string value

bingads.v13.internal.extensions.csv_to_field_StartDate(entity, value)[source]
bingads.v13.internal.extensions.csv_to_field_SupportedCampaignTypes(entity, value)[source]
bingads.v13.internal.extensions.csv_to_field_ToHour(entity, value)[source]
bingads.v13.internal.extensions.csv_to_field_ToMinute(entity, value)[source]
bingads.v13.internal.extensions.csv_to_field_UrlCustomParameters(entity, value)[source]
bingads.v13.internal.extensions.csv_to_field_Urls(entity, value)[source]

set FinalUrls / FinalMobileUrls string field :param entity: FinalUrls / FinalMobileUrls :param value: the content in csv :return:set field values

bingads.v13.internal.extensions.csv_to_field_WebpageParameter_CriterionName(entity, value)[source]
bingads.v13.internal.extensions.csv_to_field_delimited_strings(entity, value)[source]
bingads.v13.internal.extensions.csv_to_hotel_setting(entity, value)[source]
bingads.v13.internal.extensions.csv_to_percent_cpc_bid(entity, value)[source]
bingads.v13.internal.extensions.csv_to_status(c, v)[source]
bingads.v13.internal.extensions.csv_to_target_setting(entity, value)[source]
bingads.v13.internal.extensions.custom_event_rule_str(rule)[source]
bingads.v13.internal.extensions.dict_bulk_str(parameters, separator)[source]
bingads.v13.internal.extensions.entity_biddingscheme_to_csv(entity, row_values)[source]
bingads.v13.internal.extensions.entity_csv_to_biddingscheme(row_values, entity)[source]
bingads.v13.internal.extensions.entity_to_csv_DSAWebpageParameter(entity, row_values)[source]

Set Campaign/AdGroup Criterion (WebpagePage) Web page parameters from bulk values :param entity: campaign/ad group criterion entity :param row_values: bulk row values

bingads.v13.internal.extensions.entity_to_csv_PriceTableRows(entity, row_values)[source]

Set Price Ad Extension price table rows from bulk values :param entity: price ad extension entity :param row_values: bulk row values

bingads.v13.internal.extensions.escape_parameter_text(s)[source]
bingads.v13.internal.extensions.field_to_csv_AdSchedule(entity, id)[source]

get the bulk string for Scheduling DayTimeRanges :param entity: Scheduling entity :return: bulk str

bingads.v13.internal.extensions.field_to_csv_AgeRanges(entity)[source]
bingads.v13.internal.extensions.field_to_csv_AgeTarget(entity)[source]
bingads.v13.internal.extensions.field_to_csv_AudienceIds(entity)[source]
bingads.v13.internal.extensions.field_to_csv_BidAdjustment(entity)[source]
bingads.v13.internal.extensions.field_to_csv_BidStrategyType(entity)[source]

parse entity to csv content :param entity: entity which has BiddingScheme attribute :return: csv content

bingads.v13.internal.extensions.field_to_csv_CampaignAssociations(entity)[source]
bingads.v13.internal.extensions.field_to_csv_CampaignLanguages(entity)[source]

parse entity to csv content :param entity: Languages :return: csv content

bingads.v13.internal.extensions.field_to_csv_CampaignType(entity)[source]
bingads.v13.internal.extensions.field_to_csv_CashbackAdjustment(entity)[source]
bingads.v13.internal.extensions.field_to_csv_CheckInDay(entity)[source]
bingads.v13.internal.extensions.field_to_csv_CriterionAudienceId(entity)[source]
bingads.v13.internal.extensions.field_to_csv_CustomAttributes(custom_attributes)[source]
bingads.v13.internal.extensions.field_to_csv_DayTimeTarget(entity)[source]
bingads.v13.internal.extensions.field_to_csv_DealTarget(entity)[source]
bingads.v13.internal.extensions.field_to_csv_DeviceTarget(entity)[source]
bingads.v13.internal.extensions.field_to_csv_EndDate(entity)[source]
bingads.v13.internal.extensions.field_to_csv_FeedItemAdSchedule(entity, id)[source]

get the bulk string for FeedItem DayTimeRanges :param entity: Scheduling entity :return: bulk str

bingads.v13.internal.extensions.field_to_csv_FromHour(entity)[source]
bingads.v13.internal.extensions.field_to_csv_FromMinute(entity)[source]
bingads.v13.internal.extensions.field_to_csv_GenderTarget(entity)[source]
bingads.v13.internal.extensions.field_to_csv_GenderTypes(entity)[source]
bingads.v13.internal.extensions.field_to_csv_GenreId(entity)[source]
bingads.v13.internal.extensions.field_to_csv_HotelDateSelectionType(entity)[source]
bingads.v13.internal.extensions.field_to_csv_Ids(ids, entity_id)[source]
bingads.v13.internal.extensions.field_to_csv_LatitudeDegrees(entity)[source]
bingads.v13.internal.extensions.field_to_csv_LocationIntentTarget(entity)[source]
bingads.v13.internal.extensions.field_to_csv_LocationName(entity)[source]
bingads.v13.internal.extensions.field_to_csv_LocationTarget(entity)[source]
bingads.v13.internal.extensions.field_to_csv_LocationType(entity)[source]
bingads.v13.internal.extensions.field_to_csv_LongitudeDegrees(entity)[source]
bingads.v13.internal.extensions.field_to_csv_MaxDays(entity)[source]
bingads.v13.internal.extensions.field_to_csv_MaxNights(entity)[source]
bingads.v13.internal.extensions.field_to_csv_MediaIds(entity)[source]

MediaIds field to csv content :param entity: entity which has MediaIds attribute :return:

bingads.v13.internal.extensions.field_to_csv_MinDays(entity)[source]
bingads.v13.internal.extensions.field_to_csv_MinNights(entity)[source]
bingads.v13.internal.extensions.field_to_csv_OSName(entity)[source]
bingads.v13.internal.extensions.field_to_csv_Radius(entity)[source]
bingads.v13.internal.extensions.field_to_csv_RadiusName(entity)[source]
bingads.v13.internal.extensions.field_to_csv_RadiusUnit(entity)[source]
bingads.v13.internal.extensions.field_to_csv_RemarketingRule(entity)[source]

convert remarketing rule to bulk string :param entity: remarketing list entity

bingads.v13.internal.extensions.field_to_csv_SchedulingDate(theDate, id)[source]

write scheduling StartDate to bulk string :param theDate: Date obj to convert :return: date bulk string

bingads.v13.internal.extensions.field_to_csv_SchedulingEndDate(entity, id)[source]

write scheduling EndDate to bulk string :param entity: Scheduling entity :return: date bulk string

bingads.v13.internal.extensions.field_to_csv_SchedulingStartDate(entity, id)[source]

write scheduling StartDate to bulk string :param entity: Scheduling entity :return: date bulk string

bingads.v13.internal.extensions.field_to_csv_StartDate(entity)[source]
bingads.v13.internal.extensions.field_to_csv_SupportedCampaignTypes(entity)[source]
bingads.v13.internal.extensions.field_to_csv_ToHour(entity)[source]
bingads.v13.internal.extensions.field_to_csv_ToMinute(entity)[source]
bingads.v13.internal.extensions.field_to_csv_UrlCustomParameters(entity)[source]

transfer the CustomParameters of a entity to csv content (string) :param entity: the entity which contains UrlCustomparameters attribute :return: csv string content

bingads.v13.internal.extensions.field_to_csv_Urls(entity, id)[source]

parse entity to csv content :param entity: FinalUrls / FinalMobileUrls :return: csv content

bingads.v13.internal.extensions.field_to_csv_UseSearcherTimeZone(bool_value, id)[source]
bingads.v13.internal.extensions.field_to_csv_WebpageParameter_CriterionName(entity)[source]
bingads.v13.internal.extensions.field_to_csv_bool(bool_value)[source]
bingads.v13.internal.extensions.field_to_csv_delimited_strings(entity)[source]
bingads.v13.internal.extensions.fixed_bid_bulk_str(value)[source]
bingads.v13.internal.extensions.format_Day(value)[source]
bingads.v13.internal.extensions.hotel_setting_to_csv(entity)[source]
bingads.v13.internal.extensions.keyword_bid_bulk_str(value, id)[source]
bingads.v13.internal.extensions.location_target_type_bulk_str(value)[source]
bingads.v13.internal.extensions.match_target_setting(token)[source]
bingads.v13.internal.extensions.minute_bulk_str(value)[source]
bingads.v13.internal.extensions.multi_bulk_str(parameters, separator)[source]
bingads.v13.internal.extensions.parse_ad_group_bid(value)[source]
bingads.v13.internal.extensions.parse_ad_rotation(value)[source]
bingads.v13.internal.extensions.parse_bid(value)[source]
bingads.v13.internal.extensions.parse_bool(value)[source]
bingads.v13.internal.extensions.parse_combination_rules(combination_list, value)[source]
bingads.v13.internal.extensions.parse_date(d_str)[source]
bingads.v13.internal.extensions.parse_datetime(dt_str)[source]

Convert the datetime str to datetime object.

Parameters

dt_str (str) – The string representing a datetime object.

Returns

The datetime object parsed from the string.

Return type

datetime | None

bingads.v13.internal.extensions.parse_datetime2(value)[source]
bingads.v13.internal.extensions.parse_device_preference(value)[source]
bingads.v13.internal.extensions.parse_dict(value)[source]
bingads.v13.internal.extensions.parse_fixed_bid(value)[source]
bingads.v13.internal.extensions.parse_keyword_bid(value)[source]
bingads.v13.internal.extensions.parse_location_target_type(value)[source]
bingads.v13.internal.extensions.parse_minute(value)[source]
bingads.v13.internal.extensions.parse_multi(value)[source]
bingads.v13.internal.extensions.parse_number_operator(operator)[source]
bingads.v13.internal.extensions.parse_rule_CustomEvents(rule_str)[source]
bingads.v13.internal.extensions.parse_rule_PageVisitors(rule_str)[source]
bingads.v13.internal.extensions.parse_rule_PageVisitorsWhoDidNotVisitAnotherPage(rule_str)[source]
bingads.v13.internal.extensions.parse_rule_PageVisitorsWhoVisitedAnotherPage(rule_str)[source]
bingads.v13.internal.extensions.parse_rule_groups(groups_str)[source]
bingads.v13.internal.extensions.parse_rule_items(items_str)[source]
bingads.v13.internal.extensions.parse_string_operator(operator)[source]
bingads.v13.internal.extensions.parse_string_rule_item(item_str)[source]
bingads.v13.internal.extensions.parse_verified_tracking_setting(str)[source]
bingads.v13.internal.extensions.rule_item_groups_str(groups, nf=Disjunctive)[source]
bingads.v13.internal.extensions.rule_items_str(items, innerOperator=' and ')[source]
bingads.v13.internal.extensions.target_setting_to_csv(entity)[source]
bingads.v13.internal.extensions.to_operation(op)[source]
bingads.v13.internal.extensions.to_verified_tracking_setting_string(value)[source]
bingads.v13.internal.extensions.unescape_parameter_text(s)[source]

Module contents