Edit

Share via

GetBrandKitsByAccountId Service Operation - Campaign Management

Retrieves all of the BrandKits associated with the specified account.

Request Elements

The GetBrandKitsByAccountIdRequest object defines the body and header elements of the service operation request. The elements must be in the same order as shown in the Request SOAP.

Note

Unless otherwise noted below, all request elements are required.

Request Body Elements

Element Description Data Type
AccountId The Microsoft Advertising identifier of the account. long

Request Header Elements

Element Description Data Type
AuthenticationToken The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts.

For more information see Authentication with OAuth.		 string
CustomerAccountId The identifier of the ad account that owns or is associated with the entities in the request. This header element must have the same value as the AccountId body element when both are required. This element is required for most service operations, and as a best practice you should always set it.

For more information see Get Your Account and Customer IDs.		 string
CustomerId The identifier of the manager account (customer) the user is accessing or operating from. A user can have access to multiple manager accounts. This element is required for most service operations, and as a best practice you should always set it.

For more information see Get Your Account and Customer IDs.		 string
DeveloperToken The developer token used to access the Bing Ads API.

For more information see Get a Developer Token.		 string
Password This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. string
UserName This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. string

Response Elements

The GetBrandKitsByAccountIdResponse object defines the body and header elements of the service operation response. The elements are returned in the same order as shown in the Response SOAP.

Response Body Elements

Element Description Data Type
BrandKits A list of brand kits to be retrieved for the specified account. BrandKit array

Response Header Elements

Element Description Data Type
TrackingId The identifier of the log entry that contains the details of the API call. string

Request SOAP

This template was generated by a tool to show the order of the body and header elements for the SOAP request. For supported types that you can use with this service operation, see the Request Body Elements reference above.

<s:Envelope xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
    <Action mustUnderstand="1">GetBrandKitsByAccountId</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <CustomerAccountId i:nil="false">ValueHere</CustomerAccountId>
    <CustomerId i:nil="false">ValueHere</CustomerId>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <GetBrandKitsByAccountIdRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <AccountId>ValueHere</AccountId>
    </GetBrandKitsByAccountIdRequest>
  </s:Body>
</s:Envelope>

Response SOAP

This template was generated by a tool to show the order of the body and header elements for the SOAP response.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
    <TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
  </s:Header>
  <s:Body>
    <GetBrandKitsByAccountIdResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <BrandKits d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <BrandKit>
          <BrandVoice d4p1:nil="false">
            <Personality d4p1:nil="false">ValueHere</Personality>
            <Tones d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <a1:string>ValueHere</a1:string>
            </Tones>
          </BrandVoice>
          <BusinessName d4p1:nil="false">ValueHere</BusinessName>
          <Fonts d4p1:nil="false">
            <BrandKitFont>
              <TextAssetType d4p1:nil="false">ValueHere</TextAssetType>
              <Typeface d4p1:nil="false">ValueHere</Typeface>
              <Weight d4p1:nil="false">ValueHere</Weight>
            </BrandKitFont>
          </Fonts>
          <Id d4p1:nil="false">ValueHere</Id>
          <Images d4p1:nil="false">
            <BrandKitImage>
              <CropHeight d4p1:nil="false">ValueHere</CropHeight>
              <CropWidth d4p1:nil="false">ValueHere</CropWidth>
              <CropX d4p1:nil="false">ValueHere</CropX>
              <CropY d4p1:nil="false">ValueHere</CropY>
              <Id>ValueHere</Id>
              <ThumbnailUrl d4p1:nil="false">ValueHere</ThumbnailUrl>
              <Url d4p1:nil="false">ValueHere</Url>
            </BrandKitImage>
          </Images>
          <LandscapeLogos d4p1:nil="false">
            <BrandKitImage>
              <CropHeight d4p1:nil="false">ValueHere</CropHeight>
              <CropWidth d4p1:nil="false">ValueHere</CropWidth>
              <CropX d4p1:nil="false">ValueHere</CropX>
              <CropY d4p1:nil="false">ValueHere</CropY>
              <Id>ValueHere</Id>
              <ThumbnailUrl d4p1:nil="false">ValueHere</ThumbnailUrl>
              <Url d4p1:nil="false">ValueHere</Url>
            </BrandKitImage>
          </LandscapeLogos>
          <Name d4p1:nil="false">ValueHere</Name>
          <Palettes d4p1:nil="false">
            <BrandKitPalette>
              <ColorType d4p1:nil="false">ValueHere</ColorType>
              <Colors d4p1:nil="false">
                <BrandKitColor>
                  <HexCode d4p1:nil="false">ValueHere</HexCode>
                  <Name d4p1:nil="false">ValueHere</Name>
                </BrandKitColor>
              </Colors>
              <Name d4p1:nil="false">ValueHere</Name>
            </BrandKitPalette>
          </Palettes>
          <SquareLogos d4p1:nil="false">
            <BrandKitImage>
              <CropHeight d4p1:nil="false">ValueHere</CropHeight>
              <CropWidth d4p1:nil="false">ValueHere</CropWidth>
              <CropX d4p1:nil="false">ValueHere</CropX>
              <CropY d4p1:nil="false">ValueHere</CropY>
              <Id>ValueHere</Id>
              <ThumbnailUrl d4p1:nil="false">ValueHere</ThumbnailUrl>
              <Url d4p1:nil="false">ValueHere</Url>
            </BrandKitImage>
          </SquareLogos>
        </BrandKit>
      </BrandKits>
    </GetBrandKitsByAccountIdResponse>
  </s:Body>
</s:Envelope>

Code Syntax

The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.

