Microsoft Bing Ads Component

Manage Microsoft Bing Ad Customer Services

Component key: ms-bing-ads

Description

Microsoft Advertising is a pay-per-click (PPC) advertising platform used to display ads based on the keywords used in a user's search query. For advertisers placing a large number of ads or developers building advertising tools, the Bing Ads API provides programmatic access to Microsoft Advertising.

Using the Bing Ads API is the most efficient way to manage many large campaigns or to integrate your marketing with other in-house systems. Some organizations may choose a hybrid approach; using the web UI for most tasks but automating reporting or campaign optimization with the API.

This component allows you to add external conversions to Ads campaigns.

Microsoft documents many frequent asked questions that will aid in troubleshooting.

Microsoft Bing Ads Connections

OAuth 2.0 Authorization Code

This component uses OAuth 2.0 to connect to the Microsoft Bing Ads API.

To use Bing Ads APIs, you must have a developer token and valid user credentials. If you do not yet have a Microsoft Advertising account, you can sign up via the Microsoft Advertising web application.

You can follow these steps to get a developer token for production.

1. Sign in with Super Admin credentials at the Microsoft Advertising Developer Portal account tab.
2. Choose the user that you want associated with the developer token. Typically an application only needs one universal token regardless how many users will be supported.
3. Click on the Request Token button.

Microsoft Advertising leverages the Microsoft identity platform endpoint for developers and the OAuth 2.0 protocol to authenticate work or school accounts from Azure Active Directory (AAD) and personal Microsoft accounts (MSA), such as hotmail.com, outlook.com, and msn.com.

Before your application can authenticate Microsoft Advertising users, you must register your application and get the corresponding client ID and client secret.

1. Navigate to the Microsoft identity platform for developers in the Azure portal - App registrations page. You can login using either a personal Microsoft Account or a Work or School Account.

2. Select New registration.

3. When the Register an application page appears, enter your application's registration information:

   • In the Name section, enter a meaningful application name that will be displayed to users of the app, for example My browserless client.
   • In the Supported account types section, select Accounts in any organizational directory and personal Microsoft accounts.

4. Select Register to create the application.

5. On the app Overview page, find the Application (client) ID value and record it for later. You will use it as the client_id when you request user consent and get an access token.

6. Select the Add a Redirect URI link and then you should see the Redirect URIs page.

   • For web applications, provide the base URL of your application. For Prismatic, use callback url https://oauth2.prismatic.io/callback. Users would use this URL to sign into a web client application.

7. For web applications, select Certificates & secrets under Manage. Select the New client secret button. Enter a value in Description, select any option for Expires and choose Add. Copy the client secret value before leaving the page. You will use it later as the client_secret to get an access token.

Now that you have a Client ID and Client Secret, add Microsoft Bing Ads step to your integration in Prismatic.

Open the Configuration Wizard Designer by clicking Configuration Wizard, select your Microsoft Bing Ads Connection and enter your client ID and secret.

Input	Default	Notes
Input Authorize URL string / Required Hidden Field	Default https://login.microsoftonline.com/common/oauth2/v2.0/authorize	Notes The OAuth 2.0 Authorization URL for Microsoft Bing Ads
Input Client ID string / Required	Default	Notes
Input Client Secret Value password / Required	Default	Notes
Input Developer Token password / Required	Default	Notes Developer token of your Account Manager account
Input Scopes string Hidden Field	Default https://ads.microsoft.com/msads.manage offline_access	Notes Microsoft Bing Ads permission scopes are set on the OAuth application
Input Token URL string / Required Hidden Field	Default https://login.microsoftonline.com/common/oauth2/v2.0/token	Notes The OAuth 2.0 Token URL for Microsoft Bing Ads

Data Sources

Select Account ID

Gets the account identifiers that are accessible from the specified customer. | key: selectAccountId | type: picklist

Input	Notes
Input Connection connection / Required	Notes
Input Customer ID string	Notes

Data Source Payload

{  "result": [    { "key": "17685412", "label": "XYZ 1 (id: 17685412)" },    { "key": "68745216", "label": "XYZ 2 (id: 68745216)" },    { "key": "89442154", "label": "XYZ 3 (id: 89442154)" }  ]}

---

Select Customer ID

Gets the customer identifiers that are accessible to the current authenticated user. | key: selectCustomerId | type: picklist

Input	Notes
Input Connection connection / Required	Notes

Data Source Payload

{  "result": [    { "key": "17685412", "label": "XYZ 1 (id: 17685412)" },    { "key": "68745216", "label": "XYZ 2 (id: 68745216)" },    { "key": "89442154", "label": "XYZ 3 (id: 89442154)" }  ]}

