Return additional fields behaviour - API

Question

Good afternoon,

I am working on app integration, and the description of the element ReturnAdditionalFields doesn't look totally right. It says that "The list of additional properties that you want included...". However, the data type is not a list/array type. Does it mean that you can only send one additional field in the request?

Example:

• Get Account: https://docs.microsoft.com/en-us/advertising/customer-management-service/getaccount?view=bingads-13

• AccountAdditionalField Values: https://docs.microsoft.com/en-us/advertising/customer-management-service/accountadditionalfield?view=bingads-13

Thanks.

Answer 1

Hello Connectors Dev,

Thank you for using our Microsoft Advertising Community Forum!

I understand that you are currently experiencing some challenges pulling API data for Account information?

Based on the syntax snippet provided, I do have a couple of questions regarding the stage at which you find yourself in.

I see within your example syntax that you are trying to request account data.

The data should, indeed, be a list. A list defined by you, created by you, and the ValueHere field should be the name of the respective list created by you.

The Account Additional Fields request is optional. Meaning that it is not required, however.

This is the best help source where you can find more information on the Account Additional Field Value: Syntax.

Therefore, the Return Additional Field is supposed to be a list (of Type AccountAdditionalField) created by you, and the ReturnAdditionalFields row, specifically >ValueHere<, should have the name of the list inserted there for the system to be able to connect the request with the respective list in order to receive the response SOAP with all the account data.

Hope this will help. If you would like to dive into more details, I’d be happy to discuss further by private messaging (especially if it is account specific information).

I will send you a private message to offer my continued support in case you’d like to discuss more, as mentioned above.

Have a great day!

Kind regards,

Anna | Microsoft Advertising Support Specialist | 800-518-5689

Answer 2

Hi everyone,

Just for people who can be in the same situation, I found out how to use the list in a SOAP request/payload.

As per another type list, 'Company type' (https://docs.microsoft.com/en-us/advertising/campaign-management-service/getcampaignsbyaccountid?view=bingads-13): "You may include multiple values as flags. How you specify multiple flags depends on the programming language that you use. For example, C# treats these values as flag values and Java treats them as an array of strings. The SOAP should include a string that contains a space-delimited list of values for example, <CampaignType>Search Shopping</CampaignType>."

So you can do so for 'ReturnAdditionalFields'. For example:

<ReturnAdditionalFields i:nil="false">AdScheduleUseSearcherTimeZone TargetSetting</ReturnAdditionalFields>

It would be great to have that description in the type/schema level instead of single operations.

Answer 3

Hi Anna,

Thanks for your response. However, I would really appreciate it if you could please provide an XML request/payload that will retrieve more than one additional field for each account.

Please let me show you another example with 'GetCampaignsByAccountId' where I can add 'AdScheduleUseSearcherTimeZone' or 'TargetSetting' additional fields but not both at the same time.

• AdScheduleUseSearcherTimeZone:

• TargetSetting:

Hence, if the description says: 'The list of additional properties that you want included within each returned campaign...', how am I able to have more than one additional field? Thanks.

Kind regards,

Manuel | Tray.io Software Engineer