public async Task<GetBrandKitsByAccountIdResponse> GetBrandKitsByAccountIdAsync(
	long accountId)
{
	var request = new GetBrandKitsByAccountIdRequest
	{
		AccountId = accountId
	};

	return (await CampaignManagementService.CallAsync((s, r) => s.GetBrandKitsByAccountIdAsync(r), request));
}

static GetBrandKitsByAccountIdResponse getBrandKitsByAccountId(
	java.lang.Long accountId) throws RemoteException, Exception
{
	GetBrandKitsByAccountIdRequest request = new GetBrandKitsByAccountIdRequest();

	request.setAccountId(accountId);

	return CampaignManagementService.getService().getBrandKitsByAccountId(request);
}

static function GetBrandKitsByAccountId(
	$accountId)
{

	$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];

	$request = new GetBrandKitsByAccountIdRequest();

	$request->AccountId = $accountId;

	return $GLOBALS['CampaignManagementProxy']->GetService()->GetBrandKitsByAccountId($request);
}

response=campaignmanagement_service.GetBrandKitsByAccountId(
	AccountId=AccountId)

Requirements

Service: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13

Request Url

https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/BrandKits/QueryByAccountId

Request Elements

The GetBrandKitsByAccountIdRequest object defines the body and header elements of the service operation request.

Note

Unless otherwise noted below, all request elements are required.

Request Body Elements

Element Description Data Type
AccountId The Microsoft Advertising identifier of the account. long

Request Header Elements

Element Description Data Type
Authorization The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts. Please ensure that the token is prefixed with "Bearer ", this is necessary for proper authentication.

For more information see Authentication with OAuth.		 string
CustomerAccountId The identifier of the ad account that owns or is associated with the entities in the request. This header element must have the same value as the AccountId body element when both are required. This element is required for most service operations, and as a best practice you should always set it.

For more information see Get Your Account and Customer IDs.		 string
CustomerId The identifier of the manager account (customer) the user is accessing or operating from. A user can have access to multiple manager accounts. This element is required for most service operations, and as a best practice you should always set it.

For more information see Get Your Account and Customer IDs.		 string
DeveloperToken The developer token used to access the Bing Ads API.

For more information see Get a Developer Token.		 string
Password This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. string
UserName This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. string

Response Elements

The GetBrandKitsByAccountIdResponse object defines the body and header elements of the service operation response. The elements are returned in the same order as shown in the Response JSON.

Response Body Elements

Element Description Data Type
BrandKits A list of brand kits to be retrieved for the specified account. BrandKit array

Response Header Elements

Element Description Data Type
TrackingId The identifier of the log entry that contains the details of the API call. string

Request JSON

This template was generated by a tool to show the body and header elements for the JSON request. For supported types that you can use with this service operation, see the Request Body Elements reference above.

{
  "AccountId": "LongValueHere"
}

Response JSON

This template was generated by a tool to show the body and header elements for the JSON response.

{
  "BrandKits": [
    {
      "BrandVoice": {
        "Personality": "ValueHere",
        "Tones": [
          "ValueHere"
        ]
      },
      "BusinessName": "ValueHere",
      "Fonts": [
        {
          "TextAssetType": "ValueHere",
          "Typeface": "ValueHere",
          "Weight": "ValueHere"
        }
      ],
      "Id": "LongValueHere",
      "Images": [
        {
          "CropHeight": IntValueHere,
          "CropWidth": IntValueHere,
          "CropX": IntValueHere,
          "CropY": IntValueHere,
          "Id": "LongValueHere",
          "ThumbnailUrl": "ValueHere",
          "Url": "ValueHere"
        }
      ],
      "LandscapeLogos": [
        {
          "CropHeight": IntValueHere,
          "CropWidth": IntValueHere,
          "CropX": IntValueHere,
          "CropY": IntValueHere,
          "Id": "LongValueHere",
          "ThumbnailUrl": "ValueHere",
          "Url": "ValueHere"
        }
      ],
      "Name": "ValueHere",
      "Palettes": [
        {
          "Colors": [
            {
              "HexCode": "ValueHere",
              "Name": "ValueHere"
            }
          ],
          "ColorType": "ValueHere",
          "Name": "ValueHere"
        }
      ],
      "SquareLogos": [
        {
          "CropHeight": IntValueHere,
          "CropWidth": IntValueHere,
          "CropX": IntValueHere,
          "CropY": IntValueHere,
          "Id": "LongValueHere",
          "ThumbnailUrl": "ValueHere",
          "Url": "ValueHere"
        }
      ]
    }
  ]
}

Code Syntax

To call REST API through SDKs, you need to upgrade SDK to a certain version and configure the system parameters.The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.

public async Task<GetBrandKitsByAccountIdResponse> GetBrandKitsByAccountIdAsync(
	long accountId)
{
	var request = new GetBrandKitsByAccountIdRequest
	{
		AccountId = accountId
	};

	return (await CampaignManagementService.CallAsync((s, r) => s.GetBrandKitsByAccountIdAsync(r), request));
}

static GetBrandKitsByAccountIdResponse getBrandKitsByAccountId(
	java.lang.Long accountId) throws RemoteException, Exception
{
	GetBrandKitsByAccountIdRequest request = new GetBrandKitsByAccountIdRequest();

	request.setAccountId(accountId);

	return CampaignManagementService.getService().getBrandKitsByAccountId(request);
}

static function GetBrandKitsByAccountId(
	$accountId)
{

	$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];

	$request = new GetBrandKitsByAccountIdRequest();

	$request->AccountId = $accountId;

	return $GLOBALS['CampaignManagementProxy']->GetService()->GetBrandKitsByAccountId($request);
}

response=campaignmanagement_service.GetBrandKitsByAccountId(
	AccountId=AccountId)
  • Last updated on