AddSharedEntity 服務作業 - 行銷活動管理
將負關鍵字清單新增至廣告帳戶連結庫,或將網站排除清單新增至客戶) 程式庫 (管理員帳戶。
重要事項
只有擁有 PlacementExclusionList) 之網站排除清單的客戶) ( (管理員帳戶的使用者,才能更新或刪除清單、新增或刪除清單專案,以及將清單與廣告帳戶產生關聯。 如果您的廣告帳戶與您不擁有的網站排除清單相關聯,您可以解除清單與帳戶的關聯,但清單和清單專案是唯讀的。 清單的擁有者取決於關聯的 SharedEntityCustomerId 元素。
如果您可以存取帳戶階層中的多個管理員帳戶,則作業的結果可能會因您設定的 CustomerId 要求標頭 元素而有所不同。
要求專案
AddSharedEntityRequest物件會定義服務作業要求的主體和標頭元素。 元素的順序必須與 要求 SOAP中所示的順序相同。
注意事項
除非下面另有說明,否則所有要求專案都是必要的。
要求本文專案
元素 | 說明 | 資料類型 |
---|---|---|
ListItems | 負關鍵字 (新負關鍵字清單所包含) 總計 5,000 個,或負數網站 (新網站排除清單中包含的最大) 總計 10,000 個。 此清單可以包含每個服務呼叫最多 5,000 個專案。 若要新增更多清單專案,請呼叫 AddListItemsToSharedList 作業。 |
SharedListItem 數 組 |
SharedEntity | 負關鍵字清單或網站排除清單。 如果 SharedEntityScope 是空的或設定為 Account,而且 SharedEntity 是 NegativeKeywordList, 則 ListItems 必須是 negative 關鍵字 (NegativeKeyword) 物件。 如果 SharedEntityScope 設定為 Customer,而且 SharedEntity 是 PlacementExclusionList, 則 ListItems 必須是 negative 網站 (NegativeSite) 物件。 |
SharedEntity |
SharedEntityScope | 指出共用實體是否可在客戶) 層級的廣告帳戶 (帳戶) 或管理員 帳戶 (使用 。 此元素為選擇性專案,且預設為 帳戶 範圍。 廣告帳戶範圍僅適用于負關鍵字清單。 將此元素設定為 Customer ,以在您的管理員帳戶中新增網站排除清單 (客戶) 共用程式庫。 |
EntityScope |
要求標頭元素
元素 | 說明 | 資料類型 |
---|---|---|
AuthenticationToken | OAuth 存取權杖,代表具有 Microsoft Advertising 帳戶許可權之使用者的認證。 如需詳細資訊,請 參閱使用 OAuth 進行驗證。 |
string |
CustomerAccountId | 擁有或與要求中實體相關聯之廣告帳戶的識別碼。 當兩者都需要時,此標頭元素必須具有與 AccountId body 元素相同的值。 此元素是大部分服務作業的必要專案,最佳做法是一律加以設定。 如需詳細資訊, 請參閱取得您的帳戶和客戶識別碼。 |
string |
CustomerId | (使用者存取或操作之使用者) 客戶的管理員帳戶識別碼。 使用者可以存取多個管理員帳戶。 此元素是大部分服務作業的必要專案,最佳做法是一律加以設定。 如需詳細資訊, 請參閱取得您的帳戶和客戶識別碼。 |
string |
DeveloperToken | 用來存取 Bing 廣告 API 的開發人員權杖。 如需詳細資訊 ,請參閱取得開發人員權杖。 |
string |
密碼 | 此元素會保留供內部使用,並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定使用者認證。 | string |
UserName | 此元素會保留供內部使用,並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定使用者認證。 | string |
Response 元素
AddSharedEntityResponse物件會定義服務作業回應的主體和標頭元素。 這些元素的傳回順序與 回應 SOAP中所示的順序相同。
回應本文專案
元素 | 說明 | 資料類型 |
---|---|---|
ListItemIds |
long值的清單,表示已加入之清單專案的識別碼。 清單的專案可能會傳回為 Null。 對於未新增清單專案的每個清單索引,對應的專案會是 Null。 |
long 陣列 |
PartialErrors |
BatchError物件的陣列,其中包含任何未成功要求專案的詳細資料。 錯誤清單不會直接對應至要求中的專案清單。 如果沒有錯誤,清單可以是空的,或者可以包含一或多個對應到要求中每個不成功清單專案的錯誤物件。 |
BatchError 數 組 |
SharedEntityId | 已加入之共用實體的識別碼。 | 長 |
回應標頭元素
元素 | 說明 | 資料類型 |
---|---|---|
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">AddSharedEntity</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>
<AddSharedEntityRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<SharedEntity i:nil="false" i:type="-- derived type specified here with the appropriate prefix --">
<AssociationCount i:nil="false">ValueHere</AssociationCount>
<ForwardCompatibilityMap xmlns:e57="http://schemas.datacontract.org/2004/07/System.Collections.Generic" i:nil="false">
<e57:KeyValuePairOfstringstring>
<e57:key i:nil="false">ValueHere</e57:key>
<e57:value i:nil="false">ValueHere</e57:value>
</e57:KeyValuePairOfstringstring>
</ForwardCompatibilityMap>
<Id i:nil="false">ValueHere</Id>
<Name i:nil="false">ValueHere</Name>
<Type i:nil="false">ValueHere</Type>
<!--This field is applicable if the derived type attribute is set to SharedList-->
<ItemCount i:nil="false">ValueHere</ItemCount>
</SharedEntity>
<ListItems i:nil="false">
<SharedListItem i:type="-- derived type specified here with the appropriate prefix --">
<ForwardCompatibilityMap xmlns:e58="http://schemas.datacontract.org/2004/07/System.Collections.Generic" i:nil="false">
<e58:KeyValuePairOfstringstring>
<e58:key i:nil="false">ValueHere</e58:key>
<e58:value i:nil="false">ValueHere</e58:value>
</e58:KeyValuePairOfstringstring>
</ForwardCompatibilityMap>
<Type i:nil="false">ValueHere</Type>
<!--These fields are applicable if the derived type attribute is set to NegativeKeyword-->
<Id i:nil="false">ValueHere</Id>
<MatchType i:nil="false">ValueHere</MatchType>
<Text i:nil="false">ValueHere</Text>
<!--These fields are applicable if the derived type attribute is set to NegativeSite-->
<Id i:nil="false">ValueHere</Id>
<Url i:nil="false">ValueHere</Url>
<!--This field is applicable if the derived type attribute is set to BrandItem-->
<BrandId>ValueHere</BrandId>
</SharedListItem>
</ListItems>
<SharedEntityScope i:nil="false">ValueHere</SharedEntityScope>
</AddSharedEntityRequest>
</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>
<AddSharedEntityResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<ListItemIds d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<a1:long>ValueHere</a1:long>
</ListItemIds>
<PartialErrors d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<BatchError d4p1:type="-- derived type specified here with the appropriate prefix --">
<Code>ValueHere</Code>
<Details d4p1:nil="false">ValueHere</Details>
<ErrorCode d4p1:nil="false">ValueHere</ErrorCode>
<FieldPath d4p1:nil="false">ValueHere</FieldPath>
<ForwardCompatibilityMap xmlns:e59="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e59:KeyValuePairOfstringstring>
<e59:key d4p1:nil="false">ValueHere</e59:key>
<e59:value d4p1:nil="false">ValueHere</e59:value>
</e59:KeyValuePairOfstringstring>
</ForwardCompatibilityMap>
<Index>ValueHere</Index>
<Message d4p1:nil="false">ValueHere</Message>
<Type d4p1:nil="false">ValueHere</Type>
<!--These fields are applicable if the derived type attribute is set to EditorialError-->
<Appealable d4p1:nil="false">ValueHere</Appealable>
<DisapprovedText d4p1:nil="false">ValueHere</DisapprovedText>
<Location d4p1:nil="false">ValueHere</Location>
<PublisherCountry d4p1:nil="false">ValueHere</PublisherCountry>
<ReasonCode>ValueHere</ReasonCode>
</BatchError>
</PartialErrors>
<SharedEntityId>ValueHere</SharedEntityId>
</AddSharedEntityResponse>
</s:Body>
</s:Envelope>
程式碼語法
範例語法可以與 Bing 廣告 SDK搭配使用。 如需更多範例,請參閱 Bing 廣告 API 程式碼范 例。
public async Task<AddSharedEntityResponse> AddSharedEntityAsync(
SharedEntity sharedEntity,
IList<SharedListItem> listItems,
EntityScope? sharedEntityScope)
{
var request = new AddSharedEntityRequest
{
SharedEntity = sharedEntity,
ListItems = listItems,
SharedEntityScope = sharedEntityScope
};
return (await CampaignManagementService.CallAsync((s, r) => s.AddSharedEntityAsync(r), request));
}
static AddSharedEntityResponse addSharedEntity(
SharedEntity sharedEntity,
ArrayOfSharedListItem listItems,
EntityScope sharedEntityScope) throws RemoteException, Exception
{
AddSharedEntityRequest request = new AddSharedEntityRequest();
request.setSharedEntity(sharedEntity);
request.setListItems(listItems);
request.setSharedEntityScope(sharedEntityScope);
return CampaignManagementService.getService().addSharedEntity(request);
}
static function AddSharedEntity(
$sharedEntity,
$listItems,
$sharedEntityScope)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new AddSharedEntityRequest();
$request->SharedEntity = $sharedEntity;
$request->ListItems = $listItems;
$request->SharedEntityScope = $sharedEntityScope;
return $GLOBALS['CampaignManagementProxy']->GetService()->AddSharedEntity($request);
}
response=campaignmanagement_service.AddSharedEntity(
SharedEntity=SharedEntity,
ListItems=ListItems,
SharedEntityScope=SharedEntityScope)
需求
服務: CampaignManagementService.svc v13
命名 空間: https://bingads.microsoft.com/CampaignManagement/v13