---

Actions

Add Client Link

Initiates the client link process to manage the accounts of another customer. Sends a link request from one customer to another customer or account. | key: addClientLinks

Input	Default	Notes
Input Client Entity ID string	Default	Notes The identifier of the client advertiser account or client customer to manage.
Input Connection connection / Required	Default	Notes
Input Customer Link Permission string	Default	Notes Determines whether the user's access to the accounts is restricted by customer hierarchy i.e., customer level client linking. This element is only applicable if Type is set to CustomerLink. In that case, the possible values include Administrative and Standard. Otherwise this field should be nil or empty.
Input Inviter Email string	Default	Notes The email of the user who created the client link request.
Input Inviter Name string	Default	Notes The name of the parent customer of the user who created the client link request.
Input Inviter Phone string	Default	Notes The phone number of the user who created the client link request.
Input Is Bill To Client boolean	Default false	Notes Determines whether the owner of the client advertiser account or the managing customer is responsible for billing payments.
Input Managing Customer ID string / Required	Default	Notes The identifier of the customer who manages or is requesting to manage the client advertiser account.
Input Name string	Default	Notes The friendly name that can be used to reference this client link. The name can contain a maximum of 40 characters.
Input Note string	Default	Notes Optional message from the requestor providing context and details about the client link invitation.
Input Suppress Notification boolean	Default false	Notes Determines whether or not to send email notification of the client link invitation to the primary user of the client advertiser account. If set to true the client will not receive an email and otherwise, since the default value is false, the client will receive an email notification.
Input Type string / Required	Default AccountLink	Notes Determines whether the link is to a client advertiser account or a client customer.

Output Example Payload

{  "data": {    "OperationErrors": {      "OperationError": [        {          "Code": 12345678,          "Details": "xyz",          "Message": "some error message"        },        {          "Code": 12345678,          "Details": "xyz",          "Message": "some error message"        }      ]    },    "PartialErrors": {      "ArrayOfOperationError": {        "OperationError": [          {            "Code": 12345678,            "Details": "xyz",            "Message": "some error message"          },          {            "Code": 12345678,            "Details": "xyz",            "Message": "some error message"          }        ]      }    }  }}

---

Get Account Info

Gets the identifiers, names, and numbers of accounts that are accessible from the specified customer. | key: getAccountsInfo

Input	Notes
Input Connection connection / Required	Notes
Input Customer ID string	Notes The identifier of the customer used to get the account information. This request element is optional. If not set, the user's credentials are used to determine the customer.

Output Example Payload

{  "data": {    "AccountsInfo": {      "AccountInfo": [        {          "Id": 12345678,          "Name": "Account Name 1",          "Number": "F123456KG",          "AccountLifeCycleStatus": "Active"        },        {          "Id": 12345678,          "Name": "Account Name 2",          "Number": "F123456KG",          "AccountLifeCycleStatus": "Active"        }      ]    }  }}

---

Get Customer

Gets the details of a customer. | key: getCustomer

Input	Notes
Input Connection connection / Required	Notes
Input Customer ID string / Required	Notes The identifier of the customer whose information you want to get.

Output Example Payload

{  "data": {    "Customer": {      "CustomerFinancialStatus": "ClearFinancialStatus",      "Id": 1234567,      "Industry": "NA",      "LastModifiedByUserId": 2,      "LastModifiedTime": "2022-10-26T13:35:34.957",      "MarketCountry": "US",      "ForwardCompatibilityMap": {        "KeyValuePairOfstringstring": [          {            "key": "ManagedByCustomerId",            "value": 0          }        ],        "MarketLanguage": "English",        "Name": "zyx",        "ServiceLevel": "SelfServe",        "CustomerLifeCycleStatus": "Active",        "TimeStamp": "AAAAADlQGFU=",        "Number": "F145006C7T",        "CustomerAddress": {          "City": "Sioux Falls",          "CountryCode": "US",          "Id": 135264702,          "Line1": "1235 W 12th St",          "Line2": "Suite 202",          "PostalCode": 27108,          "StateOrProvince": "fl",          "TimeStamp": "AAAAADlQGE4="        }      }    }  }}

---

Get Customers Info

Gets the identifiers and names of customers that are accessible to the current authenticated user. The results are filtered by customer name. | key: getCustomersInfo

Input	Default	Notes	Example
Input Connection connection / Required	Default	Notes	Example
Input Customer Name Filter string	Default	Notes A partial or full name of the customers that you want to get. The operation includes the customer in the result if the customer's name begins with the specified filter name. This request element is optional. If you do not want to filter by customer name, set this element to an empty string.	Example
Input Top Number string	Default 5	Notes A nonzero positive integer that specifies the number of customers to return in the result.	Example 5

