GetCampaignAdExtensions REST Template
Gets the campaign’s preferences for whether to include the business’ address and phone number in its text ads.
The identifier of the account that owns the campaigns.
The campaignIds value is a constant string that indicates that the POST method is getting the address and phone preferences for the specified campaigns. The body of the request includes the list of campaign identifiers whose preferences you want to get.
The following specifies the HTTP method, supported content types, and base URI to use in your request.
HTTP method: POST
Supported content types: XML and JSON
To use JSON, your request URL must include the “format=json” query string.
The key names that you use for the JSON members are the same as the elements of the XML objects shown in the examples below.
Production base URI: https://adcenterapi.microsoft.com/Api/Advertiser/v8/CampaignManagement/CampaignManagementServiceREST.svc
Sandbox base URI: Not available.
The following are the headers to include in your request.
The application access token. This header is not used.
The account identifier. For more information, see Account and Customer Identifiers.
The customer identifier. For more information, see Account and Customer Identifiers.
The developer access token.
The user’s logon password.
The user’s logon user name.
The following XML fragment shows the elements that you use to get the negative keywords for the specified campaigns. For a description of each element and the header elements that your request must include, see the GetCampaignAdExtensionRequest message.
<GetCampaignAdExtensionsRequest xmlns="http://schemas.datacontract.org/2004/07/HostedService.CampaignManagementService.Rest" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <CampaignIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:long></d4p1:long> </CampaignIds> </GetCampaignAdExtensionsRequest>
The following XML fragment shows the elements that are included in the response. For a description of each element and the TrackingId header element that the response includes, see the GetCampaignAdExtensionResponse message.
<GetCampaignAdExtensionsResponse xmlns="http://schemas.datacontract.org/2004/07/Microsoft.AdCenter.Advertiser.CampaignManagement.Api.DataContracts" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <AdExtensions xmlns:c="https://adcenter.microsoft.com/v8"> <c:AdExtension> <c:CampaignId></c:CampaignId> <c:EnableLocationExtension></c:EnableLocationExtension> <c:PhoneExtension> <c:Country></c:Country> <c:EnableClickToCallOnly></c:EnableClickToCallOnly> <c:EnablePhoneExtension></c:EnablePhoneExtension> <c:Phone></c:Phone> </c:PhoneExtension> </c:AdExtension> </AdExtensions> </GetCampaignAdExtensionsResponse>
If an error occurs, the service returns one of the following HTTP error codes.
Bad request, which indicates that the request data contains an error. The response will contain either an ApiFaultDetail or AdApiFaultDetail object that identifies the error. For a list of possible error codes, see Campaign Management Error Codes and Common Error Codes.
Method not allowed, which indicates that the URI template is not correct.