Operação de Serviço GetAssetGroupsByIds - Gestão de Campanhas
Obtém AssetGroups especificados.
Elementos do Pedido
O objeto GetAssetGroupsByIdsRequest define os elementos do corpo e do cabeçalho do pedido de operação do serviço. Os elementos têm de estar na mesma ordem mostrada no Pedido SOAP.
Nota
Salvo indicação em contrário abaixo, todos os elementos do pedido são necessários.
Elementos do Corpo do Pedido
Elemento | Descrição | Tipo de Dados |
---|---|---|
AssetGroupIds | Matriz de IDs do grupo de recursos a atualizar para a campanha especificada. Um máximo de 100 grupos de recursos pode ser especificado numa única chamada. | matriz longa |
CampaignId | O ID da campanha de desempenho máximo. | Longo |
ReturnAdditionalFields | Os valores de campo adicionais permitem-lhe obter as funcionalidades mais recentes com a versão atual da API de Gestão de Campanhas e, na próxima versão, os elementos correspondentes serão incluídos por predefinição. Este elemento de pedido é opcional. |
AssetGroupAdditionalField |
Elementos do Cabeçalho do Pedido
Elemento | Descrição | Tipo de Dados |
---|---|---|
AuthenticationToken | O token de acesso OAuth que representa as credenciais de um utilizador que tem permissões para contas do Microsoft Advertising. Para obter mais informações, veja Authentication with OAuth (Autenticação com OAuth). |
cadeia |
CustomerAccountId | O identificador da conta de anúncio que detém ou está associada às entidades no pedido. Este elemento de cabeçalho tem de ter o mesmo valor que o elemento do corpo AccountId quando ambos são necessários. Este elemento é necessário para a maioria das operações de serviço e, como melhor prática, deve sempre defini-lo. Para obter mais informações, veja Obter a Sua Conta e IDs de Cliente. |
cadeia |
CustomerId | O identificador da conta de gestor (cliente) a partir da qual o utilizador está a aceder ou a operar. Um utilizador pode ter acesso a várias contas de gestor. Este elemento é necessário para a maioria das operações de serviço e, como melhor prática, deve sempre defini-lo. Para obter mais informações, veja Obter a Sua Conta e IDs de Cliente. |
cadeia |
DeveloperToken | O token de programador utilizado para aceder à API de Anúncios do Bing. Para obter mais informações, veja Obter um Token de Programador. |
cadeia |
Palavra-passe | Este elemento está reservado para utilização interna e será removido de uma versão futura da API. Tem de utilizar o elemento AuthenticationToken para definir credenciais de utilizador. | cadeia |
Nome de Utilizador | Este elemento está reservado para utilização interna e será removido de uma versão futura da API. Tem de utilizar o elemento AuthenticationToken para definir credenciais de utilizador. | cadeia |
Elementos de Resposta
O objeto GetAssetGroupsByIdsResponse define os elementos do corpo e do cabeçalho da resposta da operação do serviço. Os elementos são devolvidos pela mesma ordem mostrada no SOAP de Resposta.
Elementos do Corpo da Resposta
Elemento | Descrição | Tipo de Dados |
---|---|---|
AssetGroups | Matriz de grupos de recursos a atualizar para a campanha especificada. Um máximo de 100 grupos de recursos pode ser especificado numa única chamada. | Matriz AssetGroup |
PartialErrors | Uma matriz de objetos BatchError que contêm detalhes para quaisquer itens de pedido que não tenham sido bem-sucedidos. | Matriz BatchError |
Elementos do Cabeçalho de Resposta
Elemento | Descrição | Tipo de Dados |
---|---|---|
TrackingId | O identificador da entrada de registo que contém os detalhes da chamada à API. | cadeia |
Pedir SOAP
Este modelo foi gerado por uma ferramenta para mostrar a ordem dos elementos do corpo e do cabeçalho do pedido SOAP. Para tipos suportados que pode utilizar com esta operação de serviço, veja a referência Request Body Elements (Elementos do Corpo do Pedido ) acima.
<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">GetAssetGroupsByIds</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>
<GetAssetGroupsByIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<CampaignId>ValueHere</CampaignId>
<AssetGroupIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</AssetGroupIds>
<ReturnAdditionalFields i:nil="false">ValueHere</ReturnAdditionalFields>
</GetAssetGroupsByIdsRequest>
</s:Body>
</s:Envelope>
Soap de Resposta
Este modelo foi gerado por uma ferramenta para mostrar a ordem dos elementos do corpo e do cabeçalho para a resposta 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>
<GetAssetGroupsByIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<AssetGroups d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<AssetGroup>
<AssetGroupSearchThemes d4p1:nil="false">
<AssetGroupSearchTheme>
<Id d4p1:nil="false">ValueHere</Id>
<SearchTheme d4p1:nil="false">ValueHere</SearchTheme>
</AssetGroupSearchTheme>
</AssetGroupSearchThemes>
<AssetGroupUrlTargets d4p1:nil="false">
<AssetGroupUrlTarget>
<Id d4p1:nil="false">ValueHere</Id>
<TargetCondition1 d4p1:nil="false">ValueHere</TargetCondition1>
<TargetCondition2 d4p1:nil="false">ValueHere</TargetCondition2>
<TargetCondition3 d4p1:nil="false">ValueHere</TargetCondition3>
<TargetConditionOperator1 d4p1:nil="false">ValueHere</TargetConditionOperator1>
<TargetConditionOperator2 d4p1:nil="false">ValueHere</TargetConditionOperator2>
<TargetConditionOperator3 d4p1:nil="false">ValueHere</TargetConditionOperator3>
<TargetValue1 d4p1:nil="false">ValueHere</TargetValue1>
<TargetValue2 d4p1:nil="false">ValueHere</TargetValue2>
<TargetValue3 d4p1:nil="false">ValueHere</TargetValue3>
</AssetGroupUrlTarget>
</AssetGroupUrlTargets>
<BusinessName d4p1:nil="false">ValueHere</BusinessName>
<CallToAction d4p1:nil="false">ValueHere</CallToAction>
<Descriptions d4p1:nil="false">
<AssetLink>
<Asset d4p1:nil="false" d4p1:type="-- derived type specified here with the appropriate prefix --">
<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 TextAsset-->
<Text d4p1:nil="false">ValueHere</Text>
<!--These fields are applicable if the derived type attribute is set to ImageAsset-->
<CropHeight d4p1:nil="false">ValueHere</CropHeight>
<CropWidth d4p1:nil="false">ValueHere</CropWidth>
<CropX d4p1:nil="false">ValueHere</CropX>
<CropY d4p1:nil="false">ValueHere</CropY>
<SubType d4p1:nil="false">ValueHere</SubType>
<TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
<TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
<!--These fields are applicable if the derived type attribute is set to VideoAsset-->
<SubType d4p1:nil="false">ValueHere</SubType>
<ThumbnailImage d4p1:nil="false">
<CropHeight d4p1:nil="false">ValueHere</CropHeight>
<CropWidth d4p1:nil="false">ValueHere</CropWidth>
<CropX d4p1:nil="false">ValueHere</CropX>
<CropY d4p1:nil="false">ValueHere</CropY>
<SubType d4p1:nil="false">ValueHere</SubType>
<TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
<TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
</ThumbnailImage>
</Asset>
<AssetPerformanceLabel d4p1:nil="false">ValueHere</AssetPerformanceLabel>
<EditorialStatus d4p1:nil="false">ValueHere</EditorialStatus>
<PinnedField d4p1:nil="false">ValueHere</PinnedField>
</AssetLink>
</Descriptions>
<EditorialStatus d4p1:nil="false">ValueHere</EditorialStatus>
<EndDate d4p1:nil="false">
<Day>ValueHere</Day>
<Month>ValueHere</Month>
<Year>ValueHere</Year>
</EndDate>
<FinalMobileUrls d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</FinalMobileUrls>
<FinalUrls d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</FinalUrls>
<ForwardCompatibilityMap xmlns:e399="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e399:KeyValuePairOfstringstring>
<e399:key d4p1:nil="false">ValueHere</e399:key>
<e399:value d4p1:nil="false">ValueHere</e399:value>
</e399:KeyValuePairOfstringstring>
</ForwardCompatibilityMap>
<Headlines d4p1:nil="false">
<AssetLink>
<Asset d4p1:nil="false" d4p1:type="-- derived type specified here with the appropriate prefix --">
<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 TextAsset-->
<Text d4p1:nil="false">ValueHere</Text>
<!--These fields are applicable if the derived type attribute is set to ImageAsset-->
<CropHeight d4p1:nil="false">ValueHere</CropHeight>
<CropWidth d4p1:nil="false">ValueHere</CropWidth>
<CropX d4p1:nil="false">ValueHere</CropX>
<CropY d4p1:nil="false">ValueHere</CropY>
<SubType d4p1:nil="false">ValueHere</SubType>
<TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
<TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
<!--These fields are applicable if the derived type attribute is set to VideoAsset-->
<SubType d4p1:nil="false">ValueHere</SubType>
<ThumbnailImage d4p1:nil="false">
<CropHeight d4p1:nil="false">ValueHere</CropHeight>
<CropWidth d4p1:nil="false">ValueHere</CropWidth>
<CropX d4p1:nil="false">ValueHere</CropX>
<CropY d4p1:nil="false">ValueHere</CropY>
<SubType d4p1:nil="false">ValueHere</SubType>
<TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
<TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
</ThumbnailImage>
</Asset>
<AssetPerformanceLabel d4p1:nil="false">ValueHere</AssetPerformanceLabel>
<EditorialStatus d4p1:nil="false">ValueHere</EditorialStatus>
<PinnedField d4p1:nil="false">ValueHere</PinnedField>
</AssetLink>
</Headlines>
<Id d4p1:nil="false">ValueHere</Id>
<Images d4p1:nil="false">
<AssetLink>
<Asset d4p1:nil="false" d4p1:type="-- derived type specified here with the appropriate prefix --">
<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 TextAsset-->
<Text d4p1:nil="false">ValueHere</Text>
<!--These fields are applicable if the derived type attribute is set to ImageAsset-->
<CropHeight d4p1:nil="false">ValueHere</CropHeight>
<CropWidth d4p1:nil="false">ValueHere</CropWidth>
<CropX d4p1:nil="false">ValueHere</CropX>
<CropY d4p1:nil="false">ValueHere</CropY>
<SubType d4p1:nil="false">ValueHere</SubType>
<TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
<TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
<!--These fields are applicable if the derived type attribute is set to VideoAsset-->
<SubType d4p1:nil="false">ValueHere</SubType>
<ThumbnailImage d4p1:nil="false">
<CropHeight d4p1:nil="false">ValueHere</CropHeight>
<CropWidth d4p1:nil="false">ValueHere</CropWidth>
<CropX d4p1:nil="false">ValueHere</CropX>
<CropY d4p1:nil="false">ValueHere</CropY>
<SubType d4p1:nil="false">ValueHere</SubType>
<TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
<TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
</ThumbnailImage>
</Asset>
<AssetPerformanceLabel d4p1:nil="false">ValueHere</AssetPerformanceLabel>
<EditorialStatus d4p1:nil="false">ValueHere</EditorialStatus>
<PinnedField d4p1:nil="false">ValueHere</PinnedField>
</AssetLink>
</Images>
<LongHeadlines d4p1:nil="false">
<AssetLink>
<Asset d4p1:nil="false" d4p1:type="-- derived type specified here with the appropriate prefix --">
<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 TextAsset-->
<Text d4p1:nil="false">ValueHere</Text>
<!--These fields are applicable if the derived type attribute is set to ImageAsset-->
<CropHeight d4p1:nil="false">ValueHere</CropHeight>
<CropWidth d4p1:nil="false">ValueHere</CropWidth>
<CropX d4p1:nil="false">ValueHere</CropX>
<CropY d4p1:nil="false">ValueHere</CropY>
<SubType d4p1:nil="false">ValueHere</SubType>
<TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
<TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
<!--These fields are applicable if the derived type attribute is set to VideoAsset-->
<SubType d4p1:nil="false">ValueHere</SubType>
<ThumbnailImage d4p1:nil="false">
<CropHeight d4p1:nil="false">ValueHere</CropHeight>
<CropWidth d4p1:nil="false">ValueHere</CropWidth>
<CropX d4p1:nil="false">ValueHere</CropX>
<CropY d4p1:nil="false">ValueHere</CropY>
<SubType d4p1:nil="false">ValueHere</SubType>
<TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
<TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
</ThumbnailImage>
</Asset>
<AssetPerformanceLabel d4p1:nil="false">ValueHere</AssetPerformanceLabel>
<EditorialStatus d4p1:nil="false">ValueHere</EditorialStatus>
<PinnedField d4p1:nil="false">ValueHere</PinnedField>
</AssetLink>
</LongHeadlines>
<Name d4p1:nil="false">ValueHere</Name>
<Path1 d4p1:nil="false">ValueHere</Path1>
<Path2 d4p1:nil="false">ValueHere</Path2>
<StartDate d4p1:nil="false">
<Day>ValueHere</Day>
<Month>ValueHere</Month>
<Year>ValueHere</Year>
</StartDate>
<Status d4p1:nil="false">ValueHere</Status>
<Videos d4p1:nil="false">
<AssetLink>
<Asset d4p1:nil="false" d4p1:type="-- derived type specified here with the appropriate prefix --">
<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 TextAsset-->
<Text d4p1:nil="false">ValueHere</Text>
<!--These fields are applicable if the derived type attribute is set to ImageAsset-->
<CropHeight d4p1:nil="false">ValueHere</CropHeight>
<CropWidth d4p1:nil="false">ValueHere</CropWidth>
<CropX d4p1:nil="false">ValueHere</CropX>
<CropY d4p1:nil="false">ValueHere</CropY>
<SubType d4p1:nil="false">ValueHere</SubType>
<TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
<TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
<!--These fields are applicable if the derived type attribute is set to VideoAsset-->
<SubType d4p1:nil="false">ValueHere</SubType>
<ThumbnailImage d4p1:nil="false">
<CropHeight d4p1:nil="false">ValueHere</CropHeight>
<CropWidth d4p1:nil="false">ValueHere</CropWidth>
<CropX d4p1:nil="false">ValueHere</CropX>
<CropY d4p1:nil="false">ValueHere</CropY>
<SubType d4p1:nil="false">ValueHere</SubType>
<TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
<TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
</ThumbnailImage>
</Asset>
<AssetPerformanceLabel d4p1:nil="false">ValueHere</AssetPerformanceLabel>
<EditorialStatus d4p1:nil="false">ValueHere</EditorialStatus>
<PinnedField d4p1:nil="false">ValueHere</PinnedField>
</AssetLink>
</Videos>
</AssetGroup>
</AssetGroups>
<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:e400="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e400:KeyValuePairOfstringstring>
<e400:key d4p1:nil="false">ValueHere</e400:key>
<e400:value d4p1:nil="false">ValueHere</e400:value>
</e400: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>
</GetAssetGroupsByIdsResponse>
</s:Body>
</s:Envelope>
Sintaxe de Código
A sintaxe de exemplo pode ser utilizada com os SDKs de Anúncios do Bing. Veja Exemplos de Código da API de Anúncios do Bing para obter mais exemplos.
public async Task<GetAssetGroupsByIdsResponse> GetAssetGroupsByIdsAsync(
long campaignId,
IList<long> assetGroupIds,
AssetGroupAdditionalField? returnAdditionalFields)
{
var request = new GetAssetGroupsByIdsRequest
{
CampaignId = campaignId,
AssetGroupIds = assetGroupIds,
ReturnAdditionalFields = returnAdditionalFields
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetAssetGroupsByIdsAsync(r), request));
}
static GetAssetGroupsByIdsResponse getAssetGroupsByIds(
java.lang.Long campaignId,
ArrayOflong assetGroupIds,
ArrayList<AssetGroupAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
GetAssetGroupsByIdsRequest request = new GetAssetGroupsByIdsRequest();
request.setCampaignId(campaignId);
request.setAssetGroupIds(assetGroupIds);
request.setReturnAdditionalFields(returnAdditionalFields);
return CampaignManagementService.getService().getAssetGroupsByIds(request);
}
static function GetAssetGroupsByIds(
$campaignId,
$assetGroupIds,
$returnAdditionalFields)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetAssetGroupsByIdsRequest();
$request->CampaignId = $campaignId;
$request->AssetGroupIds = $assetGroupIds;
$request->ReturnAdditionalFields = $returnAdditionalFields;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetAssetGroupsByIds($request);
}
response=campaignmanagement_service.GetAssetGroupsByIds(
CampaignId=CampaignId,
AssetGroupIds=AssetGroupIds,
ReturnAdditionalFields=ReturnAdditionalFields)
Requisitos
Serviço: CampaignManagementService.svc v13
Espaço de nomes: https://bingads.microsoft.com/CampaignManagement/v13
URL do Pedido
https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/AssetGroups/QueryByIds
Elementos do Pedido
O objeto GetAssetGroupsByIdsRequest define os elementos do corpo e do cabeçalho do pedido de operação do serviço.
Nota
Salvo indicação em contrário abaixo, todos os elementos do pedido são necessários.
Elementos do Corpo do Pedido
Elemento | Descrição | Tipo de Dados |
---|---|---|
AssetGroupIds | Matriz de IDs do grupo de recursos a atualizar para a campanha especificada. Um máximo de 100 grupos de recursos pode ser especificado numa única chamada. | matriz longa |
CampaignId | O ID da campanha de desempenho máximo. | Longo |
ReturnAdditionalFields | Os valores de campo adicionais permitem-lhe obter as funcionalidades mais recentes com a versão atual da API de Gestão de Campanhas e, na próxima versão, os elementos correspondentes serão incluídos por predefinição. Este elemento de pedido é opcional. |
AssetGroupAdditionalField |
Elementos do Cabeçalho do Pedido
Elemento | Descrição | Tipo de Dados |
---|---|---|
Autorização | O token de acesso OAuth que representa as credenciais de um utilizador que tem permissões para contas do Microsoft Advertising. Certifique-se de que o token tem o prefixo "Portador", que é necessário para uma autenticação adequada. Para obter mais informações, veja Authentication with OAuth (Autenticação com OAuth). |
cadeia |
CustomerAccountId | O identificador da conta de anúncio que detém ou está associada às entidades no pedido. Este elemento de cabeçalho tem de ter o mesmo valor que o elemento do corpo AccountId quando ambos são necessários. Este elemento é necessário para a maioria das operações de serviço e, como melhor prática, deve sempre defini-lo. Para obter mais informações, veja Obter a Sua Conta e IDs de Cliente. |
cadeia |
CustomerId | O identificador da conta de gestor (cliente) a partir da qual o utilizador está a aceder ou a operar. Um utilizador pode ter acesso a várias contas de gestor. Este elemento é necessário para a maioria das operações de serviço e, como melhor prática, deve sempre defini-lo. Para obter mais informações, veja Obter a Sua Conta e IDs de Cliente. |
cadeia |
DeveloperToken | O token de programador utilizado para aceder à API de Anúncios do Bing. Para obter mais informações, veja Obter um Token de Programador. |
cadeia |
Palavra-passe | Este elemento está reservado para utilização interna e será removido de uma versão futura da API. Tem de utilizar o elemento AuthenticationToken para definir credenciais de utilizador. | cadeia |
Nome de Utilizador | Este elemento está reservado para utilização interna e será removido de uma versão futura da API. Tem de utilizar o elemento AuthenticationToken para definir credenciais de utilizador. | cadeia |
Elementos de Resposta
O objeto GetAssetGroupsByIdsResponse define os elementos do corpo e do cabeçalho da resposta da operação do serviço. Os elementos são devolvidos pela mesma ordem mostrada no JSON de Resposta.
Elementos do Corpo da Resposta
Elemento | Descrição | Tipo de Dados |
---|---|---|
AssetGroups | Matriz de grupos de recursos a atualizar para a campanha especificada. Um máximo de 100 grupos de recursos pode ser especificado numa única chamada. | Matriz AssetGroup |
PartialErrors | Uma matriz de objetos BatchError que contêm detalhes para quaisquer itens de pedido que não tenham sido bem-sucedidos. | Matriz BatchError |
Elementos do Cabeçalho de Resposta
Elemento | Descrição | Tipo de Dados |
---|---|---|
TrackingId | O identificador da entrada de registo que contém os detalhes da chamada à API. | cadeia |
Pedir JSON
Este modelo foi gerado por uma ferramenta para mostrar os elementos do corpo e do cabeçalho do pedido JSON. Para tipos suportados que pode utilizar com esta operação de serviço, veja a referência Request Body Elements (Elementos do Corpo do Pedido ) acima.
{
"CampaignId": "LongValueHere",
"AssetGroupIds": [
"LongValueHere"
],
"ReturnAdditionalFields": "ValueHere"
}
JSON de Resposta
Este modelo foi gerado por uma ferramenta para mostrar os elementos do corpo e do cabeçalho da resposta JSON.
Segue-se um exemplo aplicável se o tipo de Recurso for ImageAsset, BatchError for EditorialError.
{
"AssetGroups": [
{
"AssetGroupSearchThemes": [
{
"Id": "LongValueHere",
"SearchTheme": "ValueHere"
}
],
"AssetGroupUrlTargets": [
{
"Id": "LongValueHere",
"TargetCondition1": "ValueHere",
"TargetCondition2": "ValueHere",
"TargetCondition3": "ValueHere",
"TargetConditionOperator1": "ValueHere",
"TargetConditionOperator2": "ValueHere",
"TargetConditionOperator3": "ValueHere",
"TargetValue1": "ValueHere",
"TargetValue2": "ValueHere",
"TargetValue3": "ValueHere"
}
],
"BusinessName": "ValueHere",
"CallToAction": "ValueHere",
"Descriptions": [
{
"Asset": {
"Id": "LongValueHere",
"Name": "ValueHere",
"Type": "ImageAsset",
"CropHeight": IntValueHere,
"CropWidth": IntValueHere,
"CropX": IntValueHere,
"CropY": IntValueHere,
"SubType": "ValueHere",
"TargetHeight": IntValueHere,
"TargetWidth": IntValueHere
},
"AssetPerformanceLabel": "ValueHere",
"EditorialStatus": "ValueHere",
"PinnedField": "ValueHere"
}
],
"EditorialStatus": "ValueHere",
"EndDate": {
"Day": IntValueHere,
"Month": IntValueHere,
"Year": IntValueHere
},
"FinalMobileUrls": [
"ValueHere"
],
"FinalUrls": [
"ValueHere"
],
"ForwardCompatibilityMap": [
{
"key": "ValueHere",
"value": "ValueHere"
}
],
"Headlines": [
{
"Asset": {
"Id": "LongValueHere",
"Name": "ValueHere",
"Type": "ImageAsset",
"CropHeight": IntValueHere,
"CropWidth": IntValueHere,
"CropX": IntValueHere,
"CropY": IntValueHere,
"SubType": "ValueHere",
"TargetHeight": IntValueHere,
"TargetWidth": IntValueHere
},
"AssetPerformanceLabel": "ValueHere",
"EditorialStatus": "ValueHere",
"PinnedField": "ValueHere"
}
],
"Id": "LongValueHere",
"Images": [
{
"Asset": {
"Id": "LongValueHere",
"Name": "ValueHere",
"Type": "ImageAsset",
"CropHeight": IntValueHere,
"CropWidth": IntValueHere,
"CropX": IntValueHere,
"CropY": IntValueHere,
"SubType": "ValueHere",
"TargetHeight": IntValueHere,
"TargetWidth": IntValueHere
},
"AssetPerformanceLabel": "ValueHere",
"EditorialStatus": "ValueHere",
"PinnedField": "ValueHere"
}
],
"LongHeadlines": [
{
"Asset": {
"Id": "LongValueHere",
"Name": "ValueHere",
"Type": "ImageAsset",
"CropHeight": IntValueHere,
"CropWidth": IntValueHere,
"CropX": IntValueHere,
"CropY": IntValueHere,
"SubType": "ValueHere",
"TargetHeight": IntValueHere,
"TargetWidth": IntValueHere
},
"AssetPerformanceLabel": "ValueHere",
"EditorialStatus": "ValueHere",
"PinnedField": "ValueHere"
}
],
"Name": "ValueHere",
"Path1": "ValueHere",
"Path2": "ValueHere",
"StartDate": {
"Day": IntValueHere,
"Month": IntValueHere,
"Year": IntValueHere
},
"Status": "ValueHere",
"Videos": [
{
"Asset": {
"Id": "LongValueHere",
"Name": "ValueHere",
"Type": "ImageAsset",
"CropHeight": IntValueHere,
"CropWidth": IntValueHere,
"CropX": IntValueHere,
"CropY": IntValueHere,
"SubType": "ValueHere",
"TargetHeight": IntValueHere,
"TargetWidth": IntValueHere
},
"AssetPerformanceLabel": "ValueHere",
"EditorialStatus": "ValueHere",
"PinnedField": "ValueHere"
}
]
}
],
"PartialErrors": [
{
"Code": IntValueHere,
"Details": "ValueHere",
"ErrorCode": "ValueHere",
"FieldPath": "ValueHere",
"ForwardCompatibilityMap": [
{
"key": "ValueHere",
"value": "ValueHere"
}
],
"Index": IntValueHere,
"Message": "ValueHere",
"Type": "EditorialError",
"Appealable": "ValueHere",
"DisapprovedText": "ValueHere",
"Location": "ValueHere",
"PublisherCountry": "ValueHere",
"ReasonCode": IntValueHere
}
]
}
Sintaxe de Código
Para chamar a API REST através de SDKs, tem de atualizar o SDK para uma determinada versão e configurar os parâmetros do sistema. A sintaxe de exemplo pode ser utilizada com os SDKs de Anúncios do Bing. Veja Exemplos de Código da API de Anúncios do Bing para obter mais exemplos.
public async Task<GetAssetGroupsByIdsResponse> GetAssetGroupsByIdsAsync(
long campaignId,
IList<long> assetGroupIds,
AssetGroupAdditionalField? returnAdditionalFields)
{
var request = new GetAssetGroupsByIdsRequest
{
CampaignId = campaignId,
AssetGroupIds = assetGroupIds,
ReturnAdditionalFields = returnAdditionalFields
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetAssetGroupsByIdsAsync(r), request));
}
static GetAssetGroupsByIdsResponse getAssetGroupsByIds(
java.lang.Long campaignId,
ArrayOflong assetGroupIds,
ArrayList<AssetGroupAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
GetAssetGroupsByIdsRequest request = new GetAssetGroupsByIdsRequest();
request.setCampaignId(campaignId);
request.setAssetGroupIds(assetGroupIds);
request.setReturnAdditionalFields(returnAdditionalFields);
return CampaignManagementService.getService().getAssetGroupsByIds(request);
}
static function GetAssetGroupsByIds(
$campaignId,
$assetGroupIds,
$returnAdditionalFields)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetAssetGroupsByIdsRequest();
$request->CampaignId = $campaignId;
$request->AssetGroupIds = $assetGroupIds;
$request->ReturnAdditionalFields = $returnAdditionalFields;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetAssetGroupsByIds($request);
}
response=campaignmanagement_service.GetAssetGroupsByIds(
CampaignId=CampaignId,
AssetGroupIds=AssetGroupIds,
ReturnAdditionalFields=ReturnAdditionalFields)