Output Example Payload

{  "data": {    "CustomersInfo": {      "CustomerInfo": [        {          "Id": 12345678,          "Name": "xyz inc"        },        {          "Id": 12345689,          "Name": "xyz inc"        }      ]    }  }}

---

Get Linked Accounts And Customers Info

Gets the customer and account hierarchy under the specified customer. | key: getLinkedAccountsAndCustomersInfo

Input	Default	Notes
Input Connection connection / Required	Default	Notes
Input Customer ID string / Required	Default	Notes The identifier of the customer whose hierarchy you want to get.
Input Only Parent Accounts boolean	Default false	Notes Determines whether to return only the advertiser accounts that belong to the customer or to also return linked customers and linked advertiser accounts under other customers. To limit the results to advertiser accounts directly under the specified customer, set this element to true, and otherwise leave it empty or set the property to false. The default value is false.

Output Example Payload

{  "data": {    "AccountsInfo": {      "AccountInfo": [        {          "Id": 12345678,          "Name": "Account Name 1",          "Number": "F123456KG",          "AccountLifeCycleStatus": "Active"        },        {          "Id": 12345678,          "Name": "Account Name 2",          "Number": "F123456KG",          "AccountLifeCycleStatus": "Active"        }      ]    },    "CustomersInfo": {      "CustomerInfo": [        {          "Id": 12345678,          "Name": "xyz inc"        }      ]    }  }}

---

Raw Request

Issue any request to Bing Ads API. | key: rawRequest

Input	Default	Notes
Input Account ID string / Required	Default	Notes Use this field to search the Id element of the AdvertiserAccount.
Input Connection connection / Required	Default	Notes
Input Customer ID string / Required	Default	Notes
Input Soap Action string / Required	Default	Notes After selecting the Microsoft Bing API Web Service, the Soap Action is the method or endpoint you want call.
Input Soap Body Request code / Required	Default	Notes The required SOAP Body element contains the actual SOAP message intended for the ultimate endpoint of the message. Immediate child elements of the SOAP Body element may be namespace-qualified.
Input Web Service API string / Required	Default CUSTOMER_MANAGEMENT_API	Notes Bing Ads API Version 13 includes the following web service addresses.

---

Search Accounts

Searches for accounts that match the request criteria. | key: searchAccounts

Input	Notes
Input Account ID string	Notes Use this field to search the Id element of the AdvertiserAccount.
Input Account Life Cycle Status string	Notes Use this field to search the AccountLifeCycleStatus element of the AdvertiserAccount.
Input Account Name string	Notes Use this field to search the Name element of the AdvertiserAccount.
Input Account Number string	Notes Use this field to search the Number element of the AdvertiserAccount.
Input Connection connection / Required	Notes
Input Customer ID string	Notes Use this field to search the Id element of the Customer.
Input Ordering string	Notes Determines the order of results by the specified property of an account.
Input User ID string	Notes Use this field to search the UserId element of the User.

Output Example Payload

{  "data": {    "Accounts": {      "AdvertiserAccount": [        {          "BillToCustomerId": 369545927,          "CurrencyCode": "USD",          "AccountFinancialStatus": "ClearFinancialStatus",          "Id": 156089854,          "Language": "English",          "LastModifiedByUserId": 3,          "LastModifiedTime": "2022-10-26T18:6:8.443",          "Name": "XYZ.co",          "Number": "F168K7MC",          "ParentCustomerId": 1696874121,          "PaymentMethodId": 1268789111,          "PaymentMethodType": "CreditCard",          "PrimaryUserId": 168125418,          "AccountLifeCycleStatus": "Active",          "TimeStamp": "AAAAADlTWUc=",          "TimeZone": "CentralTimeUSCanada",          "LinkedAgencies": {            "CustomerInfo": [              {                "Id": 12345678,                "Name": "xyz inc"              },              {                "Id": 12345689,                "Name": "xyz inc"              }            ]          },          "TaxInformation": {            "KeyValuePairOfstringstring": [              {                "key": "ManagedByCustomerId",                "value": 0              }            ]          },          "BusinessAddress": {            "City": "Sioux Falls",            "CountryCode": "US",            "Id": 135264777,            "Line1": "4516 S 50th St",            "Line2": "Suite 220",            "PostalCode": 37108,            "StateOrProvince": "NE",            "BusinessName": "XYZ Software Inc."          },          "AutoTagType": "Inactive"        }      ]    }  }}

---

Search Client Links

