GetSharedEntities 服務作業 - 活動管理
取得負關鍵字清單或網站排除清單。
重要事項
只有擁有 PlacementExclusionList) 之網站排除清單的客戶) ( (管理員帳戶的使用者,才能更新或刪除清單、新增或刪除清單專案,以及將清單與廣告帳戶產生關聯。 如果您的廣告帳戶與您不擁有的網站排除清單相關聯,您可以解除清單與帳戶的關聯,但清單和清單專案是唯讀的。 清單的擁有者取決於關聯的 SharedEntityCustomerId 元素。
如果您可以存取帳戶階層中的多個管理員帳戶,則作業的結果可能會因您設定的 CustomerId 要求標頭 元素而有所不同。
要求專案
GetSharedEntitiesRequest物件會定義服務作業要求的主體和標頭元素。 元素的順序必須與 要求 SOAP中所示的順序相同。
注意事項
除非下面另有說明,否則所有要求專案都是必要的。
要求本文專案
元素 | 說明 | 資料類型 |
---|---|---|
SharedEntityScope | 指出共用實體是否可在客戶) 層級的廣告帳戶 (帳戶) 或管理員 帳戶 (使用 。 此元素為選擇性專案,且預設為 帳戶 範圍。 廣告帳戶範圍僅適用于負關鍵字清單。 將此元素設定為 Customer ,以在您的管理員帳戶中取得網站排除清單, (客戶) 共用程式庫。 |
EntityScope |
SharedEntityType | 要從廣告帳戶或管理員帳戶 (客戶) 程式庫取得的共用實體類型。 將此元素設定為 NegativeKeywordList,以在您的廣告帳戶共用程式庫中取得 negative 關鍵字清單 (NegativeKeywordList) 。 將此元素設定為 PlacementExclusionList,以在您的管理員帳戶 (客戶) 共用程式庫中取得 PlacementExclusionList) (網站排除清單。 |
string |
要求標頭元素
元素 | 說明 | 資料類型 |
---|---|---|
AuthenticationToken | OAuth 存取權杖,代表具有 Microsoft Advertising 帳戶許可權之使用者的認證。 如需詳細資訊,請 參閱使用 OAuth 進行驗證。 |
string |
CustomerAccountId | 擁有或與要求中實體相關聯之廣告帳戶的識別碼。 當兩者都需要時,此標頭元素必須具有與 AccountId body 元素相同的值。 此元素是大部分服務作業的必要專案,最佳做法是一律加以設定。 如需詳細資訊, 請參閱取得您的帳戶和客戶識別碼。 |
string |
CustomerId | (使用者存取或操作之使用者) 客戶的管理員帳戶識別碼。 使用者可以存取多個管理員帳戶。 此元素是大部分服務作業的必要專案,最佳做法是一律加以設定。 如需詳細資訊, 請參閱取得您的帳戶和客戶識別碼。 |
string |
DeveloperToken | 用來存取 Bing 廣告 API 的開發人員權杖。 如需詳細資訊 ,請參閱取得開發人員權杖。 |
string |
密碼 | 此元素會保留供內部使用,並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定使用者認證。 | string |
UserName | 此元素會保留供內部使用,並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定使用者認證。 | string |
Response 元素
GetSharedEntitiesResponse物件會定義服務作業回應的主體和標頭元素。 這些元素的傳回順序與 回應 SOAP中所示的順序相同。
回應本文專案
元素 | 說明 | 資料類型 |
---|---|---|
SharedEntities | 負關鍵字清單或網站排除清單。 | SharedEntity 數 組 |
回應標頭元素
元素 | 說明 | 資料類型 |
---|---|---|
TrackingId | 包含 API 呼叫詳細資料的記錄專案識別碼。 | string |
要求 SOAP
此範本是由工具所產生,用來顯示 SOAP 要求的主體和標頭元素順序。 如需可搭配此服務作業使用的支援類型,請參閱上述 的要求本文專案 參考。
<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">GetSharedEntities</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>
<GetSharedEntitiesRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<SharedEntityType i:nil="false">ValueHere</SharedEntityType>
<SharedEntityScope i:nil="false">ValueHere</SharedEntityScope>
</GetSharedEntitiesRequest>
</s:Body>
</s:Envelope>
回應 SOAP
此範本是由工具所產生,用來顯示 SOAP 回應的 主體 和 標頭 元素順序。
<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>
<GetSharedEntitiesResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<SharedEntities d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<SharedEntity d4p1:type="-- derived type specified here with the appropriate prefix --">
<AssociationCount d4p1:nil="false">ValueHere</AssociationCount>
<ForwardCompatibilityMap xmlns:e166="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e166:KeyValuePairOfstringstring>
<e166:key d4p1:nil="false">ValueHere</e166:key>
<e166:value d4p1:nil="false">ValueHere</e166:value>
</e166:KeyValuePairOfstringstring>
</ForwardCompatibilityMap>
<Id d4p1:nil="false">ValueHere</Id>
<Name d4p1:nil="false">ValueHere</Name>
<Type d4p1:nil="false">ValueHere</Type>
<!--This field is applicable if the derived type attribute is set to SharedList-->
<ItemCount d4p1:nil="false">ValueHere</ItemCount>
</SharedEntity>
</SharedEntities>
</GetSharedEntitiesResponse>
</s:Body>
</s:Envelope>
程式碼語法
範例語法可以與 Bing 廣告 SDK搭配使用。 如需更多範例,請參閱 Bing 廣告 API 程式碼范 例。
public async Task<GetSharedEntitiesResponse> GetSharedEntitiesAsync(
string sharedEntityType,
EntityScope? sharedEntityScope)
{
var request = new GetSharedEntitiesRequest
{
SharedEntityType = sharedEntityType,
SharedEntityScope = sharedEntityScope
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetSharedEntitiesAsync(r), request));
}
static GetSharedEntitiesResponse getSharedEntities(
java.lang.String sharedEntityType,
EntityScope sharedEntityScope) throws RemoteException, Exception
{
GetSharedEntitiesRequest request = new GetSharedEntitiesRequest();
request.setSharedEntityType(sharedEntityType);
request.setSharedEntityScope(sharedEntityScope);
return CampaignManagementService.getService().getSharedEntities(request);
}
static function GetSharedEntities(
$sharedEntityType,
$sharedEntityScope)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetSharedEntitiesRequest();
$request->SharedEntityType = $sharedEntityType;
$request->SharedEntityScope = $sharedEntityScope;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetSharedEntities($request);
}
response=campaignmanagement_service.GetSharedEntities(
SharedEntityType=SharedEntityType,
SharedEntityScope=SharedEntityScope)
需求
服務: CampaignManagementService.svc v13
命名 空間: https://bingads.microsoft.com/CampaignManagement/v13