My Business Business Information API . locations . attributes

Instance Methods

close()

Close httplib2 connections.

getExtended(name, x__xgafv=None)

Returns the specified attributes with extended metadata. This includes both the merchant-provided data and the consumer-facing view, which may differ. It also includes metadata describing the current state of edits on each attribute, its origin source, and rejection details.

getGoogleUpdated(name, x__xgafv=None)

Retrieves attributes for a location as they appear live on Google Maps and Search. This consumer-facing view may have been updated by Google or user-generated content and may differ from the merchant's version.

Method Details

close()
Close httplib2 connections.
getExtended(name, x__xgafv=None)
Returns the specified attributes with extended metadata. This includes both the merchant-provided data and the consumer-facing view, which may differ. It also includes metadata describing the current state of edits on each attribute, its origin source, and rejection details.

Args:
  name: string, Required. Google identifier for this location in the form of `locations/{location_id}/attributes`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for AttributesService.GetExtendedAttributes.
  "extendedAttributes": [ # Output only. The attributes with extended metadata.
    { # Represents an attribute along with its edit metadata and current serving state.
      "attributeProvidedByMerchant": { # A location attribute. Attributes provide additional information about a location. The attributes that can be set on a location may vary based on the properties of that location (for example, category). Available attributes are determined by Google and may be added and removed without API changes. # Output only. The underlying attribute data managed by the merchant.
        "name": "A String", # Required. The resource name for this attribute.
        "repeatedEnumValue": { # Values for an attribute with a `value_type` of REPEATED_ENUM. This consists of two lists of value IDs: those that are set (true) and those that are unset (false). Values absent are considered unknown. At least one value must be specified. # When the attribute value type is REPEATED_ENUM, this contains the attribute value, and the other values fields must be empty.
          "setValues": [ # Enum values that are set.
            "A String",
          ],
          "unsetValues": [ # Enum values that are unset.
            "A String",
          ],
        },
        "uriValues": [ # When the attribute value type is URL, this field contains the value(s) for this attribute, and the other values fields must be empty.
          { # Values for an attribute with a `value_type` of URL.
            "uri": "A String", # Required. The proposed URI value for this attribute.
          },
        ],
        "valueType": "A String", # Output only. The type of value that this attribute contains. This should be used to determine how to interpret the value.
        "values": [ # The values for this attribute. The type of the values supplied must match that expected for that attribute. This is a repeated field where multiple attribute values may be provided. Attribute types only support one value.
          "",
        ],
      },
      "attributeSeenByConsumers": { # A location attribute. Attributes provide additional information about a location. The attributes that can be set on a location may vary based on the properties of that location (for example, category). Available attributes are determined by Google and may be added and removed without API changes. # Output only. The attribute data currently visible to consumers on Google Maps and Search.
        "name": "A String", # Required. The resource name for this attribute.
        "repeatedEnumValue": { # Values for an attribute with a `value_type` of REPEATED_ENUM. This consists of two lists of value IDs: those that are set (true) and those that are unset (false). Values absent are considered unknown. At least one value must be specified. # When the attribute value type is REPEATED_ENUM, this contains the attribute value, and the other values fields must be empty.
          "setValues": [ # Enum values that are set.
            "A String",
          ],
          "unsetValues": [ # Enum values that are unset.
            "A String",
          ],
        },
        "uriValues": [ # When the attribute value type is URL, this field contains the value(s) for this attribute, and the other values fields must be empty.
          { # Values for an attribute with a `value_type` of URL.
            "uri": "A String", # Required. The proposed URI value for this attribute.
          },
        ],
        "valueType": "A String", # Output only. The type of value that this attribute contains. This should be used to determine how to interpret the value.
        "values": [ # The values for this attribute. The type of the values supplied must match that expected for that attribute. This is a repeated field where multiple attribute values may be provided. Attribute types only support one value.
          "",
        ],
      },
      "extendedFieldData": { # Represents detailed metadata for an edit on a specific field/attribute. # Output only. Detailed edit status and metadata for this specific attribute.
        "lastEditLifecycleStage": "A String", # Output only. The current lifecycle stage of the merchant's most recent edit on this value.
        "rejectionReason": "A String", # Output only. Reason for rejection, only populated if `last_edit_lifecycle_stage` is `EDIT_LIFECYCLE_STAGE_REJECTED`.
        "source": "A String", # Output only. Origin source attribution of the most recent merchant edit. Not all edits will have a source specified.
        "updateTime": "A String", # Output only. Timestamp of when the merchant's most recent edit was submitted.
      },
    },
  ],
  "name": "A String", # Output only. Google identifier for this location in the form of `locations/{location_id}/attributes`.
}
getGoogleUpdated(name, x__xgafv=None)
Retrieves attributes for a location as they appear live on Google Maps and Search. This consumer-facing view may have been updated by Google or user-generated content and may differ from the merchant's version.

Args:
  name: string, Required. Google identifier for this location in the form of `locations/{location_id}/attributes`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A container for all the attributes for a given location.
  "attributes": [ # A collection of attributes that need to be updated.
    { # A location attribute. Attributes provide additional information about a location. The attributes that can be set on a location may vary based on the properties of that location (for example, category). Available attributes are determined by Google and may be added and removed without API changes.
      "name": "A String", # Required. The resource name for this attribute.
      "repeatedEnumValue": { # Values for an attribute with a `value_type` of REPEATED_ENUM. This consists of two lists of value IDs: those that are set (true) and those that are unset (false). Values absent are considered unknown. At least one value must be specified. # When the attribute value type is REPEATED_ENUM, this contains the attribute value, and the other values fields must be empty.
        "setValues": [ # Enum values that are set.
          "A String",
        ],
        "unsetValues": [ # Enum values that are unset.
          "A String",
        ],
      },
      "uriValues": [ # When the attribute value type is URL, this field contains the value(s) for this attribute, and the other values fields must be empty.
        { # Values for an attribute with a `value_type` of URL.
          "uri": "A String", # Required. The proposed URI value for this attribute.
        },
      ],
      "valueType": "A String", # Output only. The type of value that this attribute contains. This should be used to determine how to interpret the value.
      "values": [ # The values for this attribute. The type of the values supplied must match that expected for that attribute. This is a repeated field where multiple attribute values may be provided. Attribute types only support one value.
        "",
      ],
    },
  ],
  "name": "A String", # Required. Google identifier for this location in the form of `locations/{location_id}/attributes`.
}