Estructura de la API de informes de Search Ads 360

Los componentes principales de la API de Search Ads 360 Reporting son los recursos y los servicios. Un recurso representa una entidad de Search Ads 360 y usas un servicio para recuperar entidades de Search Ads 360.

Jerarquía de objetos

Una cuenta de Search Ads 360 es una jerarquía de objetos.

  • El recurso de nivel superior de una cuenta es el cliente.

  • Cada cuenta contiene una o más campañas activas.

  • Cada Campaign contiene uno o más grupos de anuncios que agrupan tus anuncios en colecciones lógicas.

  • Cada AdGroup contiene uno o más anuncios de grupo de anuncios.

  • Puedes adjuntar uno o más AdGroupCriterion o CampaignCriterion a un grupo de anuncios o una campaña. Los criterios definen cómo se activan los anuncios.

    • Existen muchos tipos de criterios, como palabras clave, rangos de edad y ubicaciones. Los criterios definidos a nivel de la campaña afectan a todos los demás recursos de la campaña. También puedes especificar presupuestos y fechas para toda la campaña.

Recursos

Los recursos representan las entidades de tu cuenta de Search Ads 360. Entre los recursos de ejemplo, se incluyen Customer, Campaign y AdGroup.

IDs de objetos

Cada objeto de Search Ads 360 se identifica con su propio ID. Algunos IDs son únicos a nivel global, es decir, en todas las cuentas de Search Ads 360, mientras que otros son únicos solo dentro de un alcance limitado.

Alcance de unicidad del ID de objeto
ID de presupuesto Global
ID de la campaña Global
ID del grupo de anuncios Global
ID del anuncio Grupo de anuncios

Cada par AdGroupId / AdId es único a nivel global.
ID de AdGroupCriterion Grupo de anuncios

Cada par AdGroupId / CriterionId es único a nivel global.
ID de CampaignCriterion Campaña

Cada par CampaignId / CriterionId es único a nivel global.
Extensiones de anuncios Campaña

Cada par CampaignId / AdExtensionId es único a nivel global.
ID del feed Global
ID del elemento del feed Global
ID del atributo del feed Feed
ID de asignación de feeds Global
ID de etiqueta Global
ID de UserList Global

Estas reglas de ID pueden ser útiles cuando diseñas el almacenamiento local para tus objetos de Search Ads 360.

Tipos de objetos

Algunos objetos se pueden usar para varios tipos de entidades. Si este es el caso, el objeto contiene un campo type que describe su contenido. Por ejemplo, AdGroupAd puede hacer referencia a un anuncio de texto, un anuncio de hotel o un anuncio local. Puedes acceder al valor del tipo a través del campo AdGroupAd.ad.type. Su valor se muestra en la enumeración AdType.

Nombres de recursos

Cada recurso se identifica de forma única con una cadena resource_name que concatena el recurso y sus elementos superiores en una ruta.

Por ejemplo, los nombres de los recursos de la campaña tienen el siguiente formato:

customers/CUSTOMER_ID/campaigns/CAMPAIGN_ID

Una campaña con el ID 987654 en la cuenta de Search Ads 360 con el ID de cliente 1234567 tiene el resource_name:

customers/1234567/campaigns/987654

Servicios

Los servicios te permiten recuperar tus entidades y metadatos de Search Ads 360. Existen tres tipos de servicios:

Servicio de búsqueda
SearchAds360Service es el servicio único y unificado para recuperar todos los objetos de recursos y las estadísticas de rendimiento. Proporciona dos métodos: Search y SearchStream. Ambos métodos requieren una consulta que especifique el recurso que se consultará, los atributos del recurso y las métricas de rendimiento que se recuperarán, los predicados que se usarán para filtrar la solicitud y los segmentos que se usarán para desglosar aún más las estadísticas de rendimiento. Consulta Cómo crear informes de búsqueda y Lenguaje de consulta de Search Ads 360 para obtener más información.
Servicio de campo
SearchAds360FieldService recupera metadatos sobre los recursos, como los atributos disponibles para un recurso y su tipo de datos. Puedes solicitar el catálogo de recursos, campos de recursos, claves de segmentación y métricas disponibles en los métodos de búsqueda SearchAds360Service. Consulta Cómo recuperar metadatos de recursos para obtener más información.
Servicios específicos de la entidad

Estos servicios proporcionan un método de solicitud GET que recupera una sola instancia de recurso. Esto es útil para examinar la estructura de un recurso.

Estos son algunos ejemplos de servicios específicos de la entidad: