Esta página fornece informações sobre os cabeçalhos de solicitação XML SOAP necessários e os cabeçalhos que são retornados em resposta.
Cabeçalhos de solicitação obrigatórios
Todas as chamadas SOAP da API precisam ter um elemento <RequestHeader>
no cabeçalho. esse elemento é definido em todas as WSDLs de serviço. As bibliotecas de cliente fornecem
métodos para adicionar esse cabeçalho para você, usando os valores fornecidos. Esta é uma descrição de todos os elementos de <RequestHeader>
:
Elemento | Descrição |
---|---|
<networkCode> |
O código da rede que está sendo endereçada. Os códigos de rede são necessários ao fazer todas as solicitações, exceto Use apenas o código de rede disponível no login da sua conta. Você pode encontrar o código no site do Google Ad Manager para sua conta, em Administrador > página "Configurações de rede" ao lado de "Código de rede". |
<applicationName> |
Um nome de string arbitrário que identifica seu aplicativo. Isso será mostrado nos arquivos de registro do Google. Por exemplo: "Meu inventário Aplicativo" ou "App_1". |
Observação:todas as solicitações que seu aplicativo envia para a API Ad Manager precisam incluir um token de acesso OAuth2. Transmita o token no cabeçalho HTTP como: Authorization: Bearer YOUR_ACCESS_TOKEN
.
O código a seguir é um exemplo de chamada de solicitação SOAP para getAdUnitsByStatement()
que procura pela raiz AdUnit
.
<?xml version="1.0" encoding="UTF-8"?> <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <soapenv:Header> <ns1:RequestHeader soapenv:actor="http://schemas.xmlsoap.org/soap/actor/next" soapenv:mustUnderstand="0" xmlns:ns1="https://www.google.com/apis/ads/publisher/v202408"> <ns1:networkCode>123456</ns1:networkCode> <ns1:applicationName>DfpApi-Java-2.1.0-dfp_test</ns1:applicationName> </ns1:RequestHeader> </soapenv:Header> <soapenv:Body> <getAdUnitsByStatement xmlns="https://www.google.com/apis/ads/publisher/v202408"> <filterStatement> <query>WHERE parentId IS NULL LIMIT 500</query> </filterStatement> </getAdUnitsByStatement> </soapenv:Body> </soapenv:Envelope>
Observação:se a solicitação de SOAP causar uma Unmarshalling error
, consulte as dicas de solução de problemas em Erros comuns.
Cabeçalhos de resposta
Todas as respostas retornadas da API incluem os elementos de cabeçalho a seguir. Conforme é uma prática recomendada registrar esses valores.
Elemento | Descrição |
---|---|
<requestId> |
Identifica essa solicitação de modo exclusivo. Se você tiver algum problema de suporte, envie esse ID, poderemos encontrar sua solicitação mais facilmente. |
<responseTime> |
Tempo decorrido entre o recebimento da solicitação pelo serviço da Web e o envio do resposta. |
Exemplo de resposta
O código a seguir mostra um exemplo de resposta SOAP para a solicitação anterior.
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Header> <ResponseHeader xmlns="https://www.google.com/apis/ads/publisher/v202408"> <requestId>xxxxxxxxxxxxxxxxxxxx</requestId> <responseTime>1063</responseTime> </ResponseHeader> </soap:Header> <soap:Body> <getAdUnitsByStatementResponse xmlns="https://www.google.com/apis/ads/publisher/v202408"> <rval> <totalResultSetSize>1</totalResultSetSize> <startIndex>0</startIndex> <results> <id>2372</id> <name>RootAdUnit</name> <description></description> <targetWindow>TOP</targetWindow> <status>ACTIVE</status> <adUnitCode>1002372</adUnitCode> <inheritedAdSenseSettings> <value> <adSenseEnabled>true</adSenseEnabled> <borderColor>FFFFFF</borderColor> <titleColor>0000FF</titleColor> <backgroundColor>FFFFFF</backgroundColor> <textColor>000000</textColor> <urlColor>008000</urlColor> <adType>TEXT_AND_IMAGE</adType> <borderStyle>DEFAULT</borderStyle> <fontFamily>DEFAULT</fontFamily> <fontSize>DEFAULT</fontSize> </value> </inheritedAdSenseSettings> </results> </rval> </getAdUnitsByStatementResponse> </soap:Body> </soap:Envelope>