Searches for the client links for the customer of the current authenticated user, filtered by the search criteria. The operation returns the most recent link for each unique combination of agency customer and client account. | key: searchClientLinks

Input	Notes
Input Client Account ID string	Notes Search for advertiser account ClientLink objects by the client advertiser account identifier.
Input Client Customer ID string	Notes Search for customer ClientLink objects by the client customer identifier.
Input Connection connection / Required	Notes
Input Direct Managing Customer ID string	Notes Search for both customer and advertiser account ClientLink objects by the agency's managing customer identifier. If other customers also link to the client customer, the results will not include those client links.
Input Managing Customer ID string / Required	Notes Search for advertiser account ClientLink objects by the agency's managing customer identifier. If other customers also link to the client advertiser account, the results will include those client links. This predicate value is deprecated in favor of the DirectManagingCustomerId predicate.
Input Ordering string	Notes Determines the order of results by the specified property of an account.

Output Example Payload

{  "data": {    "ClientLinks": {      "ClientLink": [        {          "ClientEntityId": 144015218,          "ClientEntityName": "Taylor - Test",          "ClientEntityNumber": "F113T5TB",          "InviterEmail": "taylor.reece@prismatic.io",          "InviterName": "Taylor",          "InviterPhone": "null",          "IsBillToClient": false,          "LastModifiedByUserId": 134084676,          "LastModifiedDateTime": "2022-11-11T15:26:49.357",          "ManagingCustomerId": 169592807,          "ManagingCustomerName": "prismatic.io",          "ManagingCustomerNumber": "F145006C7T",          "Name": "Taylor Link",          "Note": "null",          "StartDate": "2022-11-11T15:26:49.24Z",          "Status": "LinkPending",          "SuppressNotification": false,          "Timestamp": "AAAAAAAAAAA=",          "Type": "AccountLink"        },        {          "ClientEntityId": 138108451,          "ClientEntityName": "Test Example 1",          "ClientEntityNumber": "F107RHVU",          "InviterEmail": "jason.comes@prisamtic.io",          "InviterName": "Jason Comes",          "InviterPhone": "605-728-2868",          "IsBillToClient": true,          "LastModifiedByUserId": 134080686,          "LastModifiedDateTime": "2022-11-10T01:10:11.55",          "ManagingCustomerId": 169592807,          "ManagingCustomerName": "prismatic.io",          "ManagingCustomerNumber": "F145006C7T",          "Name": "Test Client Link",          "Note": "This is just a test",          "StartDate": "2022-11-10T01:10:11.423Z",          "Status": "LinkPending",          "SuppressNotification": false,          "Timestamp": "AAAAAAAAAAA=",          "Type": "AccountLink"        },        {          "ClientEntityId": 138108420,          "ClientEntityName": "Jason Comes",          "ClientEntityNumber": "F107A9K1",          "InviterEmail": "jason.comes@prisamtic.io",          "InviterName": "Jason Comes",          "InviterPhone": "605-728-2868",          "IsBillToClient": false,          "LastModifiedByUserId": 9,          "LastModifiedDateTime": "2022-11-10T00:56:25.223",          "ManagingCustomerId": 169592807,          "ManagingCustomerName": "prismatic.io",          "ManagingCustomerNumber": "F145006C7T",          "Name": "Test Client Link",          "Note": "This is just a test",          "StartDate": "2022-11-09T23:55:38.373Z",          "Status": "Active",          "SuppressNotification": false,          "Timestamp": "AAAAAAAAAAA=",          "Type": "AccountLink"        }      ]    }  }}

---

Send User Invitation

Sends an email invitation for a user to sign up for Microsoft Advertising. The invitation limits account access and permissions. | key: sendUserInvitation

Input	Default	Notes
Input Account ID string Value List	Default	Notes An array of identifiers of the accounts that the user can manage. To specify that the user can manage all current and future accounts of the customer to which the user belongs, set to NULL.
Input Connection connection / Required	Default	Notes
Input Customer ID string / Required	Default	Notes The identifier of the customer this user is invited to manage. The AccountIds element determines which customer accounts the user can manage.
Input Email string / Required	Default	Notes The email address corresponding to the user's Microsoft account. The address can contain a maximum of 100 characters.
Input First Name string / Required	Default	Notes The first name of the user. The first name is limited to 40 characters.
Input Last Name string / Required	Default	Notes The last name of the user. The last name is limited to 40 characters.
Input Lcid string / Required	Default EnglishUS	Notes The locale to use when sending correspondence to the user by email or postal mail.
Input Role Id string / Required	Default	Notes The role that the user has for each customer or list of accounts.

Output Example Payload

{  "data": {    "UserInvitationId": 134015178  }}

---